feat: earning intrinsics #872

Merged
Sainan merged 1 commits from earn-intrinsics into main 2025-01-31 08:03:15 -08:00
Owner

Closes #552
Closes #554

Closes #552 Closes #554
coderabbitai[bot] commented 2025-01-31 00:13:24 -08:00 (Migrated from github.com)
Author
Owner

Walkthrough

The pull request introduces changes to handle player skill gains during mission inventory updates. In the missionInventoryUpdateService.ts file, a new case for "PlayerSkillGains" is added to the addMissionInventoryUpdates function. This modification allows updating the PlayerSkills property of the inventory object, specifically incrementing the LPP_SPACE and LPP_DRIFTER properties based on the provided inventory updates. The requestTypes.ts file is correspondingly updated to include a new IPlayerSkills type and add a PlayerSkillGains property to the IMissionInventoryUpdateRequest interface, supporting the new functionality for tracking player skill gains.

Assessment against linked issues

Objective Addressed Explanation
Save Intrinsics gains [#552]
Implement player skill gains tracking [#554]
Support full set of skill gain types
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.
<!-- This is an auto-generated comment: summarize by coderabbit.ai --> <!-- walkthrough_start --> ## Walkthrough The pull request introduces changes to handle player skill gains during mission inventory updates. In the `missionInventoryUpdateService.ts` file, a new case for `"PlayerSkillGains"` is added to the `addMissionInventoryUpdates` function. This modification allows updating the `PlayerSkills` property of the inventory object, specifically incrementing the `LPP_SPACE` and `LPP_DRIFTER` properties based on the provided inventory updates. The `requestTypes.ts` file is correspondingly updated to include a new `IPlayerSkills` type and add a `PlayerSkillGains` property to the `IMissionInventoryUpdateRequest` interface, supporting the new functionality for tracking player skill gains. ## Assessment against linked issues | Objective | Addressed | Explanation | |-----------|-----------|-------------| | Save Intrinsics gains [#552] | ✅ | | | Implement player skill gains tracking [#554] | ✅ | | | Support full set of skill gain types | ✅ | | <!-- walkthrough_end --> <!-- internal state start --> <!-- FAHghAtBAEAqAWBLAztF0CGA7TBXALgPYQDmAplmQE4b5kAm0AxoQLasX4Bc0ADldEIAjAFZkm+RADcyqIQE9mhetQxChifADoMiaFAB8wY+CjGAxOegAFAErQAyrnYYq84wjJ9cAGx/QqMgBHXFl8aEl8HwZoACIAMzJaHiSqLEQsEjQsfCoM5EQmZFjoAHcMVGRcIVZNOkYFCPgvXGRqR10sbEwsRnREFRzEeMQYxvxm6CxnIXaADgB2ACYtaABJcPQK5EImRFoY0s14Jq8AcU0ACWqAsl5CAqI3aHjCAQdeDCYyADkMkQwDmoMioABoeowmN1ZpgmN9kG1GLRTi9CH5CEdMtAAKq2AAyPAA2vB8PheMguAB6SkkY7VLQsViU5Cfb7pLAAtpUEGUj5fX7/QHA6iU3i+HyUxZLAC6AAoSWSKdTaRN6YzmayKIKuTy+d8/hyhdyRWK/JLlgBKVYeSYqZBMPK8SSEHCEeIo03+QIhMLZeiFA6oCbIzTMHwPWRoBGhVDmACscaWEOg8bjABZVj9CJh6P7nV1/Cp8LofKg3tAyAAPXg+bC0RAu1CBEiuf1YiZeJjwbDkVCsDAqbJNdCe24+5DhVxefiEKQDGIZFF2h2IJ0NrBaYyGEyQGAURhuvBEUgUVT1JTsTg8fiCUTiSQyOSKFgqGjqTQ6PTb0wwBD9VDdBgBDEOQlA0OejIcDkPA0KU0BVC4zyNC+qjvtouj6BARg7mYwDIFQTDMsChSyJStQIuuaxYDIORvPI2K8PQBxAtyJFaPgFLALE3HAJY0AAIJrCeYEHIwCH9s8h5dj2sg2l4/rxO6GS5MouDwpgUxkHBUJtEOHbQAABgO9AALIoAULpUTRTz0YxgYGS8uBYBI64RNm3a9NE0C4HZdBNmQtbnkQfC1vI7TIAA1ogfjIKsHziMMAZ+PI4KhsZAHMBUXivAI+kRWQigGbE1ihdQDhRX4ZydMUDmlEgXbeb5kb6QZJUYGFVDldFpYOTOvDUPgiiHi1GTWXRDnCGIEirJ4mlweGtJMNkDpkFBHEogZeLWNYAD6DjWPxADCACiDnYIwm3bTtAAithrAAYrAx22L1VCEP1VCSJGh6taVnUVT10BCFlB44PpUgYD4MZ8G9c4qH0YOTAZo2cHRDFMX5BkzUgAG5pormsMoiXNZMLA5G9/jxOGcGNMpb30GpGRZBgc1AzQzknIu+nIEc+ANROBxreCkPU0zqK5ZMM7wgUWKHjW7XhQD0Atvk0AM3kWLkRZOAo7Rzw+RjsiZtmhAdgIVYoJIWLxE5LkupDmiKOUAE+HQgQHgIgSEzI9CbsYvFWPxrtnuuQbZvpKhMLW4Gh4I7pVvcn0xOWYpCD4hQVkMX3IFu0BZswHm9m5S7iNH9aNnHFbVm854p9U6dLZw+ORqU1BeP2g5czjavDPEm7cbEW64fhhGDf1yCUt6Mb4LA8jj+xnEDwHAlCaBZ4xOJrhDe60mZLJwCzQpSnk6p6ks5QcFj2Q4IGWsbUdV1MUGeCwX6YgrCJ+EAt0GtAG9PB1Q2g+hyD4RQ6UNJ9QGilQy98yoAyqvkZ+lcJjoCvsXFqawzIUUstRVGbh0YHFsMEaeDllLUHiPybGXhjL4xdJXW+sD/rdWQA5CgHl1IR1oCzCcVA1L4FwIEIGYD0SYiyPpXIXwoqy3dPLDq8ElYqywKgXmSAcBa1crrGyjVDaxTgJMC2E4xY8L4QIrww0kaYPMpRXBetbKGyIeOfApCcjkP5LcfsqtlJfHwOCFRKIL4w3elAoGZAxYYF4P1XoMRX76P/uYrwBirZZEgZ9UYsU5IFxkmrQgkYsCm0wIpe8PRFCJLFik7OggJahNynPWQ4I8kCHoDk1AaVg5VKUCfSm1NKkVioG9AQHl6Dp2kSiFCVCcx5g0ZUCRiASAkhyuUKgSJ/4J3OkGSYNtnL5gdoNZBFisHaysnguxhDiFhGcW7Ch3wyjHEIAQaAhMFLyDFpoVALBBELUKH7Cwgc2nlyUeg20pdXD/LLPHauScPbeDThnJu2dc4mTIBMZQ8FZldH4YIg2okeC3wAIrTwANIFUOunTgzjDIj0pFfCeU8wiz3nhxBygAkwkMmsfFYQiXyBJaMHI4I75/UfoDRcBlKXUsnmcic9KjaMuADAKily3FYvqDiyx2CsBHNsQQugDiSFDhFQRKltSaUSpnkaheDk8lwQyFHXAdoYECvgdVHg/KFZMJigAbgMlxHisqsI4T3HE90QFjxr3AjESCV4AgYDgpvJCz5lCoQ0OhL8fqfwXlqPgHaAxkA7UCHOLSDAdoC0+phbCaamBXPiN8eIswABs8R61pjjGoAAzAATgWLmegHa4wLAAIz0CYH22tSwyDNpUG20t/r02aCzfQHNebRit3oDtfcpagA= --> <!-- internal state end --> <!-- finishing_touch_checkbox_start --> <details> <summary>✨ Finishing Touches</summary> - [ ] <!-- {"checkboxId": "7962f53c-55bc-4827-bfbf-6a18da830691"} --> 📝 Generate Docstrings (Beta) </details> <!-- finishing_touch_checkbox_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-31 00:17:10 -08:00
coderabbitai[bot] (Migrated from github.com) left a comment
Author
Owner

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/types/requestTypes.ts (1)

77-77: Consider making PlayerSkillGains optional for backward compatibility.

The PlayerSkillGains property is marked as required. This could break existing code that doesn't provide this property.

Apply this diff to make the property optional:

-    PlayerSkillGains: IPlayerSkills;
+    PlayerSkillGains?: IPlayerSkills;
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between de7758684b and cfacfcefbe.

📒 Files selected for processing (2)
  • src/services/missionInventoryUpdateService.ts (1 hunks)
  • src/types/requestTypes.ts (2 hunks)
🔇 Additional comments (1)
src/types/requestTypes.ts (1)

14-15: LGTM!

The import of IPlayerSkills is correctly added alongside other inventory types.

**Actionable comments posted: 1** <details> <summary>🧹 Nitpick comments (1)</summary><blockquote> <details> <summary>src/types/requestTypes.ts (1)</summary><blockquote> `77-77`: **Consider making PlayerSkillGains optional for backward compatibility.** The `PlayerSkillGains` property is marked as required. This could break existing code that doesn't provide this property. Apply this diff to make the property optional: ```diff - PlayerSkillGains: IPlayerSkills; + PlayerSkillGains?: IPlayerSkills; ``` </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 de7758684b7cf277723738bb2f1e387b15a34f21 and cfacfcefbe6f6f45ab397ddd97571dc162e5ade9. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `src/services/missionInventoryUpdateService.ts` (1 hunks) * `src/types/requestTypes.ts` (2 hunks) </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>src/types/requestTypes.ts (1)</summary> `14-15`: **LGTM!** The import of `IPlayerSkills` is correctly added alongside other inventory types. </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
@ -153,0 +154,4 @@
inventory.PlayerSkills.LPP_SPACE += value.LPP_SPACE;
inventory.PlayerSkills.LPP_DRIFTER += value.LPP_DRIFTER;
break;
}
coderabbitai[bot] (Migrated from github.com) commented 2025-01-31 00:17:09 -08:00
Author
Owner

⚠️ Potential issue

Add null checks and validation for PlayerSkills.

The current implementation has potential issues:

  1. No null check for inventory.PlayerSkills
  2. No validation of input values
  3. No error handling for potential overflow

Apply this diff to add safety checks:

 case "PlayerSkillGains": {
+    if (!inventory.PlayerSkills) {
+        inventory.PlayerSkills = { LPP_SPACE: 0, LPP_DRIFTER: 0 };
+    }
+    // Ensure input values are non-negative
+    const spaceGains = Math.max(0, value.LPP_SPACE || 0);
+    const drifterGains = Math.max(0, value.LPP_DRIFTER || 0);
+    // Prevent overflow
+    inventory.PlayerSkills.LPP_SPACE = Math.min(
+        Number.MAX_SAFE_INTEGER,
+        inventory.PlayerSkills.LPP_SPACE + spaceGains
+    );
+    inventory.PlayerSkills.LPP_DRIFTER = Math.min(
+        Number.MAX_SAFE_INTEGER,
+        inventory.PlayerSkills.LPP_DRIFTER + drifterGains
+    );
-    inventory.PlayerSkills.LPP_SPACE += value.LPP_SPACE;
-    inventory.PlayerSkills.LPP_DRIFTER += value.LPP_DRIFTER;
     break;
 }
📝 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.

            case "PlayerSkillGains": {
                if (!inventory.PlayerSkills) {
                    inventory.PlayerSkills = { LPP_SPACE: 0, LPP_DRIFTER: 0 };
                }
                // Ensure input values are non-negative
                const spaceGains = Math.max(0, value.LPP_SPACE || 0);
                const drifterGains = Math.max(0, value.LPP_DRIFTER || 0);
                // Prevent overflow
                inventory.PlayerSkills.LPP_SPACE = Math.min(
                    Number.MAX_SAFE_INTEGER,
                    inventory.PlayerSkills.LPP_SPACE + spaceGains
                );
                inventory.PlayerSkills.LPP_DRIFTER = Math.min(
                    Number.MAX_SAFE_INTEGER,
                    inventory.PlayerSkills.LPP_DRIFTER + drifterGains
                );
                break;
            }
_:warning: Potential issue_ **Add null checks and validation for PlayerSkills.** The current implementation has potential issues: 1. No null check for `inventory.PlayerSkills` 2. No validation of input values 3. No error handling for potential overflow Apply this diff to add safety checks: ```diff case "PlayerSkillGains": { + if (!inventory.PlayerSkills) { + inventory.PlayerSkills = { LPP_SPACE: 0, LPP_DRIFTER: 0 }; + } + // Ensure input values are non-negative + const spaceGains = Math.max(0, value.LPP_SPACE || 0); + const drifterGains = Math.max(0, value.LPP_DRIFTER || 0); + // Prevent overflow + inventory.PlayerSkills.LPP_SPACE = Math.min( + Number.MAX_SAFE_INTEGER, + inventory.PlayerSkills.LPP_SPACE + spaceGains + ); + inventory.PlayerSkills.LPP_DRIFTER = Math.min( + Number.MAX_SAFE_INTEGER, + inventory.PlayerSkills.LPP_DRIFTER + drifterGains + ); - inventory.PlayerSkills.LPP_SPACE += value.LPP_SPACE; - inventory.PlayerSkills.LPP_DRIFTER += value.LPP_DRIFTER; break; } ``` <!-- suggestion_start --> <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 case "PlayerSkillGains": { if (!inventory.PlayerSkills) { inventory.PlayerSkills = { LPP_SPACE: 0, LPP_DRIFTER: 0 }; } // Ensure input values are non-negative const spaceGains = Math.max(0, value.LPP_SPACE || 0); const drifterGains = Math.max(0, value.LPP_DRIFTER || 0); // Prevent overflow inventory.PlayerSkills.LPP_SPACE = Math.min( Number.MAX_SAFE_INTEGER, inventory.PlayerSkills.LPP_SPACE + spaceGains ); inventory.PlayerSkills.LPP_DRIFTER = Math.min( Number.MAX_SAFE_INTEGER, inventory.PlayerSkills.LPP_DRIFTER + drifterGains ); break; } ````` </details> <!-- suggestion_end --> <!-- This is an auto-generated comment by CodeRabbit -->
Sign in to join this conversation.
No description provided.