CNI: Support defining on-prem connections inline (#389)

Author: pattra

packages/spectral/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.13.0",
+  "version": "10.14.0",
   "description": "Utility library for building Prismatic connectors and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",

packages/spectral/src/serverTypes/convertIntegration.test.ts

@@ -1,6 +1,7 @@
 import { describe, expect, it } from "@jest/globals";
 import { configPage, configVar, flow } from "..";
-import { convertConfigPages, convertFlow } from "./convertIntegration";
+import { convertConfigPages, convertFlow, convertConfigVar } from "./convertIntegration";
+import type { ConfigVar } from "../types";
 
 describe("convertFlow with polling triggers", () => {
   const baseFlowInput = {
@@ -146,3 +147,132 @@ describe("convertConfigPages", () => {
     expect(result[0].elements).toHaveLength(0);
   });
 });
+
+describe("convertConfigVar", () => {
+  const referenceKey = "test-component";
+  const componentRegistry = {};
+
+  describe("onPremConnectionConfig validation", () => {
+    it("should return onPremiseConnectionConfig when connection has onPremControlled inputs and config set", () => {
+      const connectionConfigVar = {
+        stableKey: "test-connection",
+        dataType: "connection",
+        onPremConnectionConfig: "allowed",
+        inputs: {
+          host: {
+            label: "Host",
+            type: "string",
+            onPremControlled: true,
+          },
+          port: {
+            label: "Port",
+            type: "string",
+            onPremControlled: true,
+          },
+        },
+      } as ConfigVar;
+
+      const result = convertConfigVar(
+        "TestConnection",
+        connectionConfigVar,
+        referenceKey,
+        componentRegistry,
+      );
+      expect("onPremiseConnectionConfig" in result && result.onPremiseConnectionConfig).toBe(
+        "allowed",
+      );
+    });
+
+    it("should throw when connection has onPremControlled inputs but no onPremConnectionConfig", () => {
+      const connectionConfigVar = {
+        stableKey: "test-connection",
+        dataType: "connection",
+        inputs: {
+          host: {
+            label: "Host",
+            type: "string",
+            onPremControlled: true,
+          },
+          port: {
+            label: "Port",
+            type: "string",
+            onPremControlled: true,
+          },
+        },
+      } as ConfigVar;
+
+      expect(() =>
+        convertConfigVar("TestConnection", connectionConfigVar, referenceKey, componentRegistry),
+      ).toThrow(
+        "Connection test-connection has onPremControlled inputs but no onPremConnectionConfig value set",
+      );
+    });
+
+    it("should default to 'disallowed' when connection has no onPremControlled inputs and no config", () => {
+      const connectionConfigVar = {
+        stableKey: "test-connection",
+        dataType: "connection",
+        inputs: {
+          apiKey: {
+            label: "API Key",
+            type: "string",
+          },
+        },
+      } as ConfigVar;
+
+      const result = convertConfigVar(
+        "TestConnection",
+        connectionConfigVar,
+        referenceKey,
+        componentRegistry,
+      );
+      expect("onPremiseConnectionConfig" in result && result.onPremiseConnectionConfig).toBe(
+        "disallowed",
+      );
+    });
+
+    it("should allow 'disallowed' config when connection has no onPremControlled inputs", () => {
+      const connectionConfigVar = {
+        stableKey: "test-connection",
+        dataType: "connection",
+        onPremConnectionConfig: "disallowed",
+        inputs: {
+          apiKey: {
+            label: "API Key",
+            type: "string",
+          },
+        },
+      } as ConfigVar;
+
+      const result = convertConfigVar(
+        "TestConnection",
+        connectionConfigVar,
+        referenceKey,
+        componentRegistry,
+      );
+      expect("onPremiseConnectionConfig" in result && result.onPremiseConnectionConfig).toBe(
+        "disallowed",
+      );
+    });
+
+    it("should throw when connection has defined config but no onPremControlled inputs", () => {
+      const connectionConfigVar = {
+        stableKey: "test-connection",
+        dataType: "connection",
+        onPremConnectionConfig: "allowed",
+        inputs: {
+          apiKey: {
+            label: "API Key",
+            type: "string",
+          },
+        },
+      } as ConfigVar;
+
+      expect(() =>
+        convertConfigVar("TestConnection", connectionConfigVar, referenceKey, componentRegistry),
+      ).toThrow(
+        "Connection test-connection has onPremConnectionConfig set but no onPremControlled inputs",
+      );
+    });
+  });
+});

packages/spectral/src/serverTypes/convertIntegration.ts

@@ -39,6 +39,7 @@ import {
   PollingTriggerType,
   StandardTriggerType,
   TriggerPerformFunction,
+  OnPremiseConnectionConfigTypeEnum,
 } from "../types";
 import {
   Component as ServerComponent,
@@ -751,6 +752,34 @@ export const convertInputValue = (value: unknown, collectionType: CollectionType
   }));
 };
 
