feat(cdn): use single fingerprint for all files in a package (#150)

* feat(cdn): use single fingerprint for all files in a package

* refactor(cdn): for single fingerprint combine all individual fingerprint ids

* test(cdn): verify that the expected files are uploaded to s3

* style(cdn): fix lint issues

Author: sgore-godaddy

lib/plugins/cdn.js

@@ -1,7 +1,7 @@
 const fp = require('fastify-plugin');
-const finger = require('fingerprinting');
 const mime = require('mime-types');
 const tar = require('tar');
+const finger = require('fingerprinting');
 
 /**
  * @typedef {import('aws-sdk').S3.PutObjectOutput} AWSPutObjectResponse
@@ -63,9 +63,10 @@ module.exports = fp(
        * Unpack tarball and process files and metadata
        *
        * @param {ReadableStream} stream Tarball readable stream
+       * @param {boolean} useSingleFingerprint Use single fingerprint id for all files
        * @returns {Promise<WrhsAssets>} Warehouse assets
        */
-      async function tarballToAssets(stream) {
+      async function tarballToAssets(stream, useSingleFingerprint) {
         const files = [];
         let metadata = {};
 
@@ -102,6 +103,20 @@ module.exports = fp(
             .on('finish', resolve);
         });
 
+        if (useSingleFingerprint) {
+          // make a new ids content combining all the individual ids
+          const singleIdContent = files.reduce(
+            (acc, { id }) => `${acc}${id}`,
+            ''
+          );
+          const { id: singleId } = finger('singleFingerPrint.txt', {
+            content: Buffer.from(singleIdContent)
+          });
+          files.forEach((file) => {
+            file.id = singleId;
+          });
+        }
+
         return { metadata, files };
       }
     );

lib/routes/cdn.js

@@ -32,7 +32,8 @@ module.exports =
           type: 'object',
           properties: {
             expiration: { type: ['string', 'number'] },
-            cdn_base_url: { type: 'string' }
+            cdn_base_url: { type: 'string' },
+            use_single_fingerprint: { type: 'boolean' }
           }
         },
         response: {
@@ -76,7 +77,7 @@ module.exports =
          */
         async (req, res) => {
           const {
-            query: { expiration, cdn_base_url: cdnBaseUrl }
+            query: { expiration, cdn_base_url: cdnBaseUrl, use_single_fingerprint: useSingleFingerprint }
           } = req;
           const nowMs = Date.now();
           let expTimestamp = null;
@@ -98,7 +99,7 @@ module.exports =
             );
           }
 
-          const wrhsAssets = await fastify.tarballToAssets(req.raw);
+          const wrhsAssets = await fastify.tarballToAssets(req.raw, useSingleFingerprint);
           const { files, metadata: metas } = wrhsAssets;
           await fastify.uploadAssetFilesToStorage(files, expTimestamp);
 

package-lock.json

@@ -33,8 +33,8 @@
     "eslint": "^8.57.0",
     "eslint-config-godaddy": "^7.1.0",
     "fastify": "^3.29.5",
-    "fastify-plugin": "^4.5.1",
     "fastify-cli": "^2.3.0",
+    "fastify-plugin": "^4.5.1",
     "nock": "^13.5.4",
     "nodemon": "^2.0.22",
     "pino-pretty": "^10.0.0",

package.json

@@ -8,11 +8,9 @@ const { build } = require('../helper');
 test('CDN API', async (t) => {
   const fastify = build(t);
 
-  t.plan(1);
+  t.plan(2);
 
   t.test('upload assets', async (t) => {
-    t.plan(3);
-
     const tarball = await fs.readFile(
       path.join(__dirname, '..', 'fixtures', 'files', 'my-tarball.tgz')
     );
@@ -58,9 +56,87 @@ test('CDN API', async (t) => {
       .listObjectsV2({ Bucket: 'warehouse-cdn' })
       .promise();
     const filenames = files.map(({ Key }) => Key);
-    t.same(filenames, [
-      '574d0c0f86b220913f60ee7aae20ec6a/main.css',
-      '71fbac4eca64da6727d4a9c9cd00e353/main.js'
-    ]);
+
+    const expectedFiles = [
+      '71fbac4eca64da6727d4a9c9cd00e353/main.js',
+      '574d0c0f86b220913f60ee7aae20ec6a/main.css'
+    ];
+
+    expectedFiles.forEach(file => {
+      t.ok(filenames.includes(file), `${file} should be uploaded to the bucket`);
+    });
+
+    t.end();
+  });
+
+  t.test('upload assets with single fingerprint', async (t) => {
+    const tarball = await fs.readFile(
+      path.join(__dirname, '..', 'fixtures', 'files', 'my-tarball.tgz')
+    );
+
+    const res = await fastify.inject({
+      method: 'POST',
+      url: '/cdn',
+      payload: tarball,
+      query: {
+        use_single_fingerprint: true
+      }
+    });
+
+    t.equal(res.statusCode, 201);
+
+    const payload = JSON.parse(res.payload);
+    const payloadFiles = payload.files.map(file => file.url);
+
+    // file url is in format https://cdn-example.com/fingerPrintId0/main.js,
+    // capture the fingerPrintId0 by taking second last element of the url from the first file
+    const fingerPrintId0 = payloadFiles[0].split('/').splice(-2, 1)[0];
+
+    const regex = new RegExp(`https://cdn-example\\.com/${fingerPrintId0}/main\\.(js|css)$`);
+    t.ok(payloadFiles.every(file => regex.test(file)), 'All file URLs should match the expected pattern keeping the same fingerprint id');
+
+    t.same(payload, {
+      fingerprints: [
+        '318a308660ba069e74d756cdc854ca52.gz',
+        '318a308660ba069e74d756cdc854ca52.gz'
+      ],
+      recommended: [
+        '318a308660ba069e74d756cdc854ca52/main.js',
+        '318a308660ba069e74d756cdc854ca52/main.css'
+      ],
+      files: [
+        {
+          url: 'https://cdn-example.com/318a308660ba069e74d756cdc854ca52/main.js',
+          metadata: {
+            css: false,
+            js: true,
+            foo: 'bar'
+          }
+        },
+        {
+          url: 'https://cdn-example.com/318a308660ba069e74d756cdc854ca52/main.css',
+          metadata: {
+            css: true,
+            js: false,
+            beep: 'boop'
+          }
+        }
+      ]
+    });
+
+    const { Contents: files } = await fastify.s3
+      .listObjectsV2({ Bucket: 'warehouse-cdn' })
+      .promise();
+    const filenames = files.map(({ Key }) => Key);
+    const expectedFiles = [
+      '318a308660ba069e74d756cdc854ca52/main.js',
+      '318a308660ba069e74d756cdc854ca52/main.css'
+    ];
+
+    expectedFiles.forEach(file => {
+      t.ok(filenames.includes(file), `${file} should be uploaded to the bucket`);
+    });
+
+    t.end();
   });
 });