feat: enable CDN cache for all sales channels (#1562)

* feat: enable CDN cache for all sales channels

* feat: enable CDN cache for all sales channels

- Remove isDefautSalesChannel restriction from isCacheableSegment so
  non-default channels are cacheable (CDN varies by vtex_segment/VTEXSC)
- Always persist VTEXSC cookie for ?sc=X requests regardless of
  cacheability, ensuring sales channel continuity across navigation
- Remove unused PAGE_CACHE_ALLOWED_KEY import from vtex middleware

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* fix: guard non-default channels against caching when channelPrivacy is unknown

Non-default sales channels are only cacheable when channelPrivacy is explicitly
"public". If channelPrivacy is null/undefined (e.g. cold request), skip CDN
cache to avoid serving a private channel response on first hit.

* fix: skip Set-Cookie on cacheable responses to allow CDN caching

Cloudflare does not cache responses with Set-Cookie headers. Guard both
VTEXSC and vtex_segment cookies inside the !isCacheableSegment block so
cacheable responses stay cookie-free and the CDN can cache them.

Navigation continuity is preserved: the first cold request for a non-default
channel is always non-cacheable (channelPrivacy unknown), so cookies are
set there and carried by the browser on subsequent requests.

* feat: enable CDN cache for all sales channels via cookie vary

Remove channel restriction from isCacheableSegment — all non-private
channels are now cacheable. Always set vtex_segment and VTEXSC on every
response so the CDN (Cloudflare) can vary its cache key by them and serve
the correct bucket per sales channel.

Requires deco-cx/deco#XXXX (allowlist vtex_segment/VTEXSC in middleware).

* fix: remove UTM checks from isCacheableSegment

* fix: replace removed @deco/deco RequestInit import with local DecoRequestInit

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Author: igoramf

utils/http.ts

@@ -1,5 +1,4 @@
-import { type RequestInit } from "@deco/deco";
-import { fetchSafe } from "./fetch.ts";
+import { type DecoRequestInit, fetchSafe } from "./fetch.ts";
 
 // Check if DEBUG_HTTP env var is set
 const DEBUG_HTTP = Deno.env.get("DEBUG_HTTP") === "true";
@@ -25,7 +24,7 @@ export class HttpError extends Error {
   }
 }
 
-export interface TypedRequestInit<T> extends Omit<RequestInit, "body"> {
+export interface TypedRequestInit<T> extends Omit<DecoRequestInit, "body"> {
   body: T;
   excludeFromSearchParams?: string[];
   templateMarker?: string;
@@ -82,7 +81,7 @@ export type ClientOf<T> = {
       searchParams?: infer Params;
     } ? (
         params: URLPatternParams<`/${path}`> & Params,
-        init?: Omit<RequestInit, "body">,
+        init?: Omit<DecoRequestInit, "body">,
       ) => Promise<TypedResponse<ResBody>>
     : never
     : never;
@@ -241,7 +240,7 @@ export const createHttpClient = <T>(
       }
       return (
         params: Record<string, string | number | string[] | number[]>,
-        init?: RequestInit & {
+        init?: DecoRequestInit & {
           excludeFromSearchParams?: string[];
           templateMarker?: string;
         },

vtex/middleware.ts

@@ -1,5 +1,5 @@
 import { getCookies } from "std/http/cookie.ts";
-import { PAGE_CACHE_ALLOWED_KEY, PAGE_DIRTY_KEY } from "@deco/deco/blocks";
+import { PAGE_DIRTY_KEY } from "@deco/deco/blocks";
 import { AppMiddlewareContext } from "./mod.ts";
 import {
   getISCookiesFromBag,
@@ -45,10 +45,5 @@ export const middleware = (
     );
   }
 
-  // PAGE_CACHE_ALLOWED_KEY: opts in to CDN page caching (VTEX-only)
-  if (cacheable) {
-    ctx.bag.set(PAGE_CACHE_ALLOWED_KEY, true);
-  }
-
   return ctx.next!();
 };

vtex/utils/segment.ts

@@ -61,24 +61,13 @@ export const isAnonymous = (
     !regionId;
 };
 
-/**
- * Checks if the segment is cacheable for CDN purposes.
- * By default, uses isAnonymous (UTMs affect cacheability because prices
- * can vary by utm_source). With removeUTMFromCacheKey, UTMs are ignored
- * (opt-in for stores that don't vary prices by UTM).
- */
 export const isCacheableSegment = (ctx: AppContext) => {
   const payload = getSegmentFromBag(ctx)?.payload;
   if (payload?.channelPrivacy === "private") return false;
 
-  if (ctx.advancedConfigs?.removeUTMFromCacheKey) {
-    if (!payload) return true;
-    const { campaigns, channel, priceTables, regionId } = payload;
-    return !campaigns &&
-      (!channel || isDefautSalesChannel(ctx, channel)) &&
-      !priceTables && !regionId;
-  }
-  return isAnonymous(ctx);
+  if (!payload) return true;
+  const { campaigns, priceTables, regionId } = payload;
+  return !campaigns && !priceTables && !regionId;
 };
 
 const setSegmentInBag = (ctx: AppContext, data: WrappedSegment) =>
@@ -259,28 +248,27 @@ export const setSegmentBag = (
   const token = serialize(segment);
   setSegmentInBag(ctx, { payload: segment, token });
 
-  // Skip Set-Cookie when the segment only differs by UTMs.
-  // UTMs don't affect page content, so the response can still be cached.
-  // Only set cookies when content-affecting fields differ (campaigns,
-  // non-default sales channel, price tables, region).
-  if (!isCacheableSegment(ctx)) {
-    if (segmentFromRequest.channel) {
-      setCookie(ctx.response.headers, {
-        value: `sc=${segmentFromRequest.channel}`,
-        name: SALES_CHANNEL_COOKIE,
-        path: "/",
-        secure: true,
-      });
-    }
+  // Always persist sales channel when it comes from request params so the
+  // browser carries it across navigation. The CDN varies its cache key by
+  // VTEXSC, so setting this cookie does not prevent CDN caching.
+  if (segmentFromRequest.channel) {
+    setCookie(ctx.response.headers, {
+      value: `sc=${segmentFromRequest.channel}`,
+      name: SALES_CHANNEL_COOKIE,
+      path: "/",
+      secure: true,
+    });
+  }
 
-    if (vtex_segment !== token) {
-      setCookie(ctx.response.headers, {
-        value: token,
-        name: SEGMENT_COOKIE_NAME,
-        path: "/",
-        secure: true,
-        httpOnly: true,
-      });
-    }
+  // Always keep vtex_segment fresh so the CDN vary key stays accurate.
+  // The CDN varies by this cookie, so setting it does not prevent caching.
+  if (vtex_segment !== token) {
+    setCookie(ctx.response.headers, {
+      value: token,
+      name: SEGMENT_COOKIE_NAME,
+      path: "/",
+      secure: true,
+      httpOnly: true,
+    });
   }
 };