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

ceiling amount contribute #2556

Merged
merged 1 commit into from
Dec 17, 2024
Merged

ceiling amount contribute #2556

merged 1 commit into from
Dec 17, 2024

Conversation

aymericdelab
Copy link
Collaborator

@aymericdelab aymericdelab commented Dec 17, 2024

Summary by CodeRabbit

  • New Features

    • Updated contribution calculation to potentially allow for higher maximum contributions.
  • Bug Fixes

    • Improved handling of contributions based on input values, ensuring proper reset and deletion of contributions.

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 9:06pm
eternum-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 17, 2024 9:06pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
eternum-landing ⬜️ Ignored (Inspect) Visit Preview Dec 17, 2024 9:06pm

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
Contributor

coderabbitai bot commented Dec 17, 2024

Walkthrough

The pull request modifies the HyperstructureResourceChip component, specifically changing the rounding method for calculating the maximum contributable amount from Math.floor to Math.ceil. This adjustment potentially allows for a slightly higher contribution amount. The component retains its existing logic for handling contributions, with useEffect hooks managing input value updates and resets based on specific conditions.

Changes

File Change Summary
client/src/ui/components/hyperstructures/HyperstructureResourceChip.tsx Modified max contributable amount calculation from Math.floor() to Math.ceil()

Poem

🐰 A rabbit's tale of rounding might,
Where ceil replaces floor so bright
Contributions climb a little higher
With math that makes the numbers fire
A chip that leaps beyond its bound
Precision dancing round and round! 🔢


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

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 (2)
client/src/ui/components/hyperstructures/HyperstructureResourceChip.tsx (2)

Line range hint 42-54: Consider performance and maintainability improvements

The component could benefit from several optimizations:

  1. Memoize the maxContributableAmount calculation to prevent unnecessary recalculations
  2. Extract the contribution logic into a custom hook for better reusability
  3. Add explicit type assertions for numeric operations to prevent potential type coercion issues

Consider refactoring like this:

// Create a custom hook
const useContributions = (
  resourceId: number,
  initialContributions: Record<number, number>,
  onContributionsChange: (contributions: Record<number, number>) => void
) => {
  const [inputValue, setInputValue] = useState<number>(0);

  useEffect(() => {
    const contributionsCopy = { ...initialContributions };
    if (inputValue === 0 || isNaN(inputValue)) {
      delete contributionsCopy[resourceId];
    } else {
      contributionsCopy[resourceId] = inputValue;
    }
    onContributionsChange(contributionsCopy);
  }, [inputValue, resourceId, onContributionsChange]);

  return { inputValue, setInputValue };
};

// Memoize complex calculations
const maxContributableAmount = useMemo(() => {
  let amount = Math.min(progress.costNeeded! - progress.amount, balance);
  amount *= progress.costNeeded - progress.amount > balance ? safetyMargin : 1;
  return Math.ceil(amount);
}, [progress.costNeeded, progress.amount, balance, safetyMargin]);

Line range hint 89-102: Enhance user feedback for contribution limits

The MAX button and input field could provide better feedback about contribution limits and safety margins:

  1. Consider showing the safety margin in the tooltip when hovering over the MAX button
  2. Add visual feedback when the input approaches the maximum safe contribution

Consider enhancing the tooltip content:

onMouseEnter={() => {
  setTooltip({
    position: "top",
    content: (
      <>
        {findResourceById(getIconResourceId(resourceId, false))?.trait as string} ({currencyIntlFormat(balance)})
        {production?.consumption_rate !== 0n && (
          <div className="text-yellow-400">
            Includes 5% safety margin for consumed resources
          </div>
        )}
      </>
    ),
  });
}}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c78ae1e and e21b600.

📒 Files selected for processing (1)
  • client/src/ui/components/hyperstructures/HyperstructureResourceChip.tsx (1 hunks)
🔇 Additional comments (1)
client/src/ui/components/hyperstructures/HyperstructureResourceChip.tsx (1)

40-40: Verify the impact of using Math.ceil on contribution limits

Changing from Math.floor to Math.ceil could potentially lead to overcontribution in edge cases, especially when dealing with decimal values. While this allows for slightly higher contributions, it needs careful consideration:

  1. When combined with the 95% safety margin, rounding up might exceed the intended safety buffer
  2. For resources with precise balance requirements, ceiling could lead to insufficient remaining balance

Let's analyze the usage of this component and potential edge cases:

✅ Verification successful

Using Math.ceil for maxContributableAmount is safe in this context

The change from Math.floor to Math.ceil is safe because:

  1. The component already implements a 95% safety margin (safetyMargin = 0.95) when consumption rate exists and available balance is the limiting factor
  2. The maximum contribution is first calculated as the minimum between remaining cost and balance: Math.min(progress.costNeeded! - progress.amount, balance)
  3. The safety margin is only applied when balance is the limiting factor: maxContributableAmount *= progress.costNeeded - progress.amount > balance ? safetyMargin : 1
  4. Rounding up with Math.ceil after these safeguards cannot exceed the safe limits since the value has already been capped

The implementation ensures that even with ceiling rounding:

  • When balance-limited: The 95% safety margin prevents overcontribution
  • When cost-limited: Rounding up cannot exceed the remaining cost needed
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for other components that might be affected by this change
# Look for related balance checks and safety calculations

# Check for other instances of Math.floor/ceil in relation to contributions
rg -A 3 "Math\.(floor|ceil).*contribution" 

# Look for balance validation logic
ast-grep --pattern 'balance < $_ || $_ > balance'

# Search for safety margin implementations
rg -A 3 "safetyMargin.*contribution"

Length of output: 135


Script:

#!/bin/bash
# Let's try a broader search to understand the context better

# Look for any Math.floor or Math.ceil operations
rg -A 3 "Math\.(floor|ceil)"

# Search for balance-related calculations
rg -A 3 "(balance|amount|contribution)"

# Look for the component usage
rg -l "HyperstructureResourceChip"

# Check the entire file content for better context
fd -t f "HyperstructureResourceChip.tsx" --exec cat {}

Length of output: 76319


Script:

#!/bin/bash
# Let's look for safety margin and contribution-related code in the component

# Search for the full HyperstructureResourceChip component implementation
ast-grep --pattern 'const HyperstructureResourceChip = $$$'

# Look for any balance or contribution validation logic
rg -A 5 "(maxContributableAmount|safetyMargin|contribution.*balance)" client/src/ui/components/hyperstructures/HyperstructureResourceChip.tsx

# Check for any tests related to this component
fd -t f "HyperstructureResourceChip.test" -X cat {}

Length of output: 11813

@ponderingdemocritus ponderingdemocritus merged commit 3a505c8 into next Dec 17, 2024
7 of 9 checks passed
@ponderingdemocritus ponderingdemocritus deleted the hyper-fix branch December 17, 2024 22:39
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