fix: provide LoadOutPresets & Ships in missionInventoryUpdate response #869

Sainan · 2025-01-25T03:24:48-08:00

Sainan commented

2025-01-25 03:24:48 -08:00

Fixes #868

coderabbitai[bot] commented

2025-01-25 03:24:54 -08:00

(Migrated from github.com)

Walkthrough

The pull request introduces changes to the inventory handling in two controllers: inventoryController.ts and missionInventoryUpdateController.ts. A new function getInventoryResponse is added to inventoryController.ts, which replaces the previous method of generating inventory responses. This function takes an inventory document and a flag for XP-based level cap, and returns a transformed inventory response compatible with the client interface. The changes modify how inventory responses are processed, moving from inline logic to a more modular approach. The modifications impact how inventory data is prepared and returned, particularly in the context of mission inventory updates.

Assessment against linked issues

Objective	Addressed	Explanation
Loadout changes on mission complete/abort	✅
Handle default loadout after mission	❓	Unable to definitively confirm without seeing full implementation details of `getInventoryResponse`

The assessment is limited due to the minimal context provided in the linked issue. While the changes suggest improvements in inventory and loadout handling, a complete validation would require more detailed review of the implementation specifics.

✨ 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 changes to the inventory handling in two controllers: `inventoryController.ts` and `missionInventoryUpdateController.ts`. A new function `getInventoryResponse` is added to `inventoryController.ts`, which replaces the previous method of generating inventory responses. This function takes an inventory document and a flag for XP-based level cap, and returns a transformed inventory response compatible with the client interface. The changes modify how inventory responses are processed, moving from inline logic to a more modular approach. The modifications impact how inventory data is prepared and returned, particularly in the context of mission inventory updates. ## Assessment against linked issues | Objective | Addressed | Explanation | |-----------|-----------|-------------| | Loadout changes on mission complete/abort | ✅ | | | Handle default loadout after mission | ❓ | Unable to definitively confirm without seeing full implementation details of `getInventoryResponse` | The assessment is limited due to the minimal context provided in the linked issue. While the changes suggest improvements in inventory and loadout handling, a complete validation would require more detailed review of the implementation specifics.      <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-25 03:30:16 -08:00

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

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

Line range hint 57-262: Consider breaking down the large function for better maintainability.

The getInventoryResponse function handles multiple concerns (config overrides, feature flags, data population). Consider breaking it down into smaller, focused functions for better maintainability.

Example refactor:

 export const getInventoryResponse = async (
     inventory: TInventoryDatabaseDocument,
     xpBasedLevelCapDisabled: boolean
 ): Promise<IInventoryClient> => {
-    const inventoryWithLoadOutPresets = await inventory.populate<{ LoadOutPresets: ILoadoutDatabase }>(
-        "LoadOutPresets"
-    );
-    const inventoryWithLoadOutPresetsAndShips = await inventoryWithLoadOutPresets.populate<{ Ships: IShipInventory }>(
-        "Ships"
-    );
-    const inventoryResponse = inventoryWithLoadOutPresetsAndShips.toJSON<IInventoryClient>();
+    const inventoryResponse = await populateAndTransformInventory(inventory);
+    applyConfigOverrides(inventoryResponse, xpBasedLevelCapDisabled);
+    applyFeatureFlags(inventoryResponse);
+    return inventoryResponse;
 };
+
+async function populateAndTransformInventory(
+    inventory: TInventoryDatabaseDocument
+): Promise<IInventoryClient> {
+    const inventoryWithLoadOutPresets = await inventory.populate<{ LoadOutPresets: ILoadoutDatabase }>(
+        "LoadOutPresets"
+    );
+    const inventoryWithLoadOutPresetsAndShips = await inventoryWithLoadOutPresets.populate<{ Ships: IShipInventory }>(
+        "Ships"
+    );
+    return inventoryWithLoadOutPresetsAndShips.toJSON<IInventoryClient>();
+}
+
+function applyConfigOverrides(
+    inventoryResponse: IInventoryClient,
+    xpBasedLevelCapDisabled: boolean
+): void {
+    if (config.infiniteCredits) {
+        inventoryResponse.RegularCredits = 999999999;
+    }
+    // ... other config overrides
+}
+
+function applyFeatureFlags(inventoryResponse: IInventoryClient): void {
+    // Fix for #380
+    inventoryResponse.NextRefill = { $date: { $numberLong: "9999999999999" } };
+    // This determines if the "void fissures" tab is shown in navigation.
+    inventoryResponse.HasOwnedVoidProjectionsPreviously = true;
+    inventoryResponse.LastInventorySync = toOid(new Types.ObjectId());
+}

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6a427018e3 and 465b8c005d.

📒 Files selected for processing (2)

