Merge branch 'develop' into develop

dougtoppin · web-flow · commit e9a85b72948d · 2023-02-16T13:55:33.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.1.1] - 2023-02-09
+
+### Added
+
+- package-lock.json for all modules [#426](https://github.com/aws-solutions/serverless-image-handler/pull/426)
+- github workflows for running unit test, eslint and prettier formatting, cdk nag, security scans [#402](https://github.com/aws-solutions/serverless-image-handler/pull/402)
+- demo-ui unicode support [#416](https://github.com/aws-solutions/serverless-image-handler/issues/416)
+- support for multiple cloudformation stack deployments in the same region [#438](https://github.com/aws-solutions/serverless-image-handler/pull/438)
+
+### Changed
+
+- axios version update to 1.2.3 [#425](https://github.com/aws-solutions/serverless-image-handler/pull/425)
+- json5 version update to 1.0.2 [#428](https://github.com/aws-solutions/serverless-image-handler/pull/428)
+- CodeQL advisory resolutions
+- contributing guidelines
+
 ## [6.1.0] - 2022-11-10
 
 ### Added
diff --git a/source/constructs/lib/common-resources/common-resources-construct.ts b/source/constructs/lib/common-resources/common-resources-construct.ts
@@ -91,7 +91,7 @@ export class CommonResources extends Construct {
     const applicationType = "AWS-Solutions";
 
     const application = new appreg.Application(stack, "AppRegistry", {
-      applicationName: Fn.join("-", [props.applicationName, Aws.REGION, Aws.ACCOUNT_ID]),
+      applicationName: Fn.join("-", ["AppRegistry", Aws.STACK_NAME, Aws.REGION, Aws.ACCOUNT_ID]),
       description: `Service Catalog application to track and manage all your resources for the solution ${props.applicationName}`,
     });
     application.associateStack(stack);
@@ -102,7 +102,7 @@ export class CommonResources extends Construct {
     Tags.of(application).add("Solutions:ApplicationType", applicationType);
 
     const attributeGroup = new appreg.AttributeGroup(stack, "DefaultApplicationAttributes", {
-      attributeGroupName: Aws.STACK_NAME,
+      attributeGroupName: `AppRegistry-${Aws.STACK_NAME}`,
       description: "Attribute group for solution information",
       attributes: {
         applicationType,
diff --git a/source/constructs/package-lock.json b/source/constructs/package-lock.json
diff --git a/source/constructs/package.json b/source/constructs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "constructs",
-  "version": "6.1.0",
+  "version": "6.1.1",
   "description": "Serverless Image Handler Constructs",
   "license": "Apache-2.0",
   "bin": {
diff --git a/source/constructs/test/__snapshots__/constructs.test.ts.snap b/source/constructs/test/__snapshots__/constructs.test.ts.snap
@@ -332,7 +332,10 @@ exports[`Serverless Image Handler Stack Snapshot 1`] = `
           "Fn::Join": [
             "-",
             [
-              "sih",
+              "AppRegistry",
+              {
+                "Ref": "AWS::StackName",
+              },
               {
                 "Ref": "AWS::Region",
               },
@@ -1936,7 +1939,15 @@ exports[`Serverless Image Handler Stack Snapshot 1`] = `
         },
         "Description": "Attribute group for solution information",
         "Name": {
-          "Ref": "AWS::StackName",
+          "Fn::Join": [
+            "",
+            [
+              "AppRegistry-",
+              {
+                "Ref": "AWS::StackName",
+              },
+            ],
+          ],
         },
         "Tags": {
           "SolutionId": "S0ABC",
diff --git a/source/custom-resource/index.ts b/source/custom-resource/index.ts
@@ -548,7 +548,7 @@ async function checkSecretsManager(
 async function checkFallbackImage(
   requestProperties: CheckFallbackImageRequestProperties
 ): Promise<{ Message: string; Data: unknown }> {
-  const { FallbackImageS3Bucket, FallbackImageS3Key } = requestProperties as CheckFallbackImageRequestProperties;
+  const { FallbackImageS3Bucket, FallbackImageS3Key } = requestProperties;
 
   if (isNullOrWhiteSpace(FallbackImageS3Bucket)) {
     throw new CustomResourceError("S3BucketNotProvided", "You need to provide the default fallback image bucket.");
diff --git a/source/custom-resource/package-lock.json b/source/custom-resource/package-lock.json
diff --git a/source/custom-resource/package.json b/source/custom-resource/package.json
@@ -1,6 +1,6 @@
 {
   "name": "custom-resource",
-  "version": "6.1.0",
+  "version": "6.1.1",
   "private": true,
   "description": "Serverless Image Handler custom resource",
   "license": "Apache-2.0",
@@ -26,4 +26,4 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.8.4"
   }
-}
+}
diff --git a/source/demo-ui/scripts.js b/source/demo-ui/scripts.js
@@ -18,10 +18,13 @@ function importOriginalImage() {
     // Assemble the image request
     const request = {
         bucket: bucketName,
-        key: encodeURIComponent(keyName)
+        key: keyName
     }
     const strRequest = JSON.stringify(request);
-    const encRequest = btoa(strRequest);
+    const encRequest = btoa(encodeURIComponent(strRequest).replace(/%([0-9A-F]{2})/g, function(match, p1) {
+        return String.fromCharCode(parseInt(p1, 16))
+    }));
+    
     // Import the image data into the element
     $(`#img-original`)
         .attr(`src`, `${appVariables.apiEndpoint}/${encRequest}`)
@@ -77,14 +80,18 @@ function getPreviewImage() {
     // Set up the request body
     const request = {
         bucket: bucketName,
-        key: encodeURIComponent(keyName),
+        key: keyName,
         edits: _edits
     }
     if (Object.keys(request.edits).length === 0) { delete request.edits }
     console.log(request);
     // Setup encoded request
     const str = JSON.stringify(request);
-    const enc = btoa(str);
+
+    const enc = btoa(encodeURIComponent(str).replace(/%([0-9A-F]{2})/g, function(match, p1) {
+        return String.fromCharCode(parseInt(p1, 16))
+    }));
+
     // Fill the preview image
     $(`#img-preview`).attr(`src`, `${appVariables.apiEndpoint}/${enc}`);
     // Fill the request body field
diff --git a/source/image-handler/image-handler.ts b/source/image-handler/image-handler.ts
@@ -443,7 +443,7 @@ export class ImageHandler {
     alpha: string,
     sourceImageMetadata: sharp.Metadata
   ): Promise<Buffer> {
-    const params = { Bucket: bucket, Key: decodeURIComponent(key) };
+    const params = { Bucket: bucket, Key: key };
     try {
       const { width, height } = sourceImageMetadata;
       const overlayImage: S3.GetObjectOutput = await this.s3Client.getObject(params).promise();
diff --git a/source/image-handler/image-request.ts b/source/image-handler/image-request.ts
@@ -269,7 +269,7 @@ export class ImageRequest {
     if (requestType === RequestTypes.DEFAULT) {
       // Decode the image request and return the image key
       const { key } = this.decodeRequest(event);
-      return decodeURIComponent(key);
+      return key;
     }
 
     if (requestType === RequestTypes.THUMBOR || requestType === RequestTypes.CUSTOM) {
@@ -291,7 +291,12 @@ export class ImageRequest {
       }
 
       return decodeURIComponent(
-        path.replace(/\/\d+x\d+:\d+x\d+\/|(?<=\/)\d+x\d+\/|filters:[^/]+|\/fit-in(?=\/)|^\/+/g, "").replace(/^\/+/, "")
+        path
+          .replace(
+            /\/\d+x\d+:\d+x\d+\/|(?<=\/)\d+x\d+\/|filters:watermark\(.*\)|filters:[^/]+|\/fit-in(?=\/)|^\/+/g,
+            ""
+          )
+          .replace(/^\/+/, "")
       );
     }
 
@@ -445,6 +450,7 @@ export class ImageRequest {
         return ContentTypes.PNG;
       case "FFD8FFDB":
       case "FFD8FFE0":
+      case "FFD8FFED":
       case "FFD8FFEE":
       case "FFD8FFE1":
         return ContentTypes.JPEG;
diff --git a/source/image-handler/package-lock.json b/source/image-handler/package-lock.json
diff --git a/source/image-handler/package.json b/source/image-handler/package.json
@@ -1,6 +1,6 @@
 {
   "name": "image-handler",
-  "version": "6.1.0",
+  "version": "6.1.1",
   "private": true,
   "description": "A Lambda function for performing on-demand image edits and manipulations.",
   "license": "Apache-2.0",
diff --git a/source/image-handler/test/image-request/determine-output-format.spec.ts b/source/image-handler/test/image-request/determine-output-format.spec.ts
@@ -5,14 +5,7 @@ import S3 from "aws-sdk/clients/s3";
 import SecretsManager from "aws-sdk/clients/secretsmanager";
 
 import { ImageRequest } from "../../image-request";
-import {
-  ContentTypes,
-  ImageHandlerEvent,
-  ImageFormatTypes,
-  ImageRequestInfo,
-  RequestTypes,
-  StatusCodes,
-} from "../../lib";
+import { ImageHandlerEvent, ImageFormatTypes, ImageRequestInfo, RequestTypes } from "../../lib";
 import { SecretProvider } from "../../secret-provider";
 
 const request: Record<string, any> = {
diff --git a/source/image-handler/test/image-request/fix-quality.spec.ts b/source/image-handler/test/image-request/fix-quality.spec.ts
@@ -5,14 +5,7 @@ import S3 from "aws-sdk/clients/s3";
 import SecretsManager from "aws-sdk/clients/secretsmanager";
 
 import { ImageRequest } from "../../image-request";
-import {
-  ContentTypes,
-  ImageHandlerEvent,
-  ImageFormatTypes,
-  ImageRequestInfo,
-  RequestTypes,
-  StatusCodes,
-} from "../../lib";
+import { ImageFormatTypes, ImageRequestInfo, RequestTypes } from "../../lib";
 import { SecretProvider } from "../../secret-provider";
 
 const imageRequestInfo: ImageRequestInfo = {
diff --git a/source/image-handler/test/image-request/infer-image-type.spec.ts b/source/image-handler/test/image-request/infer-image-type.spec.ts
@@ -24,6 +24,18 @@ describe("inferImageType", () => {
     expect(result).toEqual("image/jpeg");
   });
 
+  it('Should pass if it returns "image/jpeg for a magic number of FFD8FFED"', () => {
+    // Arrange
+    const imageBuffer = Buffer.from([0xff, 0xd8, 0xff, 0xed, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
+
+    // Act
+    const imageRequest = new ImageRequest(s3Client, secretProvider);
+    const result = imageRequest.inferImageType(imageBuffer);
+
+    // Assert
+    expect(result).toEqual("image/jpeg");
+  });
+
   it("Should pass throw an exception", () => {
     // Arrange
     const imageBuffer = Buffer.from([0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
diff --git a/source/image-handler/test/image-request/parse-image-key.spec.ts b/source/image-handler/test/image-request/parse-image-key.spec.ts
@@ -261,4 +261,34 @@ describe("parseImageKey", () => {
       });
     }
   });
+
+  it("Should pass if an image key value is provided in the thumbor request format with a watermark containing a slash", () => {
+    // Arrange
+    const event = {
+      path: "/fit-in/400x400/filters:watermark(bucket,folder/key.png,0,0)/image.jpg",
+    };
+
+    // Act
+    const imageRequest = new ImageRequest(s3Client, secretProvider);
+    const result = imageRequest.parseImageKey(event, RequestTypes.THUMBOR);
+
+    // Assert
+    const expectedResult = "image.jpg";
+    expect(result).toEqual(expectedResult);
+  });
+
+  it("Should pass if an image key value is provided in the thumbor request format with a watermark not containing a slash", () => {
+    // Arrange
+    const event = {
+      path: "/fit-in/400x400/filters:watermark(bucket,key.png,0,0)/image.jpg",
+    };
+
+    // Act
+    const imageRequest = new ImageRequest(s3Client, secretProvider);
+    const result = imageRequest.parseImageKey(event, RequestTypes.THUMBOR);
+
+    // Assert
+    const expectedResult = "image.jpg";
+    expect(result).toEqual(expectedResult);
+  });
 });
diff --git a/source/image-handler/test/thumbor-mapper/filter.spec.ts b/source/image-handler/test/thumbor-mapper/filter.spec.ts
@@ -638,4 +638,68 @@ describe("filter", () => {
     };
     expect(edits).toEqual(expectedResult.edits);
   });
+
+  it("Should pass for fit-in combined with watermark in folder", () => {
+    // watermark params: bucket, key, xPos, yPos, alpha, wRatio, hRatio
+    const path = "/fit-in/400x400/filters:watermark(bucket,folder/key.png,0,0)/image.jpg";
+
+    // Act
+    const thumborMapper = new ThumborMapper();
+    const edits = thumborMapper.mapPathToEdits(path);
+
+    // Assert
+    const expectedResult = {
+      edits: {
+        resize: {
+          width: 400,
+          height: 400,
+          fit: "inside",
+        },
+        overlayWith: {
+          bucket: "bucket",
+          key: "folder/key.png",
+          alpha: undefined,
+          wRatio: undefined,
+          hRatio: undefined,
+          options: {
+            left: "0",
+            top: "0",
+          },
+        },
+      },
+    };
+    expect(edits).toEqual(expectedResult.edits);
+  });
+
+  it("Should pass for fit-in combined with watermark not in folder", () => {
+    // watermark params: bucket, key, xPos, yPos, alpha, wRatio, hRatio
+    const path = "/fit-in/400x400/filters:watermark(bucket,key.png,0,0)/image.jpg";
+
+    // Act
+    const thumborMapper = new ThumborMapper();
+    const edits = thumborMapper.mapPathToEdits(path);
+
+    // Assert
+    const expectedResult = {
+      edits: {
+        resize: {
+          width: 400,
+          height: 400,
+          fit: "inside",
+        },
+        overlayWith: {
+          bucket: "bucket",
+          key: "key.png",
+          alpha: undefined,
+          wRatio: undefined,
+          hRatio: undefined,
+          options: {
+            left: "0",
+            top: "0",
+          },
+        },
+      },
+    };
+    expect(edits).toEqual(expectedResult.edits);
+  });
 });
diff --git a/source/image-handler/test/thumbor-mapper/mappings.spec.ts b/source/image-handler/test/thumbor-mapper/mappings.spec.ts
@@ -1,7 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { Image } from "aws-sdk/clients/rekognition";
 import { ImageFitTypes, ImageFormatTypes } from "../../lib";
 import { ThumborMapper } from "../../thumbor-mapper";
 
diff --git a/source/package-lock.json b/source/package-lock.json
diff --git a/source/package.json b/source/package.json
diff --git a/source/solution-utils/package-lock.json b/source/solution-utils/package-lock.json
diff --git a/source/solution-utils/package.json b/source/solution-utils/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "constructs",`
`3`		`- "version": "6.1.0",`
	`3`	`+ "version": "6.1.1",`
`4`	`4`	`"description": "Serverless Image Handler Constructs",`
`5`	`5`	`"license": "Apache-2.0",`
`6`	`6`	`"bin": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "custom-resource",`
`3`		`- "version": "6.1.0",`
	`3`	`+ "version": "6.1.1",`
`4`	`4`	`"private": true,`
`5`	`5`	`"description": "Serverless Image Handler custom resource",`
`6`	`6`	`"license": "Apache-2.0",`
`@@ -26,4 +26,4 @@`
`26`	`26`	`"ts-node": "^10.9.1",`
`27`	`27`	`"typescript": "^4.8.4"`
`28`	`28`	`}`
`29`		`-}`
	`29`	`+}`