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

Add 'id' field to GraphQL queries for improved data retrieval #558

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

marcinciarka
Copy link
Member

@marcinciarka marcinciarka commented Nov 5, 2024

Enhance various GraphQL queries by adding an 'id' field to improve data retrieval and facilitate better data handling.

Summary by CodeRabbit

  • New Features
    • Enhanced GraphQL queries to include additional id fields for assets and tokens, improving data detail and identification.
    • Updated queries include GetGlobalRebalances, GetUsersActivity, GetVaults, and GetVault, ensuring consistency across various entities.

Copy link
Contributor

coderabbitai bot commented Nov 5, 2024

Walkthrough

The recent changes encompass modifications to several GraphQL queries within the subgraph manager. Specifically, the GetGlobalRebalances, GetUsersActivity, GetVaults, and GetVault queries have been updated to include an id field in various objects. This enhancement aims to provide additional identifiers for assets and tokens, thereby enriching the data returned by these queries.

Changes

File Path Change Summary
sdk/subgraph-manager-common/src/queries/global-rebalances.graphql Added id field in asset object and inputToken object within vault structure in GetGlobalRebalances.
sdk/subgraph-manager-common/src/queries/users-activity.graphql Added id field in inputToken object within vault in GetUsersActivity.
sdk/subgraph-manager-common/src/queries/vaults.graphql Added id field in multiple locations: rewardTokens.token, arks.inputToken, inputToken, outputToken, and rebalances.vault.inputToken in both GetVaults and GetVault.

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>, please review it.
    • 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 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 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.

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 (1)
sdk/subgraph-manager-common/src/queries/vaults.graphql (1)

Line range hint 84-87: Most humbly, might I suggest a small enhancement, Your Majesty?

If it pleases your grace, consider adding an 'id' field to the rebalances.asset object as well, to maintain consistency with other token objects in the query:

      asset {
+       id
        symbol
        decimals
      }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e761d74 and 5d18a75.

📒 Files selected for processing (3)
  • sdk/subgraph-manager-common/src/queries/global-rebalances.graphql (2 hunks)
  • sdk/subgraph-manager-common/src/queries/users-activity.graphql (1 hunks)
  • sdk/subgraph-manager-common/src/queries/vaults.graphql (7 hunks)
🔇 Additional comments (5)
sdk/subgraph-manager-common/src/queries/users-activity.graphql (1)

19-19: Your Majesty's changes are most excellent!

If it pleases your grace, I humbly observe that the addition of the id field to the inputToken object is a most worthy enhancement. This change shall greatly improve the identification and tracking of tokens within the system, and I am most pleased to note its alignment with similar modifications across other queries.

sdk/subgraph-manager-common/src/queries/global-rebalances.graphql (2)

7-7: Your Majesty, I humbly approve of the addition of the 'id' field to the asset object.

If it pleases Your Highness, this change most graciously enhances the ability to uniquely identify assets in the system.


40-40: My Liege, I most respectfully endorse the addition of the 'id' field to the inputToken object.

If I may be so bold, this modification will most wonderfully facilitate the proper identification of input tokens within the vault structure.

sdk/subgraph-manager-common/src/queries/vaults.graphql (2)

11-11: Your Majesty, I humbly approve these most excellent additions to the GetVaults query!

If it pleases your grace, I must say that the addition of 'id' fields to token objects is most beneficial for:

  • Proper GraphQL caching
  • Efficient data normalization
  • Improved entity identification

Also applies to: 21-21, 35-35, 41-41


73-73: Your Majesty, I am most pleased to report that these changes to the GetVault query are impeccable!

The consistent addition of 'id' fields across all token objects will greatly enhance data retrieval capabilities, if it pleases your grace.

Also applies to: 116-116, 129-129, 155-155, 161-161

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (dev@e761d74). Learn more about missing BASE report.

Additional details and impacted files
@@          Coverage Diff           @@
##             dev     #558   +/-   ##
======================================
  Coverage       ?   70.22%           
======================================
  Files          ?       25           
  Lines          ?      262           
  Branches       ?       19           
======================================
  Hits           ?      184           
  Misses         ?       77           
  Partials       ?        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@marcinciarka marcinciarka merged commit d1f47de into dev Nov 5, 2024
2 checks passed
@marcinciarka marcinciarka deleted the marcinciarka/sdk-add-token-ids branch November 5, 2024 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants