feat: add ref--repo--owner_code surrogate key for pipeline responses depending on codebus resources

Author: stefan-guggisberg

src/json-pipe.js

@@ -62,9 +62,12 @@ async function fetchJsonContent(state, req, res) {
     res.headers.delete('content-type');
     res.headers.set('location', redirectLocation);
     const keys = [];
-    keys.push(await computeSurrogateKey(`${contentBusId}${info.path}`));
     if (state.content.sourceBus === 'content') {
+      keys.push(await computeSurrogateKey(`${contentBusId}${info.path}`));
       keys.push(contentBusId);
+    } else {
+      keys.push(`${ref}--${repo}--${owner}_code`);
+      keys.push(await computeSurrogateKey(`${ref}--${repo}--${owner}${info.path}`));
     }
     res.headers.set('x-surrogate-key', keys.join(' '));
     res.error = 'moved';

src/robots-pipe.js

@@ -120,7 +120,6 @@ async function computeSurrogateKeys(state) {
 
   const pathKey = `${state.ref}--${state.repo}--${state.owner}${state.info.path}`;
   keys.push(await computeSurrogateKey(`${state.site}--${state.org}_config.json`));
-  keys.push(pathKey.replace(/\//g, '_')); // TODO: remove
   keys.push(await computeSurrogateKey(pathKey));
   return keys;
 }

test/json-pipe.test.js

@@ -253,7 +253,29 @@ describe('JSON Pipe Test', () => {
     });
   });
 
-  it('ignores newer last modified from metadata.json even if newer', async () => {
+  it('respects redirects (code)', async () => {
+    const state = createDefaultState();
+    state.s3Loader
+      .reply(
+        'helix-code-bus',
+        'owner/repo/ref/en/index.json',
+        new PipelineResponse(TEST_SINGLE_SHEET, {
+          headers: {
+            'content-type': 'application/json',
+            'x-amz-meta-redirect-location': '/de/index.json',
+          },
+        }),
+      )
+      .reply('helix-content-bus', 'foobar/preview/en/index.json', null);
+    const resp = await jsonPipe(state, new PipelineRequest('https://json-filter.com/?limit=10&offset=5'));
+    assert.strictEqual(resp.status, 301);
+    assert.deepStrictEqual(Object.fromEntries(resp.headers.entries()), {
+      'location': '/de/index.json',
+      'x-surrogate-key': 'ref--repo--owner_code SIMSxecp2CJXqGYs',
+    });
+  });
+
+  it('ignores last modified from metadata.json even if newer', async () => {
     const state = createDefaultState();
     state.s3Loader.reply(
       'helix-content-bus',
@@ -267,18 +289,6 @@ describe('JSON Pipe Test', () => {
         },
       }),
     );
-    state.s3Loader.reply(
-      'helix-code-bus',
-      'foobar/preview/metadata.json',
-      new PipelineResponse(JSON.stringify({
-        data: [
-        ],
-      }), {
-        headers: {
-          'last-modified': 'Wed, 15 Oct 2009 17:50:00 GMT',
-        },
-      }),
-    );
     const resp = await jsonPipe(state, new PipelineRequest('https://json-filter.com/?limit=10&offset=5'));
     assert.strictEqual(resp.status, 200);
     assert.deepStrictEqual(await resp.json(), {

test/robots-pipe.test.js

@@ -69,7 +69,7 @@ describe('Robots Pipe Test', () => {
     assert.deepStrictEqual(Object.fromEntries(resp.headers.entries()), {
       'content-type': 'text/plain; charset=utf-8',
       vary: 'x-forwarded-host',
-      'x-surrogate-key': 'U_NW4adJU7Qazf-I ref--repo--owner_robots.txt ZcR1sjWODctSccZh',
+      'x-surrogate-key': 'U_NW4adJU7Qazf-I ZcR1sjWODctSccZh',
     });
     assert.strictEqual(resp.body, 'this is my robots.txt');
   });
@@ -149,7 +149,7 @@ describe('Robots Pipe Test', () => {
     assert.deepStrictEqual(Object.fromEntries(resp.headers.entries()), {
       'content-type': 'text/plain; charset=utf-8',
       vary: 'x-forwarded-host',
-      'x-surrogate-key': 'U_NW4adJU7Qazf-I ref--repo--owner_robots.txt ZcR1sjWODctSccZh',
+      'x-surrogate-key': 'U_NW4adJU7Qazf-I ZcR1sjWODctSccZh',
     });
     assert.strictEqual(resp.body, `User-Agent: *
 Allow: /
@@ -184,7 +184,7 @@ Sitemap: https://www.example.com/sitemap.xml`);
     assert.deepStrictEqual(Object.fromEntries(resp.headers.entries()), {
       'content-type': 'text/plain; charset=utf-8',
       vary: 'x-forwarded-host',
-      'x-surrogate-key': 'U_NW4adJU7Qazf-I ref--repo--owner_robots.txt ZcR1sjWODctSccZh',
+      'x-surrogate-key': 'U_NW4adJU7Qazf-I ZcR1sjWODctSccZh',
     });
     assert.strictEqual(resp.body, `User-Agent: *
 Allow: /