2020-05-05 12:16:51 +00:00
|
|
|
import { precacheAndRoute } from "workbox-precaching";
|
|
|
|
|
import { clientsClaim, setCacheNameDetails, skipWaiting } from "workbox-core";
|
2022-11-18 09:33:23 +00:00
|
|
|
import { registerRoute, Route } from "workbox-routing";
|
2020-05-05 12:16:51 +00:00
|
|
|
import {
|
|
|
|
|
CacheFirst,
|
|
|
|
|
NetworkOnly,
|
|
|
|
|
StaleWhileRevalidate,
|
|
|
|
|
} from "workbox-strategies";
|
2024-05-16 12:33:28 +00:00
|
|
|
import {
|
2024-06-14 11:00:23 +00:00
|
|
|
cachedApiUrlRegex,
|
|
|
|
|
getApplicationParamsFromUrl,
|
|
|
|
|
getPrefetchRequests,
|
|
|
|
|
PrefetchApiService,
|
2024-08-06 14:52:22 +00:00
|
|
|
} from "ee/utils/serviceWorkerUtils";
|
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",
|
2024-05-16 12:33:28 +00:00
|
|
|
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/),
|
2022-06-15 15:37:41 +00:00
|
|
|
profile: new RegExp(/v1\/(users\/profile|workspaces)/),
|
2020-05-05 12:16:51 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/* eslint-disable no-restricted-globals */
|
2023-05-24 07:20:26 +00:00
|
|
|
// Note: if you need to filter out some files from precaching,
|
2024-06-14 11:00:23 +00:00
|
|
|
|
2023-05-24 07:20:26 +00:00
|
|
|
// do that in craco.build.config.js → workbox webpack plugin options
|
2024-07-31 15:41:28 +00:00
|
|
|
// TODO: Fix this the next time the file is edited
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2024-06-14 11:00:23 +00:00
|
|
|
const toPrecache = (self as any).__WB_MANIFEST;
|
2022-09-05 03:24:44 +00:00
|
|
|
precacheAndRoute(toPrecache);
|
|
|
|
|
|
2024-08-18 09:18:08 +00:00
|
|
|
self.__WB_DISABLE_DEV_LOGS = true;
|
2020-05-05 12:16:51 +00:00
|
|
|
skipWaiting();
|
|
|
|
|
clientsClaim();
|
|
|
|
|
|
2024-06-14 11:00:23 +00:00
|
|
|
const prefetchApiService = new PrefetchApiService();
|
2024-05-16 12:33:28 +00:00
|
|
|
|
|
|
|
|
/**
|
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.
|
2024-05-16 12:33:28 +00:00
|
|
|
*/
|
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(() => {
|
2024-05-16 12:33:28 +00:00
|
|
|
// Silently fail
|
|
|
|
|
});
|
2024-06-14 11:00:23 +00:00
|
|
|
});
|
2024-05-16 12:33:28 +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());
|
|
|
|
|
|
2022-11-18 09:33:23 +00:00
|
|
|
registerRoute(
|
2024-06-14 11:00:23 +00:00
|
|
|
new Route(({ request, sameOrigin }) => {
|
|
|
|
|
return sameOrigin && request.destination === "document";
|
|
|
|
|
}, htmlRouteHandlerCallback),
|
2024-05-16 12:33:28 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
|
|
// Route for fetching the API directly
|
|
|
|
|
registerRoute(
|
2024-06-14 11:00:23 +00:00
|
|
|
// Intercept requests to the consolidated API and module instances API
|
|
|
|
|
cachedApiUrlRegex,
|
2024-05-16 12:33:28 +00:00
|
|
|
async ({ event, request }) => {
|
|
|
|
|
// Check for cached response
|
2024-06-14 11:00:23 +00:00
|
|
|
const cachedResponse = await prefetchApiService.getCachedResponse(request);
|
2024-05-16 12:33:28 +00:00
|
|
|
|
|
|
|
|
// 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",
|
2022-11-18 09:33:23 +00:00
|
|
|
);
|