feat: exalted weapons on webui #644

Sainan · 2024-12-28T01:16:06-08:00

AMelonInsideLemon commented

2024-12-28 01:16:06 -08:00

(Migrated from github.com)

Closes #478

coderabbitai[bot] commented

2024-12-28 01:16:12 -08:00

(Migrated from github.com)

Note

Reviews paused

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.

@coderabbitai review to trigger a single review.

Walkthrough

The pull request introduces changes to support special items and exalted weapons across multiple files in the codebase. The modifications include adding a new SpecialItem type to the ItemType enum, updating the sellController to handle special items, creating an addSpecialItem function in the inventory service, and enhancing the getItemListsController to include exalted weapons information. The web interface (index.html and script.js) has been updated to display and manage exalted weapons, providing users with more detailed inventory interaction capabilities.

Assessment against linked issues

Objective	Addressed	Explanation
Enable leveling of frame-specific weapons via WebUI	❓	Partial implementation visible, but unclear if full XP transfer is implemented.
Bind frame weapon leveling to frame max level	❓	Changes suggest infrastructure for handling special/exalted weapons, but direct XP transfer mechanism not explicitly shown.
Improve convenience for testing builds/forma	❓	UI changes indicate improved weapon management, but specific leveling mechanics need further verification.

The changes provide a foundation for handling frame-specific weapons, but the full implementation of XP transfer or automatic leveling is not definitively demonstrated in the provided diff. While the infrastructure for managing special and exalted items has been established, the specific mechanics of leveling frame-specific weapons remain unclear and would require additional review or implementation 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?

❤️ 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.

> [!NOTE] > ## Reviews paused > > Use the following commands to manage reviews: > - `@coderabbitai resume` to resume automatic reviews. > - `@coderabbitai review` to trigger a single review.   ## Walkthrough The pull request introduces changes to support special items and exalted weapons across multiple files in the codebase. The modifications include adding a new `SpecialItem` type to the `ItemType` enum, updating the `sellController` to handle special items, creating an `addSpecialItem` function in the inventory service, and enhancing the `getItemListsController` to include exalted weapons information. The web interface (`index.html` and `script.js`) has been updated to display and manage exalted weapons, providing users with more detailed inventory interaction capabilities. ## Assessment against linked issues | Objective | Addressed | Explanation | |-----------|-----------|-------------| | Enable leveling of frame-specific weapons via WebUI | ❓ | Partial implementation visible, but unclear if full XP transfer is implemented. | | Bind frame weapon leveling to frame max level | ❓ | Changes suggest infrastructure for handling special/exalted weapons, but direct XP transfer mechanism not explicitly shown. | | Improve convenience for testing builds/forma | ❓ | UI changes indicate improved weapon management, but specific leveling mechanics need further verification. | The changes provide a foundation for handling frame-specific weapons, but the full implementation of XP transfer or automatic leveling is not definitively demonstrated in the provided diff. While the infrastructure for managing special and exalted items has been established, the specific mechanics of leveling frame-specific weapons remain unclear and would require additional review or implementation 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 2024-12-28 01:19:15 -08:00

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

Actionable comments posted: 2

🧹 Nitpick comments (6)

static/webui/script.js (3)

452-454: Consider clarifying the style reset logic.

Using style = "" resets all inline styles on the .card. If your intention is simply to remove a display: none property or revert a temporary hide, you might prefer toggling a specific class or explicitly removing only the display style. This helps avoid accidentally resetting other inline styles that may be added in the future.

470-493: Keep the UI logic consistent with other gear listings.

This segment correctly forms table rows for special items, showing names, XP, etc. However, the logic is largely similar to how suits and weapons are rendered. Consider extracting these repeated structures into a helper function to streamline updates and reduce duplication across different item categories.

494-522: DRY out rename and remove actions.

The rename and remove anchors (including “Make Rank 30” logic) mirror existing code for other inventory categories. Duplication may invite maintenance overhead. Consider creating reusable functions or components for repeating behavior, thus aligning with the DRY principle.
src/controllers/custom/addItemController.ts (1)
21-24: Wrap variable declarations in their own block if needed.

