appsmithorg
chore: Prefetch consolidated api using service worker
Description
[!TIP]
Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.
Fixes #Issue Number
or
Fixes Issue URL
[!WARNING]
If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.
Automation
/ok-to-test tags=""
:mag: Cypress test results
[!CAUTION]
If you modify the content in this section, you are likely to disrupt the CI result for your PR.
Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9012824234.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33306.
recreate: .
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9027698556.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33306.
recreate: .
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9030519052.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33306.
recreate: .
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9053293027.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33306.
recreate: .
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9056956178.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33306.
recreate: .
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9058341066.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33306.
recreate: .
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9060856157.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33306.
recreate: .
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9066006434.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33306.
recreate: .
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9066733558.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33306.
recreate: .
Walkthrough
Walkthrough
The recent updates enhance the service worker utilities and caching strategies in the Appsmith web application. New utility functions were added for handling search queries, path matching, and API request construction. A ConsolidatedApiCacheStrategy class was introduced to manage caching for API requests. Additionally, service worker logic was updated to incorporate these new utilities and caching strategies, improving the efficiency and functionality of the service worker.
Changes
| File Path | Change Summary |
|---|---|
app/client/src/utils/serviceWorkerUtils.js |
Introduced new utility functions for search queries, path matching, API parameters, and prefetch requests. Added ConsolidatedApiCacheStrategy class for enhanced caching. |
app/client/src/serviceWorker.js |
Added imports for new utilities and caching strategies. Updated cache name details and route handling logic. Introduced handleFetchHtml function and new API fetch route. |
app/client/src/utils/serviceWorkerUtils.test.js |
Added test cases for the new utility functions and caching strategy methods. |
Recent Review Details
Configuration used: CodeRabbit UI Review profile: CHILL
Commits
Files that changed from the base of the PR and between 17b6d45eba80ed6f75cbdf129c36caf23c22a9ad and 30e2db9961d444b984560bb034ef87b443318213.Files selected for processing (1)
- app/client/src/serviceWorker.js (3 hunks)
Files skipped from review as they are similar to previous changes (1)
- app/client/src/serviceWorker.js
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?
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
@coderabbitaiin 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
@coderabbitaiin 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.
-
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 pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger a review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai helpto 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.yamlfile 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.
![coderabbitai[bot] avatar](https://avatars.githubusercontent.com/in/347564?v=4 "Published by a pub.dev verified publisher"){kind=small}
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9078735379.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33306.
recreate: .