Adapters with IRuntimeAdapter interface

Author: patuwwy

package.json

@@ -104,15 +104,8 @@
   "workspaces": {
     "packages": [
       "packages/*",
-      "packages/reference-apps/*",
       "bdd/"
     ],
-    "refapps": [
-      "packages/reference-apps/*"
-    ],
-    "modules": [
-      "packages/*"
-    ],
     "bdd": [
       "bdd/"
     ]

packages/adapter-docker/src/docker-instance-adapter.ts

@@ -11,7 +11,7 @@ import {
     InstanceConfig,
     RunnerContainerConfiguration,
     InstanceLimits,
-    STHConfiguration,
+    DockerAdapterConfiguration,
 } from "@scramjet/types";
 import path from "path";
 import { DockerodeDockerHelper } from "./dockerode-docker-helper";
@@ -32,6 +32,7 @@ IComponent {
     private dockerHelper: IDockerHelper;
     private _limits?: InstanceLimits = {};
     private resources: DockerAdapterResources = {};
+
     id: string = "";
 
     logger: IObjectLogger;
@@ -41,7 +42,7 @@ IComponent {
     get limits() { return this._limits || {} as InstanceLimits; }
     private set limits(value: InstanceLimits) { this._limits = value; }
 
-    constructor(_sthConfig: STHConfiguration, id: string = "") {
+    constructor(_config: DockerAdapterConfiguration, id: string = "") {
         this.dockerHelper = new DockerodeDockerHelper();
 
         this.logger = new ObjLogger(this, { id });

packages/adapter-docker/src/index.ts

@@ -1,13 +1,39 @@
+import { DockerAdapterConfiguration, IInstanceAdapter, IRuntimeAdapter, ISequenceAdapter } from "@scramjet/types";
 import { DockerodeDockerHelper } from "./dockerode-docker-helper";
+import { DockerSequenceAdapter } from "./docker-sequence-adapter";
+import { DockerInstanceAdapter } from "./docker-instance-adapter";
 
 /**
  * Adapter module must provide SequenceAdapter, InstanceAdapter classes, init method and name field.
  */
-export { DockerSequenceAdapter as SequenceAdapter } from "./docker-sequence-adapter";
-export { DockerInstanceAdapter as InstanceAdapter } from "./docker-instance-adapter";
+export default class DockerAdapter implements IRuntimeAdapter {
+    name = "docker";
 
-export const init = async (..._args: any[]) => {
-    return await DockerodeDockerHelper.isDockerConfigured() ? {} : { error: "Docker initialization failed" };
-};
+    #_instanceAdapter: IInstanceAdapter;
+    #_sequenceAdapter: ISequenceAdapter;
 
-export const name = "docker";
+    get instanceAdapter() {
+        return this.#_instanceAdapter;
+    }
+
+    get sequenceAdapter() {
+        return this.#_sequenceAdapter;
+    }
+
+    config: DockerAdapterConfiguration;
+
+    constructor(config: DockerAdapterConfiguration) {
+        this.config = config;
+
+        this.#_instanceAdapter = new DockerInstanceAdapter(this.config);
+        this.#_sequenceAdapter = new DockerSequenceAdapter(this.config);
+    }
+
+    getSequenceAdapter(): ISequenceAdapter {
+        return this.#_sequenceAdapter;
+    }
+
+    async init(): Promise<{ error?: string }> {
+        return await DockerodeDockerHelper.isDockerConfigured() ? {} : { error: "Docker initialization failed" };
+    }
+}

packages/adapter-k8s/src/index.ts

@@ -1,11 +1,41 @@
+import { IInstanceAdapter, IRuntimeAdapter, ISequenceAdapter, K8SAdapterConfiguration } from "@scramjet/types";
+import { KubernetesInstanceAdapter } from "./kubernetes-instance-adapter";
+import { KubernetesSequenceAdapter } from "./kubernetes-sequence-adapter";
+
 /**
  * Adapter module must provide SequenceAdapter, InstanceAdapter classes, init method and name field.
  */
 export { KubernetesSequenceAdapter as SequenceAdapter } from "./kubernetes-sequence-adapter";
 export { KubernetesInstanceAdapter as InstanceAdapter } from "./kubernetes-instance-adapter";
 
-export const init = async (..._args: any[]) => {
-    return Promise.resolve({ });
-};
+export default class KubernetesAdapter implements IRuntimeAdapter {
+    name = "kubernetes";
+
+    #_instanceAdapter: IInstanceAdapter;
+    #_sequenceAdapter: ISequenceAdapter;
+
+    get instanceAdapter() {
+        return this.#_instanceAdapter;
+    }
+
+    get sequenceAdapter() {
+        return this.#_sequenceAdapter;
+    }
+
+    config: K8SAdapterConfiguration;
+
+    constructor(config: K8SAdapterConfiguration) {
+        this.config = config;
+
+        this.#_instanceAdapter = new KubernetesInstanceAdapter(this.config);
+        this.#_sequenceAdapter = new KubernetesSequenceAdapter(this.config);
+    }
+
+    getSequenceAdapter(): ISequenceAdapter {
+        return this.#_sequenceAdapter;
+    }
 
-export const name = "kubernetes";
+    async init(): Promise<{ error?: string }> {
+        return Promise.resolve({});
+    }
+}

packages/adapter-k8s/src/kubernetes-instance-adapter.ts

@@ -15,7 +15,7 @@ import path from "path";
 import { ObjLogger } from "@scramjet/obj-logger";
 import { createReadStream } from "fs";
 import { KubernetesClientAdapter } from "./kubernetes-client-adapter";
-import { adapterConfigDecoder } from "./kubernetes-config-decoder";
+//import { adapterConfigDecoder } from "./kubernetes-config-decoder";
 import { getRunnerEnvEntries } from "@scramjet/adapters-utils";
 import { PassThrough } from "stream";
 import { RunnerExitCode } from "@scramjet/symbols";
@@ -42,13 +42,13 @@ IComponent {
     constructor(config: K8SAdapterConfiguration) {
         // @TODO this is a redundant check (it was already checked in sequence adapter)
         // We should move this to config service decoding: https://github.com/scramjetorg/transform-hub/issues/279
-        const decodedAdapterConfig = adapterConfigDecoder.decode(config);
+        // const decodedAdapterConfig = adapterConfigDecoder.decode(config);
 
-        if (!decodedAdapterConfig.isOk()) {
-            throw new Error("Invalid Kubernetes Adapter configuration");
-        }
+        // if (!decodedAdapterConfig.isOk()) {
+        //     throw new Error("Invalid Kubernetes Adapter configuration");
+        // }
 
-        this.adapterConfig = decodedAdapterConfig.value;
+        this.adapterConfig = config;//decodedAdapterConfig.value;
         this.logger = new ObjLogger(this);
     }
 

packages/adapter-k8s/src/kubernetes-sequence-adapter.ts

@@ -57,7 +57,7 @@ class KubernetesSequenceAdapter implements ISequenceAdapter {
 
     private adapterConfig: K8SAdapterConfiguration;
 
-    constructor(config: KubernetesSequenceAdapter) {
+    constructor(config: K8SAdapterConfiguration) {
         const decodedAdapterConfig = adapterConfigDecoder.decode(config);
 
         if (!decodedAdapterConfig.isOk()) {

packages/adapter-process/src/index.ts

@@ -1,15 +1,43 @@
+import { IInstanceAdapter, IRuntimeAdapter, ISequenceAdapter, ProcessAdapterConfiguration } from "@scramjet/types";
+import { ProcessInstanceAdapter } from "./process-instance-adapter";
+import { ProcessSequenceAdapter } from "./process-sequence-adapter";
+
 /**
- * Adapter module must provide SequenceAdapter, InstanceAdapter classes, init method and name field.
+ * Adapter class must implement IRuntimeAdapter Interface.
  */
-export { ProcessSequenceAdapter as SequenceAdapter } from "./process-sequence-adapter";
-export { ProcessInstanceAdapter as InstanceAdapter } from "./process-instance-adapter";
 
-export const init = async (config: any) => {
-    if (!config.sequencesRoot) {
-        return Promise.reject({ error: "No 'sequencesRoot' in config" });
+export default class ProcessAdapter implements IRuntimeAdapter {
+    name = "process";
+
+    #_instanceAdapter: IInstanceAdapter;
+    #_sequenceAdapter: ISequenceAdapter;
+
+    get instanceAdapter() {
+        return this.#_instanceAdapter;
+    }
+
+    get sequenceAdapter() {
+        return this.#_sequenceAdapter;
+    }
+
+    config: ProcessAdapterConfiguration;
+
+    constructor(config: ProcessAdapterConfiguration) {
+        this.config = config;
+
+        this.#_instanceAdapter = new ProcessInstanceAdapter(this.config);
+        this.#_sequenceAdapter = new ProcessSequenceAdapter(this.config);
     }
 
-    return Promise.resolve({});
-};
+    getSequenceAdapter(): ISequenceAdapter {
+        return this.#_sequenceAdapter;
+    }
+
+    init(): Promise<{ error?: string }> {
+        if (!this.config.sequencesRoot) {
+            return Promise.reject({ error: "No 'sequencesRoot' in config" });
+        }
 
-export const name = "process";
+        return Promise.resolve({});
+    }
+}

packages/adapter-process/src/process-instance-adapter.ts

@@ -1,11 +1,12 @@
-import { STHConfiguration,
+import {
     ExitCode,
     InstanceConfig,
     InstanceLimits,
     IObjectLogger,
     MonitoringMessageData,
     SequenceConfig,
-    IInstanceAdapter
+    IInstanceAdapter,
+    ProcessAdapterConfiguration
 } from "@scramjet/types";
 import { ObjLogger } from "@scramjet/obj-logger";
 import { streamToString } from "@scramjet/utility";
@@ -22,7 +23,7 @@ const gotPython = "\n                              _ \n __      _____  _ __  ___
  */
 class ProcessInstanceAdapter implements IInstanceAdapter {
     logger: IObjectLogger;
-    sthConfig: STHConfiguration;
+    config: ProcessAdapterConfiguration;
 
     private runnerProcess?: ChildProcess;
     private crashLogStreams?: Promise<string[]>;
@@ -34,9 +35,9 @@ class ProcessInstanceAdapter implements IInstanceAdapter {
         this.logger.warn("Limits are not yet supported in process runner");
     }
 
-    constructor(config: STHConfiguration) {
+    constructor(config: ProcessAdapterConfiguration) {
         this.logger = new ObjLogger(this);
-        this.sthConfig = config;
+        this.config = config;
     }
 
     async init(): Promise<void> {
@@ -71,7 +72,7 @@ class ProcessInstanceAdapter implements IInstanceAdapter {
             this.logger.trace(gotPython);
             const runnerPath = path.resolve(__dirname, require.resolve("@scramjet/python-runner"));
 
-            if (this.sthConfig.debug)
+            if (this.config.debug)
                 debugFlags = ["-m", "pdb", "-c", "continue"];
 
             return [
@@ -82,7 +83,7 @@ class ProcessInstanceAdapter implements IInstanceAdapter {
                 "./python-runner-startup.log",
             ];
         }
-        if (this.sthConfig.debug)
+        if (this.config.debug)
             debugFlags = ["--inspect-brk=9229"];
 
         return [

packages/adapters-utils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scramjet/adapters-utils",
-  "version": "0.34.4",
+  "version": "0.35.0",
   "description": "This package is part of Scramjet Transform Hub. This module holds the docker adapters utilized by Scramjet Transform Hub",
   "main": "./src/index.ts",
   "scripts": {
@@ -15,21 +15,21 @@
   "author": "Scramjet <open-source@scramjet.org>",
   "license": "AGPL-3.0",
   "dependencies": {
-    "@scramjet/model": "^0.34.4",
-    "@scramjet/obj-logger": "^0.34.4",
-    "@scramjet/pre-runner": "^0.34.4",
-    "@scramjet/python-runner": "^0.34.4",
-    "@scramjet/runner": "^0.34.4",
-    "@scramjet/sth-config": "^0.34.4",
-    "@scramjet/symbols": "^0.34.4",
-    "@scramjet/utility": "^0.34.4",
+    "@scramjet/model": "^0.35.0",
+    "@scramjet/obj-logger": "^0.35.0",
+    "@scramjet/pre-runner": "^0.35.0",
+    "@scramjet/python-runner": "^0.35.0",
+    "@scramjet/runner": "^0.35.0",
+    "@scramjet/sth-config": "^0.35.0",
+    "@scramjet/symbols": "^0.35.0",
+    "@scramjet/utility": "^0.35.0",
     "scramjet": "^4.36.9",
     "shell-escape": "^0.2.0",
     "systeminformation": "^5.12.7",
     "ts.data.json": "^2.2.0"
   },
   "devDependencies": {
-    "@scramjet/types": "^0.34.4",
+    "@scramjet/types": "^0.35.0",
     "@types/js-yaml": "4.0.5",
     "@types/node": "15.12.5",
     "@types/request": "2.48.8",

packages/host/src/lib/adapter-manager.ts

@@ -1,8 +1,13 @@
 import { ObjLogger } from "@scramjet/obj-logger";
 import { IRuntimeAdapter, InstanceRequirements, STHConfiguration } from "@scramjet/types";
 
+export type InitializedRuntimeAdapter = IRuntimeAdapter & {
+    pkgName: string;
+    status: "ready" | { error?: string };
+};
+
 export class AdapterManager {
-    adapters: { [key: string]: IRuntimeAdapter } = {};
+    adapters: { [key: string]: InitializedRuntimeAdapter } = {};
     sthConfig: STHConfiguration;
 
     logger = new ObjLogger(this);
@@ -23,13 +28,18 @@ export class AdapterManager {
             Object.keys(this.sthConfig.adapters).map(
                 async (pkgName) => {
                     const typedPkgName = pkgName as unknown as keyof STHConfiguration["adapters"];
-                    const adapter = Object.assign(await import(pkgName), { pkgName }) as IRuntimeAdapter;
+                    const config = this.sthConfig.adapters[typedPkgName]!;
+
+                    const adapter = Object.assign(
+                        new (await import(pkgName)).default(config),
+                        { pkgName }
+                    ) as InitializedRuntimeAdapter;
 
                     if (!AdapterManager.validateAdapter(adapter)) {
                         throw new Error(`Invalid adapter provided ${adapter.pkgName}`);
                     }
 
-                    adapter.config = this.sthConfig.adapters[typedPkgName]!;
+                    adapter.config = config;
                     adapter.status = await this.initAdapter(adapter);
 
                     if (adapter.status !== "ready") {
@@ -63,7 +73,7 @@ export class AdapterManager {
      * @returns {boolean} True if required fields are available.
      */
     static validateAdapter(adapter: IRuntimeAdapter): boolean {
-        return !!(adapter.name.trim() && ["SequenceAdapter", "InstanceAdapter", "init"].every((className: string) => className in adapter));
+        return !!(adapter.name?.trim() && ["sequenceAdapter", "instanceAdapter", "init"].every((className: string) => className in adapter));
     }
 
     /**
@@ -73,7 +83,7 @@ export class AdapterManager {
      * @returns Object with error field if initialization failed, "ready" otherwise.
      */
     async initAdapter(adapter: IRuntimeAdapter): Promise<{ error?: string } | "ready"> {
-        const initResult = await adapter.init(adapter.config);
+        const initResult = await adapter.init();
 
         return initResult.error ? initResult : Promise.resolve("ready");
     }
@@ -84,7 +94,7 @@ export class AdapterManager {
      * @param {string} pkgName Adapter package name.
      * @returns {IRuntimeAdapter} Adapter
      */
-    getAdapterByName(pkgName: string): IRuntimeAdapter | undefined {
+    getAdapterByName(pkgName: string): InitializedRuntimeAdapter | undefined {
         return Object.values(this.adapters).find(a => a.pkgName === pkgName);
     }