feat(webui): add "Fully Level Up Helminth" #717

Merged
Sainan merged 2 commits from helminth-unlockall into main 2025-01-05 03:26:26 -08:00
Owner
No description provided.
coderabbitai[bot] commented 2025-01-04 22:18:04 -08:00 (Migrated from github.com)
Author
Owner

Walkthrough

The pull request introduces a new feature for unlocking Helminth-related capabilities across multiple files. In the infestedFoundryController.ts, a new case labeled "custom_unlockall" has been implemented to handle XP calculations and updates for the Infested Foundry. The index.html file has been modified to include a new button for fully leveling up Helminth, positioned alongside an existing button for unlocking Focus Schools. Correspondingly, the script.js file adds a new doHelminthUnlockAll() function that enables users to trigger the Helminth unlocking process through a POST request to the appropriate API endpoint. These changes collectively provide a streamlined mechanism for users to unlock and maximize Helminth-related features in the application.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.
<!-- This is an auto-generated comment: summarize by coderabbit.ai --> <!-- walkthrough_start --> ## Walkthrough The pull request introduces a new feature for unlocking Helminth-related capabilities across multiple files. In the `infestedFoundryController.ts`, a new case labeled "custom_unlockall" has been implemented to handle XP calculations and updates for the Infested Foundry. The `index.html` file has been modified to include a new button for fully leveling up Helminth, positioned alongside an existing button for unlocking Focus Schools. Correspondingly, the `script.js` file adds a new `doHelminthUnlockAll()` function that enables users to trigger the Helminth unlocking process through a POST request to the appropriate API endpoint. These changes collectively provide a streamlined mechanism for users to unlock and maximize Helminth-related features in the application. <!-- walkthrough_end --> <!-- internal state start --> <!-- FAHghAtBAEAqAWBLAztF0CGA7TBXALgPYQDmAplmQE4b5kAm0AxoQLasX4Bc0ADldEIAjAFZkm+RADcyqIQE9mhetQxChifADoMiaFAB8wY+CjHYmgDZkeAMzK0AFAHcyQ3IgCUPDPUYAiADFcS0tFABkyGUtoAFVeaAAJMktWRCx8eH9gADlcViFqHgB2AEZi4FjkIugAZV0sbGNDE0gYCkZCWzwiUgpVOkYWdk4efkFRcUkZOUUWFRp1TR09FtMYBHR0bB7ickoaQaURjJ4aZ2hkfNYMKkUFJQW1DW1dfQgjVrNgZComAHoWBkqIRQtRkP8MLxEP90vZkINAoRcFh6HcAMKEYGg6xULT4ZBcYD+EnAADEZOgAEEAJJ9A60BiXa63RRdZjwbDkZDGKnQSgXJgYarQSxqFJM/xMXAItgAfRRlkITAA1hhQv5oJy5GQKJg/EyiNBMmRoAADOGyRHI1EYrH4EFgqhm6C2FESRBYrRwJCoIUi9VK5yoWyEAQYZgyoisQS8AaenCZWgc8Qq1AmyNUKicaBkAAecaoiAoTFNvEI6QJ0EcAA0AAqeQTdDNmmlYeHWlFo+Rm7005vwU31tCoazIdOcnClACspQAHMVp3KAAzLgA0aHwzHV0rFdAnpvoiFs9mzWFL/N1KkYRuzGCY8GNnK3mWzyHgoMY2C/fgPSizsjlqi6QkNA9Z9i+g44LgvD0Iyf7ZkwiBxnIwpMliT7oMOD5cqa36XBgMxPqa6QyBkYbyN6CCmm+QEiqGAiZOg/qmh0CFkAAjrgVrQM4mgfgQ0DZvguBUFgIGYFgihwfgGBUYO+pHpIGHskxfpoWg2L0LgpaoBGAquu6ymNJYmiKAx0CKsqKoSYGroOCJb5CSkjI3oQxHmm2HYMEiXZ3C6QhoZ0ODgcYFLUpYdCHAm6buRmKhMGK0VYqg7L5uWVBHGGfC4EIplMLmGSaMWPLADAORkIKGm+NePBmlKUbylZqqBv4LrpB5FrtlaPk2t2mLYk6LpuuexmaeavwAkCDo4uCkLQrC3UIr1fnyANM1OviyBmsSpJld8CK0IgAKuO4MLpCoeZaPA+CsJYRIktk4W0vSAxMlc7Csk2HK4aV1E/Vg3LjRmiSwAAsuErqINYmlSKCMgeTVxUqd0+mVdA7j4EQOAWc1NmA5goRJCkaQZI+1jRHpqKYNArDKMex1HRhRoZvmKCSATmPY662V47ZRNItKqC1A+hCgsg3q1HGSG2IzoTyBuGZcxhuNYEqqr8zEgsynUovi1qwoY7qODODQvBxowHURrwtwYCQZuPrJJAbs4SAPoTUWoJoqBHsgvBioo/CEIWkiyPJpoGcrOPZW68uilEKQSTBxOpJWj7akbeo1UyR6IfgYRG0GHlswiElR96OTuYQJoCAiVA6Y56qCAII0eliTc4YDsjGnFCmgxDooYPIyJbtlSokMdBsI4Ueo3CoWjGGFlJUpF8YpT3HkJUlTNYKl3TpWGWUCLwuX5YVkih6VMAAEIENz2f0HVIBR8wYrjgAvP4Qj4Dg39YBA/BEA3DuJqLEiVjoqk/vQQgyRU5k1iGrayK9LCOE8AAbn8AYYIcdIjRDiAkWBpNMggH+FHAw7VEwKX8FSJgLAUT4E1NUNuOB2RmkOpIE6bgPCLUutdW6lgdo3zvhhOmR5ZYMCfi/RKwpkCfz/hjH+ACizAPkKA88+VIH+GgQg9WKpkHa2QCLD84tUEYIMDo6yEUtbKh1kYsWlhkAkLIRQjy1DaE2gYZcKYCZvpsNkhw/4p1uEXXzHwu6LpABJhOaEAvADDP2ETgaRH8v4/wUf/QBKi1HgNVFAwgFjVT6JsYYvWDjTGYPySqKx0ADG62MQ4pxCS4n/FiS4jMbi6EZEYd4lGE1/HHUCVw86qJQk3XCbtbI+0IDGHYf0oJMJkBMCLLwbQIhCTjPJMvOk+w3qMA+io76nduTmAUmI7olYQTaV0jTAyrcxpmmgYQtOFTkFmhdm7R86AVDIEQCQSgblXT3mhpoRkHk+YE3ZHZR5ZMIDZj3EyewtBRJhx9OgW5PiCBAoAF7dxbNmKQ6pEAyTIFSAg8BMUug4JkZQG8KBXGzE+ZMGYZTUBHD0D8RZsWMEKAxU0Nx8agQjHWAA8rUWAzkuI8RZgpM080hneXoL5W0lFeDwF4C6Do5ZKy8X4h5CVdw+C20pSys0oiyDvyFtGBUiCWqhF7CivSfhkY4AoJOK5GY0Xt1MvgNkA5TQLKWVuB4QcpCEtspcB0Dg7rpCZM4IeG88aExiFCzI9lEVOQ6liPCzCF7AH+iXDmoEPUmTMs5G46RUDuknOQegLsdVYHcqIhmQpjKxQ8tNR0roi7ZWoCCAQk56CmQJhmmuBrMp7zbcoMg4dLwXCLayysZB7auU0lK1ieZ2YSTrg3JF2qqWCQwCebxBMMzj0nqpBS1dBwtyMjFHNS8IpRR3q2+K4ht4tu+gfTK6Fj6n0npwYqshmjQDBmQKlP5armgeSTJ51q9GhFQS4vxR1OFnX+P65CKztrrP2p8dYhVOiowIHsfohwmTDA4KcISGALh7K+g8eYqglivFWB8UAbRjhpHwHKQlyA5R4uLK4egcpDqZXeLh9jABOJgy4JP0AACy2CENOJgAAmOT9AhAAGZbByaEMuOTmnpwYGnNOa8ZAFMqFsBJucy4VNMhaGxqAHHNDcfoLx/jlUGByg6GJoAA=== --> <!-- internal state end --> <!-- tips_start --> --- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? <details> <summary>❤️ Share</summary> - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code) </details> <details> <summary>🪧 Tips</summary> ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit <commit_id>, please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR. ([Beta](https://docs.coderabbit.ai/early-access#beta)) - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements. </details> <!-- tips_end -->
coderabbitai[bot] (Migrated from github.com) reviewed 2025-01-04 22:22:19 -08:00
coderabbitai[bot] (Migrated from github.com) left a comment
Author
Owner