+const validateOnPremConnectionConfig = (
+  connection: ConfigVar,
+): OnPremiseConnectionConfigTypeEnum => {
+  if (isConnectionDefinitionConfigVar(connection)) {
+    const hasOnPremControlledInputs = Object.values(connection.inputs).some((value) => {
+      return "onPremControlled" in value && value.onPremControlled;
+    });
+
+    const { onPremConnectionConfig: config } = connection;
+
+    if (hasOnPremControlledInputs && !config) {
+      throw new Error(
+        `Connection ${connection.stableKey} has onPremControlled inputs but no onPremConnectionConfig value set. Please set an onPremConnectionConfig value for the connection.`,
+      );
+    }
+
+    if (!hasOnPremControlledInputs && config && config !== "disallowed") {
+      throw new Error(
+        `Connection ${connection.stableKey} has onPremConnectionConfig set but no onPremControlled inputs. The connection will not be valid without onPremControlled inputs (host, port).`,
+      );
+    }
+
+    return hasOnPremControlledInputs && config ? config : "disallowed";
+  }
+
+  return "disallowed";
+};
+
 /** Converts a Config Var into the structure necessary for YAML generation. */
 export const convertConfigVar = (
   key: string,
@@ -781,6 +810,7 @@ export const convertConfigVar = (
       description,
       key,
       dataType: "connection",
+      onPremiseConnectionConfig: validateOnPremConnectionConfig(configVar),
       connection: {
         key: camelCase(key),
         component: codeNativeIntegrationComponentReference(referenceKey),

packages/spectral/src/types/ConfigVars.ts

@@ -296,12 +296,15 @@ type BaseConnectionConfigVar = BaseConfigVar & {
   dataType: "connection";
 };
 
+export type OnPremiseConnectionConfigTypeEnum = "allowed" | "disallowed" | "required";
+
 type ConnectionDefinitionConfigVar =
   ConnectionDefinition extends infer TConnectionDefinitionType extends ConnectionDefinition
     ? TConnectionDefinitionType extends infer TConnectionDefinition extends ConnectionDefinition
       ? BaseConnectionConfigVar &
           Omit<TConnectionDefinition, "inputs" | "display" | "key"> & {
             icons?: TConnectionDefinition["display"]["icons"];
+            onPremConnectionConfig?: OnPremiseConnectionConfigTypeEnum;
             inputs: {
               [Key in keyof TConnectionDefinition["inputs"]]: TConnectionDefinition["inputs"][Key] &
                 ConfigVarInputVisibility;
@@ -310,8 +313,6 @@ type ConnectionDefinitionConfigVar =
       : never
     : never;
 
-type OnPremiseConnectionConfigTypeEnum = "allowed" | "disallowed" | "required";
-
 type ConnectionReferenceConfigVar = ComponentRegistryConnection extends infer TConnectionReference
   ? TConnectionReference extends ComponentRegistryConnection
     ? BaseConnectionConfigVar & {