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

Wl/t3 #1758

Closed
wants to merge 16 commits into from
Closed

Wl/t3 #1758

wants to merge 16 commits into from

Conversation

dydxwill
Copy link
Contributor

@dydxwill dydxwill commented Jun 24, 2024

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • New Features

    • Improved support for the wl/t3 branch in workflow triggers for development, staging, and mainnet environments.
    • Added new function to generate a mapping of clobPairId to ticker values in market refresh logic.
  • Enhancements

    • Introduced asynchronous operations and statistics tracking in message forwarding logic.
    • Implemented thread pool management using the Piscina library.
  • Bug Fixes

    • Ensured test environment cleanup with database helper functions in message forwarder tests.
  • Refactor

    • Reorganized and refactored imports and function signatures in message processing helpers.
  • Dependencies

    • Added piscina package to manage concurrent processing tasks.

Copy link
Contributor

coderabbitai bot commented Jun 24, 2024

Walkthrough

These updates enhance the GitHub workflows to trigger on a new branch, add a new function for market tickers, refactor test setups, introduce dependencies, and improve message handling and async task processing. Additionally, a new logger-based worker function and thread pool configuration have been added. Collectively, these changes improve workflow flexibility, code maintainability, and performance.

Changes

File Path Change Summary
.github/workflows/indexer-build-and-push-dev-staging.yml Modify triggers to include branch 'wl/t3'.
.github/workflows/indexer-build-and-push-mainnet.yml Add branch trigger 'wl/t3'.
indexer/packages/postgres/src/loops/perpetual-market-refresher.ts Add getClobPairIdToTickerMap() function and export it along with getPerpetualMarketTicker.
indexer/services/socks/__tests__/lib/message-forwarder.test.ts Clear data in beforeAll hook and comment out updatePerpetualMarkets call in the test.
indexer/services/socks/package.json Add piscina dependency.
indexer/services/socks/src/lib/message-forwarder.ts Reorder imports, make onMessage async, introduce piscina, and update message processing logic to support async operations and statistics tracking.
indexer/services/socks/src/lib/workers/blank-worker.ts New file: Introduce print() function to log "Hello, World!" using logger.
indexer/services/socks/src/lib/workers/from-kafka-helpers.ts Refactor imports, rename and update getMessageToForward to getMessagesToForward, and adjust function signatures and logic for getMessagesToForward, getTickerOrThrow, and getCandleMessageId.
indexer/services/socks/src/threadpool.ts Export new piscina constant configured for thread pool.

Poem

In the code forest, changes arise,
Branches trigger as workflows stabilize.
Market tickers mapped with care,
Refactored tests, async tasks to spare.
Threads now pool, a worker's cheer,
Logs say "Hello," enhancements here.

Let's celebrate with a bunny hop,
These updates surely won't stop! 🐇🎉


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between edcf8f8 and 42ee573.

Files selected for processing (2)
  • indexer/services/socks/src/lib/message-forwarder.ts (5 hunks)
  • indexer/services/socks/src/lib/workers/blank-worker.ts (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • indexer/services/socks/src/lib/message-forwarder.ts
  • indexer/services/socks/src/lib/workers/blank-worker.ts

@dydxwill dydxwill closed this Jun 27, 2024
@dydxwill dydxwill reopened this Jul 9, 2024
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 (2)
indexer/services/socks/src/lib/message-forwarder.ts (2)

1-3: Remove commented-out import.

The commented-out import statement for Worker from worker_threads should be removed if it is not needed.


185-186: Commented-out code.

The code for perpetualMarketRefresher.updatePerpetualMarkets() is commented out. If it's not needed, consider removing it.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 42ee573 and 181eb2c.

Files selected for processing (2)
  • indexer/services/socks/tests/lib/message-forwarder.test.ts (1 hunks)
  • indexer/services/socks/src/lib/message-forwarder.ts (8 hunks)
Files skipped from review due to trivial changes (1)
  • indexer/services/socks/tests/lib/message-forwarder.test.ts
Additional comments not posted (6)
indexer/services/socks/src/lib/message-forwarder.ts (6)

4-6: Reordering imports.

Reordering imports can improve readability. Ensure that this change is consistent with the project's import style guidelines.


9-9: Importing Piscina.

The import for Piscina is added. Ensure that Piscina is correctly configured and utilized in the file.


20-20: Reordered and refactored imports.

The import statement for getMessagesToForward and getChannels has been refactored to import from ./workers/from-kafka-helpers. This change is consistent with the new file structure.


22-26: Configuring Piscina instance.

The Piscina instance is configured with a filename, minThreads, and maxThreads. Ensure that these configurations align with the expected workload and performance requirements.


215-217: Using getClobPairIdToTickerMap.

The new function getClobPairIdToTickerMap is used to get a mapping of clobPairId to ticker. Ensure that the function returns the correct data and handles errors appropriately.


226-226: Running Piscina task.

The piscina.run({}) call is made. Ensure that the task being run by Piscina is correctly defined and that the empty object passed as an argument is intentional.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 181eb2c and b825fb2.

Files selected for processing (2)
  • indexer/services/socks/src/lib/message-forwarder.ts (8 hunks)
  • indexer/services/socks/src/threadpool.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • indexer/services/socks/src/threadpool.ts
Files skipped from review as they are similar to previous changes (1)
  • indexer/services/socks/src/lib/message-forwarder.ts

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b825fb2 and 3495536.

Files selected for processing (3)
  • .github/workflows/indexer-build-and-push-mainnet.yml (1 hunks)
  • indexer/services/socks/src/lib/message-forwarder.ts (7 hunks)
  • indexer/services/socks/src/lib/workers/from-kafka-helpers.ts (8 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/indexer-build-and-push-mainnet.yml
Files skipped from review as they are similar to previous changes (1)
  • indexer/services/socks/src/lib/message-forwarder.ts
Additional comments not posted (5)
indexer/services/socks/src/lib/workers/from-kafka-helpers.ts (5)

19-21: Reorganized and new imports look good.

The reorganization of imports and addition of new imports are appropriate and support the refactored functions.


Line range hint 33-48:
Review the commented-out line.

The line await perpetualMarketRefresher.updatePerpetualMarkets(); is commented out. Ensure this is intentional and does not affect the functionality.


Line range hint 33-48:
Refactored function logic looks good.

The changes to the function getMessagesToForward are appropriate and enhance its functionality.


113-117: Function getTickerOrThrow looks good.

The function correctly retrieves a ticker from the map and throws an error if the ticker is not found.


136-140: Function getCandleMessageId looks good.

The function correctly generates an ID for a candle message and includes error handling for unrecognized resolutions.

@dydxwill dydxwill closed this Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

1 participant