@digitraffic/common 2023.3.10-1 → 2023.3.17-1

package/dist/aws/runtime/environment.d.ts

@@ -1 +1,9 @@
+export declare enum EnvKeys {
+    AWS_REGION = "AWS_REGION",
+    SECRET_ID = "SECRET_ID",
+    SECRET_OVERRIDE_AWS_REGION = "SECRET_OVERRIDE_AWS_REGION"
+}
+/**
+ * @deprecated Use digitraffic/common/utils/utils#getEnvVariable
+ */
 export declare function envValue(key: string, defaultValue?: string): string;

package/dist/aws/runtime/environment.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.envValue = void 0;
+exports.envValue = exports.EnvKeys = void 0;
+var EnvKeys;
+(function (EnvKeys) {
+    EnvKeys["AWS_REGION"] = "AWS_REGION";
+    EnvKeys["SECRET_ID"] = "SECRET_ID";
+    EnvKeys["SECRET_OVERRIDE_AWS_REGION"] = "SECRET_OVERRIDE_AWS_REGION";
+})(EnvKeys = exports.EnvKeys || (exports.EnvKeys = {}));
+/**
+ * @deprecated Use digitraffic/common/utils/utils#getEnvVariable
+ */
 function envValue(key, defaultValue) {
     const value = process.env[key];
     if (value == null) {

package/dist/aws/runtime/secrets/secret-holder.d.ts

@@ -6,6 +6,10 @@ import { GenericSecret } from "./secret";
  * By default, secrets are cached for 5 minutes and then reread from the Secrets Manager(This can be overridden with configuration).
  *
  * Supports setting the database environment paramaters from the secret too.
+ *
+ * If you want secret manager to get values from different region than the lambda runtime is running, you can override this by
+ * setting the region with utils setSecretOverideAwsRegionEnv method.
+ *
  */
 export declare class SecretHolder<Secret extends GenericSecret> {
     private readonly secretId;

package/dist/aws/runtime/secrets/secret-holder.js

@@ -18,6 +18,10 @@ const DEFAULT_CONFIGURATION = {
  * By default, secrets are cached for 5 minutes and then reread from the Secrets Manager(This can be overridden with configuration).
  *
  * Supports setting the database environment paramaters from the secret too.
+ *
+ * If you want secret manager to get values from different region than the lambda runtime is running, you can override this by
+ * setting the region with utils setSecretOverideAwsRegionEnv method.
+ *
  */
 class SecretHolder {
     constructor(secretId, prefix = "", expectedKeys = [], configuration = DEFAULT_CONFIGURATION) {

package/dist/aws/runtime/secrets/secret.js

@@ -2,11 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSecret = void 0;
 const aws_sdk_1 = require("aws-sdk");
-const smClient = new aws_sdk_1.SecretsManager({
-    region: process.env.AWS_REGION,
-});
+const utils_1 = require("../../../utils/utils");
+const environment_1 = require("../environment");
+// SECRET_OVERRIDE_AWS_REGION might not have been set before import of
+// secret, so we need to lazy initialize SecretsManager
+let smClient;
+function getSmClient() {
+    if (!smClient) {
+        smClient = new aws_sdk_1.SecretsManager({
+            region: (0, utils_1.getEnvVariableOrElse)(environment_1.EnvKeys.SECRET_OVERRIDE_AWS_REGION, // this is override secret region
+            (0, utils_1.getEnvVariable)(environment_1.EnvKeys.AWS_REGION)),
+        });
+    }
+    return smClient;
+}
 async function getSecret(secretId, prefix = "") {
-    const secretObj = await smClient
+    const secretObj = await getSmClient()
         .getSecretValue({
         SecretId: secretId,
     })

package/dist/test/secrets-manager.js

@@ -26,6 +26,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.mockSecret = exports.stubSecretsManager = void 0;
 const AWS = require("aws-sdk");
 const sinon = __importStar(require("sinon"));
+const environment_1 = require("../aws/runtime/environment");
+const utils_1 = require("../utils/utils");
+(0, utils_1.setEnvVariable)(environment_1.EnvKeys.AWS_REGION, "eu-west-1");
 const secretValue = sinon.stub();
 /**
  * Stub Secrets Manager for tests.  You must call this
@@ -37,7 +40,7 @@ function stubSecretsManager() {
     const smStub = {
         getSecretValue: secretValue,
     };
-    sinon.stub(AWS, 'SecretsManager').returns(smStub);
+    sinon.stub(AWS, "SecretsManager").returns(smStub);
     return smStub.getSecretValue;
 }
 exports.stubSecretsManager = stubSecretsManager;

package/dist/types/aws-env.d.ts

@@ -0,0 +1,3 @@
+export interface AwsEnv {
+    readonly region: string;
+}

package/dist/types/aws-env.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=aws-env.js.map

package/dist/utils/utils.d.ts

@@ -1,3 +1,5 @@
+import { AwsEnv } from "../types/aws-env";
+import { Either } from "../types/either";
 /**
  * Check if arrays have only elements that also exists also in other array.
  * Individual element count doesn't matter.
@@ -19,7 +21,6 @@
  * @param a first array to compare
  * @param b second array to compare
  */
-import { Either } from "../types/either";
 export declare function bothArraysHasSameValues(a: null | undefined | unknown[], b: null | undefined | unknown[]): boolean;
 /**
  * Returns the last item on the array.  If the array is empty, throws an error!
@@ -29,6 +30,14 @@ export declare function getLast<T>(array: T[], sortFunction?: (a: T) => number):
  * Returns the first item on the array.  If the array is empty, throws an error!
  */
 export declare function getFirst<T>(array: T[], sortFunction?: (a: T) => number): T;
+/**
+ * Gets basic AWS environment variables. Throws error if variables are not found.
+ *
+ * @param key Environment key
+ * @return string
+ * @See https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html
+ */
+export declare function getAwsEnv(): AwsEnv;
 /**
  * Gets environment variable. Throws error if variable is not found.
  *
@@ -44,6 +53,13 @@ export declare function getEnvVariable(key: string): string;
  * @return Either<string>
  */
 export declare function getEnvVariableSafe(key: string): Either<string>;
+/**
+ * Sets environment variable.
+ *
+ * @param key Environment key
+ * @param value Environment variable value
+ */
+export declare function setEnvVariable(key: string, value: string): void;
 /**
  * Gets environment variable. If environment variable is undefined, returns value of given function.
  *
@@ -59,3 +75,17 @@ export declare function getEnvVariableOr<T>(key: string, fn: () => T): string |
  * @param orElse Alternative value
  */
 export declare function getEnvVariableOrElse<T>(key: string, orElse: T): string | T;
+export declare function setSecretOverideAwsRegionEnv(region: string): void;
+/**
+ * ESLint won't allow to call Object.prototype builtin methods.
+ * To call hasOwnProperty we must use Object.prototype.hasOwnProperty.call()
+ * @param object to test for property
+ * @param propertyName property name to check
+ * @see https://eslint.org/docs/latest/rules/no-prototype-builtins
+ */
+export declare function hasOwnPropertySafe(object: object, propertyName: string): boolean;
+/**
+ * Return an error message from the given object hat might be an Error object.
+ * @param maybeError
+ */
+export declare function getErrorMessage(maybeError: unknown): string;

package/dist/utils/utils.js

@@ -1,6 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnvVariableOrElse = exports.getEnvVariableOr = exports.getEnvVariableSafe = exports.getEnvVariable = exports.getFirst = exports.getLast = exports.bothArraysHasSameValues = void 0;
+exports.getErrorMessage = exports.hasOwnPropertySafe = exports.setSecretOverideAwsRegionEnv = exports.getEnvVariableOrElse = exports.getEnvVariableOr = exports.setEnvVariable = exports.getEnvVariableSafe = exports.getEnvVariable = exports.getAwsEnv = exports.getFirst = exports.getLast = exports.bothArraysHasSameValues = void 0;
+const environment_1 = require("../aws/runtime/environment");
+/**
+ * Check if arrays have only elements that also exists also in other array.
+ * Individual element count doesn't matter.
+ * Function works only for primitive types and for other it just checks the reference to object.
+ *
+ * Some examples
+ * bothArraysHasSameValues( [a, b], [b, a] )    => true
+ * bothArraysHasSameValues( [a, a], [a, a, a] ) => true
+ * bothArraysHasSameValues( [a, b], [a] )       => false
+ *
+ * Object references:
+ * const o1 = { a: 1, b: 2};
+ * const o2 = { a: 1, b: 2};
+ * // Arrays has references to same objects
+ * bothArraysHasSameValues([o1], [o1]))         => true
+ * Arrays have references to different objects
+ * bothArraysHasSameValues([o1], [o2]))         => false
+ *
+ * @param a first array to compare
+ * @param b second array to compare
+ */
 function bothArraysHasSameValues(a, b) {
     if ((a && !b) || (!a && b)) {
         return false;
@@ -40,6 +62,19 @@ function getFirstOrLast(getFirst, array, sortFunction) {
     }
     return array[index];
 }
+/**
+ * Gets basic AWS environment variables. Throws error if variables are not found.
+ *
+ * @param key Environment key
+ * @return string
+ * @See https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html
+ */
+function getAwsEnv() {
+    return {
+        region: getEnvVariable("AWS_REGION"),
+    };
+}
+exports.getAwsEnv = getAwsEnv;
 /**
  * Gets environment variable. Throws error if variable is not found.
  *
@@ -72,6 +107,16 @@ function getEnvVariableSafe(key) {
     return { result: "ok", value };
 }
 exports.getEnvVariableSafe = getEnvVariableSafe;
+/**
+ * Sets environment variable.
+ *
+ * @param key Environment key
+ * @param value Environment variable value
+ */
+function setEnvVariable(key, value) {
+    process.env[key] = value;
+}
+exports.setEnvVariable = setEnvVariable;
 /**
  * Gets environment variable. If environment variable is undefined, returns value of given function.
  *
@@ -97,4 +142,30 @@ function getEnvVariableOrElse(key, orElse) {
     return getEnvVariableOr(key, () => orElse);
 }
 exports.getEnvVariableOrElse = getEnvVariableOrElse;
+function setSecretOverideAwsRegionEnv(region) {
+    setEnvVariable(environment_1.EnvKeys.SECRET_OVERRIDE_AWS_REGION, region);
+}
+exports.setSecretOverideAwsRegionEnv = setSecretOverideAwsRegionEnv;
+/**
+ * ESLint won't allow to call Object.prototype builtin methods.
+ * To call hasOwnProperty we must use Object.prototype.hasOwnProperty.call()
+ * @param object to test for property
+ * @param propertyName property name to check
+ * @see https://eslint.org/docs/latest/rules/no-prototype-builtins
+ */
+function hasOwnPropertySafe(object, propertyName) {
+    return Object.prototype.hasOwnProperty.call(object, propertyName);
+}
+exports.hasOwnPropertySafe = hasOwnPropertySafe;
+/**
+ * Return an error message from the given object hat might be an Error object.
+ * @param maybeError
+ */
+function getErrorMessage(maybeError) {
+    if (maybeError instanceof Error) {
+        return maybeError.name + ": " + maybeError.message;
+    }
+    return String(maybeError);
+}
+exports.getErrorMessage = getErrorMessage;
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitraffic/common",
-  "version": "2023.03.10-1",
+  "version": "2023.3.17-1",
   "description": "",
   "repository": {
     "type": "git",

package/src/aws/runtime/environment.ts

@@ -1,3 +1,12 @@
+export enum EnvKeys {
+    AWS_REGION = "AWS_REGION",
+    SECRET_ID = "SECRET_ID",
+    SECRET_OVERRIDE_AWS_REGION = "SECRET_OVERRIDE_AWS_REGION",
+}
+
+/**
+ * @deprecated Use digitraffic/common/utils/utils#getEnvVariable
+ */
 export function envValue(key: string, defaultValue?: string): string {
     const value = process.env[key];
 

package/src/aws/runtime/secrets/secret-holder.ts

@@ -18,6 +18,10 @@ const DEFAULT_CONFIGURATION = {
  * By default, secrets are cached for 5 minutes and then reread from the Secrets Manager(This can be overridden with configuration).
  *
  * Supports setting the database environment paramaters from the secret too.
+ *
+ * If you want secret manager to get values from different region than the lambda runtime is running, you can override this by
+ * setting the region with utils setSecretOverideAwsRegionEnv method.
+ *
  */
 export class SecretHolder<Secret extends GenericSecret> {
     private readonly secretId: string;

package/src/aws/runtime/secrets/secret.ts

@@ -1,8 +1,21 @@
 import { SecretsManager } from "aws-sdk";
-
-const smClient = new SecretsManager({
-    region: process.env.AWS_REGION,
-});
+import { getEnvVariable, getEnvVariableOrElse } from "../../../utils/utils";
+import { EnvKeys } from "../environment";
+
+// SECRET_OVERRIDE_AWS_REGION might not have been set before import of
+// secret, so we need to lazy initialize SecretsManager
+let smClient: SecretsManager | undefined;
+function getSmClient(): SecretsManager {
+    if (!smClient) {
+        smClient = new SecretsManager({
+            region: getEnvVariableOrElse<string>(
+                EnvKeys.SECRET_OVERRIDE_AWS_REGION, // this is override secret region
+                getEnvVariable(EnvKeys.AWS_REGION)
+            ),
+        });
+    }
+    return smClient;
+}
 
 export type GenericSecret = Record<string, string>;
 
@@ -10,7 +23,7 @@ export async function getSecret<Secret>(
     secretId: string,
     prefix = ""
 ): Promise<Secret> {
-    const secretObj = await smClient
+    const secretObj = await getSmClient()
         .getSecretValue({
             SecretId: secretId,
         })

package/src/test/secrets-manager.ts

@@ -1,6 +1,9 @@
-import AWS = require('aws-sdk');
+import AWS = require("aws-sdk");
 import * as sinon from "sinon";
+import { EnvKeys } from "../aws/runtime/environment";
+import { setEnvVariable } from "../utils/utils";
 
+setEnvVariable(EnvKeys.AWS_REGION, "eu-west-1");
 const secretValue = sinon.stub();
 
 /**
@@ -14,7 +17,7 @@ export function stubSecretsManager() {
         getSecretValue: secretValue,
     };
 
-    sinon.stub(AWS, 'SecretsManager').returns(smStub);
+    sinon.stub(AWS, "SecretsManager").returns(smStub);
 
     return smStub.getSecretValue;
 }

package/src/types/aws-env.ts

@@ -0,0 +1,3 @@
+export interface AwsEnv {
+    readonly region: string;
+}

package/src/utils/utils.ts

@@ -1,3 +1,7 @@
+import { AwsEnv } from "../types/aws-env";
+import { Either } from "../types/either";
+import { EnvKeys } from "../aws/runtime/environment";
+
 /**
  * Check if arrays have only elements that also exists also in other array.
  * Individual element count doesn't matter.
@@ -19,8 +23,6 @@
  * @param a first array to compare
  * @param b second array to compare
  */
-import { Either } from "../types/either";
-
 export function bothArraysHasSameValues(
     a: null | undefined | unknown[],
     b: null | undefined | unknown[]
@@ -72,6 +74,19 @@ function getFirstOrLast<T>(
     return array[index];
 }
 
+/**
+ * Gets basic AWS environment variables. Throws error if variables are not found.
+ *
+ * @param key Environment key
+ * @return string
+ * @See https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html
+ */
+export function getAwsEnv(): AwsEnv {
+    return {
+        region: getEnvVariable("AWS_REGION"),
+    };
+}
+
 /**
  * Gets environment variable. Throws error if variable is not found.
  *
@@ -104,6 +119,16 @@ export function getEnvVariableSafe(key: string): Either<string> {
     return { result: "ok", value };
 }
 
+/**
+ * Sets environment variable.
+ *
+ * @param key Environment key
+ * @param value Environment variable value
+ */
+export function setEnvVariable(key: string, value: string) {
+    process.env[key] = value;
+}
+
 /**
  * Gets environment variable. If environment variable is undefined, returns value of given function.
  *
@@ -128,3 +153,32 @@ export function getEnvVariableOr<T>(key: string, fn: () => T): string | T {
 export function getEnvVariableOrElse<T>(key: string, orElse: T): string | T {
     return getEnvVariableOr(key, () => orElse);
 }
+
+export function setSecretOverideAwsRegionEnv(region: string) {
+    setEnvVariable(EnvKeys.SECRET_OVERRIDE_AWS_REGION, region);
+}
+
+/**
+ * ESLint won't allow to call Object.prototype builtin methods.
+ * To call hasOwnProperty we must use Object.prototype.hasOwnProperty.call()
+ * @param object to test for property
+ * @param propertyName property name to check
+ * @see https://eslint.org/docs/latest/rules/no-prototype-builtins
+ */
+export function hasOwnPropertySafe(
+    object: object,
+    propertyName: string
+): boolean {
+    return Object.prototype.hasOwnProperty.call(object, propertyName);
+}
+
+/**
+ * Return an error message from the given object hat might be an Error object.
+ * @param maybeError
+ */
+export function getErrorMessage(maybeError: unknown) {
+    if (maybeError instanceof Error) {
+        return maybeError.name + ": " + maybeError.message;
+    }
+    return String(maybeError);
+}