tests(idempotency): add utility to workspace unit tests and CI (#1160)

* chore: fix package.lock & package

* ci: add idempotency to ci checks on PRs

* refactor: minor styling changes to folder structure, exports, types

* test: unit tests style + added missing

* chore: temporarily excluded makeFunctionIdempotent from coverage report

* refactor: rename npx DynamoDbPersistenceLayer to DynamoDBPersistenceLayer

* refactor: rename npx DynamoDbPersistenceLayer to DynamoDBPersistenceLayer

* refactor: rename npx DynamoDbPersistenceLayer to DynamoDBPersistenceLayer

* chore: revert changes to PersistenceLayerInterface

* Trigger Build

* Update packages/idempotency/src/persistence/PersistenceLayer.ts

Co-authored-by: ijemmy <[email protected]>

Co-authored-by: ijemmy <[email protected]>

Author: dreamorosi

Diff for: .github/workflows/reusable-run-linting-check-and-unit-tests.yml

@@ -42,11 +42,11 @@ jobs:
         if: steps.cache-node-modules.outputs.cache-hit == 'true'
         run: |
           npm run build -w packages/commons
-          npm run build -w packages/logger & npm run build -w packages/tracer & npm run build -w packages/metrics -w packages/parameters
+          npm run build -w packages/logger & npm run build -w packages/tracer & npm run build -w packages/metrics & npm run build -w packages/parameters & npm run build -w packages/idempotency
       - name: Run linting
-        run: npm run lint -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters
+        run: npm run lint -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency
       - name: Run unit tests
-        run: npm t -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters
+        run: npm t -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency
   check-examples:
     runs-on: ubuntu-latest
     env:

Diff for: package-lock.json

@@ -9,7 +9,8 @@
     "packages/logger",
     "packages/metrics",
     "packages/tracer",
-    "packages/parameters"
+    "packages/parameters",
+    "packages/idempotency"
   ],
   "scripts": {
     "init-environment": "husky install",
@@ -84,4 +85,4 @@
   "dependencies": {
     "hosted-git-info": "^5.0.0"
   }
-}
+}

Diff for: package.json

@@ -1,7 +1,7 @@
 module.exports = {
   displayName: {
     name: 'AWS Lambda Powertools utility: IDEMPOTENCY',
-    color: 'cyan',
+    color: 'blue',
   },
   'runner': 'groups',
   'preset': 'ts-jest',
@@ -25,6 +25,7 @@ module.exports = {
   'coveragePathIgnorePatterns': [
     '/node_modules/',
     '/types/',
+    'src/makeFunctionIdempotent.ts', // TODO: remove this once makeFunctionIdempotent is implemented
   ],
   'coverageThreshold': {
     'global': {
@@ -38,5 +39,8 @@ module.exports = {
     'json-summary',
     'text',
     'lcov'
+  ],
+  'setupFiles': [
+    '<rootDir>/tests/helpers/populateEnvironmentVariables.ts'
   ]
 };

Diff for: packages/idempotency/jest.config.js

@@ -13,18 +13,18 @@
     "commit": "commit",
     "test": "npm run test:unit",
     "test:unit": "jest --group=unit --detectOpenHandles --coverage --verbose",
-    "test:e2e:nodejs12x": "RUNTIME=nodejs12x jest --group=e2e",
-    "test:e2e:nodejs14x": "RUNTIME=nodejs14x jest --group=e2e",
-    "test:e2e:nodejs16x": "RUNTIME=nodejs16x jest --group=e2e",
-    "test:e2e": "jest --group=e2e",
+    "test:e2e:nodejs12x": "echo \"Not implemented\"",
+    "test:e2e:nodejs14x": "echo \"Not implemented\"",
+    "test:e2e:nodejs16x": "echo \"Not implemented\"",
+    "test:e2e": "echo \"Not implemented\"",
     "watch": "jest --watch --group=unit",
     "build": "tsc",
     "lint": "eslint --ext .ts --no-error-on-unmatched-pattern src tests",
     "lint-fix": "eslint --fix --ext .ts --no-error-on-unmatched-pattern src tests",
     "package": "mkdir -p dist/ && npm pack && mv *.tgz dist/",
-    "package-bundle": "../../package-bundler.sh logger-bundle ./dist",
+    "package-bundle": "../../package-bundler.sh idempotency-bundle ./dist",
     "prepare": "npm run build",
-    "postversion": "git push --tags"
+    "postversion": "echo \"Not implemented\""
   },
   "homepage": "https://github.com/awslabs/aws-lambda-powertools-typescript/tree/master/packages/idempotency#readme",
   "license": "MIT",
@@ -42,7 +42,7 @@
     "url": "https://github.com/awslabs/aws-lambda-powertools-typescript/issues"
   },
   "dependencies": {
-    "@aws-lambda-powertools/commons": "^1.2.1",
+    "@aws-lambda-powertools/commons": "^1.4.1",
     "@aws-sdk/lib-dynamodb": "^3.170.0"
   },
   "keywords": [
@@ -56,4 +56,4 @@
     "aws-sdk-client-mock": "^2.0.0",
     "aws-sdk-client-mock-jest": "^2.0.0"
   }
-}
+}

