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: trade history crash #2445

Merged
merged 1 commit into from
Dec 12, 2024
Merged

fix: trade history crash #2445

merged 1 commit into from
Dec 12, 2024

Conversation

r0man1337
Copy link
Contributor

@r0man1337 r0man1337 commented Dec 12, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced filtering logic for displaying trade events in the Market Trading History.
    • Improved error handling in the Trade History Event component to prevent runtime errors.
  • Bug Fixes

    • Added checks to ensure resourceGiven and resourceTaken are defined before processing trade events.
  • Refactor

    • Simplified rendering logic by utilizing derived variables for resource details in the Trade History Event.
  • Chores

    • Implemented error logging and graceful failure in price calculation functions.

Copy link

vercel bot commented Dec 12, 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 12, 2024 10:24am
eternum-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 12, 2024 10:24am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
eternum-landing ⬜️ Ignored (Inspect) Visit Preview Dec 12, 2024 10:24am

Copy link
Contributor

coderabbitai bot commented Dec 12, 2024

Walkthrough

The pull request introduces enhancements to the MarketTradingHistory and TradeHistoryEvent components. In MarketTradingHistory, the filtering logic for trade events is updated to ensure both resourceGiven and resourceTaken are defined before checking against the selectedResourceId. In TradeHistoryEvent, error handling is added for undefined resources, and rendering logic is simplified by using derived variables. Both components maintain their core functionalities while improving robustness and clarity.

Changes

File Path Change Summary
client/src/ui/components/trading/MarketTradingHistory.tsx Updated filtering logic to check for resourceGiven and resourceTaken before comparing to selectedResourceId. Minor adjustments to JSX rendering.
client/src/ui/components/trading/TradeHistoryEvent.tsx Added error handling for undefined resourceTaken and resourceGiven. Simplified rendering logic and updated getLordsPricePerResource with error handling.

Possibly related PRs

  • [client] show all my trades in history #2046: This PR modifies the MarketTradingHistory component, which is directly related to the main PR's changes in the same component, enhancing the filtering logic for trade events.
  • [client] show all my trades in history #2046: It also updates the TradeHistoryEvent component, which is relevant since the main PR also involves changes to this component, specifically in handling trade events and their rendering.

Suggested reviewers

  • edisontim

🐇 In the market where trades do flow,
A filter's strength we now bestow.
With resources checked, no errors to see,
Our trading history dances with glee!
Simplified paths, clear as day,
In the world of trades, we hop and play! 🎉


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. (Experiment)
  • @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 12, 2024

You are out of MentatBot reviews. Your usage will refresh December 16 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

🧹 Outside diff range and nitpick comments (4)
client/src/ui/components/trading/TradeHistoryEvent.tsx (3)

47-52: Consider adding type safety for amount values

While the null checks prevent crashes from undefined resources, consider adding type safety for the amount values to prevent potential NaN issues in the currency formatting.

-        <div>{`${currencyIntlFormat(divideByPrecision(resourceTaken.amount), 2)} for ${currencyIntlFormat(
-          divideByPrecision(resourceGiven.amount),
-          2,
-        )}`}</div>
+        <div>{`${currencyIntlFormat(divideByPrecision(Number(resourceTaken.amount) || 0), 2)} for ${currencyIntlFormat(
+          divideByPrecision(Number(resourceGiven.amount) || 0),
+          2,
+        )}`}</div>

62-62: Consider improving readability of resource ID selection

The nested ternary within array access could be made more readable by extracting the logic into a separate variable.

-                resourceTaken.resourceId === ResourcesIds.Lords ? resourceGiven.resourceId : resourceTaken.resourceId,
+                const displayResourceId = resourceTaken.resourceId === ResourcesIds.Lords 
+                  ? resourceGiven.resourceId 
+                  : resourceTaken.resourceId;
+                displayResourceId,

74-82: Consider improving error handling feedback

While catching errors is good, silently returning 0 might hide issues from users. Consider:

  1. Adding more specific error types
  2. Providing user feedback for calculation errors
 try {
   const lordsResource = resourceA.resourceId === ResourcesIds.Lords ? resourceA : resourceB;
   const otherResource = resourceA.resourceId === ResourcesIds.Lords ? resourceB : resourceA;

   return Number(lordsResource.amount) / Number(otherResource.amount);
 } catch (e) {
   console.error(e);
-  return 0;
+  const error = e instanceof Error ? e : new Error('Unknown error');
+  console.error('Price calculation failed:', error);
+  // Consider showing a user-friendly error message in the UI
+  return null;
 }
client/src/ui/components/trading/MarketTradingHistory.tsx (1)

Line range hint 127-131: Consider improving filter condition readability

While the null checks are good, the filter condition could be more readable by breaking it down into smaller parts.

-        .filter((trade) =>
-          trade.event.resourceGiven && trade.event.resourceTaken && selectedResourceId
-            ? trade.event.resourceGiven.resourceId === selectedResourceId ||
-              trade.event.resourceTaken.resourceId === selectedResourceId
-            : true,
-        )
+        .filter((trade) => {
+          // First check if we have valid resources
+          if (!trade.event.resourceGiven || !trade.event.resourceTaken) {
+            return false;
+          }
+          
+          // If no resource is selected, show all trades
+          if (!selectedResourceId) {
+            return true;
+          }
+          
+          // Show trades matching the selected resource
+          return trade.event.resourceGiven.resourceId === selectedResourceId ||
+                 trade.event.resourceTaken.resourceId === selectedResourceId;
+        })
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e500824 and 395b4a4.

📒 Files selected for processing (2)
  • client/src/ui/components/trading/MarketTradingHistory.tsx (1 hunks)
  • client/src/ui/components/trading/TradeHistoryEvent.tsx (4 hunks)
🔇 Additional comments (2)
client/src/ui/components/trading/TradeHistoryEvent.tsx (1)

29-33: LGTM: Good defensive programming practice!

The early null check for undefined resources effectively prevents the component from crashing when either resourceTaken or resourceGiven is undefined. This is a clean solution that follows best practices.

client/src/ui/components/trading/MarketTradingHistory.tsx (1)

Line range hint 127-131: Verify comprehensive handling of undefined resources

Let's verify that all potential undefined resource scenarios are covered.

✅ Verification successful

Based on the search results, I can now generate the final response as we have comprehensive information about the usage of resourceGiven and resourceTaken in the codebase.

All undefined resource scenarios are properly handled

The codebase shows proper handling of undefined resources in both locations where these properties are used:

  • In MarketTradingHistory.tsx: The code uses a safe conditional check trade.event.resourceGiven && trade.event.resourceTaken before accessing their properties
  • In TradeHistoryEvent.tsx: The code implements explicit null checks with if (!resourceTaken || !resourceGiven) after destructuring

No other unsafe usages of these properties were found in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for direct access to resourceGiven or resourceTaken without null checks
rg -n "\.resourceGiven|\.resourceTaken" --type ts

# Search for potential null checks on these properties
rg -n "(!|\?\.).*resource(Given|Taken)" --type ts

# Look for similar patterns that might need the same protection
ast-grep --pattern 'trade.event.$_' 

Length of output: 2299

@ponderingdemocritus ponderingdemocritus merged commit 2eae96c into next Dec 12, 2024
8 of 9 checks passed
@ponderingdemocritus ponderingdemocritus deleted the fix/trade-history branch December 12, 2024 10:31
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