Skip to content

fix(item-stats): improve random option selection and validation - #475

Merged
AngeloTadeucci merged 2 commits into
masterfrom
stats-calculator
Jun 6, 2025
Merged

fix(item-stats): improve random option selection and validation#475
AngeloTadeucci merged 2 commits into
masterfrom
stats-calculator

Conversation

@AngeloTadeucci

@AngeloTadeucci AngeloTadeucci commented Jun 6, 2025

Copy link
Copy Markdown
Collaborator

Create a mutable list of available entries to avoid duplicates when
selecting random item options. Remove locked preset entries from this
list to ensure they are not reselected. Add a check to stop selection
when no entries remain, logging an error for better diagnostics.

Refactor offense stat validation by precomputing offense attribute
flags and simulating the addition of a new stat to correctly enforce
the offense line threshold for non-weapon, non-accessory, non-pet items.

Summary by CodeRabbit

  • Bug Fixes

    • Improved random option selection to prevent infinite loops and handle cases with no available options.
    • Enhanced error logging with more detailed context for easier troubleshooting.
  • Refactor

    • Refined logic for offense stat threshold checks to ensure more accurate validation.
    • Updated logging methods for consistency.

Create a mutable list of available entries to avoid duplicates when
selecting random item options. Remove locked preset entries from this
list to ensure they are not reselected. Add a check to stop selection
when no entries remain, logging an error for better diagnostics.

Refactor offense stat validation by precomputing offense attribute
flags and simulating the addition of a new stat to correctly enforce
the offense line threshold for non-weapon, non-accessory, non-pet items.
@coderabbitai

coderabbitai Bot commented Jun 6, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The RandomItemOption method in ItemStatsCalculator.cs was updated to use a mutable list for available entries, ensuring locked options are excluded during random selection and preventing infinite loops when no options remain. The IsValidStat method's offense stat threshold logic was refined by precomputing offense attribute flags and incrementing offense count unconditionally. Error logging calls were standardized.

Changes

File(s) Change Summary
Maple2.Server.Game/Util/ItemStatsCalculator.cs Refactored RandomItemOption to manage available entries robustly, updated offense stat logic in IsValidStat, and standardized error logging from Log.Error to Log.Logger.Error.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant ItemStatsCalculator

    Caller->>ItemStatsCalculator: RandomItemOption(entries, presets, ...)
    ItemStatsCalculator->>ItemStatsCalculator: Initialize availableEntries from entries
    loop For each preset
        ItemStatsCalculator->>ItemStatsCalculator: Remove locked entries from availableEntries
    end
    loop While options needed and availableEntries not empty
        ItemStatsCalculator->>ItemStatsCalculator: Select random entry from availableEntries
        ItemStatsCalculator->>ItemStatsCalculator: Validate with IsValidStat
        alt Valid
            ItemStatsCalculator->>ItemStatsCalculator: Add to result, remove from availableEntries
        else Invalid
            ItemStatsCalculator->>ItemStatsCalculator: Remove from availableEntries
        end
    end
    alt No availableEntries
        ItemStatsCalculator->>ItemStatsCalculator: Log error with context
    end
    ItemStatsCalculator-->>Caller: Return selected options
Loading

Possibly related PRs

  • AngeloTadeucci/Maple2#306: Refines the same methods for offense stat line limitation logic in ItemStatsCalculator.cs.
  • AngeloTadeucci/Maple2#242: Introduces and modifies item stat randomization logic in ItemStatsCalculator.cs, affecting related data structures and methods.

Suggested reviewers

  • Zintixx

Poem

In the meadow of code where the item stats grow,
A rabbit hops by, with logic in tow.
Offense lines counted, options refined,
No infinite loops—just order aligned.
With logs now precise and entries in hand,
This patch brings clarity across the land! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4c32e5b and c529779.

📒 Files selected for processing (1)
  • Maple2.Server.Game/Util/ItemStatsCalculator.cs (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Maple2.Server.Game/Util/ItemStatsCalculator.cs
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build
  • GitHub Check: format
  • GitHub Check: build
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8a075ca and 4c32e5b.

📒 Files selected for processing (1)
  • Maple2.Server.Game/Util/ItemStatsCalculator.cs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build
  • GitHub Check: build
  • GitHub Check: format
🔇 Additional comments (4)
Maple2.Server.Game/Util/ItemStatsCalculator.cs (4)

520-521: Good solution to prevent infinite loops during selection.

Creating a mutable copy of available entries is the correct approach to track which entries can still be selected, preventing the infinite loop scenario described in the PR objectives.


546-546: Excellent logging improvements for better diagnostics.

The updates to use Log.Logger.Error and the addition of comprehensive error logging when no entries remain provide valuable diagnostic information. The error message includes all relevant context (ItemType, StatsType, Total) which will help with troubleshooting.

Also applies to: 551-553


602-609: Excellent refactoring of offense stat validation logic.

The precomputing of offense attribute flags and the simulation approach for checking the threshold are both improvements:

  • The boolean flags make the logic more readable and reduce repeated attribute list lookups
  • The pattern matching syntax for item type checking is cleaner
  • Simulating the addition of the new stat by incrementing the count before the threshold check correctly models the expected behavior

This properly enforces the offense line threshold as described in the PR objectives.


529-529: 🛠️ Refactor suggestion

Add null check before removing entry from availableEntries.

Consider adding a null check to prevent issues if FirstOrDefault returns a default entry:

 ItemOption.Entry entry = option.Entries.FirstOrDefault(e => e.BasicAttribute == basic);
 // Ignore any invalid presets, they will get populated with valid data below.
 AddResult(entry, statResult, specialResult);
-availableEntries.Remove(entry);
+if (entry.BasicAttribute != null || entry.SpecialAttribute != null) {
+    availableEntries.Remove(entry);
+}

Likely an incorrect or invalid review comment.

Comment thread Maple2.Server.Game/Util/ItemStatsCalculator.cs
Comment thread Maple2.Server.Game/Util/ItemStatsCalculator.cs
@AngeloTadeucci
AngeloTadeucci merged commit b35bf29 into master Jun 6, 2025
@AngeloTadeucci
AngeloTadeucci deleted the stats-calculator branch June 6, 2025 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants