InjectiveLabs / sdk-python

Injective Exchange API for Python clients
Apache License 2.0
41 stars 29 forks source link

feat/reduce_calls_for_cookies #314

Closed aarmoa closed 7 months ago

aarmoa commented 8 months ago

https://injective-labs.atlassian.net/browse/CHAIN-20?atlOrigin=eyJpIjoiZDFlNmFlOWJjNjdkNGI3NjgwN2QwOTcyZDI3MDA2NzUiLCJwIjoiaiJ9

Summary by CodeRabbit

coderabbitai[bot] commented 8 months ago

Walkthrough

The update involves a significant overhaul of the codebase, focusing on centralizing cookies management and metadata handling for gRPC calls. This restructuring emphasizes direct method calls over lambda functions and introduces a structured approach to managing cookies and metadata through the CookieAssistant class and its variants. These changes aim to enhance code readability, maintainability, and consistency in creating API instances for testing purposes.

Changes

Files Change Summary
CHANGELOG.md Refactored cookies management logic to utilize all gRPC calls' responses for updating current cookies.
pyinjective/async_client.py
.../core/network.py
.../utils/grpc_api_request_assistant.py
.../utils/grpc_api_stream_assistant.py
Replaced lambda functions with direct method calls, centralized metadata handling using CookieAssistant, and simplified code structure.
tests/client/chain/grpc/...
tests/client/indexer/grpc/...
tests/client/indexer/stream_grpc/...
tests/core/...
Streamlined API instance creation in tests using a new method _api_instance and updated cookie management tests.

🐰✨
In the realm of code where the data flows,
A refactor vast, in the wind it blows.
With cookies managed and metadata neat,
Our code now dances with nimble feet.
Cheers to the changes, to simplicity we toast,
From every function to each test post.
🎉🐇


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 .` - `Generate unit-tests 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 tests 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 tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
codecov[bot] commented 8 months ago

Codecov Report

Attention: Patch coverage is 91.97861% with 15 lines in your changes are missing coverage. Please review.

Project coverage is 76.98%. Comparing base (8adf955) to head (378e2ac).

Files Patch % Lines
pyinjective/core/network.py 78.87% 10 Missing and 5 partials :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #314 +/- ## ========================================== + Coverage 76.40% 76.98% +0.58% ========================================== Files 51 51 Lines 4170 4145 -25 Branches 353 309 -44 ========================================== + Hits 3186 3191 +5 + Misses 878 874 -4 + Partials 106 80 -26 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.