feat: earn focus xp with a lens #871

Sainan · 2025-01-27T04:39:23-08:00

Sainan commented

2025-01-27 04:39:23 -08:00

Closes #547
Closes #551

Closes #547 Closes #551

coderabbitai[bot] commented

2025-01-27 04:39:29 -08:00

(Migrated from github.com)

Walkthrough

The pull request introduces a new feature for managing focus experience points (XP) in the inventory system across multiple files. In inventoryService.ts, a new function addFocusXpIncreases is added to handle incrementing focus XP for different focus types. The missionInventoryUpdateService.ts is updated to support processing of focus XP increases through a new case in the addMissionInventoryUpdates method. Additionally, the requestTypes.ts is modified to include an optional FocusXpIncreases property in the IMissionInventoryUpdateRequest type, allowing for the transmission of focus XP increase data during mission inventory updates. These changes collectively enhance the system's capability to track and manage focus-specific experience points within the inventory management workflow.

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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.

## Walkthrough The pull request introduces a new feature for managing focus experience points (XP) in the inventory system across multiple files. In `inventoryService.ts`, a new function `addFocusXpIncreases` is added to handle incrementing focus XP for different focus types. The `missionInventoryUpdateService.ts` is updated to support processing of focus XP increases through a new case in the `addMissionInventoryUpdates` method. Additionally, the `requestTypes.ts` is modified to include an optional `FocusXpIncreases` property in the `IMissionInventoryUpdateRequest` type, allowing for the transmission of focus XP increase data during mission inventory updates. These changes collectively enhance the system's capability to track and manage focus-specific experience points within the inventory management workflow.      <details> <summary>✨ Finishing Touches</summary> - [ ]  📝 Generate Docstrings (Beta) </details>   --- 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>

coderabbitai[bot] (Migrated from github.com) reviewed 2025-01-27 04:43:53 -08:00

coderabbitai[bot] (Migrated from github.com) left a comment

Actionable comments posted: 1

🧹 Nitpick comments (2)

src/services/inventoryService.ts (2)
913-924: Consider removing unused enum values.

The enum includes several focus types that aren't used in the implementation (AP_UNIVERSAL, AP_PRECEPT, AP_FUSION, AP_UMBRA, AP_ANY). Consider removing them to maintain a cleaner codebase.
 enum FocusType {
-    AP_UNIVERSAL,
     AP_ATTACK,
     AP_DEFENSE,
     AP_TACTIC,
     AP_POWER,
-    AP_PRECEPT,
-    AP_FUSION,
     AP_WARD,
-    AP_UMBRA,
-    AP_ANY
 }
927-927: Consider using a more explicit initialization.

The current initialization only includes the used focus types. Consider making this more explicit by using a type for the focus XP object.
+type FocusXPState = {
+    AP_ATTACK: number;
+    AP_DEFENSE: number;
+    AP_TACTIC: number;
+    AP_POWER: number;
+    AP_WARD: number;
+};
+
+const DEFAULT_FOCUS_XP: FocusXPState = {
+    AP_ATTACK: 0,
+    AP_DEFENSE: 0,
+    AP_TACTIC: 0,
+    AP_POWER: 0,
+    AP_WARD: 0
+};
+
-inventory.FocusXP ??= { AP_ATTACK: 0, AP_DEFENSE: 0, AP_TACTIC: 0, AP_POWER: 0, AP_WARD: 0 };
+inventory.FocusXP ??= { ...DEFAULT_FOCUS_XP };

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 97bec71b05 and 812f190e72.

📒 Files selected for processing (3)

src/services/inventoryService.ts (1 hunks)
src/services/missionInventoryUpdateService.ts (2 hunks)
src/types/requestTypes.ts (1 hunks)

🔇 Additional comments (3)

src/types/requestTypes.ts (1)

75-75: LGTM! Type definition is well-structured.

The optional FocusXpIncreases property is correctly typed as number[] and appropriately placed within the interface.

src/services/missionInventoryUpdateService.ts (2)

9-9: LGTM! Import is correctly placed.

The addFocusXpIncreases import is properly added and maintains alphabetical ordering.

149-152: LGTM! Focus XP case is well-implemented.

The case properly handles the focus XP increases by calling the imported function and follows the established pattern of other cases in the switch statement.

**Actionable comments posted: 1** <details> <summary>🧹 Nitpick comments (2)</summary><blockquote> <details> <summary>src/services/inventoryService.ts (2)</summary><blockquote> `913-924`: **Consider removing unused enum values.** The enum includes several focus types that aren't used in the implementation (`AP_UNIVERSAL`, `AP_PRECEPT`, `AP_FUSION`, `AP_UMBRA`, `AP_ANY`). Consider removing them to maintain a cleaner codebase. ```diff enum FocusType { - AP_UNIVERSAL, AP_ATTACK, AP_DEFENSE, AP_TACTIC, AP_POWER, - AP_PRECEPT, - AP_FUSION, AP_WARD, - AP_UMBRA, - AP_ANY } ``` --- `927-927`: **Consider using a more explicit initialization.** The current initialization only includes the used focus types. Consider making this more explicit by using a type for the focus XP object. ```diff +type FocusXPState = { + AP_ATTACK: number; + AP_DEFENSE: number; + AP_TACTIC: number; + AP_POWER: number; + AP_WARD: number; +}; + +const DEFAULT_FOCUS_XP: FocusXPState = { + AP_ATTACK: 0, + AP_DEFENSE: 0, + AP_TACTIC: 0, + AP_POWER: 0, + AP_WARD: 0 +}; + -inventory.FocusXP ??= { AP_ATTACK: 0, AP_DEFENSE: 0, AP_TACTIC: 0, AP_POWER: 0, AP_WARD: 0 }; +inventory.FocusXP ??= { ...DEFAULT_FOCUS_XP }; ``` </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 97bec71b0502a5ddebec70b17a8b88460dca15b9 and 812f190e7281ba3ac40d621fdc54b0104b16ecda. </details> <details> <summary>📒 Files selected for processing (3)</summary> * `src/services/inventoryService.ts` (1 hunks) * `src/services/missionInventoryUpdateService.ts` (2 hunks) * `src/types/requestTypes.ts` (1 hunks) </details> <details> <summary>🔇 Additional comments (3)</summary><blockquote> <details> <summary>src/types/requestTypes.ts (1)</summary> `75-75`: **LGTM! Type definition is well-structured.** The optional `FocusXpIncreases` property is correctly typed as `number[]` and appropriately placed within the interface. </details> <details> <summary>src/services/missionInventoryUpdateService.ts (2)</summary> `9-9`: **LGTM! Import is correctly placed.** The `addFocusXpIncreases` import is properly added and maintains alphabetical ordering. --- `149-152`: **LGTM! Focus XP case is well-implemented.** The case properly handles the focus XP increases by calling the imported function and follows the established pattern of other cases in the switch statement. </details> </blockquote></details> </details>

src/services/inventoryService.ts

						
				@ -912,0 +930,4 @@

				        inventory.FocusXP.AP_TACTIC += focusXpPlus[FocusType.AP_TACTIC];

				        inventory.FocusXP.AP_POWER += focusXpPlus[FocusType.AP_POWER];

				        inventory.FocusXP.AP_WARD += focusXpPlus[FocusType.AP_WARD];

				    }

coderabbitai[bot] (Migrated from github.com) commented

2025-01-27 04:43:52 -08:00

🛠️ Refactor suggestion

Add type safety and validation for focus XP updates.

The current implementation has several potential issues:

No validation of array length matching enum values
No bounds checking for XP values
Direct array access without type safety

