feat: add encrypted deployment utility

Author: chrismclarke

packages/scripts/src/commands/deployment/common.ts

@@ -1,9 +1,13 @@
+import { existsSync } from "fs";
+import { logWarning } from "shared";
+import { readJSONSync } from "fs-extra";
+import path from "path";
+
 import { DEPLOYMENT_CONFIG_EXAMPLE_DEFAULTS, getDefaultAppConfig } from "data-models";
 import type { IDeploymentConfig, IDeploymentConfigJson } from "data-models";
-import path from "path";
 
 import { DEPLOYMENTS_PATH } from "../../paths";
-import { loadDeploymentJson } from "./utils";
+import { getStackFileNames, loadDeploymentJson } from "./utils";
 
 // re-export of type for convenience
 export type { IDeploymentConfigJson };
@@ -16,6 +20,28 @@ export function generateDeploymentConfig(name: string): IDeploymentConfig {
   return config;
 }
 
+/**
+ * Read a json file from deployment encrypted folder
+ * @param deploymentName name of deployment folder to read config from
+ * @param filename name of json to read config from (should already be decrypted)
+ * @returns parsed json if exists, null if does not exist
+ **/
+export function loadEncryptedConfig(filename: string) {
+  // Determine path to deployment config ts that called function for source of encrypted config
+  const configTsPath = getStackFileNames().find((filePath) => filePath.includes(".idems_app"));
+  const encryptedConfigPath = path.resolve(configTsPath, "../", "encrypted");
+  const target = path.resolve(encryptedConfigPath, filename);
+  if (!existsSync(target)) {
+    logWarning({
+      msg1: `Encrypted config does not exist,\nsome features may be unavailable`,
+      msg2: filename,
+    });
+    console.log(target);
+    return null;
+  }
+  return readJSONSync(target);
+}
+
 /** Load and extend an existing deployment config **/
 export function extendDeploymentConfig(options: {
   parent: string;

packages/scripts/src/commands/deployment/utils.ts

@@ -101,3 +101,24 @@ export function convertStringsToFunctions<T>(data: T) {
   });
   return data;
 }
+
+/**
+ * Utility function to determine the filename stack of current function invocation.
+ * Uses Node v8 stack trace api to determine call stacks (in same way error stacks are managed)
+ * Adapted from https://github.com/sindresorhus/callsites and https://v8.dev/docs/stack-trace-api
+ */
+export function getStackFileNames() {
+  // take a copy of default stack track prepare method to revert after use
+  const _prepareStackTrace = Error.prepareStackTrace;
+  try {
+    // alter stack trace method to remove self reference and return stack as filenames
+    Error.prepareStackTrace = (_, callSites) => {
+      return callSites.slice(1).map((callSite) => callSite.getFileName());
+    };
+    // create error to generate stacktrace and return (typed to match altered stack trace)
+    return new Error().stack as any as string[];
+  } finally {
+    // revert stack trace method
+    Error.prepareStackTrace = _prepareStackTrace;
+  }
+}