@dylandepass/helix-product-pipeline 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.2.0](https://github.com/adobe-rnd/helix-product-pipeline/compare/v2.1.0...v2.2.0) (2026-02-04)
+
+
+### Features
+
+* Remove media pipe and move to helix-product-pipeline-worker ([645d2f5](https://github.com/adobe-rnd/helix-product-pipeline/commit/645d2f5850f0b4f5abfe25e6330c68e31508d812))
+
 # [2.1.0](https://github.com/adobe-rnd/helix-product-pipeline/compare/v2.0.2...v2.1.0) (2026-02-03)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dylandepass/helix-product-pipeline",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Helix Product Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/index.js

@@ -15,4 +15,4 @@ export { productHTMLPipe } from './product-html-pipe.js';
 export { productIndexPipe } from './product-index-pipe.js';
 export { productMerchantFeedPipe } from './product-merchant-feed-pipe.js';
 export { productSitemapPipe } from './product-sitemap-pipe.js';
-export { productMediaPipe } from './product-media-pipe.js';
+export { applyByoCdnHeaders } from './utils/cache-headers.js';

package/src/steps/set-cache-headers.js

@@ -16,13 +16,10 @@ import {
   computeProductPathKey,
   computeSiteKey,
   compute404Key,
-  computeMediaKeys,
   computeAuthoredContentKey,
   computeProductKeys,
 } from '@dylandepass/helix-product-shared';
-
-export const isMediaRequest = (url) => /\/media_[0-9a-f]{40,}[/a-zA-Z0-9_-]*\.[0-9a-z]+$/.test(url.pathname);
-const BYO_CDN_TYPES = ['akamai', 'cloudflare', 'fastly', 'cloudfront'];
+import { applyByoCdnHeaders } from '../utils/cache-headers.js';
 
 /**
  * Sets the cache headers for a product
@@ -32,92 +29,29 @@ const BYO_CDN_TYPES = ['akamai', 'cloudflare', 'fastly', 'cloudfront'];
  * @returns {void}
  */
 export function setCachingHeaders(req, resp, cacheKeys) {
-  const url = new URL(req.url);
-
-  // determine BYO CDN type
-  let byo_cdn_type = req.headers.get('x-byo-cdn-type');
-  const via = req.headers.get('via') || '';
-  const cdn_loop = req.headers.get('cdn-loop') || '';
-  // FIXME: cloudflare seems to strip the CDN-Loop header, i.e. the worker can't see it...
-  if (!BYO_CDN_TYPES.includes(byo_cdn_type)) {
-    // sniff downstream cdn type
-    if (/[Aa]kamai/.test(via)) {
-      byo_cdn_type = 'akamai';
-    } else if (via.includes('varnish') || cdn_loop.startsWith('Fastly')) {
-      byo_cdn_type = 'fastly';
-    } else if (cdn_loop.includes('cloudflare') || req.headers.has('cf-worker')) {
-      byo_cdn_type = 'cloudflare';
-    } else if (via.includes('CloudFront')) {
-      byo_cdn_type = 'cloudfront';
-    } else {
-      // invalid/unsupported CDN type
-      byo_cdn_type = undefined;
-    }
-  }
-
   // cache instructions for BYO CDN and the browser
   const pushInvalidation = req.headers.get('x-push-invalidation') === 'enabled';
+
   // browser ttl & browser cache-control
   let browserTTL;
   if ([302, 400, 401].includes(resp.status)) {
     browserTTL = 0;
     resp.headers.set('cache-control', 'private; no-cache');
   } else {
-    if (isMediaRequest(url)) {
-      browserTTL = resp.status === 200 ? 2592000 : 3600;
-    } else {
-      browserTTL = 7200;
-    }
+    browserTTL = 7200;
     resp.headers.set('cache-control', `max-age=${browserTTL}, must-revalidate`);
   }
 
   // CDN ttl
   let cdnTTL;
   if ([400, 401].includes(resp.status)) {
-    // don't cache 400 & 401 repsonses in order to avoid potential downstream caching issues
+    // don't cache 400 & 401 responses in order to avoid potential downstream caching issues
     cdnTTL = 0;
-  } else if (isMediaRequest(url)) {
-    cdnTTL = resp.status === 200 ? 2592000 : 3600;
   } else {
     cdnTTL = pushInvalidation ? 172800 : 300;
   }
-  switch (byo_cdn_type) {
-    case 'cloudflare':
-      resp.headers.set('cdn-cache-control', `max-age=${cdnTTL}, must-revalidate`);
-      break;
-    case 'fastly':
-      resp.headers.set('surrogate-control', `max-age=${cdnTTL}, stale-while-revalidate=0`);
-      break;
-    case 'akamai':
-      resp.headers.set('edge-control', `!no-store,max-age=${cdnTTL}s,downstream-ttl=${browserTTL}s`);
-      break;
-    case 'cloudfront':
-      resp.headers.set('cache-control', `max-age=${browserTTL}, s-maxage=${cdnTTL}, must-revalidate`);
-      break;
-    default:
-      break;
-  }
 
-  // BYO CDN cache tags
-  // apply cache tags: transform Fastly Surrogate-Key to Cloudflare Cache-Tag
-  if (cacheKeys.length) {
-    switch (byo_cdn_type) {
-      case 'fastly':
-        resp.headers.set('surrogate-key', cacheKeys.join(' '));
-        break;
-      case 'akamai':
-        resp.headers.set('edge-cache-tag', cacheKeys.join(' '));
-        break;
-      case 'cloudflare':
-        resp.headers.set('cache-tag', `${cacheKeys.join(',')}`);
-        break;
-      case 'cloudfront':
-        // cloudfront doesn't support cache tags/keys ...
-        break;
-      default:
-        break;
-    }
-  }
+  applyByoCdnHeaders(resp, req, cacheKeys, browserTTL, cdnTTL);
 }
 
 /**
@@ -172,18 +106,3 @@ export async function setProductCacheHeaders(state, req, resp) {
   const productKeys = await computeProductKeys(org, site, info.path, contentBusId);
   setCachingHeaders(req, resp, productKeys);
 }
-
-/**
- * Sets the cache headers for a product
- * @param {PipelineState} state
- * @param {PipelineRequest} req
- * @param {PipelineResponse} resp
- * @returns {Promise<void>}
- */
-export async function setMediaCacheHeaders(state, req, resp) {
-  const { org, site } = state;
-  const url = new URL(req.url);
-  const keys = await computeMediaKeys(org, site, url.pathname);
-
-  setCachingHeaders(req, resp, keys);
-}

package/src/utils/cache-headers.js

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+const BYO_CDN_TYPES = ['akamai', 'cloudflare', 'fastly', 'cloudfront'];
+
+/**
+ * Detects the BYO CDN type from the request headers.
+ *
+ * @param {Request|object} req - The request object (must have headers)
+ * @returns {string|undefined} - The detected CDN type or undefined
+ */
+const detectByoCdnType = (req) => {
+  const { headers } = req;
+  let byoCdnType = headers.get('x-byo-cdn-type');
+  const via = headers.get('via') || '';
+  const cdnLoop = headers.get('cdn-loop') || '';
+
+  if (!BYO_CDN_TYPES.includes(byoCdnType)) {
+    if (/[Aa]kamai/.test(via)) {
+      byoCdnType = 'akamai';
+    } else if (via.includes('varnish') || cdnLoop.startsWith('Fastly')) {
+      byoCdnType = 'fastly';
+    } else if (cdnLoop.includes('cloudflare') || headers.has('cf-worker')) {
+      byoCdnType = 'cloudflare';
+    } else if (via.includes('CloudFront')) {
+      byoCdnType = 'cloudfront';
+    } else {
+      byoCdnType = undefined;
+    }
+  }
+
+  return BYO_CDN_TYPES.includes(byoCdnType) ? byoCdnType : undefined;
+};
+
+/**
+ * Applies BYO CDN specific cache headers to the response.
+ *
+ * @param {Response|object} resp - The response object
+ * @param {Request|object} req - The request object
+ * @param {string[]} cacheKeys - List of cache keys/tags
+ * @param {number} browserTTL - Browser TTL in seconds
+ * @param {number} cdnTTL - CDN TTL in seconds
+ */
+export const applyByoCdnHeaders = (resp, req, cacheKeys, browserTTL, cdnTTL) => {
+  const byoCdnType = detectByoCdnType(req);
+  const keys = cacheKeys && cacheKeys.length ? cacheKeys : [];
+
+  switch (byoCdnType) {
+    case 'cloudflare':
+      resp.headers.set('cdn-cache-control', `max-age=${cdnTTL}, must-revalidate`);
+      if (keys.length) resp.headers.set('cache-tag', keys.join(','));
+      break;
+    case 'fastly':
+      resp.headers.set('surrogate-control', `max-age=${cdnTTL}, stale-while-revalidate=0`);
+      if (keys.length) resp.headers.set('surrogate-key', keys.join(' '));
+      break;
+    case 'akamai':
+      resp.headers.set('edge-control', `!no-store,max-age=${cdnTTL}s,downstream-ttl=${browserTTL}s`);
+      if (keys.length) resp.headers.set('edge-cache-tag', keys.join(' '));
+      break;
+    case 'cloudfront':
+      resp.headers.set('cache-control', `max-age=${browserTTL}, s-maxage=${cdnTTL}, must-revalidate`);
+      break;
+    default:
+      break;
+  }
+};

package/src/product-media-pipe.js

@@ -1,64 +0,0 @@
-/*
- * Copyright 2025 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import { PipelineResponse, PipelineStatusError } from '@adobe/helix-html-pipeline';
-import { validatePathInfo } from './utils/path.js';
-import initConfig from './steps/init-config.js';
-import fetchMedia from './steps/fetch-media.js';
-import { setLastModified } from './utils/last-modified.js';
-import { setMediaCacheHeaders } from './steps/set-cache-headers.js';
-
-export async function productMediaPipe(state, req) {
-  state.type = 'media';
-
-  if (!validatePathInfo(state.info)) {
-    return new PipelineResponse('', {
-      status: 404,
-      headers: {
-        'x-error': 'invalid path',
-      },
-    });
-  }
-
-  const res = new PipelineResponse('');
-
-  try {
-    await initConfig(state, req, res);
-
-    state.timer?.update('content-fetch');
-    await fetchMedia(state, res);
-    if (res.status === 404) {
-      return new PipelineResponse('', {
-        status: 404,
-        headers: {
-          'x-error': 'not found',
-        },
-      });
-    } else if (res.error) {
-      if (res.status < 400) {
-        return res;
-      }
-      throw new PipelineStatusError(res.status, res.error);
-    }
-
-    setLastModified(state, res);
-
-    await setMediaCacheHeaders(state, req, res);
-
-    res.headers = state.content.headers;
-    res.body = state.content.data;
-  } catch (e) {
-    res.error = e.message;
-  }
-
-  return res;
-}

package/src/steps/fetch-media.js

@@ -1,41 +0,0 @@
-/*
- * Copyright 2022 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-import { extractLastModified, recordLastModified } from '../utils/last-modified.js';
-
-/**
- * Loads the content from either the content-bus or code-bus and stores it in `state.content`
- * @param {PipelineState} state
- * @param {PipelineResponse} res
- * @returns {Promise<void>}
- */
-export default async function fetchMedia(state, res) {
-  const {
-    info, org, site,
-  } = state;
-  const bucketId = 'helix-product-bus';
-
-  const key = `${org}/${site}/media/${info.originalFilename}`;
-  const ret = await state.s3Loader.getObject(bucketId, key);
-
-  if (ret.status === 200) {
-    res.status = 200;
-    delete res.error;
-    state.content.data = ret.body;
-    state.content.headers = ret.headers;
-
-    recordLastModified(state, res, 'content', extractLastModified(ret.headers));
-  } else {
-    // keep 404, but propagate others as 502
-    res.status = ret.status === 404 ? 404 : 502;
-    res.error = `failed to load ${info.resourcePath} from product-bus: ${ret.status}`;
-  }
-}