PromucFlow_constructor/app/client/src/serviceWorker.ts

118 lines
3.4 KiB
TypeScript
Raw Normal View History

2020-05-05 12:16:51 +00:00
import { precacheAndRoute } from "workbox-precaching";
import { clientsClaim, setCacheNameDetails, skipWaiting } from "workbox-core";
import { registerRoute, Route } from "workbox-routing";
2020-05-05 12:16:51 +00:00
import {
CacheFirst,
NetworkOnly,
StaleWhileRevalidate,
} from "workbox-strategies";
import {
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
cachedApiUrlRegex,
getApplicationParamsFromUrl,
getPrefetchRequests,
PrefetchApiService,
} from "ee/utils/serviceWorkerUtils";
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
import type { RouteHandlerCallback } from "workbox-core/types";
2020-05-05 12:16:51 +00:00
setCacheNameDetails({
prefix: "appsmith",
suffix: "",
2020-05-05 12:16:51 +00:00
precache: "precache-v1",
runtime: "runtime",
googleAnalytics: "appsmith-ga",
});
const regexMap = {
appViewPage: new RegExp(/api\/v1\/pages\/\w+\/view$/),
static3PAssets: new RegExp(
/(tiny.cloud|googleapis|gstatic|cloudfront).*.(js|css|woff2)/,
),
shims: new RegExp(/shims\/.*.js/),
profile: new RegExp(/v1\/(users\/profile|workspaces)/),
2020-05-05 12:16:51 +00:00
};
/* eslint-disable no-restricted-globals */
fix: don’t cache icons by the service worker (#23558) ## Description This PR prevents the service worker from caching the icons. For the background on why we moved from `.filter()` to `exclude: []`, see https://github.com/appsmithorg/appsmith/pull/21996#discussion_r1156075049 (that PR was reverted later). #### Type of change - Chore (housekeeping or task changes that don't impact user perception) ## Testing > #### How Has This Been Tested? - [ ] Manual: built the app, cleared service worker caches, reloaded, ensured the service worker doesn’t preload icons anymore #### Test Plan > Add Testsmith test cases links that relate to this PR > > #### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > ## Checklist: #### Dev activity - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Test-plan-implementation#speedbreaker-features-to-consider-for-every-change) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans/_edit#areas-of-interest) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed
2023-05-24 07:20:26 +00:00
// Note: if you need to filter out some files from precaching,
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
fix: don’t cache icons by the service worker (#23558) ## Description This PR prevents the service worker from caching the icons. For the background on why we moved from `.filter()` to `exclude: []`, see https://github.com/appsmithorg/appsmith/pull/21996#discussion_r1156075049 (that PR was reverted later). #### Type of change - Chore (housekeeping or task changes that don't impact user perception) ## Testing > #### How Has This Been Tested? - [ ] Manual: built the app, cleared service worker caches, reloaded, ensured the service worker doesn’t preload icons anymore #### Test Plan > Add Testsmith test cases links that relate to this PR > > #### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > ## Checklist: #### Dev activity - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Test-plan-implementation#speedbreaker-features-to-consider-for-every-change) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans/_edit#areas-of-interest) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed
2023-05-24 07:20:26 +00:00
// do that in craco.build.config.js → workbox webpack plugin options
// TODO: Fix this the next time the file is edited
// eslint-disable-next-line @typescript-eslint/no-explicit-any
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
const toPrecache = (self as any).__WB_MANIFEST;
precacheAndRoute(toPrecache);
chore: Remove some logs and errors from console - 1/n (#35674) ## Description This PR removes some of the errors and logs from the console. The following fixes were added to this PR - Remove the error => Refused to set unsafe header "Expect" - Remove the aria label warnings - Remove the logs from service worker in dev mode 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/10438062046> > Commit: 63fbfb22f40508ab298c765c4edbba7c42a125e1 > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=10438062046&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.All` > Spec: > <hr>Sun, 18 Aug 2024 06:12:03 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary by CodeRabbit - **Accessibility Improvements** - Added `aria-label` attributes to the `StyledSearchInput` and `Label` components for enhanced screen reader support. - Improved the semantic structure of the `Label` component by providing additional context for assistive technologies. - **Performance Enhancements** - Removed the `Expect` header from API requests to streamline the request process. - **Logging Adjustments** - Disabled development logs in the service worker to enhance performance in production environments. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-08-18 09:18:08 +00:00
self.__WB_DISABLE_DEV_LOGS = true;
2020-05-05 12:16:51 +00:00
skipWaiting();
clientsClaim();
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
const prefetchApiService = new PrefetchApiService();
/**
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
* Route handler callback for HTML pages.
* This callback is responsible for prefetching the API requests for the application page.
*/
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
const htmlRouteHandlerCallback: RouteHandlerCallback = async ({
event,
request,
url,
}) => {
// Extract application params from the URL
const applicationParams = getApplicationParamsFromUrl(url);
// If application params are present, prefetch the API requests for the application
if (applicationParams) {
const prefetchRequests = getPrefetchRequests(applicationParams);
prefetchRequests.forEach((prefetchRequest) => {
prefetchApiService.cacheApi(prefetchRequest).catch(() => {
// Silently fail
});
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
});
}
const networkHandler = new NetworkOnly();
return networkHandler.handle({ event, request });
};
2020-05-05 12:16:51 +00:00
// This route's caching seems too aggressive.
// TODO(abhinav): Figure out if this is really necessary.
// Maybe add the assets locally?
registerRoute(({ url }) => {
return (
regexMap.shims.test(url.pathname) || regexMap.static3PAssets.test(url.href)
);
}, new CacheFirst());
registerRoute(({ url }) => {
return regexMap.profile.test(url.pathname);
}, new NetworkOnly());
registerRoute(({ url }) => {
return regexMap.appViewPage.test(url.pathname);
}, new StaleWhileRevalidate());
registerRoute(
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
new Route(({ request, sameOrigin }) => {
return sameOrigin && request.destination === "document";
}, htmlRouteHandlerCallback),
);
// Route for fetching the API directly
registerRoute(
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
// Intercept requests to the consolidated API and module instances API
cachedApiUrlRegex,
async ({ event, request }) => {
// Check for cached response
chore: Prefetch module apis in service worker (#34003) ## Description This PR has the following changes - Modify the prefetch api cache strategy to handle multiple prefetch requests. - Convert the service worker files from js to ts - Code splitting of CE and EE for service worker utils to handle EE specific changes - Jest test cases for the updated logic 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="@tag.All" ### :mag: Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9511154598> > Commit: 785197e27873e71ed457f785a73d4ea57f379213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9511154598&attempt=1" target="_blank">Click here!</a> <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced API request handling with new utility functions and caching strategies for service worker operations. - Updated service worker configuration to TypeScript for improved type safety and maintainability. - Added type definitions for `node-fetch` to support new service worker functionalities. - **Refactor** - Consolidated `view` and `edit` endpoint URL construction in `ConsolidatedPageLoadApi` for better code maintainability. - **Chores** - Updated dependencies in `package.json` for better development experience and compatibility. - Added tests for new service worker utility functions to ensure reliability and correctness. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-14 11:00:23 +00:00
const cachedResponse = await prefetchApiService.getCachedResponse(request);
// If the response is cached, return the response
if (cachedResponse) {
return cachedResponse;
}
// If the response is not cached, fetch the response
const networkHandler = new NetworkOnly();
return networkHandler.handle({ event, request });
},
"GET",
);