## Description Prefetch the consolidated API using the service worker. This api is prefetched for the view and edit urls. Fixes [Issue URL](https://github.com/appsmithorg/appsmith/issues/33497) > [!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/9108829019> > Commit: 30e2db9961d444b984560bb034ef87b443318213 > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9108829019&attempt=2" 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
111 lines
3.0 KiB
JavaScript
111 lines
3.0 KiB
JavaScript
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 {
|
|
getPrefetchConsolidatedApiRequest,
|
|
ConsolidatedApiCacheStrategy,
|
|
} from "utils/serviceWorkerUtils";
|
|
|
|
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.__WB_MANIFEST;
|
|
precacheAndRoute(toPrecache);
|
|
|
|
self.__WB_DISABLE_DEV_DEBUG_LOGS = false;
|
|
skipWaiting();
|
|
clientsClaim();
|
|
|
|
const consolidatedApiCacheStrategy = new ConsolidatedApiCacheStrategy();
|
|
|
|
/**
|
|
*
|
|
* @param {ExtendableEvent} event
|
|
* @param {Request} request
|
|
* @param {URL} url
|
|
* @returns
|
|
*/
|
|
const handleFetchHtml = async (event, request, url) => {
|
|
// Get the prefetch consolidated api request if the url matches the builder or viewer path
|
|
const prefetchConsolidatedApiRequest = getPrefetchConsolidatedApiRequest(url);
|
|
|
|
if (prefetchConsolidatedApiRequest) {
|
|
consolidatedApiCacheStrategy
|
|
.cacheConsolidatedApi(prefetchConsolidatedApiRequest)
|
|
.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";
|
|
},
|
|
async ({ event, request, url }) => handleFetchHtml(event, request, url),
|
|
),
|
|
);
|
|
|
|
// Route for fetching the API directly
|
|
registerRoute(
|
|
new RegExp("/api/v1/consolidated-api/"),
|
|
async ({ event, request }) => {
|
|
// Check for cached response
|
|
const cachedResponse =
|
|
await consolidatedApiCacheStrategy.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",
|
|
);
|