Diff for: packages/idempotency/package.json

@@ -0,0 +1,13 @@
+interface ConfigServiceInterface {
+
+  get(name: string): string
+
+  getServiceName(): string
+
+  getFunctionName(): string
+
+}
+
+export {
+  ConfigServiceInterface
+};

Diff for: packages/idempotency/src/EnvironmentVariablesService.ts

@@ -0,0 +1,36 @@
+import { ConfigServiceInterface } from './ConfigServiceInterface';
+import { EnvironmentVariablesService as CommonEnvironmentVariablesService } from '@aws-lambda-powertools/commons';
+
+/**
+ * Class EnvironmentVariablesService
+ *
+ * This class is used to return environment variables that are available in the runtime of
+ * the current Lambda invocation.
+ * These variables can be a mix of runtime environment variables set by AWS and
+ * variables that can be set by the developer additionally.
+ *
+ * @class
+ * @extends {CommonEnvironmentVariablesService}
+ * @implements {ConfigServiceInterface}
+ * @see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
+ * @see https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#environment-variables
+ */
+class EnvironmentVariablesService extends CommonEnvironmentVariablesService implements ConfigServiceInterface {
+  
+  // Reserved environment variables
+  private functionNameVariable = 'AWS_LAMBDA_FUNCTION_NAME';
+
+  /**
+   * It returns the value of the AWS_LAMBDA_FUNCTION_NAME environment variable.
+   *
+   * @returns {string}
+   */
+  public getFunctionName(): string {
+    return this.get(this.functionNameVariable);
+  }
+
+}
+
+export {
+  EnvironmentVariablesService
+};

Diff for: packages/idempotency/src/config/ConfigServiceInterface.ts

@@ -0,0 +1 @@
+export * from './EnvironmentVariablesService';

Diff for: packages/idempotency/src/config/EnvironmentVariablesService.ts

@@ -1,10 +1,11 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { AnyFunction } from './types/AnyFunction';
-import { IdempotencyOptions } from './IdempotencyOptions';
+import type { AnyFunction } from './types/AnyFunction';
+import type { IdempotencyOptions } from './types/IdempotencyOptions';
 
 const makeFunctionIdempotent = <U>(
   fn: AnyFunction<U>,
   _options: IdempotencyOptions
+  // TODO: revisit this with a more specific type if possible
+  /* eslint-disable @typescript-eslint/no-explicit-any */
 ): (...args: Array<any>) => Promise<U | void> => (...args) => fn(...args);
 
 export { makeFunctionIdempotent };

Diff for: packages/idempotency/src/config/index.ts

@@ -1,5 +1,6 @@
 import { DynamoDB, DynamoDBServiceException } from '@aws-sdk/client-dynamodb';
-import { DynamoDBDocument, GetCommandOutput } from '@aws-sdk/lib-dynamodb';
+import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
+import type { GetCommandOutput } from '@aws-sdk/lib-dynamodb';
 import { DynamoPersistenceConstructorOptions } from '../types/DynamoPersistenceConstructorOptions';
 import { IdempotencyItemAlreadyExistsError, IdempotencyItemNotFoundError } from '../Exceptions';
 import { IdempotencyRecordStatus } from '../types/IdempotencyRecordStatus';