Consider this safer implementation:

 if (focusXpPlus) {
+    if (focusXpPlus.length < FocusType.AP_WARD + 1) {
+        logger.warn(`Received incomplete focus XP array: ${focusXpPlus.length} elements`);
+        return;
+    }
+
     inventory.FocusXP ??= { AP_ATTACK: 0, AP_DEFENSE: 0, AP_TACTIC: 0, AP_POWER: 0, AP_WARD: 0 };
+
+    // Ensure XP values are non-negative
+    const getXP = (type: FocusType): number => Math.max(0, focusXpPlus[type] || 0);
+
-    inventory.FocusXP.AP_ATTACK += focusXpPlus[FocusType.AP_ATTACK];
-    inventory.FocusXP.AP_DEFENSE += focusXpPlus[FocusType.AP_DEFENSE];
-    inventory.FocusXP.AP_TACTIC += focusXpPlus[FocusType.AP_TACTIC];
-    inventory.FocusXP.AP_POWER += focusXpPlus[FocusType.AP_POWER];
-    inventory.FocusXP.AP_WARD += focusXpPlus[FocusType.AP_WARD];
+    inventory.FocusXP.AP_ATTACK += getXP(FocusType.AP_ATTACK);
+    inventory.FocusXP.AP_DEFENSE += getXP(FocusType.AP_DEFENSE);
+    inventory.FocusXP.AP_TACTIC += getXP(FocusType.AP_TACTIC);
+    inventory.FocusXP.AP_POWER += getXP(FocusType.AP_POWER);
+    inventory.FocusXP.AP_WARD += getXP(FocusType.AP_WARD);
 }

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

    if (focusXpPlus) {
        if (focusXpPlus.length < FocusType.AP_WARD + 1) {
            logger.warn(`Received incomplete focus XP array: ${focusXpPlus.length} elements`);
            return;
        }

        inventory.FocusXP ??= { AP_ATTACK: 0, AP_DEFENSE: 0, AP_TACTIC: 0, AP_POWER: 0, AP_WARD: 0 };

        // Ensure XP values are non-negative
        const getXP = (type: FocusType): number => Math.max(0, focusXpPlus[type] || 0);

        inventory.FocusXP.AP_ATTACK += getXP(FocusType.AP_ATTACK);
        inventory.FocusXP.AP_DEFENSE += getXP(FocusType.AP_DEFENSE);
        inventory.FocusXP.AP_TACTIC += getXP(FocusType.AP_TACTIC);
        inventory.FocusXP.AP_POWER += getXP(FocusType.AP_POWER);
        inventory.FocusXP.AP_WARD += getXP(FocusType.AP_WARD);
    }