Although modern JavaScript doesn’t usually leak variables across case clauses, some linters warn about declarations in case statements. You can safely ignore or address this by wrapping this case in curly braces to avoid any potential “case fall-through” pitfalls.

Example:
        case ItemType.SpecialItem:
+       {
            const specialItem = await addSpecialItem(request.InternalName, accountId);
            res.json(specialItem);
            break;
+       }
🧰 Tools

🪛 Biome (1.9.4)

[error] 22-22: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.

The declaration is defined in this switch clause:

Unsafe fix: Wrap the declaration in a block.

(lint/correctness/noSwitchDeclarations)
src/controllers/custom/getItemListsController.ts (1)
27-46: Extract warframe processing logic into a separate function.

The warframe processing logic is complex enough to warrant its own function. This would improve readability and maintainability.

Consider this refactor:
+const processWarframe = (uniqueName: string, item: any, lang: any): ListedItem => {
+    const warframe: ListedItem = {
+        uniqueName,
+        name: getString(item.name, lang)
+    };
+    const exalted = getExalted(uniqueName);
+    if (exalted) {
+        warframe.exalted = [];
+        exalted.forEach(element => {
+            const exalted = ExportWeapons[element] || ExportSentinels[element];
+            warframe.exalted?.push({
+                uniqueName: element,
+                name: getString(exalted.name, lang)
+            });
+        });
+    }
+    return warframe;
+};

 for (const [uniqueName, item] of Object.entries(ExportWarframes)) {
     if (item.productCategory == "Suits") {
-        const warframe: ListedItem = {
-            uniqueName,
-            name: getString(item.name, lang)
-        };
-        const exalted = getExalted(uniqueName);
-        if (exalted) {
-            warframe.exalted = [];
-            exalted.forEach(element => {
-                const exalted = ExportWeapons[element] || ExportSentinels[element];
-                warframe.exalted?.push({
-                    uniqueName: element,
-                    name: getString(exalted.name, lang)
-                });
-            });
-        }
-        warframes.push(warframe);
+        warframes.push(processWarframe(uniqueName, item, lang));
     }
 }
static/webui/index.html (1)
129-132: Consider extracting the duplicated note into a reusable component.

The inventory synchronization note is duplicated across multiple sections. Consider extracting it into a reusable component or template to follow the DRY principle.

Consider moving the note to a separate HTML file and including it where needed:
-<p class="mb-4">
-    Note: Changes made here will only be reflected in-game when the game re-downloads your
-    inventory. Visiting the navigation should be the easiest way to trigger that.
-</p>
+<div id="inventory-sync-note"></div>

// In script.js:
+document.querySelectorAll('#inventory-sync-note').forEach(el => {
+    fetch('/webui/components/inventory-sync-note.html')
+        .then(response => response.text())
+        .then(html => el.innerHTML = html);
+});

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4d1bbff99e and 1184d18244.

📒 Files selected for processing (8)

src/controllers/api/sellController.ts (1 hunks)
src/controllers/custom/addItemController.ts (2 hunks)
src/controllers/custom/getItemListsController.ts (3 hunks)
src/helpers/customHelpers/addItemHelpers.ts (1 hunks)
src/services/inventoryService.ts (2 hunks)
src/types/sellTypes.ts (1 hunks)
static/webui/index.html (2 hunks)
static/webui/script.js (1 hunks)

🧰 Additional context used

🪛 Biome (1.9.4)

src/controllers/custom/addItemController.ts

[error] 22-22: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.

The declaration is defined in this switch clause:

Unsafe fix: Wrap the declaration in a block.

(lint/correctness/noSwitchDeclarations)

🪛 eslint

static/webui/script.js

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

(no-undef)

🔇 Additional comments (9)

static/webui/script.js (3)

455-469: Verify safe access to exalted property.

Before accessing itemMap[item.ItemType].exalted, consider verifying itemMap[item.ItemType] is defined. Otherwise, if itemMap lacks an entry for the ItemType, it could result in a runtime error.

524-565: Evaluate jQuery “$ is not defined” lint error and factor out repeated post logic.

• The static analysis hint indicates a potential 'no-undef' for $. Ensure that the environment or bundler properly includes jQuery or that $ is declared globally.