Actionable comments posted: 0

🧹 Nitpick comments (3)
static/webui/script.js (1)

958-963: Consider adding success/error handling and user feedback.
While this method successfully posts to the endpoint, you might want to include success/error callbacks (e.g., .done() and .fail()) to provide clearer user feedback and robust error handling—especially if something goes wrong during the unlock process.
Regarding the static analysis warning that 'doHelminthUnlockAll' is defined but never used, it appears to be a false positive since the function is indeed called from the HTML.

🧰 Tools
🪛 eslint

[error] 958-958: 'doHelminthUnlockAll' is defined but never used.

(@typescript-eslint/no-unused-vars)


[error] 960-960: '$' is not defined.

(no-undef)

src/controllers/api/infestedFoundryController.ts (1)

226-241: Return a JSON response for consistency.
Currently, the "custom_unlockall" case simply calls res.end() without returning any JSON. For consistency with other cases and to confirm the unlock operation’s success, it may be helpful to return a minimal JSON response (e.g., { status: "ok" }).

static/webui/index.html (1)

281-282: Maintain consistent button structures.
Using a paragraph for one button and not for the other may introduce minor layout inconsistencies. Consider wrapping both buttons similarly (or removing the <p> wrapper) to maintain uniform styling in the UI.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06bc0123ba and 9c09d4fb5c.

📒 Files selected for processing (3)
  • src/controllers/api/infestedFoundryController.ts (1 hunks)
  • static/webui/index.html (1 hunks)
  • static/webui/script.js (1 hunks)
🧰 Additional context used
🪛 eslint
static/webui/script.js

[error] 958-958: 'doHelminthUnlockAll' is defined but never used.

(@typescript-eslint/no-unused-vars)


[error] 960-960: '$' is not defined.

(no-undef)

**Actionable comments posted: 0** <details> <summary>🧹 Nitpick comments (3)</summary><blockquote> <details> <summary>static/webui/script.js (1)</summary><blockquote> `958-963`: **Consider adding success/error handling and user feedback.** While this method successfully posts to the endpoint, you might want to include success/error callbacks (e.g., `.done()` and `.fail()`) to provide clearer user feedback and robust error handling—especially if something goes wrong during the unlock process. Regarding the static analysis warning that `'doHelminthUnlockAll' is defined but never used`, it appears to be a false positive since the function is indeed called from the HTML. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 eslint</summary> [error] 958-958: 'doHelminthUnlockAll' is defined but never used. (@typescript-eslint/no-unused-vars) --- [error] 960-960: '$' is not defined. (no-undef) </details> </details> </blockquote></details> <details> <summary>src/controllers/api/infestedFoundryController.ts (1)</summary><blockquote> `226-241`: **Return a JSON response for consistency.** Currently, the `"custom_unlockall"` case simply calls `res.end()` without returning any JSON. For consistency with other cases and to confirm the unlock operation’s success, it may be helpful to return a minimal JSON response (e.g., `{ status: "ok" }`). </blockquote></details> <details> <summary>static/webui/index.html (1)</summary><blockquote> `281-282`: **Maintain consistent button structures.** Using a paragraph for one button and not for the other may introduce minor layout inconsistencies. Consider wrapping both buttons similarly (or removing the `<p>` wrapper) to maintain uniform styling in the UI. </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: .coderabbit.yaml** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 06bc0123baee78b6d339bea8da8c734132b49620 and 9c09d4fb5c24db3f4b0435a55dede4fdef9802ed. </details> <details> <summary>📒 Files selected for processing (3)</summary> * `src/controllers/api/infestedFoundryController.ts` (1 hunks) * `static/webui/index.html` (1 hunks) * `static/webui/script.js` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 eslint</summary> <details> <summary>static/webui/script.js</summary> [error] 958-958: 'doHelminthUnlockAll' is defined but never used. (@typescript-eslint/no-unused-vars) --- [error] 960-960: '$' is not defined. (no-undef) </details> </details> </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Sign in to join this conversation.
No description provided.