Adjust IRuntimeAdapter interface

Author: patuwwy

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

@@ -1,13 +1,11 @@
 import { STHConfiguration,
     ExitCode,
-    IComponent,
-    ILifeCycleAdapterMain,
-    ILifeCycleAdapterRun,
     InstanceConfig,
     InstanceLimits,
     IObjectLogger,
     MonitoringMessageData,
-    SequenceConfig
+    SequenceConfig,
+    IInstanceAdapter
 } from "@scramjet/types";
 import { ObjLogger } from "@scramjet/obj-logger";
 import { streamToString } from "@scramjet/utility";
@@ -22,10 +20,7 @@ const gotPython = "\n                              _ \n __      _____  _ __  ___
 /**
  * Adapter for running Instance by Runner executed in separate process.
  */
-class ProcessInstanceAdapter implements
-    ILifeCycleAdapterMain,
-    ILifeCycleAdapterRun,
-    IComponent {
+class ProcessInstanceAdapter implements IInstanceAdapter {
     logger: IObjectLogger;
     sthConfig: STHConfiguration;
 

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

@@ -1,9 +1,9 @@
 import {
     ProcessSequenceConfig,
     ISequenceAdapter,
-    STHConfiguration,
     SequenceConfig,
     IObjectLogger,
+    ProcessAdapterConfiguration,
 } from "@scramjet/types";
 import { ObjLogger } from "@scramjet/obj-logger";
 import { isDefined, readStreamedJSON } from "@scramjet/utility";
@@ -56,11 +56,11 @@ class ProcessSequenceAdapter implements ISequenceAdapter {
     logger: IObjectLogger;
 
     name = "ProcessSequenceAdapter";
-    config: NonNullable<STHConfiguration["adapters"]["@scramjet/adapter-process"]>;
+    config: ProcessAdapterConfiguration;
 
-    constructor(config: STHConfiguration) {
+    constructor(config: ProcessAdapterConfiguration) {
         this.logger = new ObjLogger(this);
-        this.config = config.adapters["@scramjet/adapter-process"]!;
+        this.config = config;
     }
 
     /**

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

@@ -12,7 +12,7 @@ export class AdapterManager {
     }
 
     /**
-     * Initializes configured adapters.
+     * Initializes all configured adapters.
      *
      * @returns True if any adapter is available. False otherwise.
      */
@@ -37,6 +37,7 @@ export class AdapterManager {
                     }
 
                     if (this.adapters[adapter.pkgName]) throw new Error("Invalid adapters configuration, duplicated adapter name");
+
                     this.adapters[adapter.pkgName] = adapter;
                 }
             )
@@ -48,23 +49,41 @@ export class AdapterManager {
             this.logger.info(`${adaptersCount} Adapters available:`, this.adapters);
 
             return true;
-        } else {
-            this.logger.warn("No adapters defined. Sequences and Instances unsupported.");
-
-            return false;
         }
+
+        this.logger.warn("No adapters defined. Sequences and Instances unsupported.");
+
+        return false;
     }
 
+    /**
+     * Validates adapter.
+     *
+     * @param {IRuntimeAdapter} adapter Checks if adapter provides required fields.
+     * @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));
     }
 
+    /**
+     * Initializes adapter with adapter config.
+     *
+     * @param {IRuntimeAdapter} adapter Adapter to initialize
+     * @returns
+     */
     async initAdapter(adapter: IRuntimeAdapter): Promise<{ error?: string } | "ready"> {
         const initResult = await adapter.init(adapter.config);
 
         return initResult.error ? initResult : Promise.resolve("ready");
     }
 
+    /**
+     * Returns Adapter by given package name.
+     *
+     * @param {string} pkgName Adapter package name.
+     * @returns {IRuntimeAdapter} Adapter
+     */
     getAdapterByName(pkgName: string): IRuntimeAdapter | undefined {
         return Object.values(this.adapters).find(a => a.pkgName === pkgName);
     }

packages/types/src/instance-adapter.ts

@@ -1,4 +1,9 @@
 import { ILifeCycleAdapterMain, ILifeCycleAdapterRun } from "./lifecycle-adapters";
 import { IComponent } from "./component";
 
-export interface IInstanceAdapter extends ILifeCycleAdapterMain, ILifeCycleAdapterRun, IComponent {}
+export interface IInstanceAdapter extends ILifeCycleAdapterMain, ILifeCycleAdapterRun, IComponent {
+}
+
+export interface IInstanceAdapterContructor {
+    new (config: any): IInstanceAdapter
+}

packages/types/src/runtime-adapter.ts

@@ -1,16 +1,9 @@
-import { IComponent } from "./component";
-import { IInstanceAdapter } from "./instance-adapter";
-import { ILifeCycleAdapterMain, ILifeCycleAdapterRun } from "./lifecycle-adapters";
-import { ISequenceAdapter } from "./sequence-adapter";
-import { STHConfiguration } from "./sth-configuration";
+import { IInstanceAdapterContructor } from "./instance-adapter";
+import { ISequenceAdapterContructor } from "./sequence-adapter";
 
 export interface IRuntimeAdapter {
-    SequenceAdapter: ISequenceAdapter & { new (config: STHConfiguration): ISequenceAdapter };
-    InstanceAdapter:
-        ILifeCycleAdapterMain &
-        ILifeCycleAdapterRun &
-        IComponent &
-        { new (config: STHConfiguration): IInstanceAdapter };
+    SequenceAdapter: ISequenceAdapterContructor;
+    InstanceAdapter: IInstanceAdapterContructor;
     name: string;
     pkgName: string;
     init(config: any): Promise<{ error?: string }>;

packages/types/src/sequence-adapter.ts

@@ -32,3 +32,7 @@ export interface ISequenceAdapter {
 
     logger: IObjectLogger;
 }
+
+export interface ISequenceAdapterContructor {
+    new (config: any): ISequenceAdapter;
+}