Address eslint, CodeQL recommendations and issues

Author: Doug Toppin

.github/workflows/cdk-nag.yml

@@ -23,4 +23,4 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: |
           cd source/constructs && npm i --only=dev
-          npx cdk synth
+          npx cdk synth

.github/workflows/code-style-lint.yml

@@ -33,4 +33,4 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: |
           cd source && npm i --only=dev
-          npx --y eslint . --ext .ts
+          npx --y eslint . --ext .ts

.github/workflows/codeql.yml

@@ -21,4 +21,4 @@ jobs:
       - uses: github/codeql-action/init@v2
         with:
             languages: ${{ matrix.language }}
-      - uses: github/codeql-action/analyze@v2
+      - uses: github/codeql-action/analyze@v2

.github/workflows/run-unit-test.yml

@@ -23,4 +23,4 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: |
           cd deployment
-          chmod +x ./run-unit-tests.sh && DEBUG=true ./run-unit-tests.sh
+          chmod +x ./run-unit-tests.sh && DEBUG=true ./run-unit-tests.sh

.viperlightignore

@@ -0,0 +1,5 @@
+node_modules/*
+CONTRIBUTING.md:46
+CODE_OF_CONDUCT.md:4
+coverage/*
+.zip

.viperlightrc

@@ -0,0 +1,4 @@
+{
+  "all": true,
+  "failOn": "medium"
+}

CONTRIBUTING.md

@@ -22,17 +22,17 @@ When filing an issue, please check [existing open](https://github.com/aws-soluti
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
 1. You are working against the latest source on the _main_ branch.
-2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
-3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
+1. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
+1. You open an issue to discuss any significant work - we would hate for your time to be wasted.
 
 To send us a pull request, please:
 
 1. Fork the repository.
-2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
-3. Ensure local tests pass.
-4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+1. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
+1. Ensure local tests pass.
+1. Commit to your fork using clear commit messages.
+1. Send us a pull request, answering any default questions in the pull request interface.
+1. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
 
 GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 

source/.eslintignore

@@ -2,3 +2,4 @@
 *.d.ts
 node_modules
 coverage
+**/test/*

source/.eslintrc.json

@@ -11,7 +11,7 @@
     "sourceType": "module",
     "project": "**/tsconfig.json"
   },
-  "ignorePatterns": ["**/*.js"],
+  "ignorePatterns": ["**/*.js", "**/node_modules/**"],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
@@ -38,6 +38,8 @@
 
     "jsdoc/require-param-type": ["off"],
     "jsdoc/require-returns-type": ["off"],
-    "jsdoc/newline-after-description": ["off"]
+    "jsdoc/newline-after-description": ["off"],
+
+    "import/no-unresolved": 1 // warn only on Unable to resolve path import/no-unresolved
   }
 }

source/constructs/lib/back-end/back-end-construct.ts

