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

FE-1281 | Move pools router into local tRPC router #4005

Merged
merged 2 commits into from
Dec 9, 2024
Merged

FE-1281 | Move pools router into local tRPC router #4005

merged 2 commits into from
Dec 9, 2024

Conversation

deividaspetraitis
Copy link
Collaborator

@deividaspetraitis deividaspetraitis commented Dec 9, 2024

What is the purpose of the change:

Moves pools router into local tRPC router for following methods:

  • getPools
  • getPool

Linear Task

https://linear.app/osmosis/issue/FE-1281/move-pools-router-into-local-trpc-router

Brief Changelog

  • Imported existing poolsRouter into local-router
  • Replaced in the source code to use local router for getPools, getPool instead of egde

Testing and Verifying

This change has been tested locally by rebuilding the website and verified content and links are expected

Moves pools router into local tRPC router for following methods:

- getUserPools
- getPools
- getPool
Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/web/components/complex/add-conc-liquidity.tsx

Oops! Something went wrong! :(

ESLint: 8.50.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/packages/web/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces modifications across several components and hooks to change the data source for pool information from an edge API to a local API. This adjustment affects components such as AddConcLiquidity, PoolsTable, and UserPositionsSection, among others, ensuring they retrieve pool data from the updated local API endpoints. While the core logic and structure of these components remain intact, the changes primarily focus on the data fetching mechanisms and the introduction of new filtering options in the PoolsTable component.

Changes

File Path Change Summary
packages/web/components/complex/add-conc-liquidity.tsx Updated pool data query from api.edge.pools.getPool.useQuery to api.local.pools.getPool.useQuery.
packages/web/components/complex/pools-table.tsx Changed data fetching from api.edge.pools.getPools.useInfiniteQuery to api.local.pools.getPools.useInfiniteQuery. Expanded filtering options for pool types and adjusted column display logic.
packages/web/components/complex/portfolio/user-positions.tsx Updated user pools query from api.edge.pools.getUserPools.useQuery to api.local.pools.getUserPools.useQuery.
packages/web/hooks/ui-config/use-add-concentrated-liquidity-config.ts Modified pool data query from api.edge.pools.getPool.useQuery to api.local.pools.getPool.useQuery.
packages/web/hooks/ui-config/use-historical-and-depth-data.ts Updated pool data query from api.edge.pools.getPool.useQuery to api.local.pools.getPool.useQuery and changed active liquidity query to api.local.concentratedLiquidity.getLiquidityPerTickRange.useQuery.
packages/web/modals/add-liquidity.tsx Changed pool data fetching from api.edge.pools.getPool to api.local.pools.getPool.
packages/web/pages/pool/[id].tsx Updated pool data fetching from api.edge.pools.getPool.useQuery to api.local.pools.getPool.useQuery.
packages/web/server/api/local-router.ts Added poolsRouter to the localRouter structure.

Possibly related PRs

Suggested reviewers

  • JoseRFelix
  • jonator
  • CryptoAssassin1
  • MaxMillington

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: 2

🧹 Outside diff range and nitpick comments (3)
packages/web/components/complex/portfolio/user-positions.tsx (1)

Line range hint 99-112: LGTM! Consider adding error handling for the query.

The migration from edge to local router is correct. However, the query lacks error handling which could be important for user feedback.

Consider adding error handling:

 const { data: allMyPoolDetails, isLoading: isLoadingMyPoolDetails } =
   api.local.pools.getUserPools.useQuery(
     {
       userOsmoAddress: address ?? "",
     },
     {
       enabled: Boolean(address),
+      onError: (error) => {
+        console.error('Failed to fetch user pools:', error);
+        // Add user feedback handling here
+      },
       trpc: {
         context: {
           skipBatch: true,
         },
       },
     }
   );
packages/web/pages/pool/[id].tsx (1)

29-29: LGTM! Consider enhancing error handling for better UX.

The migration to local router is correct. The error handling through isError is good, but could be enhanced for better user experience.

Consider enhancing error handling:

-const { data: pool, isError } = api.local.pools.getPool.useQuery({ poolId });
+const { data: pool, isError, error } = api.local.pools.getPool.useQuery(
+  { poolId },
+  {
+    onError: (error) => {
+      console.error('Failed to fetch pool:', error);
+      // Consider showing a user-friendly error message
+    },
+  }
+);
packages/web/hooks/ui-config/use-add-concentrated-liquidity-config.ts (1)

Line range hint 64-69: Consider adding error handling for the pool query.

The switch to local API looks good. However, consider adding error handling to gracefully handle cases where the pool data fetch fails.

 const { data: pool, isFetched: isPoolFetched } =
   api.local.pools.getPool.useQuery(
     { poolId },
     {
       refetchInterval: 5_000, // 5 seconds
+      retry: 3,
+      onError: (error) => {
+        console.error('Failed to fetch pool data:', error);
+        // Handle error appropriately
+      }
     }
   );
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6218439 and e644826.

📒 Files selected for processing (8)
  • packages/web/components/complex/add-conc-liquidity.tsx (1 hunks)
  • packages/web/components/complex/pools-table.tsx (1 hunks)
  • packages/web/components/complex/portfolio/user-positions.tsx (1 hunks)
  • packages/web/hooks/ui-config/use-add-concentrated-liquidity-config.ts (1 hunks)
  • packages/web/hooks/ui-config/use-historical-and-depth-data.ts (1 hunks)
  • packages/web/modals/add-liquidity.tsx (1 hunks)
  • packages/web/pages/pool/[id].tsx (1 hunks)
  • packages/web/server/api/local-router.ts (2 hunks)
👮 Files not reviewed due to content moderation or server errors (3)
  • packages/web/modals/add-liquidity.tsx
  • packages/web/hooks/ui-config/use-historical-and-depth-data.ts
  • packages/web/components/complex/pools-table.tsx

Copy link

vercel bot commented Dec 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
osmosis-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 9, 2024 1:44pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
osmosis-frontend-datadog ⬜️ Ignored (Inspect) Visit Preview Dec 9, 2024 1:44pm
osmosis-frontend-dev ⬜️ Ignored (Inspect) Visit Preview Dec 9, 2024 1:44pm
osmosis-testnet ⬜️ Ignored (Inspect) Visit Preview Dec 9, 2024 1:44pm

@jonator jonator merged commit e3333d4 into stage Dec 9, 2024
35 checks passed
@jonator jonator deleted the FE-1281 branch December 9, 2024 17:24
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