Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add Helminth abilities #643

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

SlayerOrnstein
Copy link
Member

@SlayerOrnstein SlayerOrnstein commented Oct 20, 2024

What did you fix?

Add Helminth abilities into scraper process. I took a partial from one of the ability uniqueNames to form the base

Before:

{
	"ExportWarframes": [...],
	"ExportAbilities": [
        {
            "abilityUniqueName": "/Lotus/Powersuits/PowersuitAbilities/HelminthEfficiencyAbility",
            "abilityName": "Energized Munitions",
            "description": "Increase the efficiency of your ammo consumption."
        },
        {
            "abilityUniqueName": "/Lotus/Powersuits/PowersuitAbilities/HelminthCompanionAbility",
            "abilityName": "Master's Summons",
            "description": "Heal your companion and call it to your side."
        },
        {
            "abilityUniqueName": "/Lotus/Powersuits/PowersuitAbilities/HelminthEnergyShareAbility",
            "abilityName": "Voracious Metastasis",
            "description": "Consume Energy to heal yourself and grant matching Energy to each ally."
        },
		...
	]
}

After:

{
    "abilities": [
      {
        "uniqueName": "/Lotus/Powersuits/PowersuitAbilities/HelminthEfficiencyAbility",
        "name": "Energized Munitions",
        "description": "Increase the efficiency of your ammo consumption.",
        "imageName": "energized-munitions-d5df009f96.png"
      },
      {
        "uniqueName": "/Lotus/Powersuits/PowersuitAbilities/HelminthCompanionAbility",
        "name": "Master's Summons",
        "description": "Heal your companion and call it to your side.",
        "imageName": "master's-summons-b2337980b6.png"
      },
	...
    ],
    "category": "Warframes",
    "drops": [
      { 
		"chance": 1, 
		"location": "Entrati (Son), Associate",
 		"rarity": "Common", 
		"type": "Helminth Segment Blueprint" },
      {
        "chance": 1,
        "location": "Entrati (Son), Family",
        "rarity": "Common",
        "type": "Helminth Invigoration Segment Blueprint"
      }
    ],
    "isPrime": false,
    "masterable": true,
    "name": "Helminth",
    "tradable": false,
    "type": "Warframe",
    "uniqueName": "/Lotus/Powersuits/PowersuitAbilities/Helminth"
  }

Reproduction steps


Evidence/screenshot/link to line

Considerations

  • Does this contain a new dependency? No
  • Does this introduce opinionated data formatting or manual data entry? Yes
  • Does this pr include updated data files in a separate commit that can be reverted for a clean code-only pr? Yes
  • Have I run the linter? Yes
  • Is is a bug fix, feature request, or enhancement? Feature

Summary by CodeRabbit

  • New Features

    • Enhanced data processing for the 'Warframes' category, now including detailed information about the 'Helminth'.
    • Improved structure for 'Upgrades' category data with the addition of a type property.
    • Introduced multiple new abilities related to the 'Helminth' powersuit.
  • Bug Fixes

    • Updated test logic to exclude 'Helminth' from specific tests, refining the filtering criteria for warframe components.
  • Documentation

    • Added comments to clarify new code segments for better maintainability and readability.

Copy link

coderabbitai bot commented Oct 20, 2024

Warning

Rate limit exceeded

@SlayerOrnstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 41 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 6e57453 and acc3d24.

Walkthrough

The changes in this pull request modify the Scraper class within the build/scraper.mjs file. A new conditional block is added to the fetchResources method to handle the 'Warframes' category by creating an object for 'Helminth' with its name, display name, and abilities. Additionally, the handling of the 'Upgrades' category is updated to include a type property in modSets. Comments have been added for clarity, but no changes were made to the declarations of exported or public entities. The test file test/index.spec.mjs is updated to include 'Helminth' in the namedExclusions array, affecting the test filtering logic. New abilities related to 'Helminth' have been added to the JSON structure in data/cache/.images.json.

Changes

File Change Summary
build/scraper.mjs - Modified fetchResources to add handling for 'Warframes' category, creating a 'Helminth' object.
- Updated 'Upgrades' handling to include a type property in modSets.
- Added comments for clarity.
test/index.spec.mjs - Updated namedExclusions to include 'Helminth' alongside 'Excalibur Prime'.
- Added new test cases for 'Helminth' properties.
data/cache/.images.json - Added multiple new entries for 'Helminth' abilities, each with uniqueName, hash, and isComponent attributes.

Sequence Diagram(s)

sequenceDiagram
    participant Scraper
    participant DataSource
    participant DataArray

    Scraper->>DataSource: Fetch resources
    DataSource-->>Scraper: Return data
    Scraper->>Scraper: Check category
    alt Warframes
        Scraper->>DataArray: Create Helminth object
    end
    alt Upgrades
        Scraper->>DataArray: Structure modSets with type
    end
    Scraper->>DataArray: Push data into array
Loading

Possibly related PRs

  • feat: added RailJack turrets #644: The changes in this PR also modify the build/scraper.mjs file, specifically within the fetchResources method, which is directly related to the modifications made in the main PR regarding data handling for different categories, including 'Weapons'.

Suggested reviewers

  • TobiTenno

🐰 In the realm of code where changes bloom,
A Helminth rises, dispelling the gloom.
With upgrades refined, and comments so clear,
Our scraper now dances, spreading good cheer!
So hop along, friends, to the data we seek,
In the world of Warframes, it's bright and unique! 🌟


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

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
build/scraper.mjs (1)

96-104: LGTM with a suggestion for improvement

The addition of the 'Helminth' object to the 'Warframes' category aligns well with the PR objectives. The structure of the object matches the description in the PR summary, which is good for consistency.

However, I suggest adding a null check for raw.ExportAbilities to improve error handling:

Consider adding a null check for raw.ExportAbilities:

 if (category === 'Warframes') {
   const helminth = {
     uniqueName: '/Lotus/Powersuits/PowersuitAbilities/Helminth',
     name: 'Helminth',
-    abilities: raw.ExportAbilities,
+    abilities: raw.ExportAbilities || [],
   };

   data.push(helminth, ...raw.ExportWarframes);
 }

This change ensures that abilities will always be an array, even if raw.ExportAbilities is undefined.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5edca7a and e1575a2.

