fix: load stage prices based on header

Author: maxakuru

src/global.d.ts

@@ -52,6 +52,7 @@ declare global {
     info: PathInfo;
     content: PipelineContent;
     catalogPriceRules?: SharedTypes.CatalogPriceRules;
+    stagePricing?: boolean;
   }
 
   export interface PipelineContent extends ImportedPipelineContent {

src/product-html-pipe.js

@@ -104,7 +104,7 @@ export async function productHTMLPipe(state, req) {
 
     transformImages(state);
 
-    await fetchCatalogPriceRules(state);
+    await fetchCatalogPriceRules(state, req);
     applyProductPriceRule(state, res);
 
     state.timer?.update('render');

src/product-index-pipe.js

@@ -151,7 +151,7 @@ export async function productIndexPipe(state, req) {
 
     await setIndexCacheHeaders(state, req, res);
 
-    await fetchCatalogPriceRules(state);
+    await fetchCatalogPriceRules(state, req);
     applyCatalogPriceRules(state, res);
 
     setLastModified(state, res);

src/product-json-pipe.js

@@ -65,7 +65,7 @@ export async function productJSONPipe(state, req) {
 
     transformImages(state);
 
-    await fetchCatalogPriceRules(state);
+    await fetchCatalogPriceRules(state, req);
     applyProductPriceRule(state, res);
 
     // set surrogate keys

src/steps/fetch-price-rules.js

@@ -11,6 +11,7 @@
  */
 
 const PRICING_BUCKET_ID = 'helix-commerce-pricing';
+const PRICING_BUCKET_DEV_ID = 'helix-commerce-pricing-dev';
 
 /**
  * @param {string} org
@@ -28,16 +29,27 @@ function emptyRules() {
 
 /**
  * Fetch all catalog price rules. Sets state.catalogPriceRules.
+ * When the request carries `x-env: stage`, fetches from the dev pricing bucket and sets
+ * state.stagePricing = true so cache headers can be suppressed downstream.
  * Used for both single-product and index routes.
  * @param {PipelineState} state
+ * @param {PipelineRequest} [req]
  */
-export async function fetchCatalogPriceRules(state) {
+export async function fetchCatalogPriceRules(state, req) {
   const { org, site, s3Loader } = state;
+  const useStagePricing = req?.headers?.get('x-env') === 'stage';
+  const bucketId = useStagePricing
+    ? PRICING_BUCKET_DEV_ID
+    : PRICING_BUCKET_ID;
+  if (useStagePricing) {
+    state.log.info('fetching catalog price rules from dev bucket');
+    state.stagePricing = true;
+  }
 
   /** @type {PipelineResponse} */
   let res;
   try {
-    res = await s3Loader.getObject(PRICING_BUCKET_ID, catalogRulesKey(org, site));
+    res = await s3Loader.getObject(bucketId, catalogRulesKey(org, site));
     if (res.status !== 200) {
       state.catalogPriceRules = emptyRules();
       return;

src/steps/set-cache-headers.js

@@ -108,6 +108,7 @@ export async function setProductCacheHeaders(state, req, resp) {
 
   const productKeys = await computeProductKeys(org, site, info.path, contentBusId);
   setCachingHeaders(req, resp, productKeys);
+  if (state.stagePricing) resp.headers.set('cache-control', 'no-store');
 }
 
 /**
@@ -122,6 +123,7 @@ export async function setIndexCacheHeaders(state, req, resp) {
   const keys = await computeIndexKeys(org, site, info.path);
   keys.push(computePriceRulesKey(org, site));
   setCachingHeaders(req, resp, keys);
+  if (state.stagePricing) resp.headers.set('cache-control', 'no-store');
 }
 
 /**
@@ -136,4 +138,5 @@ export async function setSitemapCacheHeaders(state, req, resp) {
   const keys = await computeSitemapKeys(org, site, info.path);
   keys.push(computePriceRulesKey(org, site));
   setCachingHeaders(req, resp, keys);
+  if (state.stagePricing) resp.headers.set('cache-control', 'no-store');
 }

test/steps/price-rules.test.js

@@ -763,4 +763,57 @@ describe('fetchCatalogPriceRules', () => {
     await fetchCatalogPriceRules(state);
     assert.deepStrictEqual(state.catalogPriceRules, { promotions: [] });
   });
+
+  it('uses the prod bucket and does not set stagePricing when x-env header is absent', async () => {
+    let capturedBucket;
+    const state = makeState({
+      s3Loader: {
+        async getObject(bucket) {
+          capturedBucket = bucket;
+          return { status: 404, body: 'Not Found' };
+        },
+      },
+    });
+    await fetchCatalogPriceRules(state, { headers: { get: () => null } });
+    assert.strictEqual(capturedBucket, 'helix-commerce-pricing');
+    assert.ok(!state.stagePricing, 'stagePricing must not be set');
+  });
+
+  it('uses the dev bucket and sets stagePricing when x-env: stage', async () => {
+    let capturedBucket;
+    const state = makeState({
+      s3Loader: {
+        async getObject(bucket) {
+          capturedBucket = bucket;
+          return { status: 404, body: 'Not Found' };
+        },
+      },
+    });
+    const req = { headers: { get: (name) => (name === 'x-env' ? 'stage' : null) } };
+    await fetchCatalogPriceRules(state, req);
+    assert.strictEqual(capturedBucket, 'helix-commerce-pricing-dev');
+    assert.strictEqual(state.stagePricing, true);
+  });
+
+  it('reads rules from the dev bucket when x-env: stage', async () => {
+    const rules = {
+      promotions: [{ id: 'p', name: 'P', rules: [{ path: '/p/a', price: '9.99' }] }],
+    };
+    let capturedBucket;
+    const state = makeState({
+      s3Loader: {
+        async getObject(bucket, key) {
+          capturedBucket = bucket;
+          if (bucket === 'helix-commerce-pricing-dev' && key === 'org/site/prices/catalog/rules.json') {
+            return { status: 200, body: JSON.stringify(rules) };
+          }
+          return { status: 404, body: 'Not Found' };
+        },
+      },
+    });
+    const req = { headers: { get: (name) => (name === 'x-env' ? 'stage' : null) } };
+    await fetchCatalogPriceRules(state, req);
+    assert.strictEqual(capturedBucket, 'helix-commerce-pricing-dev');
+    assert.strictEqual(state.catalogPriceRules.promotions.length, 1);
+  });
 });

test/steps/set-cache-headers.test.js

@@ -611,6 +611,22 @@ describe('setProductCacheHeaders', () => {
     assert.strictEqual(resp.headers.get('surrogate-control'), 'max-age=300, stale-while-revalidate=0');
     assert.strictEqual(resp.headers.get('surrogate-key'), 'G56lYRBKFiJX2i-A main--test-site--test-org Id9xWdjCxe493biK content-bus-id_metadata main--test-site--test-org_head content-bus-id');
   });
+
+  it('overrides cache-control to no-store when state.stagePricing is true', async () => {
+    const state = {
+      stagePricing: true,
+      content: { data: { sku: 'sku', urlKey: 'url-key' } },
+      config: { route: { params: {} } },
+      contentBusId: 'cbus',
+      info: { path: '/test', originalPath: '/test' },
+      org: 'test-org',
+      site: 'test-site',
+    };
+    const req = createRequest('https://example.com/test', { 'x-byo-cdn-type': 'cloudflare' });
+    const resp = createResponse();
+    await setProductCacheHeaders(state, req, resp);
+    assert.strictEqual(resp.headers.get('cache-control'), 'no-store');
+  });
 });
 
 describe('setIndexCacheHeaders', () => {
@@ -712,6 +728,19 @@ describe('setIndexCacheHeaders', () => {
     assert.notStrictEqual(tags1[0], tags2[0]);
     assert.strictEqual(tags1[1], tags2[1]); // same site key
   });
+
+  it('overrides cache-control to no-store when state.stagePricing is true', async () => {
+    const state = {
+      stagePricing: true,
+      org: 'test-org',
+      site: 'test-site',
+      info: { path: '/products/index.json' },
+    };
+    const req = createRequest('https://example.com/products/index.json', { 'x-byo-cdn-type': 'cloudflare' });
+    const resp = createResponse();
+    await setIndexCacheHeaders(state, req, resp);
+    assert.strictEqual(resp.headers.get('cache-control'), 'no-store');
+  });
 });
 
 describe('setSitemapCacheHeaders', () => {
@@ -793,4 +822,17 @@ describe('setSitemapCacheHeaders', () => {
     assert.notStrictEqual(indexTags[0], sitemapTags[0]);
     assert.strictEqual(indexTags[1], sitemapTags[1]); // same site key
   });
+
+  it('overrides cache-control to no-store when state.stagePricing is true', async () => {
+    const state = {
+      stagePricing: true,
+      org: 'test-org',
+      site: 'test-site',
+      info: { path: '/products/sitemap.xml' },
+    };
+    const req = createRequest('https://example.com/products/sitemap.xml', { 'x-byo-cdn-type': 'cloudflare' });
+    const resp = createResponse();
+    await setSitemapCacheHeaders(state, req, resp);
+    assert.strictEqual(resp.headers.get('cache-control'), 'no-store');
+  });
 });