_:hammer_and_wrench: Refactor suggestion_ **Add type safety and validation for focus XP updates.** The current implementation has several potential issues: 1. No validation of array length matching enum values 2. No bounds checking for XP values 3. Direct array access without type safety Consider this safer implementation: ```diff if (focusXpPlus) { + if (focusXpPlus.length < FocusType.AP_WARD + 1) { + logger.warn(`Received incomplete focus XP array: ${focusXpPlus.length} elements`); + return; + } + inventory.FocusXP ??= { AP_ATTACK: 0, AP_DEFENSE: 0, AP_TACTIC: 0, AP_POWER: 0, AP_WARD: 0 }; + + // Ensure XP values are non-negative + const getXP = (type: FocusType): number => Math.max(0, focusXpPlus[type] || 0); + - inventory.FocusXP.AP_ATTACK += focusXpPlus[FocusType.AP_ATTACK]; - inventory.FocusXP.AP_DEFENSE += focusXpPlus[FocusType.AP_DEFENSE]; - inventory.FocusXP.AP_TACTIC += focusXpPlus[FocusType.AP_TACTIC]; - inventory.FocusXP.AP_POWER += focusXpPlus[FocusType.AP_POWER]; - inventory.FocusXP.AP_WARD += focusXpPlus[FocusType.AP_WARD]; + inventory.FocusXP.AP_ATTACK += getXP(FocusType.AP_ATTACK); + inventory.FocusXP.AP_DEFENSE += getXP(FocusType.AP_DEFENSE); + inventory.FocusXP.AP_TACTIC += getXP(FocusType.AP_TACTIC); + inventory.FocusXP.AP_POWER += getXP(FocusType.AP_POWER); + inventory.FocusXP.AP_WARD += getXP(FocusType.AP_WARD); } ```  <details> <summary>📝 Committable suggestion</summary> > ‼️ **IMPORTANT** > Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements. `````suggestion if (focusXpPlus) { if (focusXpPlus.length < FocusType.AP_WARD + 1) { logger.warn(`Received incomplete focus XP array: ${focusXpPlus.length} elements`); return; } inventory.FocusXP ??= { AP_ATTACK: 0, AP_DEFENSE: 0, AP_TACTIC: 0, AP_POWER: 0, AP_WARD: 0 }; // Ensure XP values are non-negative const getXP = (type: FocusType): number => Math.max(0, focusXpPlus[type] || 0); inventory.FocusXP.AP_ATTACK += getXP(FocusType.AP_ATTACK); inventory.FocusXP.AP_DEFENSE += getXP(FocusType.AP_DEFENSE); inventory.FocusXP.AP_TACTIC += getXP(FocusType.AP_TACTIC); inventory.FocusXP.AP_POWER += getXP(FocusType.AP_POWER); inventory.FocusXP.AP_WARD += getXP(FocusType.AP_WARD); } ````` </details>

Sainan reviewed 2025-01-27 04:47:19 -08:00

src/services/inventoryService.ts

						
				@ -912,0 +930,4 @@

				        inventory.FocusXP.AP_TACTIC += focusXpPlus[FocusType.AP_TACTIC];

				        inventory.FocusXP.AP_POWER += focusXpPlus[FocusType.AP_POWER];

				        inventory.FocusXP.AP_WARD += focusXpPlus[FocusType.AP_WARD];

				    }

Sainan commented

2025-01-27 04:47:19 -08:00

So safe, feels like a blanket wrapped around me.

coderabbitai[bot] (Migrated from github.com) reviewed 2025-01-27 04:47:41 -08:00

src/services/inventoryService.ts

						
				@ -912,0 +930,4 @@

				        inventory.FocusXP.AP_TACTIC += focusXpPlus[FocusType.AP_TACTIC];

				        inventory.FocusXP.AP_POWER += focusXpPlus[FocusType.AP_POWER];

				        inventory.FocusXP.AP_WARD += focusXpPlus[FocusType.AP_WARD];

				    }

coderabbitai[bot] (Migrated from github.com) commented

2025-01-27 04:47:41 -08:00

@Sainan Glad you appreciate the safety-first approach! 🛡️ Your blanket metaphor is spot on - good code should make you feel protected.

If you found this review helpful, would you consider giving us a shout-out on X?
Thank you for using CodeRabbit!

@Sainan Glad you appreciate the safety-first approach! 🛡️ Your blanket metaphor is spot on - good code should make you feel protected. ---  If you found this review helpful, would you consider giving us a shout-out on [X](https://twitter.com/intent/tweet?related=CodeRabbitAI&text=Just%20received%20a%20fantastic%20code%20review%20from%20%40coderabbitai!%20%F0%9F%9B%A0%EF%B8%8F%20Adding%20type%20safety%20and%20validation%20for%20focus%20XP%20updates%20will%20prevent%20potential%20issues%20and%20enhance%20reliability.%20Check%20it%20out!%20%F0%9F%9A%80&url=https%3A%2F%2Fgithub.com%2Fspaceninjaserver%2FSpaceNinjaServer%2Fpull%2F871%23discussion_r1930469408)? Thank you for using CodeRabbit!

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: OpenWF/SpaceNinjaServer#871