@kapeta/local-cluster-service 0.12.1 → 0.13.0

package/src/operatorManager.ts

@@ -12,21 +12,26 @@ import { definitionsManager } from './definitionsManager';
 import { getBindHost, normalizeKapetaUri } from './utils/utils';
 import _ from 'lodash';
 import AsyncLock from 'async-lock';
+import { taskManager } from './taskManager';
 
 export const KIND_OPERATOR = 'core/resource-type-operator';
 
 class Operator {
-    private _data: any;
-    constructor(data: any) {
+    private readonly _data: DefinitionInfo;
+    constructor(data: DefinitionInfo) {
         this._data = data;
     }
 
-    getData() {
+    getLocalData() {
+        return this._data.definition.spec.local;
+    }
+
+    getDefinitionInfo() {
         return this._data;
     }
 
     getCredentials() {
-        return this._data.credentials;
+        return this._data.definition.spec.local.credentials;
     }
 }
 
@@ -72,7 +77,7 @@ class OperatorManager {
             throw new Error(`Operator missing local definition: ${resourceType}:${version}`);
         }
 
-        return new Operator(operator.definition.spec.local);
+        return new Operator(operator);
     }
 
     /**
@@ -161,7 +166,7 @@ class OperatorManager {
         return await this.operatorLock.acquire(key, async () => {
             const operator = this.getOperator(resourceType, version);
 
-            const operatorData = operator.getData();
+            const operatorData = operator.getLocalData();
 
             const portTypes = Object.keys(operatorData.ports);
 
@@ -203,6 +208,8 @@ class OperatorManager {
                 kapeta: 'true',
             };
 
+            const operatorMetadata = operator.getDefinitionInfo().definition.metadata;
+
             const bindHost = getBindHost();
 
             const ExposedPorts: { [key: string]: any } = {};
@@ -225,30 +232,41 @@ class OperatorManager {
                 Env.push(name + '=' + value);
             });
 
-            let HealthCheck = undefined;
-
-            if (operatorData.health) {
-                HealthCheck = containerManager.toDockerHealth(operatorData.health);
-            }
-
-            const container = await containerManager.ensureContainer({
-                name: containerName,
-                Image: operatorData.image,
-                Hostname: containerName + '.kapeta',
-                Labels,
-                Cmd: operatorData.cmd,
-                ExposedPorts,
-                Env,
-                HealthCheck,
-                HostConfig: {
-                    PortBindings,
-                    Mounts,
+            const task = taskManager.add(
+                `operator:ensure:${key}`,
+                async () => {
+                    let HealthCheck = undefined;
+
+                    if (operatorData.health) {
+                        HealthCheck = containerManager.toDockerHealth(operatorData.health);
+                    }
+
+                    const container = await containerManager.ensureContainer({
+                        name: containerName,
+                        Image: operatorData.image,
+                        Hostname: containerName + '.kapeta',
+                        Labels,
+                        Cmd: operatorData.cmd,
+                        ExposedPorts,
+                        Env,
+                        HealthCheck,
+                        HostConfig: {
+                            PortBindings,
+                            Mounts,
+                        },
+                    });
+
+                    await containerManager.waitForReady(container);
+
+                    return new ContainerInfo(container);
                 },
-            });
-
-            await containerManager.waitForReady(container);
+                {
+                    name: `Ensuring ${operatorMetadata.title ?? operatorMetadata.name}`,
+                    systemId,
+                }
+            );
 
-            return new ContainerInfo(container);
+            return task.wait();
         });
     }
 }

package/src/providerManager.ts

@@ -23,7 +23,7 @@ class ProviderManager {
             return FSExtra.readFile(this._webAssetCache[id], 'utf8');
         }
 
-        await repositoryManager.ensureAsset(handle, name, version);
+        await repositoryManager.ensureAsset(handle, name, version, true);
 
         const installedProvider = this.getWebProviders().find((providerDefinition) => {
             return providerDefinition.definition.metadata.name === fullName && providerDefinition.version === version;

package/src/repositoryManager.ts

@@ -10,6 +10,9 @@ import { progressListener } from './progressListener';
 import { Dependency } from '@kapeta/schemas';
 import { Actions, Config, RegistryService } from '@kapeta/nodejs-registry-utils';
 import { definitionsManager } from './definitionsManager';
+import { Task, taskManager } from './taskManager';
+import { normalizeKapetaUri } from './utils/utils';
+import { assetManager } from './assetManager';
 
 const INSTALL_ATTEMPTED: { [p: string]: boolean } = {};
 
@@ -18,14 +21,12 @@ class RepositoryManager {
     private _registryService: RegistryService;
     private _cache: { [key: string]: boolean };
     private watcher?: () => void;
-    private _installQueue: (() => Promise<void>)[];
-    private _processing: boolean = false;
+
     constructor() {
         this.changeEventsEnabled = true;
         this.listenForChanges();
         this._registryService = new RegistryService(Config.data.registry.url);
         this._cache = {};
-        this._installQueue = [];
     }
 
     setChangeEventsEnabled(enabled: boolean) {
@@ -113,75 +114,69 @@ class RepositoryManager {
         this.watcher = undefined;
     }
 
-    private async _install(refs: string[]): Promise<void> {
+    private async _install(refs: string[]): Promise<Task[]> {
         //We make sure to only install one asset at a time - otherwise unexpected things might happen
-        const out = new Promise<void>((resolve, reject) => {
-            this._installQueue.push(async () => {
+        const createInstaller = (ref: string) => {
+            return async () => {
+                if (INSTALL_ATTEMPTED[ref]) {
+                    return;
+                }
+
+                if (definitionsManager.exists(ref)) {
+                    return;
+                }
+                console.log(`Installing asset: ${ref}`);
+                INSTALL_ATTEMPTED[ref] = true;
+                //Auto-install missing asset
                 try {
-                    const normalizedRefs = refs.map((ref) => parseKapetaUri(ref).id);
-                    const filteredRefs = normalizedRefs
-                        .filter((ref) => !INSTALL_ATTEMPTED[ref])
-                        .filter((ref) => !definitionsManager.exists(ref));
-                    if (filteredRefs.length > 0) {
-                        console.log(`Auto-installing dependencies: ${filteredRefs.join(', ')}`);
-                        filteredRefs.forEach((ref) => (INSTALL_ATTEMPTED[ref] = true));
-                        //Auto-install missing asset
-                        try {
-                            //We change to a temp dir to avoid issues with the current working directory
-                            process.chdir(os.tmpdir());
-                            //Disable change events while installing
-                            this.setChangeEventsEnabled(false);
-                            socketManager.emit(`install`, 'install:action', {
-                                type: 'start',
-                                refs,
-                            });
-                            await Actions.install(progressListener, normalizedRefs, {});
-                            socketManager.emit(`install`, 'install:action', {
-                                type: 'done',
-                                refs,
-                            });
-                        } catch (e: any) {
-                            socketManager.emit(`install`, 'install:action', {
-                                type: 'failed',
-                                refs,
-                                error: e.message,
-                            });
-                        } finally {
-                            this.setChangeEventsEnabled(true);
-                        }
-                    }
-                    resolve();
-                } catch (e) {
-                    reject(e);
+                    //We change to a temp dir to avoid issues with the current working directory
+                    process.chdir(os.tmpdir());
+                    //Disable change events while installing
+                    this.setChangeEventsEnabled(false);
+                    await Actions.install(progressListener, [ref], {});
                 } finally {
-                    this._processNext().catch((e) => console.error(e));
+                    this.setChangeEventsEnabled(true);
                 }
-            });
-        });
+                definitionsManager.clearCache();
+                assetManager.clearCache();
+                console.log(`Asset installed: ${ref}`);
+            };
+        };
 
-        this._processNext().catch((e) => console.error(e));
+        const tasks: Task[] = [];
 
-        return out;
-    }
+        while (refs.length > 0) {
+            let ref = refs.shift();
+            if (!ref) {
+                continue;
+            }
+            ref = normalizeKapetaUri(ref);
 
-    async _processNext() {
-        if (this._processing) {
-            return;
-        }
-        this._processing = true;
-        try {
-            while (this._installQueue.length > 0) {
-                const item = this._installQueue.shift();
-                if (item) {
-                    await item();
-                }
+            if (INSTALL_ATTEMPTED[ref]) {
+                continue;
             }
-        } finally {
-            this._processing = false;
+
+            if (definitionsManager.exists(ref)) {
+                continue;
+            }
+
+            const task = taskManager.add(`asset:install:${ref}`, createInstaller(ref), {
+                name: `Installing ${ref}`,
+                group: 'asset:install:',
+            });
+
+            tasks.push(task);
         }
+
+        return tasks;
     }
 
-    async ensureAsset(handle: string, name: string, version: string) {
+    async ensureAsset(
+        handle: string,
+        name: string,
+        version: string,
+        wait: boolean = true
+    ): Promise<undefined | Task[]> {
         const fullName = `${handle}/${name}`;
         const ref = `${fullName}:${version}`;
 
@@ -219,15 +214,22 @@ class RepositoryManager {
         }
 
         this._cache[ref] = true;
+        let tasks: Task[] | undefined = undefined;
         if (!installedAsset) {
-            await this._install([ref]);
+            tasks = await this._install([ref]);
         } else {
             //Ensure dependencies are installed
             const refs = assetVersion.dependencies.map((dep: Dependency) => dep.name);
             if (refs.length > 0) {
-                await this._install(refs);
+                tasks = await this._install(refs);
             }
         }
+
+        if (tasks && wait) {
+            await Promise.all(tasks.map((t) => t.future.promise));
+        }
+
+        return tasks;
     }
 }
 

package/src/socketManager.ts

@@ -32,7 +32,7 @@ export class SocketManager {
     }
 
     emitGlobal(type: string, payload: any) {
-        this.io.emit(type, { payload });
+        this.io.emit(type, payload);
     }
 
     _bindIO() {

package/src/taskManager.ts

@@ -0,0 +1,225 @@
+/**
+ * Class that handles processing background tasks.
+ */
+import { socketManager } from './socketManager';
+
+const EVENT_TASK_UPDATED = 'task-updated';
+const EVENT_TASK_ADDED = 'task-added';
+const EVENT_TASK_REMOVED = 'task-removed';
+
+export type TaskRunner<T> = (task: Task<T>) => Promise<T>;
+
+export enum TaskStatus {
+    PENDING = 'PENDING',
+    RUNNING = 'RUNNING',
+    COMPLETED = 'COMPLETED',
+    FAILED = 'FAILED',
+}
+
+interface Future<T = void> {
+    promise: Promise<T>;
+    resolve: (result: T) => void;
+    reject: (e: any) => void;
+}
+
+interface TaskMetadata {
+    name: string;
+    /**
+     * A unique prefix for the task. If defined only 1 task with this ID prefix will be executed at a time
+     */
+    group?: string;
+    progress?: number;
+
+    [key: string]: any;
+}
+
+interface TaskData<T = void> {
+    id: string;
+    status: TaskStatus;
+    errorMessage?: string;
+    metadata: TaskMetadata;
+    future: Future<T>;
+    run: TaskRunner<T>;
+}
+
+export class Task<T = void> implements TaskData<T> {
+    private data: TaskData<T>;
+
+    constructor(task: TaskData<T>) {
+        this.data = task;
+    }
+
+    get id() {
+        return this.data.id;
+    }
+
+    get status() {
+        return this.data.status;
+    }
+
+    get errorMessage() {
+        return this.data.errorMessage;
+    }
+
+    get metadata() {
+        return this.data.metadata;
+    }
+
+    get future() {
+        return this.data.future;
+    }
+
+    get run() {
+        return this.data.run;
+    }
+
+    set status(status: TaskStatus) {
+        this.data.status = status;
+    }
+
+    set errorMessage(errorMessage: string | undefined) {
+        this.data.errorMessage = errorMessage;
+    }
+
+    set metadata(metadata: TaskMetadata) {
+        this.data.metadata = metadata;
+    }
+
+    public emitUpdate() {
+        socketManager.emitGlobal(EVENT_TASK_UPDATED, this.toData());
+    }
+
+    async wait(): Promise<T> {
+        return this.future.promise;
+    }
+
+    toData() {
+        return { ...this.data };
+    }
+}
+
+function createFuture<T>(): Future<T> {
+    let resolve: (arg: T) => void = () => {};
+    let reject: () => void = () => {};
+    const promise = new Promise<T>((res, rej) => {
+        resolve = res;
+        reject = rej;
+    });
+
+    return {
+        promise,
+        resolve,
+        reject,
+    };
+}
+
+class TaskManager {
+    private _tasks: Task<any>[] = [];
+
+    public add<T>(id: string, runner: TaskRunner<T>, metadata: TaskMetadata): Task<T> {
+        const existingTask = this.get(id);
+        if (existingTask) {
+            return existingTask;
+        }
+
+        const future = createFuture<T>();
+
+        const task = new Task<T>({
+            id,
+            status: TaskStatus.PENDING,
+            metadata,
+            future,
+            run: runner,
+        });
+
+        this._tasks.push(task);
+
+        socketManager.emitGlobal(EVENT_TASK_ADDED, task.toData());
+
+        this.invokeTask(task).catch(() => {});
+
+        return task;
+    }
+
+    async waitFor(filter: (task: Task<any>) => boolean) {
+        const tasks = this._tasks.filter(filter);
+        while (tasks.length > 0) {
+            const task = tasks.shift();
+            if (!task) {
+                continue;
+            }
+            try {
+                await task.wait();
+            } catch (e) {
+                //Ignore
+            }
+        }
+    }
+
+    public get(taskId: string) {
+        return this._tasks.find((t) => t.id === taskId);
+    }
+
+    public exists(taskId: string) {
+        return !!this.get(taskId);
+    }
+
+    public remove(taskId: string) {
+        const task = this.get(taskId);
+        if (!task) {
+            return;
+        }
+
+        if (task.status === TaskStatus.RUNNING) {
+            throw new Error('Cannot remove a running task');
+        }
+
+        this._tasks = this._tasks.filter((t) => t.id !== taskId);
+        socketManager.emitGlobal(EVENT_TASK_REMOVED, task.toData());
+    }
+
+    public list(): TaskData[] {
+        return this._tasks.map((t) => t.toData());
+    }
+
+    private async invokeTask(task: Task<any>): Promise<void> {
+        if (task.metadata.group) {
+            const existingTaskInGroup = this._tasks.find(
+                (t) => t.id !== task.id && t.metadata.group === task.metadata.group && t.status === TaskStatus.RUNNING
+            );
+
+            if (existingTaskInGroup) {
+                console.log('existingTaskInGroup', existingTaskInGroup.toData());
+                return;
+            }
+        }
+
+        try {
+            task.status = TaskStatus.RUNNING;
+            task.emitUpdate();
+            const result = await task.run(task);
+            task.status = TaskStatus.COMPLETED;
+            task.future.resolve(result);
+            task.emitUpdate();
+        } catch (e: any) {
+            task.errorMessage = e.message;
+            task.status = TaskStatus.FAILED;
+            task.future.reject(e);
+            task.emitUpdate();
+        } finally {
+            this.remove(task.id);
+        }
+
+        if (task.metadata.group) {
+            const nextTaskInGroup = this._tasks.find(
+                (t) => t.id !== task.id && t.metadata.group === task.metadata.group && t.status === TaskStatus.PENDING
+            );
+            if (nextTaskInGroup) {
+                console.log('nextTaskInGroup', nextTaskInGroup.toData());
+                return this.invokeTask(nextTaskInGroup);
+            }
+        }
+    }
+}
+
+export const taskManager = new TaskManager();

package/src/tasks/routes.ts

@@ -0,0 +1,38 @@
+import Router from 'express-promise-router';
+import { Request, Response } from 'express';
+
+import { corsHandler } from '../middleware/cors';
+import { taskManager } from '../taskManager';
+
+const router = Router();
+
+router.use('/', corsHandler);
+
+/**
+ * Get all current tasks
+ */
+router.get('/', (req: Request, res: Response) => {
+    res.send(taskManager.list());
+});
+
+router.get('/:taskId', (req: Request, res: Response) => {
+    const task = taskManager.get(req.params.taskId);
+    if (!task) {
+        res.status(404).send({ error: 'Task not found' });
+        return;
+    }
+
+    res.send(task.toData());
+});
+
+router.delete('/:taskId', (req: Request, res: Response) => {
+    try {
+        taskManager.remove(req.params.taskId);
+        res.send({ ok: true });
+    } catch (e: any) {
+        res.status(400).send({ error: e.message });
+        return;
+    }
+});
+
+export default router;

package/src/utils/BlockInstanceRunner.ts

@@ -5,12 +5,10 @@ import { KapetaURI, parseKapetaUri } from '@kapeta/nodejs-utils';
 import { serviceManager } from '../serviceManager';
 import { containerManager, DockerMounts, toLocalBindVolume } from '../containerManager';
 import { LogData } from './LogData';
-import EventEmitter from 'events';
 import { clusterService } from '../clusterService';
 import { AnyMap, BlockProcessParams, InstanceType, ProcessInfo, StringMap } from '../types';
 import { Container } from 'node-docker-api/lib/container';
 import { definitionsManager } from '../definitionsManager';
-import md5 from 'md5';
 
 const KIND_BLOCK_TYPE_OPERATOR = 'core/block-type-operator';
 const KAPETA_SYSTEM_ID = 'KAPETA_SYSTEM_ID';