src/controllers/api/inventoryController.ts (3 hunks)
src/controllers/api/missionInventoryUpdateController.ts (3 hunks)

🔇 Additional comments (4)

src/controllers/api/inventoryController.ts (3)

3-3: LGTM! Import changes enhance type safety.

The addition of TInventoryDatabaseDocument type import supports proper typing for the new getInventoryResponse function.

54-55: LGTM! Controller logic is now more modular.

The change improves code organization by delegating response generation to a dedicated function while preserving the existing functionality.

Line range hint 61-64: LGTM! Successfully implements PR objectives.

The implementation correctly populates both LoadOutPresets and Ships in the inventory response, addressing the core requirement of the PR.

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

11-11: LGTM! Successfully integrates the new inventory response handling.

The changes correctly use the new getInventoryResponse function, ensuring that LoadOutPresets and Ships are included in both success and failure responses.

Also applies to: 63-63, 84-84

**Actionable comments posted: 0** <details> <summary>🧹 Nitpick comments (1)</summary><blockquote> <details> <summary>src/controllers/api/inventoryController.ts (1)</summary><blockquote> Line range hint `57-262`: **Consider breaking down the large function for better maintainability.** The `getInventoryResponse` function handles multiple concerns (config overrides, feature flags, data population). Consider breaking it down into smaller, focused functions for better maintainability. Example refactor: ```diff export const getInventoryResponse = async ( inventory: TInventoryDatabaseDocument, xpBasedLevelCapDisabled: boolean ): Promise<IInventoryClient> => { - const inventoryWithLoadOutPresets = await inventory.populate<{ LoadOutPresets: ILoadoutDatabase }>( - "LoadOutPresets" - ); - const inventoryWithLoadOutPresetsAndShips = await inventoryWithLoadOutPresets.populate<{ Ships: IShipInventory }>( - "Ships" - ); - const inventoryResponse = inventoryWithLoadOutPresetsAndShips.toJSON<IInventoryClient>(); + const inventoryResponse = await populateAndTransformInventory(inventory); + applyConfigOverrides(inventoryResponse, xpBasedLevelCapDisabled); + applyFeatureFlags(inventoryResponse); + return inventoryResponse; }; + +async function populateAndTransformInventory( + inventory: TInventoryDatabaseDocument +): Promise<IInventoryClient> { + const inventoryWithLoadOutPresets = await inventory.populate<{ LoadOutPresets: ILoadoutDatabase }>( + "LoadOutPresets" + ); + const inventoryWithLoadOutPresetsAndShips = await inventoryWithLoadOutPresets.populate<{ Ships: IShipInventory }>( + "Ships" + ); + return inventoryWithLoadOutPresetsAndShips.toJSON<IInventoryClient>(); +} + +function applyConfigOverrides( + inventoryResponse: IInventoryClient, + xpBasedLevelCapDisabled: boolean +): void { + if (config.infiniteCredits) { + inventoryResponse.RegularCredits = 999999999; + } + // ... other config overrides +} + +function applyFeatureFlags(inventoryResponse: IInventoryClient): void { + // Fix for #380 + inventoryResponse.NextRefill = { $date: { $numberLong: "9999999999999" } }; + // This determines if the "void fissures" tab is shown in navigation. + inventoryResponse.HasOwnedVoidProjectionsPreviously = true; + inventoryResponse.LastInventorySync = toOid(new Types.ObjectId()); +} ``` </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 6a427018e39dbc54e8382d0e1b859b208b5b8821 and 465b8c005d0096f1772ca8d2e67f275854096e99. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `src/controllers/api/inventoryController.ts` (3 hunks) * `src/controllers/api/missionInventoryUpdateController.ts` (3 hunks) </details> <details> <summary>🔇 Additional comments (4)</summary><blockquote> <details> <summary>src/controllers/api/inventoryController.ts (3)</summary> `3-3`: **LGTM! Import changes enhance type safety.** The addition of `TInventoryDatabaseDocument` type import supports proper typing for the new `getInventoryResponse` function. --- `54-55`: **LGTM! Controller logic is now more modular.** The change improves code organization by delegating response generation to a dedicated function while preserving the existing functionality. --- Line range hint `61-64`: **LGTM! Successfully implements PR objectives.** The implementation correctly populates both LoadOutPresets and Ships in the inventory response, addressing the core requirement of the PR. </details> <details> <summary>src/controllers/api/missionInventoryUpdateController.ts (1)</summary> `11-11`: **LGTM! Successfully integrates the new inventory response handling.** The changes correctly use the new `getInventoryResponse` function, ensuring that LoadOutPresets and Ships are included in both success and failure responses. Also applies to: 63-63, 84-84 </details> </blockquote></details> </details>

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: OpenWF/SpaceNinjaServer#869