📒 Files selected for processing (1)
  • build/scraper.mjs (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
build/scraper.mjs (2)

Line range hint 105-111: LGTM: Improved data structure for 'Upgrades' category

The addition of the type property to the modSets items enhances the data structure and aligns with the PR objectives. This change provides more detailed information about the upgrades without affecting the existing logic for other categories.

The modification is clean and straightforward, improving the overall data representation for the 'Upgrades' category.


Line range hint 96-111: Overall assessment: Focused enhancements to data structure

The changes in this file are well-focused and align closely with the PR objectives. They enhance the data structure for both the 'Warframes' and 'Upgrades' categories without introducing significant risks to the existing functionality.

Key points:

  1. Addition of 'Helminth' data to the 'Warframes' category.
  2. Improved structure for 'Upgrades' category with the new type property.

These modifications provide more detailed and structured data, which should improve the overall functionality of the scraper.

The changes are minimal, focused, and improve the data representation without altering the core logic of the Scraper class.

@SlayerOrnstein SlayerOrnstein added the Scope: Data How data is represented or cleaned up label Oct 20, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
test/index.spec.mjs (2)

26-26: LGTM. Consider adding Helminth-specific tests.

The addition of 'Helminth' to the namedExclusions array is appropriate, as it ensures that Helminth is not treated as a standard warframe in the component reflection test. This aligns with the PR objectives of introducing new Helminth abilities.

Consider adding specific test cases for Helminth abilities to ensure they are correctly represented in the data structure. This could include verifying the presence of the new imageName attribute for Helminth abilities and checking the overall structure of the Helminth data.


Line range hint 1-283: Enhance test coverage for new Helminth abilities

While the existing test suite is comprehensive, it doesn't explicitly cover the new Helminth abilities introduced in this PR. Consider adding the following test cases:

  1. Verify the presence of Helminth in the 'Warframes' category.
  2. Check the structure of Helminth abilities, including the new imageName attribute.
  3. Ensure that Helminth is correctly marked as non-masterable.
  4. Validate the integrity of Helminth-related data, such as item drops and tradability.

Here's a suggested structure for these new tests:

describe('Helminth', () => {
  let helminth;
  
  before(async () => {
    const items = await wrapConstr({ category: ['Warframes'] });
    helminth = items.find(item => item.name === 'Helminth');
  });

  it('should exist in the Warframes category', () => {
    assert(helminth, 'Helminth should be present in the Warframes category');
  });

  it('should have correctly structured abilities', () => {
    assert(Array.isArray(helminth.abilities), 'Helminth should have an abilities array');
    helminth.abilities.forEach(ability => {
      assert(ability.abilityName, 'Each ability should have a name');
      assert(ability.description, 'Each ability should have a description');
      assert(ability.imageName, 'Each ability should have an imageName');
    });
  });

  it('should be marked as non-masterable', () => {
    assert.strictEqual(helminth.masterable, false, 'Helminth should not be masterable');
  });

  it('should have correct item drops', () => {
    assert(helminth.drops, 'Helminth should have drops');
    // Add more specific checks for drops based on expected data
  });

  it('should be non-tradable', () => {
    assert.strictEqual(helminth.tradable, false, 'Helminth should not be tradable');
  });
});

These tests will help ensure that the new Helminth data is correctly structured and integrated into the existing system.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8b06472 and 7ff4e06.

📒 Files selected for processing (1)
  • test/index.spec.mjs (1 hunks)
🧰 Additional context used

Copy link
Member

@TobiTenno TobiTenno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm gonna have to go w/ @coderabbitai on this one, please add helminth-specific tests, since this seems to be unique to helminth

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
test/index.spec.mjs (3)

6-6: Reorder imports for consistency.

Consider moving the chai import before the ../build/dedupe.mjs import to maintain a consistent import order. This aligns with the static analysis suggestion and improves code readability.

Apply this diff to reorder the imports:

 import assert from 'node:assert';
 import { resolve } from 'node:path';
 import { createRequire } from 'module';
+import { expect } from 'chai';
 
 import dedupe from '../build/dedupe.mjs';
-import { expect } from 'chai';
🧰 Tools
🪛 GitHub Check: Lint

[failure] 6-6:
chai import should occur before import of ../build/dedupe.mjs


282-287: LGTM: New test case for Helminth properties.

The new test case correctly verifies Helminth's unique structure. However, consider enhancing the assertions for improved clarity and error messages.

Consider updating the assertions as follows:

-      assert(typeof helminth.component, undefined);
-      assert(typeof helminth.drops, Array);
+      assert.strictEqual(helminth.component, undefined, 'Helminth should not have a component property');
+      assert(Array.isArray(helminth.drops), 'Helminth drops should be an array');

This change provides more descriptive error messages and uses more specific assertion methods.


288-294: LGTM: New test case for Helminth abilities count.

The test case effectively verifies the expected range of Helminth abilities. The comment explaining the upper limit is helpful for future maintenance.

Consider a minor adjustment for consistency:

-    it('helminth should more the 4 abilites', async () => {
+    it('helminth should have more than 4 abilities', async () => {

This change corrects the grammatical error in the test description and improves readability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5fae883 and 9b353b0.

📒 Files selected for processing (1)
  • test/index.spec.mjs (3 hunks)
🧰 Additional context used
🪛 GitHub Check: Lint
test/index.spec.mjs

[failure] 6-6:
chai import should occur before import of ../build/dedupe.mjs

🔇 Additional comments (1)
test/index.spec.mjs (1)

27-27: LGTM: Helminth added to namedExclusions.

The addition of 'Helminth' to the namedExclusions array is consistent with the PR objectives and accommodates the unique nature of Helminth in the game.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Scope: Data How data is represented or cleaned up
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants