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

ZO: fix crash on import due to dup detection #2780

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

ZO: fix crash on import due to dup detection #2780

wants to merge 1 commit into from

Conversation

frzyc
Copy link
Owner

@frzyc frzyc commented Feb 23, 2025

Describe your changes

Bad null checks due to variable substat array lengths

Issue or discord link

Testing/validation

Checklist before requesting a review (leave this PR as draft if any part of this list is not done.)

  • I have commented my code in hard-to understand areas.
  • I have made corresponding changes to README or wiki.
  • For front-end changes, I have updated the corresponding English translations.
  • I have run yarn run mini-ci locally to validate format and lint.
  • If I have added a new library or app, I have updated the deployment scripts to ignore changes as needed

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced data handling to prevent potential runtime errors when certain data properties are missing, improving overall application stability.

@frzyc frzyc added fix ASAP Needs to be fixed as soon as possible ZO Zenless Optimizer labels Feb 23, 2025
Copy link
Contributor

coderabbitai bot commented Feb 23, 2025

Walkthrough

This pull request updates the DiscDataManager class in libs/zzz/db/src/Database/DataManagers/DiscDataManager.ts. The changes add optional chaining (?.) when accessing properties of candidate.substats[i] within the findDups method. This prevents runtime errors if the substat is undefined. There are no changes to exported interfaces or public entities.

Changes

File Change Summary
libs/zzz/db/src/.../DiscDataManager.ts Replaced direct property accesses (candidate.substats[i].key and .upgrades) with optional chaining (candidate.substats[i]?.key and ?.upgrades) in the findDups method.

Possibly related PRs

  • ZO fix crash in db merge #2646: Modified the findDups method in the DiscDataManager class to implement optional chaining for accessing candidate.substats[i], addressing similar potential runtime errors.

Poem

In the silent hum of midnight code,
Optional chaining now lightens the load.
Undefined substats no longer cause a crash,
Errors are diminished in a neat, smooth dash.
Code flows on while I sip my last coffee splash.

— Somnia

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

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
Contributor

[zzz-frontend] [Sun Feb 23 10:28:13 UTC 2025] - Deployed 67d8177 to https://genshin-optimizer-prs.github.io/pr/2780/zzz-frontend (Takes 3-5 minutes after this completes to be available)

Copy link
Contributor

@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

🧹 Nitpick comments (1)
libs/zzz/db/src/Database/DataManagers/DiscDataManager.ts (1)

255-256: Hmm... sips coffee We might want to add some array bounds checking though.

While the optional chaining helps, we should also validate the array bounds and ensure the substat object has the required properties. Here's what I suggest:

 substats.every(
   (substat, i) =>
-    substat.key === candidate.substats[i]?.key &&
-    substat.upgrades === candidate.substats[i]?.upgrades
+    i < candidate.substats.length &&
+    typeof candidate.substats[i] === 'object' &&
+    substat.key === candidate.substats[i]?.key &&
+    substat.upgrades === candidate.substats[i]?.upgrades
 )

Similar validation should be added to the other changed segment as well. This would make the code more robust against malformed data.

Also applies to: 263-264

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fe588e6 and 4f66e0e.

📒 Files selected for processing (1)
  • libs/zzz/db/src/Database/DataManagers/DiscDataManager.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: lint
🔇 Additional comments (1)
libs/zzz/db/src/Database/DataManagers/DiscDataManager.ts (1)

255-256: Zzzz... yawns The optional chaining looks good, should prevent those pesky crashes.

The addition of optional chaining operators (?.) when accessing candidate.substats[i] properties will prevent null reference errors during import. Nice catch!

Also applies to: 263-264

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix ASAP Needs to be fixed as soon as possible ZO Zenless Optimizer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant