8000 fix(progress-bar): combinatory auctions by alfetopito · Pull Request #5866 · cowprotocol/cowswap · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(progress-bar): combinatory auctions #5866

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

Merged
merged 2 commits into from
Jun 20, 2025
Merged

Conversation

alfetopito
Copy link
Collaborator
@alfetopito alfetopito commented Jun 19, 2025

Summary

This fix addresses the new reality which arrived with combinatory auctions:

  • Solvers can submit more than one solution including the same order
  • There might be many solutions that do not include the current order

So this change:

  • Filters out solutions that are not touching the relevant order
  • Group solvers solutions so they don't appear repeated in the progress bar

To Test

  1. Open dev tools and filter the network for status
  2. Place order and wait for it to trade
  3. Observe the dev tools
  • It should contain a response with all solvers that competed for the given batch
  • There might be solutions where executedAmounts is null. Those should not show up in the UI
  1. Observe the progress bar
  • There should not be duplicated solvers
  • All solvers displayed here should have executedAmounts filled in the networks console

Summary by CodeRabbit

  • Bug Fixes
    • Improved accuracy and consistency of solver competition data by filtering out invalid entries and ensuring solver names are handled in a case-insensitive manner.
  • Refactor
    • Enhanced internal data processing for solver information to ensure uniqueness and normalization.

Copy link
vercel bot commented Jun 19, 2025

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

Name Status Preview Updated (UTC)
cowfi ✅ Ready (Inspect) Visit Preview Jun 20, 2025 1:07pm
explorer-dev ✅ Ready (Inspect) Visit Preview Jun 20, 2025 1:07pm
swap-dev ✅ Ready (Inspect) Visit Preview Jun 20, 2025 1:07pm
3 Skipped Deployments
Name Status Preview Updated (UTC)
cosmos ⬜️ Ignored (Inspect) Visit Preview Jun 20, 2025 1:07pm
sdk-tools ⬜️ Ignored (Inspect) Visit Preview Jun 20, 2025 1:07pm
widget-configurator ⬜️ Ignored (Inspect) Visit Preview Jun 20, 2025 1:07pm

@alfetopito alfetopito self-assigned this Jun 19, 2025
Copy link
Contributor
coderabbitai bot commented Jun 19, 2025

Walkthrough

The code was updated to improve data normalization and filtering for solver competition data in the order progress bar hooks. Solver names are now consistently lowercased, invalid entries are filtered out, and merging is performed to ensure unique, valid solver entries. Minor import order and function signature adjustments were also made.

Changes

File(s) Change Summary
apps/cowswap-frontend/src/modules/orderProgressBar/hooks/useOrderProgressBarProps.ts Refactored solver competition mapping to a reduce with filtering and merging; normalized solver names to lowercase; updated effect dependencies and function signature; minor import order adjustment.

Poem

In the land of solvers, lowercase is king,
Merging and filtering, let the progress bar sing.
No more duplicates, no more stray,
Only valid entries light the way.
Rabbits hop with glee,
For data’s now as clean as can be! 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

yarn install v1.22.22
[1/4] Resolving packages...
(node:6139) [DEP0169] DeprecationWarning: url.parse() behavior is not standardized and prone to errors that have security implications. Use the WHATWG URL API instead. CVEs are not issued for url.parse() vulnerabilities.
(Use node --trace-deprecation ... to show where the warning was created)
[2/4] Fetching packages...
error nx@21.0.3: The engine "node" is incompatible with this module. Expected version "^20.19.0 || ^22.12.0". Got "24.2.0"
error Found incompatible module.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.


📜 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 68539fb and 26c08f0.

📒 Files selected for processing (1)
  • apps/cowswap-frontend/src/modules/orderProgressBar/hooks/useOrderProgressBarProps.ts (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/cowswap-frontend/src/modules/orderProgressBar/hooks/useOrderProgressBarProps.ts
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Setup
  • GitHub Check: Cypress
✨ 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.
< 8000 include-fragment loading="lazy" src="/cowprotocol/cowswap/issue_comments/2988617331/edit_form?textarea_id=issuecomment-2988617331-body&comment_context=" data-nonce="v2:c3f1c640-d137-5d2a-11ad-5895a4b794c5" data-view-component="true" class="previewable-comment-form js-comment-edit-form-deferred-include-fragment">

@alfetopito
Copy link
Collaborator Author

@coderabbitai review

Copy link
Contributor
coderabbitai bot commented Jun 19, 2025
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bed6a81 and 68539fb.

📒 Files selected for processing (1)
  • apps/cowswap-frontend/src/modules/orderProgressBar/hooks/useOrderProgressBarProps.ts (4 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
apps/cowswap-frontend/src/modules/orderProgressBar/hooks/useOrderProgressBarProps.ts (3)
apps/cowswap-frontend/src/modules/orderProgressBar/types.ts (1)
  • SolverCompetition (38-38)
libs/widget-lib/src/types.ts (1)
  • SupportedChainId (4-4)
apps/cowswap-frontend/src/modules/orderProgressBar/state/atoms.ts (1)
  • updateOrderProgressBarBackendInfo (110-145)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Setup
  • GitHub Check: Cypress
🔇 Additional comments (4)
apps/cowswap-frontend/src/modules/orderProgressBar/hooks/useOrderProgressBarProps.ts (4)

29-29: Import order change looks good.

The swapped import order has no functional impact and maintains readability.


487-487: Good addition of explicit return type.

Adding the explicit void return type improves code clarity and type safety.


489-500: Solver name normalization implementation looks solid.

The renaming from solverCompetition to value improves clarity, and the lowercase transformation addresses case inconsistency issues between the API and CMS data. The effect dependency array is correctly updated.


531-531: Consistent lowercase normalization in lookup.

This change aligns with the lowercase normalization applied in the data transformation, ensuring consistent behavior across the codebase.

@shoom3301
Copy link
Collaborator
image

The behaviour matches the test plan ✅

Copy link
Contributor
@elena-zh elena-zh left a comment

Choose a reason for hiding this comment

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

I've done tests on all networks, works as expected everywhere.
However, I have not faced the case where solver's amount is null. Will keep my eye on it

@alfetopito alfetopito merged commit 0f606ca into develop Jun 20, 2025
14 of 15 checks passed
@alfetopito alfetopito deleted the fix/comb-auctions branch June 20, 2025 13:37
@github-actions github-actions bot locked and limited conversation to collaborators Jun 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0