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

🐛 Fix undefined deposites #2554

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Conversation

bal7hazar
Copy link
Collaborator

@bal7hazar bal7hazar commented Dec 17, 2024

Summary by CodeRabbit

  • Bug Fixes

    • Improved the reliability of resource availability checks in player arrival notifications.
  • Chores

    • Enhanced error handling for resource tracking without altering existing functionality.

Copy link

vercel bot commented Dec 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
eternum ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 17, 2024 6:10pm
eternum-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 17, 2024 6:10pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
eternum-landing ⬜️ Ignored (Inspect) Visit Preview Dec 17, 2024 6:10pm

Copy link
Contributor

coderabbitai bot commented Dec 17, 2024

Walkthrough

The pull request introduces a minor modification to the createArrivalInfo function in the use-resource-arrivals.tsx hook. The change enhances the robustness of resource availability checking by adding a truthy check for ownedResourceTracker before comparing resource types. This prevents potential null or undefined errors while maintaining the existing logic and functionality of player arrival and notification hooks.

Changes

File Change Summary
client/src/hooks/helpers/use-resource-arrivals.tsx Updated resource availability check to ensure ownedResourceTracker is truthy before comparing resource_types

Poem

🐰 A rabbit's code review delight,
Checking resources with careful might
Null checks added with gentle care
Preventing errors everywhere
Hop, hop, hooray for robust design! 🌟


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

mentatbot bot commented Dec 17, 2024

You are out of MentatBot reviews. Your usage will refresh December 23 at 08:00 AM.

Copy link

Failed to generate code suggestions for PR

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)
client/src/hooks/helpers/use-resource-arrivals.tsx (1)

86-86: Consider addressing resource tracker initialization

While this fix properly handles undefined cases, consider if resource trackers should be guaranteed to exist through proper initialization at the data layer. This would provide stronger invariants and might prevent similar issues elsewhere.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7258c2a and cb2a7ed.

📒 Files selected for processing (1)
  • client/src/hooks/helpers/use-resource-arrivals.tsx (1 hunks)
🔇 Additional comments (2)
client/src/hooks/helpers/use-resource-arrivals.tsx (2)

Line range hint 39-42: Verify query behavior with undefined trackers

While the direct access is now protected, let's verify how the NotValue query operator handles undefined cases.

✅ Verification successful

Based on the search results, I can now generate the final response:

NotValue operator usage is consistent and safe

The NotValue operator is consistently used across the codebase in similar patterns, particularly with default/zero values:

  • For OwnedResourcesTracker: { resource_types: 0n }
  • For Army: { battle_id: 0 }
  • For Building: { entity_id: 0 }

This pattern indicates it's a standard way to handle undefined cases by checking against default/zero values, making the query in use-resource-arrivals.tsx follow established practices.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Look for similar query patterns to understand standard usage
rg -B 2 -A 2 'NotValue.*OwnedResourcesTracker'

# Check for any related tests
fd -e test.tsx -e test.ts -e spec.tsx -e spec.ts | xargs rg 'OwnedResourcesTracker'

Length of output: 949


Script:

#!/bin/bash
# Let's check the implementation of NotValue operator and its handling of undefined cases
ast-grep --pattern 'NotValue($_, $_)'

# Also check for any documentation or type definitions related to NotValue
rg -B 2 -A 2 'NotValue'

Length of output: 5170


86-86: LGTM! Good defensive programming.

The addition of the truthy check !!ownedResourceTracker fixes the potential undefined error when accessing resource_types. This makes the code more robust and prevents UI breaks when resource trackers are not yet initialized.

Let's verify that this is the only place needing such protection:

✅ Verification successful

No other unsafe resource tracker accesses found

Based on the verification results, the added null check in use-resource-arrivals.tsx is the only place where resource_types is directly accessed from a potentially undefined tracker. Other usages are either in type definitions, component queries, or initialization code where the tracker is guaranteed to exist.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other potentially unsafe resource tracker accesses
ast-grep --pattern 'OwnedResourcesTracker.$_'

Length of output: 151


Script:

#!/bin/bash
# Let's try a different pattern to find resource tracker usages
rg -A 2 "resource_types.*0n" 

Length of output: 1046


Script:

#!/bin/bash
# Let's search for all direct accesses to resource_types property
ast-grep --pattern '$_.resource_types'

Length of output: 295

@ponderingdemocritus ponderingdemocritus merged commit 3187d5a into next Dec 17, 2024
7 of 9 checks passed
@ponderingdemocritus ponderingdemocritus deleted the fix/-undefined-deposits branch December 17, 2024 19:58
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