fix user mounted file paths for ddn workspace (#97)

Author: m-Bilal

src/app/context.ts

@@ -40,6 +40,9 @@ const FUNCTIONS_TS_FILE_TEMPLATE_FILE_NAME = "functions.ejs"; // name of the tem
 
 const NODE_VERSION = "node20";
 
+const OPENAPI_SWAGGER_FILE_NAME = "swagger.json";
+const DEFAULT_CONFIGURATION_DIRECTORY = "/etc/connector/";
+
 /**
  * Context is a singleton class that holds the configuration of the app
  */
@@ -189,4 +192,29 @@ export class Context {
   public getNodeVersion(): string {
     return NODE_VERSION;
   }
+
+  /**
+   * Use this function to get filepaths for user files relating to the connector
+   * The DDN CLI is responsible for setting the correct env vars
+   * The reason we need this correction is because the filepaths can change on whether the connector is being run via the CLI or via the Docker image
+   */
+  public getUserMountedFilePath(): string {
+    // Check for HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH environment variable
+    if (process.env.HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH) {
+      return process.env.HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH;
+    }
+
+    // Check for HASURA_CONFIGURATION_DIRECTORY environment variable
+    if (process.env.HASURA_CONFIGURATION_DIRECTORY) {
+      return process.env.HASURA_CONFIGURATION_DIRECTORY;
+    }
+
+    // If neither variable is present, log warning and return default path
+    logger.warn(`Neither HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH nor HASURA_CONFIGURATION_DIRECTORY environment variables are set. Using default path (${DEFAULT_CONFIGURATION_DIRECTORY}).`);
+    return DEFAULT_CONFIGURATION_DIRECTORY;
+  }
+
+  public getDefaultOpenapiDocumentFileUri(): string {
+    return path.join(this.getUserMountedFilePath(), OPENAPI_SWAGGER_FILE_NAME);
+  }
 }

src/app/writer/index.ts

@@ -6,6 +6,7 @@ import * as types from "../types";
 import * as logger from "../../util/logger";
 import { exit } from "process";
 import { execSync } from "child_process";
+import * as context from "../context";
 
 export async function writeToFileSystem(codeToWrite: types.GeneratedCode[]) {
   try {
@@ -22,12 +23,8 @@ export async function writeToFileSystem(codeToWrite: types.GeneratedCode[]) {
     await functionsWriter.writeToFileSystem(functionsTsCode, apiTsCode);
 
     logger.info("running npm install :: installing dependencies");
-    if (process.env.HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH) {
-      execSync("npm install ", { stdio: "inherit", cwd: process.env.HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH });
-    } else {
-      execSync("npm install ", { stdio: "inherit" });
-    }
-    
+    const mountedPath = context.getInstance().getUserMountedFilePath();
+    execSync("npm install ", { stdio: "inherit", cwd: mountedPath });
     logger.info("all dependencies installed");
   } catch (e) {
     if (e instanceof apiWriter.SimilarFileContentsError) {

src/cli/init.ts

@@ -1,6 +1,7 @@
 import { Command } from "commander";
 import { resolve } from "path";
 import * as logger from "../util/logger";
+import * as context from "../app/context";
 
 export const cmd = new Command("init")
   .description(
@@ -15,13 +16,13 @@ Further reading:
   )
   .option(
     "--open-api <value>",
-    "URI of OAS Document. Defaults to /etc/connector/swagger.json",
-    "/etc/connector/swagger.json",
+    `URI of OAS Document. Defaults to ${context.getInstance().getDefaultOpenapiDocumentFileUri()}`,
+    context.getInstance().getDefaultOpenapiDocumentFileUri(),
   )
   .option(
     "--out-dir <value>",
-    "Output Directory. Defaults to /etc/connector/",
-    "/etc/connector/",
+    `Output Directory. Defaults to ${context.getInstance().getUserMountedFilePath()}`,
+    context.getInstance().getUserMountedFilePath(),
   )
   .action((args, cmd) => {
     main(args.openApi, resolve(args.outDir));

src/cli/update.ts

@@ -18,14 +18,14 @@ Further reading:
   .addOption(
     new Option(
       "--open-api <uri or filepath>",
-      "URI or file path of OAS Document. Usually ${HASURA_CONFIGURATION_DIRECTORY}/swagger.json",
+      `URI or file path of OAS Document. Defaults to ${context.getInstance().getDefaultOpenapiDocumentFileUri()}`,
     )
-      .default("./swagger.json")
+      .default(context.getInstance().getDefaultOpenapiDocumentFileUri())
       .env("NDC_OAS_DOCUMENT_URI"),
   )
   .addOption(
-    new Option("--output-directory <directory>", "Output Directory")
-      .default("./")
+    new Option("--output-directory <directory>", `Output Directory. Defaults to ${context.getInstance().getUserMountedFilePath()}`)
+      .default(context.getInstance().getUserMountedFilePath())
       .env("HASURA_CONFIGURATION_DIRECTORY"),
   )
   .addOption(