refactor: env-helpers (#249)

* refactor: env-helpers

* fix: imports

services/core/functions/demo-review-lambda/config.ts

@@ -10,15 +10,17 @@ import {
   LANGCHAIN_API_KEY_PARAM_NAME,
   OPENAI_API_KEY_PARAM_NAME,
 } from "../../constants";
-import { buildResourceName } from "../../helpers";
-import { commonLambdaEnvironment } from "../helpers/commonLambdaEnvironment";
-import { commonLambdaProps } from "../helpers/commonLambdaProps";
-import { reviewLambdaEnvironment } from "../helpers/reviewLambdaEnvironment";
+import {
+  buildResourceName,
+  commonLambdaEnvironment,
+  commonLambdaProps,
+} from "../../helpers";
+import { reviewLambdaEnvironment } from "../utils/reviewLambdaEnvironment";
 
 export type DemoReviewLambdaProps = {
   table: Table;
   bucket: Bucket;
-}
+};
 
 export class DemoReviewLambda extends NodejsFunction {
   constructor(scope: Construct, id: string, props: DemoReviewLambdaProps) {

services/core/functions/demo-review-lambda/index.ts

@@ -2,13 +2,13 @@ import { S3Client } from "@aws-sdk/client-s3";
 import { APIGatewayProxyEvent } from "aws-lambda";
 import { v4 as uuidv4 } from "uuid";
 
-import { saveInputAndResponseToS3 } from "./saveInputAndResponseToS3";
 import { getMaxPromptLength } from "../../../../src/common/model/getMaxPromptLength";
 import { logger } from "../../../../src/common/utils/logger";
 import { askAI } from "../../../../src/review/llm/askAI";
 import { demoPrompt } from "../../../../src/review/prompt/prompts";
 import { ReviewDemoCounterEntity } from "../../entities";
-import { getEnvVariable, getVariableFromSSM } from "../helpers/getVariable";
+import { getEnvVariable, getVariableFromSSM } from "../utils/getVariable";
+import { saveInputAndResponseToS3 } from "./saveInputAndResponseToS3";
 
 const DEFAULT_DEMO_MODEL = "gpt-3.5-turbo";
 
@@ -27,7 +27,7 @@ type DemoReviewLambdaResponse = {
 
 type ReviewLambdaInput = {
   code: string;
-}
+};
 
 const isReviewLambdaInput = (input: unknown): input is ReviewLambdaInput =>
   typeof input === "object" && input !== null && "code" in input;

services/core/functions/get-user/config.ts

@@ -3,13 +3,15 @@ import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
 import { Construct } from "constructs";
 import { join } from "path";
 
-import { buildResourceName } from "../../helpers";
-import { commonLambdaEnvironment } from "../helpers/commonLambdaEnvironment";
-import { commonLambdaProps } from "../helpers/commonLambdaProps";
+import {
+  buildResourceName,
+  commonLambdaEnvironment,
+  commonLambdaProps,
+} from "../../helpers";
 
 type GetUserLambdaProps = {
   table: Table;
-}
+};
 
 export class GetUserLambda extends NodejsFunction {
   constructor(scope: Construct, id: string, props: GetUserLambdaProps) {

services/core/functions/review-lambda/auth.ts

@@ -1,6 +1,6 @@
 import { subtle } from "crypto";
 
-import { getVariableFromSSM } from "../helpers/getVariable";
+import { getVariableFromSSM } from "../utils/getVariable";
 
 export const authenticate = async (
   header: string,
@@ -30,7 +30,7 @@ export const authenticate = async (
   return equal;
 };
 
-function hexToBytes(hex: string) {
+const hexToBytes = (hex: string) => {
   const len = hex.length / 2;
   const bytes = new Uint8Array(len);
 
@@ -43,4 +43,4 @@ function hexToBytes(hex: string) {
   }
 
   return bytes;
-}
+};

services/core/functions/review-lambda/config.ts

@@ -9,10 +9,12 @@ import {
   LANGCHAIN_API_KEY_PARAM_NAME,
   OPENAI_API_KEY_PARAM_NAME,
 } from "../../constants";
-import { buildResourceName } from "../../helpers";
-import { commonLambdaEnvironment } from "../helpers/commonLambdaEnvironment";
-import { commonLambdaProps } from "../helpers/commonLambdaProps";
-import { reviewLambdaEnvironment } from "../helpers/reviewLambdaEnvironment";
+import {
+  buildResourceName,
+  commonLambdaEnvironment,
+  commonLambdaProps,
+} from "../../helpers";
+import { reviewLambdaEnvironment } from "../utils/reviewLambdaEnvironment";
 
 export class ReviewLambda extends NodejsFunction {
   constructor(scope: Construct, id: string) {

services/core/functions/review-lambda/decryptKey.ts

@@ -1,6 +1,6 @@
 import { DecryptCommand, KMSClient } from "@aws-sdk/client-kms";
 
-import { getEnvVariable } from "../helpers/getVariable";
+import { getEnvVariable } from "../utils/getVariable";
 
 const kmsClient = new KMSClient({});
 

services/core/functions/review-lambda/index.ts

@@ -5,12 +5,12 @@ import { ReviewArgs, ReviewFile } from "../../../../src/common/types";
 import { logger } from "../../../../src/common/utils/logger";
 import { review } from "../../../../src/review/index";
 import { GITHUB_SIGNATURE_HEADER_KEY } from "../../constants";
-import { getVariableFromSSM } from "../helpers/getVariable";
+import { getVariableFromSSM } from "../utils/getVariable";
 
 type ReviewLambdasBody = {
   args: ReviewArgs;
   files: ReviewFile[];
-}
+};
 
 logger.settings.minLevel = 4;
 

services/core/functions/update-user/config.ts

@@ -4,14 +4,16 @@ import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
 import { Construct } from "constructs";
 import { join } from "path";
 
-import { buildResourceName } from "../../helpers";
-import { commonLambdaEnvironment } from "../helpers/commonLambdaEnvironment";
-import { commonLambdaProps } from "../helpers/commonLambdaProps";
+import {
+  buildResourceName,
+  commonLambdaEnvironment,
+  commonLambdaProps,
+} from "../../helpers";
 
 type UpdateUserLambdaProps = {
   table: Table;
   kmsKey: Key;
-}
+};
 
 export class UpdateUserLambda extends NodejsFunction {
   constructor(scope: Construct, id: string, props: UpdateUserLambdaProps) {

services/core/functions/update-user/encryptKey.ts

@@ -1,6 +1,6 @@
 import { EncryptCommand, KMSClient } from "@aws-sdk/client-kms";
 
-import { getEnvVariable } from "../helpers/getVariable";
+import { getEnvVariable } from "../utils/getVariable";
 
 const kmsClient = new KMSClient({});
 

services/core/helpers/certificates.ts

@@ -2,7 +2,7 @@ import { StringParameter } from "aws-cdk-lib/aws-ssm";
 import { Construct } from "constructs";
 
 import { getStage } from "./env-helpers";
-import { isDev } from "./environment";
+import { isDev } from "./env-helpers/environment";
 
 export const getCertificateArn = (
   scope: Construct,

services/core/helpers/env-helpers/buildResourceName.ts

@@ -0,0 +1,4 @@
+import { getStage } from "./getStage";
+
+export const buildResourceName = (resourceName: string): string =>
+  `${getStage()}-${resourceName}`;

services/core/helpers/env-helpers/config.ts

@@ -0,0 +1,3 @@
+export const defaultStage = "dev";
+export const defaultRegion = "eu-west-2";
+export const projectName = "crgpt";

services/core/helpers/environment.ts → services/core/helpers/env-helpers/environment.ts

@@ -1,4 +1,4 @@
-import { getStage } from "./env-helpers";
+import { getStage } from "./getStage";
 
 export const isProduction = (): boolean => {
   const stage = getStage();

services/core/helpers/env-helpers/getArg.ts

@@ -0,0 +1,47 @@
+export type GetArgProps = {
+  cliArg: string;
+  processEnvName: string;
+  defaultValue?: string;
+};
+
+export const getArg = ({
+  cliArg,
+  processEnvName,
+  defaultValue,
+}: GetArgProps): string => {
+  const isNonEmptyString = (arg: unknown): arg is string =>
+    typeof arg === "string" && arg !== "";
+
+  const getCdkContext = (): Record<string, unknown> | undefined => {
+    const cdkContextEnv = process.env.CDK_CONTEXT_JSON;
+
+    return cdkContextEnv != null
+      ? (JSON.parse(cdkContextEnv) as Record<string, unknown>)
+      : undefined;
+  };
+
+  const findCliArg = (key: string): string | undefined => {
+    const index = process.argv.findIndex((arg) => arg === `--${key}`);
+
+    return index !== -1 && index + 1 < process.argv.length
+      ? process.argv[index + 1]
+      : undefined;
+  };
+
+  const argSources = [
+    findCliArg(cliArg),
+    getCdkContext()?.[cliArg] as string | undefined,
+    process.env[processEnvName],
+    defaultValue,
+  ];
+
+  for (const arg of argSources) {
+    if (isNonEmptyString(arg)) {
+      return arg;
+    }
+  }
+
+  throw new Error(
+    `--${cliArg} CLI argument or ${processEnvName} env var required.`
+  );
+};

services/core/helpers/env-helpers/getRegion.ts

@@ -0,0 +1,9 @@
+import { defaultRegion } from "./config";
+import { getArg } from "./getArg";
+
+export const getRegion = (): string =>
+  getArg({
+    cliArg: "region",
+    processEnvName: "REGION",
+    defaultValue: defaultRegion,
+  });

services/core/helpers/env-helpers/getStage.ts

@@ -0,0 +1,10 @@
+import { defaultStage } from "./config";
+import { getArg } from "./getArg";
+
+export const getStage = (): string => {
+  return getArg({
+    cliArg: "stage",
+    processEnvName: "STAGE",
+    defaultValue: defaultStage,
+  });
+};

services/core/helpers/env-helpers/index.ts

@@ -0,0 +1,6 @@
+export * from "./buildResourceName";
+export * from "./config";
+export * from "./environment";
+export * from "./getArg";
+export * from "./getRegion";
+export * from "./getStage";

services/core/helpers/index.ts

@@ -1,5 +1,6 @@
 export * from "./certificates";
 export * from "./domains";
 export * from "./env-helpers";
+export * from "./env-helpers/environment";
 export * from "./format-response";
-export * from "./environment";
+export * from "./lambda";