@@ -23,7 +24,7 @@ class DynamoDBPersistenceLayer extends PersistenceLayer {
     this.statusAttr = constructorOptions.statusAttr ?? 'status';
     this.expiryAttr = constructorOptions.expiryAttr ?? 'expiration';
     this.inProgressExpiryAttr = constructorOptions.inProgressExpiryAttr ?? 'in_progress_expiry_attr';
-    this.dataAttr = constructorOptions.data_attr ?? 'data';
+    this.dataAttr = constructorOptions.dataAttr ?? 'data';
   }
 
   protected async _deleteRecord(record: IdempotencyRecord): Promise<void> {

Diff for: packages/idempotency/src/makeFunctionIdempotent.ts

@@ -1,6 +1,7 @@
 import { BinaryToTextEncoding, createHash, Hash } from 'crypto';
 import { IdempotencyRecordStatus } from '../types/IdempotencyRecordStatus';
-import { EnvironmentVariablesService } from '../EnvironmentVariablesService';
+import type { PersistenceLayerConfigureOptions } from '../types/PersistenceLayer';
+import { EnvironmentVariablesService } from '../config';
 import { IdempotencyRecord } from './IdempotencyRecord';
 import { PersistenceLayerInterface } from './PersistenceLayerInterface';
 
@@ -10,22 +11,32 @@ abstract class PersistenceLayer implements PersistenceLayerInterface {
   private envVarsService!: EnvironmentVariablesService;
 
   private expiresAfterSeconds: number;
-
-  private functionName: string = '';
-
+  
   private hashDigest: BinaryToTextEncoding;
-
+  
   private hashFunction: string;
+  
+  private idempotencyKeyPrefix: string;
 
   public constructor() { 
     this.setEnvVarsService();
     this.expiresAfterSeconds = 60 * 60; //one hour is the default expiration
     this.hashFunction = 'md5';
     this.hashDigest = 'base64';
-        
+    this.idempotencyKeyPrefix = this.getEnvVarsService().getFunctionName();
+
   }
-  public configure(functionName: string = ''): void {
-    this.functionName = this.getEnvVarsService().getLambdaFunctionName() + '.' + functionName;
+
+  /**
+   * Configures the persistence layer by passing the name of the idempotent function. This will be used
+   * in the prefix of the idempotency key
+   * 
+   * @param {PersistenceLayerConfigureOptions} options - configuration object for the persistence layer
+   */
+  public configure(options?: PersistenceLayerConfigureOptions): void {
+    if (options?.functionName && options.functionName.trim() !== '') {
+      this.idempotencyKeyPrefix = `${this.idempotencyKeyPrefix}.${options.functionName}`;
+    }
   }
 
   /**
@@ -136,7 +147,7 @@ abstract class PersistenceLayer implements PersistenceLayerInterface {
       console.warn('No data found for idempotency key');
     }
 
-    return this.functionName + '#' + this.generateHash(JSON.stringify(data));
+    return `${this.idempotencyKeyPrefix}#${this.generateHash(JSON.stringify(data))}`;
   }
 
   /**

Diff for: packages/idempotency/src/persistence/DynamoDbPersistenceLayer.ts renamed to packages/idempotency/src/persistence/DynamoDBPersistenceLayer.ts

@@ -1,7 +1,8 @@
 import { IdempotencyRecord } from './IdempotencyRecord';
+import type { PersistenceLayerConfigureOptions } from '../types/PersistenceLayer';
 
 interface PersistenceLayerInterface {
-  configure(functionName: string): void
+  configure(options?: PersistenceLayerConfigureOptions): void
   saveInProgress(data: unknown): Promise<void>
   saveSuccess(data: unknown, result: unknown): Promise<void>
   deleteRecord(data: unknown): Promise<void>

Diff for: packages/idempotency/src/persistence/PersistenceLayer.ts

@@ -1,4 +1,4 @@
-export * from './DynamoDbPersistenceLayer';
+export * from './DynamoDBPersistenceLayer';
 export * from './PersistenceLayer';
 export * from './PersistenceLayerInterface';
 export * from './IdempotencyRecord';

Diff for: packages/idempotency/src/persistence/PersistenceLayerInterface.ts

@@ -4,7 +4,7 @@ type DynamoPersistenceConstructorOptions = {
   statusAttr?: string
   expiryAttr?: string
   inProgressExpiryAttr?: string
-  data_attr?: string
+  dataAttr?: string
 };
 
 export {

Diff for: packages/idempotency/src/persistence/index.ts

@@ -1,4 +1,4 @@
-import { PersistenceLayer } from './persistence/PersistenceLayer';
+import { PersistenceLayer } from '../persistence/PersistenceLayer';
 
 type IdempotencyOptions = {
   dataKeywordArgument: string

Diff for: packages/idempotency/src/types/DynamoPersistenceConstructorOptions.ts

@@ -0,0 +1,7 @@
+type PersistenceLayerConfigureOptions = {
+  functionName?: string
+};
+
+export { 
+  PersistenceLayerConfigureOptions
+};

Diff for: packages/idempotency/src/IdempotencyOptions.ts renamed to packages/idempotency/src/types/IdempotencyOptions.ts

@@ -1,2 +1,3 @@
 export * from './AnyFunction';
-export * from './IdempotencyRecordStatus';
+export * from './IdempotencyRecordStatus';
+export * from './PersistenceLayer';

Diff for: packages/idempotency/src/types/PersistenceLayer.ts

@@ -1,2 +1,7 @@
 // Reserved variables
-process.env.AWS_REGION = 'us-east-1';
+process.env._X_AMZN_TRACE_ID = '1-abcdef12-3456abcdef123456abcdef12';
+process.env.AWS_LAMBDA_FUNCTION_NAME = 'my-lambda-function';
+process.env.AWS_EXECUTION_ENV = 'nodejs16.x';
+process.env.AWS_LAMBDA_FUNCTION_MEMORY_SIZE = '128';
+process.env.AWS_REGION = 'eu-west-1';
+process.env._HANDLER = 'index.handler';