search

osmosis-labs / osmosis

The AMM Laboratory
https://app.osmosis.zone
Apache License 2.0
888 stars 580 forks source link

refactor/test: switch SQS ingest to shared abstractions with the indexer #8478

Closed p0mvn closed 3 months ago

p0mvn commented 3 months ago

Closes: #XXX

What is the purpose of the change

Implements shared abstractions for the SQS ingest. Refactors and tests.

Testing

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes introduce new components and mock implementations related to pool extraction, transformation, and GRPC client setup for SQS streaming services. Additionally, a custom error type and new block processing strategies are implemented for better handling of block updates and transformation and loading of data into SQS. Test cases have also been adjusted and new ones added to ensure these functionalities work as expected.

Changes

Files Change Summaries
app/app.go Added imports (poolextractor, poolstransformer), and modified initialization (poolExtractor, poolsTransformer, blockProcessStrategyManager, sqsGRPCClient).
ingest/sqs/domain/errors.go Added custom error type NodeSyncCheckError with Error() method formatting error message for node sync check.
ingest/sqs/domain/ingester.go Removed Ingester interface, added BlockUpdateProcessUtilsI and its struct implementation BlockUpdateProcessUtils.
ingest/sqs/domain/mocks/block_updates_process_utils_mock.go Added mock implementation BlockUpdateProcessUtilsMock implementing BlockUpdateProcessUtilsI interface.
ingest/sqs/domain/mocks/grpc_client_mock.go Introduced GRPCClientMock that implements SQSGRPClient interface.
ingest/sqs/domain/mocks/pool_transformer_mock.go Added PoolsTransformerMock implementing PoolsTransformer interface.
ingest/sqs/domain/mocks/pools_extractor_mock.go Provided mock implementation for PoolExtractor interface.
.../ingest/sqs/service/blockprocessor/block_process_sqs_factory.go Introduced NewBlockProcessor function for creating block processing strategy based on certain conditions.
.../ingest/sqs/service/blockprocessor/block_process_sqs_factory_test.go Added test cases for NewBlockProcessor function.
.../ingest/sqs/service/blockprocessor/block_updates_sqs_block_process_strategy.go Introduced a new block processing strategy for handling block updates via SQS.
.../ingest/sqs/service/blockprocessor/export_test.go Added new block processing strategies for handling block updates and full blocks through SQS.
.../ingest/sqs/service/blockprocessor/full_sqs_block_process_strategy.go Added fullSQSBlockProcessStrategy struct implementing block processing interfaces for SQS.
.../ingest/sqs/service/blockprocessor/full_sqs_block_process_strategy_test.go Added test suite for ProcessBlock method with various scenarios using mocks and assertions.
.../ingest/sqs/service/blockprocessor/transform_and_load.go Added transformAndLoad function to transform pools and load them into SQS service.
ingest/sqs/service/sqs_streaming_service.go Signature modifications to the New function.
ingest/sqs/service/sqs_streaming_service_test.go Included changes in import statements, test case restructuring, and test data setup adjustments.
ingest/sqs/sqs_config.go Removed imports, renamed a constant, and removed Initialize function.
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between e6fce341e8c27680829ffc3438e515a395d1c2fd and 047e5a3bde7ed1912838b3ee71b9a497955dc96f.
Files selected for processing (2) * ingest/sqs/service/blockprocessor/full_sqs_block_process_strategy_test.go (1 hunks) * ingest/sqs/service/blockprocessor/transform_and_load.go (1 hunks)
Files skipped from review as they are similar to previous changes (2) * ingest/sqs/service/blockprocessor/full_sqs_block_process_strategy_test.go * ingest/sqs/service/blockprocessor/transform_and_load.go
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.