SQS-377 | Unit test ProcessPool #493

deividaspetraitis · 2024-08-28T17:51:33Z

This pull request introduces unit tests for Orderbook usecase ProcessPool method. As a side effect for more efficient testing it refactors several program parts, for example FetchTickUnrealizedCancels and FetchTicks are moved to the client side instead of keeping in orberbook usecase.

Tests aims to cover errors and one one successful case:

❯ go test ./orderbook/usecase -run "TestOrderbookUsecaseTestSuite/TestProcessPool" -v
=== RUN   TestOrderbookUsecaseTestSuite
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool/pool_is_nil
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool/cosmWasmPoolModel_is_nil
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool/pool_is_not_an_orderbook_pool
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool/orderbook_pool_has_no_ticks,_nothing_to_process
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool/failed_to_cast_pool_model_to_CosmWasmPool
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool/failed_to_fetch_ticks_for_pool
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool/failed_to_fetch_unrealized_cancels_for_pool
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool/tick_ID_mismatch_when_fetching_unrealized_ticks
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool/tick_ID_mismatch_when_fetching_tick_states
=== RUN   TestOrderbookUsecaseTestSuite/TestProcessPool/successful_pool_processing
--- PASS: TestOrderbookUsecaseTestSuite (0.03s)
    --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool (0.03s)
        --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool/pool_is_nil (0.00s)
        --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool/cosmWasmPoolModel_is_nil (0.00s)
        --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool/pool_is_not_an_orderbook_pool (0.00s)
        --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool/orderbook_pool_has_no_ticks,_nothing_to_process (0.00s)
        --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool/failed_to_cast_pool_model_to_CosmWasmPool (0.00s)
        --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool/failed_to_fetch_ticks_for_pool (0.00s)
        --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool/failed_to_fetch_unrealized_cancels_for_pool (0.00s)
        --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool/tick_ID_mismatch_when_fetching_unrealized_ticks (0.00s)
        --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool/tick_ID_mismatch_when_fetching_tick_states (0.00s)
        --- PASS: TestOrderbookUsecaseTestSuite/TestProcessPool/successful_pool_processing (0.00s)
PASS
ok      github.com/osmosis-labs/sqs/orderbook/usecase   (cached)

Introduces unit tests for Orderbook usecase ProcessPool method.

coderabbitai · 2024-08-28T17:51:39Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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 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 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.

Early access features: disabled

We are currently testing the following features in early access:

Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
Please join our Discord Community to provide feedback and report issues on the discussion post.

p0mvn

Overall LGTM!

My only recommendation is to reduce code duplication and hard coding before merge.

orderbook/usecase/orderbook_usecase_test.go

p0mvn · 2024-08-29T16:08:16Z

orderbook/usecase/orderbook_usecase_test.go

+		{
+			name:          "pool is nil",
+			pool:          nil,
+			expectedError: "pool is nil when processing order book",


Let's also import the actual errors rather than hardcoding strings.

This is so that if we need to change an error message, we only need to do it in one place

This is actually the identical situation as described in previous PR comment. If you would like still to proceed with this idea can we descope it from this task?

Per the comment in another PR, I would like to suggest considering completing it in this PR so that we avoid accumulating tech debt.

IMO, this should be under 20 minutes to change/refactor but will yield the benefit of not having to switch context to come back to in the future and/or accumulate tech debt that is already exceeding the comfortable levels.

Will leave the final call to you though!

Adds requested improvements

Add cosmwasmpool import

p0mvn

Pre-approving pending the decision on handling errors

p0mvn · 2024-09-01T17:52:39Z

orderbook/usecase/orderbook_usecase_test.go

+		{
+			name:          "pool is nil",
+			pool:          nil,
+			expectedError: "pool is nil when processing order book",


Per the comment in another PR, I would like to suggest considering completing it in this PR so that we avoid accumulating tech debt.

IMO, this should be under 20 minutes to change/refactor but will yield the benefit of not having to switch context to come back to in the future and/or accumulate tech debt that is already exceeding the comfortable levels.

Will leave the final call to you though!

Requested changes: errors as types

sonarcloud · 2024-09-02T13:04:28Z

Quality Gate failed

Failed conditions
26.7% Coverage on New Code (required ≥ 50%)

See analysis details on SonarCloud

deividaspetraitis · 2024-09-02T13:06:13Z

As per suggestion implemented error types instead of hardcoding strings. Thanks @p0mvn for your time and suggestions! 🙏

SQS-377 | Unit test ProcessPool

cf494a7

Introduces unit tests for Orderbook usecase ProcessPool method.

deividaspetraitis requested review from cryptomatictrader and p0mvn August 28, 2024 17:51

deividaspetraitis added the A:backport/v26.x backport patches to v26.x branch label Aug 28, 2024

deividaspetraitis self-assigned this Aug 28, 2024

p0mvn reviewed Aug 29, 2024

View reviewed changes

deividaspetraitis added 3 commits August 30, 2024 16:59

SQS-377 | Unit test ProcessPool

3c5c55a

Adds requested improvements

Merge remote-tracking branch 'upstream/SQS-375' into SQS-377

6a23403

SQS-377 | Unit test ProcessPool

38ad4b0

Add cosmwasmpool import

p0mvn approved these changes Sep 1, 2024

View reviewed changes

deividaspetraitis added 2 commits September 2, 2024 15:27

Merge remote-tracking branch 'upstream/SQS-375' into SQS-377

d866744

SQS-377 | Unit test ProcessPool

1faefe4

Requested changes: errors as types

deividaspetraitis merged commit 14b01e5 into SQS-375 Sep 2, 2024
8 of 9 checks passed

deividaspetraitis deleted the SQS-377 branch September 2, 2024 13:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SQS-377 | Unit test ProcessPool #493

SQS-377 | Unit test ProcessPool #493

deividaspetraitis commented Aug 28, 2024

coderabbitai bot commented Aug 28, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

p0mvn left a comment

p0mvn Aug 29, 2024

deividaspetraitis Aug 30, 2024

p0mvn Sep 1, 2024

p0mvn left a comment

p0mvn Sep 1, 2024

sonarcloud bot commented Sep 2, 2024

deividaspetraitis commented Sep 2, 2024

SQS-377 | Unit test ProcessPool #493

SQS-377 | Unit test ProcessPool #493

Conversation

deividaspetraitis commented Aug 28, 2024

coderabbitai bot commented Aug 28, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

p0mvn left a comment

Choose a reason for hiding this comment

p0mvn Aug 29, 2024

Choose a reason for hiding this comment

deividaspetraitis Aug 30, 2024

Choose a reason for hiding this comment

p0mvn Sep 1, 2024

Choose a reason for hiding this comment

p0mvn left a comment

Choose a reason for hiding this comment

p0mvn Sep 1, 2024

Choose a reason for hiding this comment

sonarcloud bot commented Sep 2, 2024

Quality Gate failed

deividaspetraitis commented Sep 2, 2024

coderabbitai bot commented Aug 28, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)