PromucFlow_constructor/app/client/src/serviceWorker.ts
Diljit 4cb6ff03f9
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"

### 🔍 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 16:30:23 +05:30

116 lines
3.3 KiB
TypeScript

import { precacheAndRoute } from "workbox-precaching";
import { clientsClaim, setCacheNameDetails, skipWaiting } from "workbox-core";
import { registerRoute, Route } from "workbox-routing";
import {
CacheFirst,
NetworkOnly,
StaleWhileRevalidate,
} from "workbox-strategies";
import {
cachedApiUrlRegex,
getApplicationParamsFromUrl,
getPrefetchRequests,
PrefetchApiService,
} from "@appsmith/utils/serviceWorkerUtils";
import type { RouteHandlerCallback } from "workbox-core/types";
setCacheNameDetails({
prefix: "appsmith",
suffix: "",
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)/),
};
/* eslint-disable no-restricted-globals */
// Note: if you need to filter out some files from precaching,
// do that in craco.build.config.js → workbox webpack plugin options
const toPrecache = (self as any).__WB_MANIFEST;
precacheAndRoute(toPrecache);
self.__WB_DISABLE_DEV_LOGS = false;
skipWaiting();
clientsClaim();
const prefetchApiService = new PrefetchApiService();
/**
* Route handler callback for HTML pages.
* This callback is responsible for prefetching the API requests for the application page.
*/
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
});
});
}
const networkHandler = new NetworkOnly();
return networkHandler.handle({ event, request });
};
// 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(
new Route(({ request, sameOrigin }) => {
return sameOrigin && request.destination === "document";
}, htmlRouteHandlerCallback),
);
// Route for fetching the API directly
registerRoute(
// Intercept requests to the consolidated API and module instances API
cachedApiUrlRegex,
async ({ event, request }) => {
// Check for cached response
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",
);