Add includeOriginPrefix option

This adds origin paths to the invalidation paths which is helpful when paths are rewritten with lambdas.

Author: badsyntax

.github/workflows/deploy.yml

@@ -33,15 +33,15 @@ jobs:
         id: update-stack
         with:
           githubToken: ${{ secrets.GITHUB_TOKEN }}
-          stackName: 'static-example-richardwillis-cloudformation-stack'
-          template: './cloudformation/cloudformation-s3bucket-example.yml'
+          stackName: 'badsyntax-github-action-example-aws-cloudfront'
+          template: './cloudformation/s3-cloudfront.yml'
           applyChangeSet: ${{ github.event_name != 'repository_dispatch' }}
           awsRegion: 'us-east-1'
           parameters: |
-            S3BucketName=static-example-richardwillis-info-us-east-1&
-            S3AllowedOrigins=https://static-example.richardwillis.info,https://*.preview.static-example.richardwillis.info&
-            CloudFrontRootHosts=static-example.richardwillis.info&
-            CertificateARN=arn:aws:acm:us-east-1:008215002370:certificate/39df7626-7d2f-42e9-94f4-a3ce61ca3d5e
+            S3BucketName=badsyntax-github-action-example-aws-cloudfront-us-east-1&
+            S3AllowedOrigins=https://cloudfront-action.richardwillis.info&
+            CloudFrontRootHosts=cloudfront-action.richardwillis.info&
+            CertificateARN=arn:aws:acm:us-east-1:008215002370:certificate/cfb34309-b9bb-4f63-9af3-51026b8107d6
 
       - uses: badsyntax/github-action-aws-s3@9537cd6d2013140b1d4e11ff526c5d75084c01df
         name: Sync mutable HTML files to S3
@@ -76,4 +76,5 @@ jobs:
           awsRegion: 'us-east-1'
           originPrefix: 'root'
           invalidatePaths: ${{ steps.sync-html-s3.outputs.S3SyncedFiles }}
-          defaultRootObject: 'index.html'
+          defaultRootObject: 'index'
+          includeOriginPrefix: true

action.yml

@@ -22,6 +22,9 @@ inputs:
   awsRegion:
     require: true
     description: 'The AWS region. For example: us-east-1'
+  includeOriginPrefix:
+    require: true
+    description: "Whether to include origin prefix paths. Useful when paths ere rewritten by Lambda's"
 runs:
   using: 'node16'
   main: 'dist/index.js'

cloudformation/cloudformation-s3bucket-example.yml renamed to cloudformation/s3-cloudfront.yml

@@ -8,7 +8,8 @@ describe('getSanitisedInvalidationPaths', () => {
     const objectKeyWithoutExtension = getSanitisedInvalidationPaths(
       ['index.html', 'blog.html', 'css/styles.css'],
       '',
-      defaultRootObject
+      defaultRootObject,
+      false
     );
     expect(objectKeyWithoutExtension).toEqual([
       '/index.html',
@@ -22,7 +23,8 @@ describe('getSanitisedInvalidationPaths', () => {
     const objectKeyWithoutExtension = getSanitisedInvalidationPaths(
       ['root/index', '/root/css/styles.css', '/'],
       'root',
-      defaultRootObject
+      defaultRootObject,
+      false
     );
     expect(objectKeyWithoutExtension).toEqual([
       '/index',
@@ -35,8 +37,25 @@ describe('getSanitisedInvalidationPaths', () => {
     const objectKeyWithoutExtension = getSanitisedInvalidationPaths(
       [],
       'root',
-      defaultRootObject
+      defaultRootObject,
+      false
     );
     expect(objectKeyWithoutExtension).toEqual([]);
   });
+
+  it('should generate correct sanitised paths including origin prefix', () => {
+    const objectKeyWithoutExtension = getSanitisedInvalidationPaths(
+      ['root/index', '/root/css/styles.css', '/'],
+      'root',
+      defaultRootObject,
+      true
+    );
+    expect(objectKeyWithoutExtension).toEqual([
+      '/index',
+      '/',
+      '/root/index',
+      '/css/styles.css',
+      '/root/css/styles.css',
+    ]);
+  });
 });

dist/index.js

@@ -36,7 +36,8 @@ async function waitForInvalidationToComplete(
 export function getSanitisedInvalidationPaths(
   invalidatePaths: string[], // eg ['/root/index', 'root/css/styles.css']
   originPrefix: string, // eg root
-  defaultRootObject: string // eg 'index.html'
+  defaultRootObject: string, // eg 'index.html'
+  includeOriginPrefix: boolean
 ): string[] {
   const defaultRootObjectWithoutExtension = defaultRootObject
     .split('.')
@@ -50,10 +51,16 @@ export function getSanitisedInvalidationPaths(
     })
     .map((path) => {
       if (originPrefix) {
-        return path.replace(`/${originPrefix}`, '');
+        const pathWithoutOrigin = path.replace(`/${originPrefix}`, '');
+        if (includeOriginPrefix) {
+          return [pathWithoutOrigin, path];
+        } else {
+          return pathWithoutOrigin;
+        }
       }
       return path;
     })
+    .flat()
     .map((path) => {
       const lowerCasePath = path.toLowerCase();
       if (

dist/index.js.map

@@ -28,11 +28,18 @@ export function getInputs() {
     trimWhitespace: true,
   });
 
+  const includeOriginPrefix =
+    getInput('includeOriginPrefix', {
+      required: true,
+      trimWhitespace: true,
+    }).toLowerCase() === 'true';
+
   return {
     invalidatePaths,
     distributionId,
     region,
     originPrefix,
     defaultRootObject,
+    includeOriginPrefix,
   };
 }

src/__tests__/main.test.ts

@@ -20,7 +20,8 @@ export async function run(): Promise<void> {
     const sanitisedInvalidatePaths = getSanitisedInvalidationPaths(
       inputs.invalidatePaths.split(',').filter(Boolean),
       inputs.originPrefix,
-      inputs.defaultRootObject
+      inputs.defaultRootObject,
+      inputs.includeOriginPrefix
     );
 
     await invalidateCloudFrontCacheWithPaths(