@@ -155,11 +155,11 @@ export class BackEnd extends Construct {
     const cloudFrontDistributionProps: DistributionProps = {
       comment: "Image Handler Distribution for Serverless Image Handler",
       defaultBehavior: {
-        origin: origin,
+        origin,
         allowedMethods: AllowedMethods.ALLOW_GET_HEAD,
         viewerProtocolPolicy: ViewerProtocolPolicy.HTTPS_ONLY,
-        originRequestPolicy: originRequestPolicy,
-        cachePolicy: cachePolicy,
+        originRequestPolicy,
+        cachePolicy,
       },
       priceClass: props.cloudFrontPriceClass as PriceClass,
       enableLogging: true,
@@ -192,9 +192,9 @@ export class BackEnd extends Construct {
       {
         existingLambdaObj: imageHandlerLambdaFunction,
         insertHttpSecurityHeaders: false,
-        logGroupProps: logGroupProps,
-        cloudFrontDistributionProps: cloudFrontDistributionProps,
-        apiGatewayProps: apiGatewayProps,
+        logGroupProps,
+        cloudFrontDistributionProps,
+        apiGatewayProps,
       }
     );
 

source/constructs/lib/common-resources/common-resources-construct.ts

@@ -107,7 +107,7 @@ export class CommonResources extends Construct {
       attributeGroupName: Aws.STACK_NAME,
       description: "Attribute group for solution information",
       attributes: {
-        applicationType: applicationType,
+        applicationType,
         version: props.solutionVersion,
         solutionID: props.solutionId,
         solutionName: props.applicationName,

source/constructs/lib/serverless-image-stack.ts

@@ -169,8 +169,8 @@ export class ServerlessImageHandlerStack extends Stack {
       solutionId: props.solutionId,
       solutionVersion: props.solutionVersion,
       solutionDisplayName: props.solutionDisplayName,
-      sourceCodeBucketName: sourceCodeBucketName,
-      sourceCodeKeyPrefix: sourceCodeKeyPrefix,
+      sourceCodeBucketName,
+      sourceCodeKeyPrefix,
       ...solutionConstructProps,
     });
 
@@ -180,8 +180,8 @@ export class ServerlessImageHandlerStack extends Stack {
     });
 
     const backEnd = new BackEnd(this, "BackEnd", {
-      sourceCodeBucketName: sourceCodeBucketName,
-      sourceCodeKeyPrefix: sourceCodeKeyPrefix,
+      sourceCodeBucketName,
+      sourceCodeKeyPrefix,
       solutionVersion: props.solutionVersion,
       solutionDisplayName: props.solutionDisplayName,
       secretsManagerPolicy: commonResources.secretsManagerPolicy,

source/custom-resource/index.ts

@@ -162,6 +162,7 @@ export async function handler(event: CustomResourceRequest, context: LambdaConte
  * @param resourceProperties the parameters to include in the function to be performed
  */
 async function performRequest(
+  // eslint-disable-next-line @typescript-eslint/ban-types
   functionToPerform: Function,
   requestType: CustomResourceRequestTypes,
   allowedRequestTypes: CustomResourceRequestTypes[],

source/image-handler/image-handler.ts

@@ -30,6 +30,7 @@ export class ImageHandler {
    * @param options Additional sharp options to be applied
    * @returns A Sharp image object
    */
+  // eslint-disable-next-line @typescript-eslint/ban-types
   private async instantiateSharpImage(originalImage: Buffer, edits: ImageEdits, options: Object): Promise<sharp.Sharp> {
     let image: sharp.Sharp = null;
 
@@ -294,7 +295,7 @@ export class ImageHandler {
   }
 
   /**
-   * @param param
+   * @param param Value of corner to check
    * @returns Boolean identifying whether roundCrop parameters are valid
    */
   private validRoundCropParam(param: number) {
@@ -508,8 +509,8 @@ export class ImageHandler {
 
     // Calculate the smart crop area
     return {
-      left: left,
-      top: top,
+      left,
+      top,
       width: extractWidth,
       height: extractHeight,
     };
@@ -520,6 +521,10 @@ export class ImageHandler {
    * @param response the response from a Rekognition detectFaces API call
    * @param faceIndex the index number of the face detected
    * @param boundingBox the box bounds
+   * @param boundingBox.Height height of bounding box
+   * @param boundingBox.Left left side of bounding box
+   * @param boundingBox.Top top of bounding box
+   * @param boundingBox.Width width of bounding box
    */
   private handleBounds(
     response: Rekognition.DetectFacesResponse,
@@ -664,6 +669,6 @@ export class ImageHandler {
       imageBuffer = await image.toBuffer({ resolveWithObject: true });
     }
 
-    return { imageBuffer: imageBuffer, format: format };
+    return { imageBuffer, format };
   }
 }

source/image-handler/image-request.ts

@@ -348,11 +348,12 @@ export class ImageRequest {
     }
   }
 
+  // eslint-disable-next-line jsdoc/require-returns-check
   /**
    * Parses the headers to be sent with the response.
    * @param event Lambda request body.
    * @param requestType Image handler request type.
-   * @returns The headers to be sent with the response.
+   * @returns (optional) The headers to be sent with the response.
    */
   public parseImageHeaders(event: ImageHandlerEvent, requestType: RequestTypes): Headers {
     if (requestType === RequestTypes.DEFAULT) {

source/image-handler/index.ts

@@ -51,7 +51,7 @@ export async function handler(event: ImageHandlerEvent): Promise<ImageHandlerExe
     return {
       statusCode: StatusCodes.OK,
       isBase64Encoded: true,
-      headers: headers,
+      headers,
       body: processedRequest,
     };
   } catch (error) {
@@ -80,7 +80,7 @@ export async function handler(event: ImageHandlerEvent): Promise<ImageHandlerExe
         return {
           statusCode: error.status ? error.status : StatusCodes.INTERNAL_SERVER_ERROR,
           isBase64Encoded: true,
-          headers: headers,
+          headers,
           body: defaultFallbackImage.Body.toString("base64"),
         };
       } catch (error) {

source/image-handler/test/image-handler/content-moderation.spec.ts

@@ -13,7 +13,7 @@ import { ImageEdits, ImageHandlerError, StatusCodes } from "../../lib";
 
 const s3Client = new S3();
 const rekognitionClient = new Rekognition();
-//jest spy
+// jest spy
 const blurSpy = jest.spyOn(sharp.prototype, "blur");
 
 describe("contentModeration", () => {

source/image-handler/thumbor-mapper.ts

@@ -73,6 +73,7 @@ export class ThumborMapper {
    * @param filterValue The specified color value
    * @param currentEdits The edits to be performed
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapBGColor(filterValue: string, currentEdits: Record<string, any>): void {
     const color = !ColorName[filterValue] ? `#${filterValue}` : filterValue;
 
@@ -84,6 +85,7 @@ export class ThumborMapper {
    * @param filterValue The blur value provided
    * @param currentEdits The edits to be performed
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapBlur(filterValue: string, currentEdits: Record<string, any>): void {
     const [radius, sigma] = filterValue.split(",").map((x) => (x === "" ? NaN : Number(x)));
     currentEdits.blur = !isNaN(sigma) ? sigma : radius / 2;
@@ -94,6 +96,7 @@ export class ThumborMapper {
    * @param filterValue the convolution value provided
    * @param currentEdits the edits to be performed
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapConvolution(filterValue: string, currentEdits: Record<string, any>): void {
     const values = filterValue.split(",");
     const matrix = values[0].split(";").map((str) => Number(str));
@@ -112,6 +115,7 @@ export class ThumborMapper {
    * @param filterValue The fill value provided
    * @param currentEdits The edits to be performed
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapFill(filterValue: string, currentEdits: Record<string, any>): void {
     if (currentEdits.resize === undefined) {
       currentEdits.resize = {};
@@ -131,6 +135,7 @@ export class ThumborMapper {
    * @param filterValue The output format
    * @param currentEdits The edits to be provided
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapFormat(filterValue: string, currentEdits: Record<string, any>): void {
     const imageFormatType = filterValue.replace(/[^0-9a-z]/gi, "").replace(/jpg/i, "jpeg") as ImageFormatTypes;
     const acceptedValues = [
@@ -153,6 +158,7 @@ export class ThumborMapper {
    * Adds withoutEnlargement option to resize in currentEdits object
    * @param currentEdits The edits to be perforemd
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapNoUpscale(currentEdits: Record<string, any>): void {
     if (currentEdits.resize === undefined) {
       currentEdits.resize = {};
@@ -166,6 +172,7 @@ export class ThumborMapper {
    * @param filterValue The ratio value
    * @param currentEdits The edits to be performed
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapResizeRatio(filterValue: string, currentEdits: Record<string, any>): void {
     if (currentEdits.resize === undefined) {
       currentEdits.resize = {};
@@ -186,6 +193,7 @@ export class ThumborMapper {
    * @param currentEdits The edits to be performed
    * @param fileFormat The image format
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapQuality(filterValue: string, currentEdits: Record<string, any>, fileFormat: ImageFormatTypes): void {
     const toSupportedImageFormatType = (format: ImageFormatTypes): ImageFormatTypes => {
       if ([ImageFormatTypes.JPG, ImageFormatTypes.JPEG].includes(format)) {
@@ -201,7 +209,6 @@ export class ThumborMapper {
       ) {
         return format;
       }
-      return;
     };
 
     // trying to get a target image type base on `fileFormat` passed to the current method.
@@ -218,6 +225,7 @@ export class ThumborMapper {
    * Maps stretch fit to the current edits
    * @param currentEdits The edits to be performed
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapStretch(currentEdits: Record<string, any>): void {
     if (currentEdits.resize === undefined) {
       currentEdits.resize = {};
@@ -233,6 +241,7 @@ export class ThumborMapper {
    * Maps upscale fit to the current edits
    * @param currentEdits The edits to be performed
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapUpscale(currentEdits: Record<string, any>): void {
     if (currentEdits.resize === undefined) {
       currentEdits.resize = {};
@@ -241,6 +250,7 @@ export class ThumborMapper {
     currentEdits.resize.fit = ImageFitTypes.INSIDE;
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private mapWatermark(filterValue: string, currentEdits: Record<string, any>): void {
     const options = filterValue.replace(/\s+/g, "").split(",");
     const [bucket, key, xPos, yPos, alpha, wRatio, hRatio] = options;
@@ -367,7 +377,7 @@ export class ThumborMapper {
    * @returns image edits associated with crop.
    */
   private mapCrop(path: string): ImageEdits {
-    const pathCropMatchResult = path.match(/\d+x\d+:\d+x\d+/g);
+    const pathCropMatchResult = path.match(/\d{1,6}x\d{1,6}:\d{1,6}x\d{1,6}/g);
 
     if (pathCropMatchResult) {
       const [leftTopPoint, rightBottomPoint] = pathCropMatchResult[0].split(":");