Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

feat: TRPC caching support (#3016)

Ivan Starkov9c672cecc977
diff --git a/apps/builder/app/routes/trpc.$.ts b/apps/builder/app/routes/trpc.$.ts
index 0b7375d0f4..ef10d82bc2 100644
--- a/apps/builder/app/routes/trpc.$.ts
+++ b/apps/builder/app/routes/trpc.$.ts
@@ -19,10 +19,45 @@ export const action = async ({ request }: ActionArgs) => {
endpoint: "/trpc",
batching: { enabled: true },
responseMeta(opts) {
- const { paths, errors, type } = opts;
- // @todo: Add caching headers if cacheMiddleware is not used
- console.info("responseMeta", { paths, errors, type });
- return {};
+ // tRPC batches multiple requests into a single network call.
+ // The `paths` array lists all request paths included in the batch.
+ const { paths, errors, type, ctx } = opts;
+
+ if (paths === undefined) {
+ return {};
+ }
+
+ if (type !== "query") {
+ // Only queries can be cached
+ return {};
+ }
+
+ if (errors.length > 0) {
+ // Errors should not be cached
+ return {};
+ }
+
+ // To enable efficient batching of tRPC requests,
+ // adopt the least max age among all paths for caching, or disable caching entirely if no max-age is set.
+ let minMaxAge = Number.MAX_SAFE_INTEGER;
+ for (const path of paths) {
+ const maxAge = ctx?.trpcCache.getMaxAge(path);
+
+ if (maxAge === undefined) {
+ return {};
+ }
+
+ minMaxAge = Math.min(minMaxAge, maxAge);
+ }
+
+ // Cap the max age at 1 hour
+ minMaxAge = Math.min(minMaxAge, 60 * 60);
+
+ return {
+ headers: {
+ "Cache-Control": `public, max-age=${minMaxAge}, s-maxage=${minMaxAge}`,
+ },
+ };
},
async createContext(opts) {
return await createContext(opts.req);
diff --git a/apps/builder/app/shared/context.server.ts b/apps/builder/app/shared/context.server.ts
index 0624325042..e66fe6cc60 100644
--- a/apps/builder/app/shared/context.server.ts
+++ b/apps/builder/app/shared/context.server.ts
@@ -84,6 +84,23 @@ const createUserPlanContext = async (
return planFeatures;
};
+const createTrpcCache = () => {
+ const proceduresMaxAge = new Map<string, number>();
+ const setMaxAge = (path: string, value: number) => {
+ proceduresMaxAge.set(
+ path,
+ Math.min(proceduresMaxAge.get(path) ?? Number.MAX_SAFE_INTEGER, value)
+ );
+ };
+
+ const getMaxAge = (path: string) => proceduresMaxAge.get(path);
+
+ return {
+ setMaxAge,
+ getMaxAge,
+ };
+};
+
/**
* argument buildEnv==="prod" only if we are loading project with production build
*/
@@ -93,11 +110,14 @@ export const createContext = async (request: Request): Promise<AppContext> => {
const deployment = createDeploymentContext(request);
const entri = createEntriContext();
const userPlanFeatures = await createUserPlanContext(request, authorization);
+ const trpcCache = createTrpcCache();
+
return {
authorization,
domain,
deployment,
entri,
userPlanFeatures,
+ trpcCache,
};
};
diff --git a/apps/builder/app/shared/marketplace/router.server.ts b/apps/builder/app/shared/marketplace/router.server.ts
index 1d0ff92f96..d7813e91c4 100644
--- a/apps/builder/app/shared/marketplace/router.server.ts
+++ b/apps/builder/app/shared/marketplace/router.server.ts
@@ -1,12 +1,19 @@
import { z } from "zod";
-import { procedure, router } from "@webstudio-is/trpc-interface/index.server";
+import {
+ procedure,
+ router,
+ createCacheMiddleware,
+} from "@webstudio-is/trpc-interface/index.server";
import { getItems, getBuildProdData } from "./db.server";
+const cacheMiddleware = createCacheMiddleware(60 * 3); // 60 * 3 = 3 minutes cache
+const cachedProcedure = procedure.use(cacheMiddleware);
+
export const marketplaceRouter = router({
- getItems: procedure.query(async () => {
+ getItems: cachedProcedure.query(async () => {
return await getItems();
}),
- getBuildData: procedure
+ getBuildData: cachedProcedure
.input(
z.object({
projectId: z.string(),
diff --git a/packages/trpc-interface/src/context/context.server.ts b/packages/trpc-interface/src/context/context.server.ts
index eeef81cb3a..09655f2ac9 100644
--- a/packages/trpc-interface/src/context/context.server.ts
+++ b/packages/trpc-interface/src/context/context.server.ts
@@ -69,6 +69,11 @@ type UserPlanFeatures = {
boolean | number
>;
+type TrpcCache = {
+ setMaxAge: (path: string, value: number) => void;
+ getMaxAge: (path: string) => number | undefined;
+};
+
/**
* AppContext is a global context that is passed to all trpc/api queries/mutations
* "authorization" is made inside the namespace because eventually there will be
@@ -80,4 +85,5 @@ export type AppContext = {
deployment: DeploymentContext;
entri: EntriContext;
userPlanFeatures: UserPlanFeatures | undefined;
+ trpcCache: TrpcCache;
};
diff --git a/packages/trpc-interface/src/context/router.server.ts b/packages/trpc-interface/src/context/router.server.ts
index e4f91ca51b..8e0c21eaed 100644
--- a/packages/trpc-interface/src/context/router.server.ts
+++ b/packages/trpc-interface/src/context/router.server.ts
@@ -4,3 +4,12 @@ import type { AppContext } from "./context.server";
export const { router, procedure, middleware, mergeRouters } = initTRPC
.context<AppContext>()
.create();
+
+export const createCacheMiddleware = (seconds: number) =>
+ middleware(async ({ meta, path, type, ctx, next }) => {
+ // tRPC batches multiple requests into a single network call.
+ // The `path` is used as key to find the least max age among all paths for caching
+ ctx.trpcCache.setMaxAge(path, seconds);
+
+ return next({ ctx });
+ });
diff --git a/packages/trpc-interface/src/index.server.ts b/packages/trpc-interface/src/index.server.ts
index 61091dae2c..e14cad054f 100644
--- a/packages/trpc-interface/src/index.server.ts
+++ b/packages/trpc-interface/src/index.server.ts
@@ -12,4 +12,5 @@ export {
procedure,
middleware,
mergeRouters,
+ createCacheMiddleware,
} from "./context/router.server";