feat: Add internal options to engine create (#89)

Author: ptiurin

src/service/engine/index.ts

@@ -22,6 +22,10 @@ export class EngineService {
     auto_stop: "AUTO_STOP"
   };
 
+  private INTERNAL_OPTIONS: Record<string, string> = {
+    FB_INTERNAL_OPTIONS_ENGINE_VERSION: "VERSION"
+  };
+
   constructor(context: ResourceManagerContext) {
     this.context = context;
   }
@@ -128,6 +132,18 @@ export class EngineService {
     }
   }
 
+  private getInternalOptions() {
+    const internalOptions: Record<string, string> = {};
+    for (const [env, optionName] of Object.entries(this.INTERNAL_OPTIONS)) {
+      const optionValue = process.env[env];
+      if (optionValue) {
+        internalOptions[optionName] = optionValue;
+        console.log(`Setting internal option ${optionName} to ${optionValue}`);
+      }
+    }
+    return internalOptions;
+  }
+
   async create(
     name: string,
     options: CreateEngineOptions = {}
@@ -149,20 +165,34 @@ export class EngineService {
         ? this.CREATE_PARAMETER_NAMES_V2
         : this.CREATE_PARAMETER_NAMES;
 
-    if (Object.values(createOptions).some(v => v !== undefined)) {
+    const internalOptions = this.getInternalOptions();
+
+    // Exlude options that are not set or not allowed for the account version
+    const filteredCreateOptions = Object.fromEntries(
+      Object.entries(createOptions).filter(
+        ([key, value]) => value !== undefined && key in createParameterNames
+      )
+    );
+
+    if (Object.keys(filteredCreateOptions).length > 0 || internalOptions) {
       query += " WITH ";
-      for (const [key, value] of Object.entries(createOptions)) {
-        if (key in createParameterNames) {
-          if (key == "spec" && accountVersion >= 2) {
-            // spec value is provided raw without quotes for accounts v2
-            query += `${createParameterNames[key]} = ${value} `;
-          } else {
-            query += `${createParameterNames[key]} = ?`;
-            queryParameters.push(value);
-          }
-        }
+    }
+
+    for (const [key, value] of Object.entries(filteredCreateOptions)) {
+      if (key == "spec" && accountVersion >= 2) {
+        // spec value is provided raw without quotes for accounts v2
+        query += `${createParameterNames[key]} = ${value} `;
+      } else {
+        query += `${createParameterNames[key]} = ? `;
+        queryParameters.push(value);
       }
     }
+
+    for (const [key, value] of Object.entries(internalOptions)) {
+      query += `${key} = ? `;
+      queryParameters.push(value);
+    }
+
     await this.context.connection.execute(query, {
       parameters: queryParameters
     });

test/unit/v2/engine.test.ts

@@ -6,7 +6,7 @@ import { Firebolt, QueryFormatter } from "../../../src";
 import { ResourceManager } from "../../../src/service";
 import { ConnectionError, DeprecationError } from "../../../src/common/errors";
 import { NodeHttpClient } from "../../../src/http/node";
-import { Authenticator} from "../../../src/auth";
+import { Authenticator } from "../../../src/auth";
 
 const apiEndpoint = "api.fake.firebolt.io";
 
@@ -225,7 +225,7 @@ describe("engine service", () => {
         client_id: "id",
         client_secret: "secret"
       }
-    }
+    };
     const firebolt = Firebolt({ apiEndpoint });
     const connection = await firebolt.connect(connectionOptions);
     // Also test diffrent way of instantiating a resource manager
@@ -367,9 +367,70 @@ describe("engine service", () => {
     try {
       await engine.delete();
       expect(false).toBeTruthy();
-    }
-    catch (e) {
+    } catch (e) {
       expect(true).toBeTruthy();
     }
   });
+  it("create engine with options", async () => {
+    server.use(
+      rest.post(
+        `https://some_system_engine.com/${QUERY_URL}`,
+        async (req, res, ctx) => {
+          const requestBody = await req.text();
+          if (requestBody.includes("CREATE ENGINE")) {
+            expect(requestBody).toContain(`ENGINE_TYPE = 'GENERAL_PURPOSE'`);
+            expect(requestBody).not.toContain(`REGION`);
+          }
+          return res(ctx.json(selectEngineResponse));
+        }
+      )
+    );
+    const firebolt = Firebolt({ apiEndpoint });
+    await firebolt.connect({
+      account: "my_account",
+      auth: {
+        client_id: "id",
+        client_secret: "secret"
+      }
+    });
+    const resourceManager = firebolt.resourceManager;
+    const engine = await resourceManager.engine.create("some_engine", {
+      region: undefined,
+      engine_type: "GENERAL_PURPOSE"
+    });
+    expect(engine).toBeTruthy();
+    expect(engine.endpoint).toEqual("https://some_engine.com");
+  });
+  it("create engine with environment variable", async () => {
+    const engine_version = "20.1.1";
+    server.use(
+      rest.post(
+        `https://some_system_engine.com/${QUERY_URL}`,
+        async (req, res, ctx) => {
+          const requestBody = await req.text();
+          if (requestBody.includes("CREATE ENGINE")) {
+            expect(requestBody).toContain(`VERSION = '${engine_version}'`);
+          }
+          return res(ctx.json(selectEngineResponse));
+        }
+      )
+    );
+    const firebolt = Firebolt({ apiEndpoint });
+    await firebolt.connect({
+      account: "my_account",
+      auth: {
+        client_id: "id",
+        client_secret: "secret"
+      }
+    });
+    const resourceManager = firebolt.resourceManager;
+
+    process.env.FB_INTERNAL_OPTIONS_ENGINE_VERSION = engine_version;
+
+    const engine = await resourceManager.engine.create("some_engine");
+    expect(engine).toBeTruthy();
+    expect(engine.endpoint).toEqual("https://some_engine.com");
+
+    delete process.env.ENGINE_NAME;
+  });
 });