Specify Adapter when sending Sequence

Author: patuwwy

packages/api-client/src/host-client.ts

@@ -80,7 +80,7 @@ export class HostClient implements ClientProvider {
      */
     async sendSequence(
         sequencePackage: Parameters<HttpClient["sendStream"]>[1],
-        requestInit?: RequestInit,
+        requestInit: RequestInit = {},
         update?: boolean
     ): Promise<SequenceClient> {
         const response = await this.client.sendStream<any>("sequence", sequencePackage, requestInit, {

packages/cli/src/lib/commands/sequence.ts

@@ -78,10 +78,11 @@ export const sequence: CommandDefinition = (program) => {
         .command("send")
         .argument("<package>", "The file or directory to upload or '-' to use the last packed. If directory, it will be packed and sent.")
         .option("--name <name>", "Allows to name sequence")
+        .option("--runtime-adapter <adapter>", "STH will try to use Adapter with this name or it's default when Adapter name is not provided.")
         .description("Send the Sequence package to the Hub")
         .action(
-            async (sequencePackage: string, { name }) => {
-                const sequenceClient = await sequenceSendPackage(sequencePackage, { name }, false, { progress: sequenceCmd.parent?.getOptionValue("progress") });
+            async (sequencePackage: string, { name, runtimeAdapter })=> {
+                const sequenceClient = await sequenceSendPackage(sequencePackage, { name, runtimeAdapter }, false, { progress: sequenceCmd.parent?.getOptionValue("progress") });
 
                 displayObject(sequenceClient, profileManager.getProfileConfig().format);
             }
@@ -233,3 +234,4 @@ export const sequence: CommandDefinition = (program) => {
             displayMessage("Sequences removed successfully.");
         });
 };
+

packages/cli/src/lib/helpers/sequence.ts

@@ -20,6 +20,7 @@ const { F_OK, R_OK } = constants;
 
 type SequenceUploadOptions = {
     name?: string;
+    runtimeAdapter?: string;
 }
 
 /**
@@ -134,6 +135,10 @@ export const sequenceSendPackage = async (
                 headers["x-name"] = options.name;
             }
 
+            if (options.runtimeAdapter) {
+                headers["x-runtime-adapter"] = options.runtimeAdapter;
+            }
+
             seq = await getHostClient().sendSequence(
                 sequenceStream,
                 { headers }

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

@@ -6,7 +6,7 @@ export type InitializedRuntimeAdapter = IRuntimeAdapter & {
     status: "ready" | { error?: string };
 };
 
-export type AdaptersStore = { [key: string]: InitializedRuntimeAdapter };
+export type AdaptersStore = Record<string, InitializedRuntimeAdapter>;
 
 export class AdapterManager {
     adapters: AdaptersStore = {};
@@ -112,6 +112,12 @@ export class AdapterManager {
         return Object.values(this.adapters).find(a => a.moduleName === moduleName);
     }
 
+    /**
+     * Returns first Adapter with "ready" status if prefferedAdapter is "detect".
+     * Returns Adapter with name provided by prefferedAdapter.
+     * @param prefferedAdapter
+     * @returns
+     */
     getDefaultAdapter(prefferedAdapter: string) {
         if (prefferedAdapter === "detect") {
             return Object.values(this.adapters).filter(adapter => adapter.status === "ready")[0];

packages/host/src/lib/host.ts

@@ -767,11 +767,12 @@ export class Host implements IComponent {
         stream.params ||= {};
 
         const sequenceName = stream.params.id_name || stream.headers["x-name"];
+        const requestedAdapter = stream.headers["x-runtime-adapter"] as string;
 
-        this.logger.info("New Sequence incoming", { name: sequenceName });
+        this.logger.info("New Sequence incoming", { name: sequenceName, requestedAdapter });
 
         try {
-            const adapter = this.adapterManager.getDefaultAdapter(this.adapterName);
+            const adapter = this.adapterManager.getDefaultAdapter(requestedAdapter || this.adapterName);
 
             if (!adapter) {
                 return {
@@ -1004,7 +1005,7 @@ export class Host implements IComponent {
      * @param {STHRestAPI.StartSequencePayload} payload App start configuration.
      */
     async startCSIController(sequence: SequenceInfo, payload: STHRestAPI.StartSequencePayload): Promise<CSIController> {
-        const adapter = this.adapterManager.getDefaultAdapter(this.adapterName);
+        const adapter = this.adapterManager.getDefaultAdapter(sequence.config.type || this.adapterName);
 
         if (!adapter) {
             throw new Error("Failed to use adapter");

packages/types/src/runner-config.ts

@@ -45,6 +45,6 @@ export type KubernetesSequenceConfig = CommonSequenceConfig & {
     type: "kubernetes"
 }
 
-export type SequenceConfig = DockerSequenceConfig | ProcessSequenceConfig | KubernetesSequenceConfig
+export type SequenceConfig = DockerSequenceConfig | ProcessSequenceConfig | KubernetesSequenceConfig;
 
 export type InstanceConfig = SequenceConfig & { instanceAdapterExitDelay: number, limits: InstanceLimits }