RequestNetwork / request-scan

Request Scan app frontend
https://scan.request.network
MIT License
0 stars 0 forks source link

feat: add cache #31

Closed rodrigopavezi closed 2 weeks ago

rodrigopavezi commented 2 weeks ago

Change:

Note: I could not add @cache tag to the payments queries because it causes the requests to return 502 intermittently. I have asked Hasura team on Discord to see what they say about it.

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces several modifications aimed at enhancing the performance and efficiency of the GraphQL client and associated queries. Key changes include the implementation of a custom fetch function with caching capabilities, adjustments to the refetching logic in hooks to prevent unnecessary polling, and the addition of caching directives to various GraphQL queries. These updates collectively aim to optimize data fetching and reduce network calls.

Changes

Files Change Summary
src/lib/graphQlClient.ts Added a custom fetch function that incorporates caching with a revalidation period of 60 seconds.
src/lib/hooks/use-latest-payments.tsx Modified refetchInterval to disable refetching if pollInterval is zero.
src/lib/hooks/use-latest-requests.tsx Modified refetchInterval to disable refetching if pollInterval is zero.
src/lib/queries/address-transactions.ts Added @cached directive to ADDRESS_TRANSACTIONS_QUERY to enable caching.
src/lib/queries/channel.ts Added @cached directive to CHANNEL_QUERY to enable caching.
src/lib/queries/request-payments.ts Added @cached directive to REQUEST_PAYMENTS_QUERY to enable caching.

Recent review details **Configuration used: CodeRabbit UI** **Review profile: ASSERTIVE**
Commits Files that changed from the base of the PR and between f4a76f3c4912559f3031dd949bafa12b9f54537e and fd4e253ab763020eb7ff80a99c7ecc57be0ba981.
Files selected for processing (6) * src/lib/graphQlClient.ts (1 hunks) * src/lib/hooks/use-latest-payments.tsx (1 hunks) * src/lib/hooks/use-latest-requests.tsx (1 hunks) * src/lib/queries/address-transactions.ts (1 hunks) * src/lib/queries/channel.ts (1 hunks) * src/lib/queries/request-payments.ts (1 hunks)
Additional comments not posted (3)
src/lib/hooks/use-latest-payments.tsx (1)
`43-43`: **LGTM!** The change to the `refetchInterval` option is a good optimization. It prevents unnecessary polling when the `pollInterval` is explicitly set to 0 by setting `refetchInterval` to `false`. This enhances the control flow and optimizes performance by avoiding unnecessary network calls.
src/lib/hooks/use-latest-requests.tsx (1)
`48-48`: **LGTM!** The change to the `refetchInterval` option is a good optimization. It prevents unnecessary polling when the `pollInterval` is explicitly set to 0 by setting `refetchInterval` to `false`. This enhances the control flow and optimizes performance by avoiding unnecessary network calls.
src/lib/queries/request-payments.ts (1)
`12-12`: **LGTM, but verify the impact of caching.** The addition of the `@cached` directive to the `RequestPaymentsQuery` query is a good strategic enhancement to optimize the performance of payment requests. Caching can reduce the number of times the query needs to be executed against the backend, leading to improved response times and reduced server load. To verify the impact of caching, consider the following: 1. Analyze the query execution logs or metrics to compare the number of times the query is executed with and without caching. Expect a reduction in the number of executions with caching enabled. 2. Measure the response times of the query with and without caching. Expect improved response times with caching, especially for repeated queries with the same parameters. 3. Monitor the server load and resource utilization before and after enabling caching. Expect a reduction in server load and resource consumption with caching, as it reduces the need for redundant query executions. 4. Validate that the cached results are consistent with the actual data. Ensure that the caching mechanism updates the cache when the underlying data changes to maintain data integrity. 5. Test the behavior of the application under different caching scenarios, such as cache hits, cache misses, and cache invalidation. Verify that the application handles these scenarios gracefully and provides a consistent user experience. By verifying the impact of caching through these steps, you can ensure that the addition of the `@cached` directive achieves the desired performance optimization without compromising data accuracy or application functionality.
--- 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 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](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.