• The logic to add special items, inside the revalidateAuthz callback, appears in multiple places. Factor it out into a single helper to avoid duplication and clarify how special items get added.

🧰 Tools

🪛 eslint

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

(no-undef)

566-569: Hide the Exalted Weapons card in an explicit manner.

This effectively hides the card when no exalted weapons are available. The approach is fine, but consider toggling classes instead of directly manipulating the style property for consistency with other UI parts.

src/types/sellTypes.ts (1)

10-10: Addition of SpecialItems key looks consistent.

Allowing SpecialItems in the ISellRequest interface aligns perfectly with the structure for other item categories. No issues noted.

src/controllers/custom/addItemController.ts (1)

4-4: Import statement looks correct.

Importing addSpecialItem from the inventoryService is appropriately scoped and consistent with the usage in this file.

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

48-52: Good integration of special items into sell logic.

This matches the existing pattern for removing items from arrays like Suits, LongGuns, etc. Ensure that test coverage includes removing special items to confirm intended functionality.

src/services/inventoryService.ts (1)

32-32: Importing EquipmentFeatures is consistent.

Pivoting to typed features such as DOUBLE_CAPACITY is a clean approach to track item capabilities in a strongly typed ecosystem.

src/helpers/customHelpers/addItemHelpers.ts (1)

5-6: LGTM! Clean enum extension.

The addition of SpecialItem to the ItemType enum is well-integrated and maintains type safety through the existing validation functions.

static/webui/index.html (1)

150-157: LGTM! Consistent table structure.

The exalted weapons table follows the same structure as other tables in the file, maintaining consistency in the UI.

**Actionable comments posted: 2** <details> <summary>🧹 Nitpick comments (6)</summary><blockquote> <details> <summary>static/webui/script.js (3)</summary><blockquote> `452-454`: **Consider clarifying the style reset logic.** Using `style = ""` resets all inline styles on the `.card`. If your intention is simply to remove a `display: none` property or revert a temporary hide, you might prefer toggling a specific class or explicitly removing only the display style. This helps avoid accidentally resetting other inline styles that may be added in the future. --- `470-493`: **Keep the UI logic consistent with other gear listings.** This segment correctly forms table rows for special items, showing names, XP, etc. However, the logic is largely similar to how suits and weapons are rendered. Consider extracting these repeated structures into a helper function to streamline updates and reduce duplication across different item categories. --- `494-522`: **DRY out rename and remove actions.** The rename and remove anchors (including “Make Rank 30” logic) mirror existing code for other inventory categories. Duplication may invite maintenance overhead. Consider creating reusable functions or components for repeating behavior, thus aligning with the DRY principle. </blockquote></details> <details> <summary>src/controllers/custom/addItemController.ts (1)</summary><blockquote> `21-24`: **Wrap variable declarations in their own block if needed.** Although modern JavaScript doesn’t usually leak variables across case clauses, some linters warn about declarations in case statements. You can safely ignore or address this by wrapping this case in curly braces to avoid any potential “case fall-through” pitfalls. Example: ```diff case ItemType.SpecialItem: + { const specialItem = await addSpecialItem(request.InternalName, accountId); res.json(specialItem); break; + } ``` <details> <summary>🧰 Tools</summary> <details> <summary>🪛 Biome (1.9.4)</summary> [error] 22-22: Other switch clauses can erroneously access this declaration. Wrap the declaration in a block to restrict its access to the switch clause. The declaration is defined in this switch clause: Unsafe fix: Wrap the declaration in a block. (lint/correctness/noSwitchDeclarations) </details> </details> </blockquote></details> <details> <summary>src/controllers/custom/getItemListsController.ts (1)</summary><blockquote> `27-46`: **Extract warframe processing logic into a separate function.** The warframe processing logic is complex enough to warrant its own function. This would improve readability and maintainability. Consider this refactor: ```diff +const processWarframe = (uniqueName: string, item: any, lang: any): ListedItem => { + const warframe: ListedItem = { + uniqueName, + name: getString(item.name, lang) + }; + const exalted = getExalted(uniqueName); + if (exalted) { + warframe.exalted = []; + exalted.forEach(element => { + const exalted = ExportWeapons[element] || ExportSentinels[element]; + warframe.exalted?.push({ + uniqueName: element, + name: getString(exalted.name, lang) + }); + }); + } + return warframe; +}; for (const [uniqueName, item] of Object.entries(ExportWarframes)) { if (item.productCategory == "Suits") { - const warframe: ListedItem = { - uniqueName, - name: getString(item.name, lang) - }; - const exalted = getExalted(uniqueName); - if (exalted) { - warframe.exalted = []; - exalted.forEach(element => { - const exalted = ExportWeapons[element] || ExportSentinels[element]; - warframe.exalted?.push({ - uniqueName: element, - name: getString(exalted.name, lang) - }); - }); - } - warframes.push(warframe); + warframes.push(processWarframe(uniqueName, item, lang)); } } ``` </blockquote></details> <details> <summary>static/webui/index.html (1)</summary><blockquote> `129-132`: **Consider extracting the duplicated note into a reusable component.** The inventory synchronization note is duplicated across multiple sections. Consider extracting it into a reusable component or template to follow the DRY principle. Consider moving the note to a separate HTML file and including it where needed: ```diff -<p class="mb-4"> - Note: Changes made here will only be reflected in-game when the game re-downloads your - inventory. Visiting the navigation should be the easiest way to trigger that. -</p> +<div id="inventory-sync-note"></div> // In script.js: +document.querySelectorAll('#inventory-sync-note').forEach(el => { + fetch('/webui/components/inventory-sync-note.html') + .then(response => response.text()) + .then(html => el.innerHTML = html); +}); ``` </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 4d1bbff99e55b8ddac60197a0331f79e780d17e1 and 1184d182444329192cda6646fb9e8a84306edcc4. </details> <details> <summary>📒 Files selected for processing (8)</summary> * `src/controllers/api/sellController.ts` (1 hunks) * `src/controllers/custom/addItemController.ts` (2 hunks) * `src/controllers/custom/getItemListsController.ts` (3 hunks) * `src/helpers/customHelpers/addItemHelpers.ts` (1 hunks) * `src/services/inventoryService.ts` (2 hunks) * `src/types/sellTypes.ts` (1 hunks) * `static/webui/index.html` (2 hunks) * `static/webui/script.js` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 Biome (1.9.4)</summary> <details> <summary>src/controllers/custom/addItemController.ts</summary> [error] 22-22: Other switch clauses can erroneously access this declaration. Wrap the declaration in a block to restrict its access to the switch clause. The declaration is defined in this switch clause: Unsafe fix: Wrap the declaration in a block. (lint/correctness/noSwitchDeclarations) </details> </details> <details> <summary>🪛 eslint</summary> <details> <summary>static/webui/script.js</summary> [error] 544-544: '$' is not defined. (no-undef) </details> </details> </details> <details> <summary>🔇 Additional comments (9)</summary> <details> <summary>static/webui/script.js (3)</summary> `455-469`: **Verify safe access to `exalted` property.** Before accessing `itemMap[item.ItemType].exalted`, consider verifying `itemMap[item.ItemType]` is defined. Otherwise, if `itemMap` lacks an entry for the `ItemType`, it could result in a runtime error. --- `524-565`: **Evaluate jQuery “$ is not defined” lint error and factor out repeated post logic.** • The static analysis hint indicates a potential `'no-undef'` for `$`. Ensure that the environment or bundler properly includes jQuery or that `$` is declared globally. • The logic to add special items, inside the `revalidateAuthz` callback, appears in multiple places. Factor it out into a single helper to avoid duplication and clarify how special items get added. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 eslint</summary> [error] 544-544: '$' is not defined. (no-undef) </details> </details> --- `566-569`: **Hide the Exalted Weapons card in an explicit manner.** This effectively hides the card when no exalted weapons are available. The approach is fine, but consider toggling classes instead of directly manipulating the style property for consistency with other UI parts. </details> <details> <summary>src/types/sellTypes.ts (1)</summary> `10-10`: **Addition of `SpecialItems` key looks consistent.** Allowing `SpecialItems` in the `ISellRequest` interface aligns perfectly with the structure for other item categories. No issues noted. </details> <details> <summary>src/controllers/custom/addItemController.ts (1)</summary> `4-4`: **Import statement looks correct.** Importing `addSpecialItem` from the `inventoryService` is appropriately scoped and consistent with the usage in this file. </details> <details> <summary>src/controllers/api/sellController.ts (1)</summary> `48-52`: **Good integration of special items into sell logic.** This matches the existing pattern for removing items from arrays like `Suits`, `LongGuns`, etc. Ensure that test coverage includes removing special items to confirm intended functionality. </details> <details> <summary>src/services/inventoryService.ts (1)</summary> `32-32`: **Importing `EquipmentFeatures` is consistent.** Pivoting to typed features such as `DOUBLE_CAPACITY` is a clean approach to track item capabilities in a strongly typed ecosystem. </details> <details> <summary>src/helpers/customHelpers/addItemHelpers.ts (1)</summary> `5-6`: **LGTM! Clean enum extension.** The addition of `SpecialItem` to the `ItemType` enum is well-integrated and maintains type safety through the existing validation functions. </details> <details> <summary>static/webui/index.html (1)</summary> `150-157`: **LGTM! Consistent table structure.** The exalted weapons table follows the same structure as other tables in the file, maintaining consistency in the UI. </details> </details> </details>

src/controllers/custom/getItemListsController.ts

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

2024-12-28 01:19:14 -08:00

⚠️ Potential issue

Add null check for exalted items.

The code assumes that either ExportWeapons[element] or ExportSentinels[element] exists. Add a null check to prevent potential runtime errors.

Apply this fix:

 exalted.forEach(element => {
     const exalted = ExportWeapons[element] || ExportSentinels[element];
+    if (!exalted) {
+        console.warn(`Exalted item not found: ${element}`);
+        return;
+    }
     warframe.exalted?.push({
         uniqueName: element,
         name: getString(exalted.name, lang)
     });
 });

Committable suggestion skipped: line range outside the PR's diff.

_:warning: Potential issue_ **Add null check for exalted items.** The code assumes that either `ExportWeapons[element]` or `ExportSentinels[element]` exists. Add a null check to prevent potential runtime errors. Apply this fix: ```diff exalted.forEach(element => { const exalted = ExportWeapons[element] || ExportSentinels[element]; + if (!exalted) { + console.warn(`Exalted item not found: ${element}`); + return; + } warframe.exalted?.push({ uniqueName: element, name: getString(exalted.name, lang) }); }); ``` > Committable suggestion skipped: line range outside the PR's diff.

src/services/inventoryService.ts

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

2024-12-28 01:19:14 -08:00

⚠️ Potential issue

Fix the duplicate-check logic in addSpecialItem.

Current check:

if (!inventory.SpecialItems.length || inventory.SpecialItems.some(obj => obj.ItemType !== itemName))

This unintentionally adds the new item if there is at least one differently named item in SpecialItems. Instead, you likely want to verify none of the existing items match itemName. For instance:

- if (!inventory.SpecialItems.length || inventory.SpecialItems.some(obj => obj.ItemType !== itemName)) {
+ if (!inventory.SpecialItems.some(obj => obj.ItemType === itemName)) {
    // Add the new special item
}

_:warning: Potential issue_ **Fix the duplicate-check logic in `addSpecialItem`.** Current check: ```js if (!inventory.SpecialItems.length || inventory.SpecialItems.some(obj => obj.ItemType !== itemName)) ``` This unintentionally adds the new item if there is at least one differently named item in `SpecialItems`. Instead, you likely want to verify *none* of the existing items match `itemName`. For instance: ```diff - if (!inventory.SpecialItems.length || inventory.SpecialItems.some(obj => obj.ItemType !== itemName)) { + if (!inventory.SpecialItems.some(obj => obj.ItemType === itemName)) { // Add the new special item } ```

coderabbitai[bot] (Migrated from github.com) reviewed 2024-12-28 01:40:51 -08:00

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

Actionable comments posted: 1

🧹 Nitpick comments (1)

src/services/inventoryService.ts (1)
436-448: Improve function documentation

The comment about "one exalted item per suit type" suggests this is an important constraint. Consider adding JSDoc documentation to:

Explain the function's purpose

Document the return value (undefined when duplicate is found)

Document the constraint of one exalted item per suit type

Add this documentation:
+/**
+ * Adds a special item (exalted weapon) to the inventory if it doesn't already exist.
+ * According to the wiki, there can only be one exalted item per suit type.
+ * 
+ * @param itemName - The name of the special item to add
+ * @param accountId - The account ID to add the item to
+ * @returns The added special item if successful, undefined if the item already exists
+ */
 export const addSpecialItem = async (itemName: string, accountId: string) => {

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1184d18244 and 603c98e348.

📒 Files selected for processing (1)

src/services/inventoryService.ts (2 hunks)

🔇 Additional comments (1)

src/services/inventoryService.ts (1)

32-32: LGTM!

The import statement correctly includes EquipmentFeatures which is used in the addSpecialItem function.

**Actionable comments posted: 1** <details> <summary>🧹 Nitpick comments (1)</summary><blockquote> <details> <summary>src/services/inventoryService.ts (1)</summary><blockquote> `436-448`: **Improve function documentation** The comment about "one exalted item per suit type" suggests this is an important constraint. Consider adding JSDoc documentation to: 1. Explain the function's purpose 2. Document the return value (undefined when duplicate is found) 3. Document the constraint of one exalted item per suit type Add this documentation: ```diff +/** + * Adds a special item (exalted weapon) to the inventory if it doesn't already exist. + * According to the wiki, there can only be one exalted item per suit type. + * + * @param itemName - The name of the special item to add + * @param accountId - The account ID to add the item to + * @returns The added special item if successful, undefined if the item already exists + */ export const addSpecialItem = async (itemName: string, accountId: string) => { ``` </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 1184d182444329192cda6646fb9e8a84306edcc4 and 603c98e348062b0db9b4e8dd6c2a3d153a6d63d5. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `src/services/inventoryService.ts` (2 hunks) </details> <details> <summary>🔇 Additional comments (1)</summary> <details> <summary>src/services/inventoryService.ts (1)</summary> `32-32`: **LGTM!** The import statement correctly includes `EquipmentFeatures` which is used in the `addSpecialItem` function. </details> </details> </details>

src/services/inventoryService.ts

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

2024-12-28 01:40:50 -08:00

⚠️ Potential issue

Fix the duplicate check logic

The current logic is incorrect and will add duplicate items. The condition:

inventory.SpecialItems.length && inventory.SpecialItems.some(obj => obj.ItemType !== itemName)

will add the item if ANY existing item has a different name, rather than preventing duplicates.

Fix the logic by replacing it with:

-if (inventory.SpecialItems.length && inventory.SpecialItems.some(obj => obj.ItemType !== itemName)) {
+if (!inventory.SpecialItems.some(obj => obj.ItemType === itemName)) {

_:warning: Potential issue_ **Fix the duplicate check logic** The current logic is incorrect and will add duplicate items. The condition: ```typescript inventory.SpecialItems.length && inventory.SpecialItems.some(obj => obj.ItemType !== itemName) ``` will add the item if ANY existing item has a different name, rather than preventing duplicates. Fix the logic by replacing it with: ```diff -if (inventory.SpecialItems.length && inventory.SpecialItems.some(obj => obj.ItemType !== itemName)) { +if (!inventory.SpecialItems.some(obj => obj.ItemType === itemName)) { ```

Sainan reviewed 2024-12-28 10:02:21 -08:00

src/services/inventoryService.ts

Sainan commented

2024-12-28 10:02:21 -08:00

This is wrong, e.g. Titania has 2 exalted weapons (arch-gun & arch-melee).

Sainan commented

2024-12-28 10:03:27 -08:00

@coderabbitai resolve
@coderabbitai pause

@coderabbitai resolve @coderabbitai pause

coderabbitai[bot] commented

2024-12-28 10:03:46 -08:00

(Migrated from github.com)

@Sainan: All set!

✅ Actions performed

Comments resolved.

Reviews paused.

@Sainan: All set! <details> <summary>:white_check_mark: Actions performed</summary> Comments resolved. --- Reviews paused. </details>

AMelonInsideLemon (Migrated from github.com) reviewed 2024-12-28 16:21:53 -08:00

src/services/inventoryService.ts

AMelonInsideLemon (Migrated from github.com) commented

2024-12-28 16:21:53 -08:00

looks better now?