@kapeta/local-cluster-service 0.12.1 → 0.13.0

package/dist/esm/src/assetManager.js

@@ -41,6 +41,9 @@ class AssetManager {
             stdTTL: 60 * 60, // 1 hour
         });
     }
+    clearCache() {
+        this.cache.flushAll();
+    }
     /**
      *
      * @param {string[]} [assetKinds]
@@ -70,22 +73,26 @@ class AssetManager {
         }
         return asset.data;
     }
-    async getAsset(ref, noCache = false) {
+    async getAsset(ref, noCache = false, autoFetch = true) {
         ref = normalizeKapetaUri(ref);
         const cacheKey = `getAsset:${ref}`;
         if (!noCache && this.cache.has(cacheKey)) {
             return this.cache.get(cacheKey);
         }
         const uri = parseKapetaUri(ref);
-        await repositoryManager.ensureAsset(uri.handle, uri.name, uri.version);
+        if (autoFetch) {
+            await repositoryManager.ensureAsset(uri.handle, uri.name, uri.version, true);
+        }
         let asset = definitionsManager
             .getDefinitions()
             .map(enrichAsset)
             .find((a) => parseKapetaUri(a.ref).equals(uri));
-        if (!asset) {
+        if (autoFetch && !asset) {
             throw new Error('Asset not found: ' + ref);
         }
-        this.cache.set(cacheKey, asset);
+        if (asset) {
+            this.cache.set(cacheKey, asset);
+        }
         return asset;
     }
     async createAsset(path, yaml) {
@@ -146,5 +153,14 @@ class AssetManager {
         this.cache.flushAll();
         await Actions.uninstall(progressListener, [asset.ref]);
     }
+    async installAsset(ref) {
+        const asset = await this.getAsset(ref, true, false);
+        if (asset) {
+            throw new Error('Asset already installed: ' + ref);
+        }
+        const uri = parseKapetaUri(ref);
+        console.log('Installing %s', ref);
+        return await repositoryManager.ensureAsset(uri.handle, uri.name, uri.version, false);
+    }
 }
 export const assetManager = new AssetManager();

package/dist/esm/src/assets/routes.js

@@ -34,8 +34,15 @@ router.get('/read', async (req, res) => {
         res.status(400).send({ error: 'Query parameter "ref" is missing' });
         return;
     }
+    const ensure = req.query.ensure !== 'false';
     try {
-        res.send(await assetManager.getAsset(req.query.ref, true));
+        const asset = await assetManager.getAsset(req.query.ref, true, ensure);
+        if (asset) {
+            res.send(asset);
+        }
+        else {
+            res.status(404).send({ error: 'Asset not found' });
+        }
     }
     catch (err) {
         res.status(400).send({ error: err.message });
@@ -109,4 +116,18 @@ router.put('/import', async (req, res) => {
         res.status(400).send({ error: err.message });
     }
 });
+router.put('/install', async (req, res) => {
+    if (!req.query.ref) {
+        res.status(400).send({ error: 'Query parameter "ref" is missing' });
+        return;
+    }
+    try {
+        const tasks = await assetManager.installAsset(req.query.ref);
+        const taskIds = tasks?.map((t) => t.id) ?? [];
+        res.status(200).send(taskIds);
+    }
+    catch (err) {
+        res.status(400).send({ error: err.message });
+    }
+});
 export default router;

package/dist/esm/src/containerManager.js

@@ -9,8 +9,8 @@ import ClusterConfiguration from '@kapeta/local-cluster-config';
 import uuid from 'node-uuid';
 import md5 from 'md5';
 import { getBlockInstanceContainerName } from './utils/utils';
-import { socketManager } from './socketManager';
 import { KapetaAPI } from '@kapeta/nodejs-api-client';
+import { taskManager } from './taskManager';
 const EVENT_IMAGE_PULL = 'docker-image-pull';
 export const CONTAINER_LABEL_PORT_PREFIX = 'kapeta_port-';
 const NANO_SECOND = 1000000;
@@ -156,120 +156,141 @@ class ContainerManager {
             console.log('Image found: %s', image);
             return false;
         }
-        const timeStarted = Date.now();
-        socketManager.emitGlobal(EVENT_IMAGE_PULL, { image, percent: -1 });
-        const api = new KapetaAPI();
-        const accessToken = await api.getAccessToken();
-        const auth = image.startsWith('docker.kapeta.com/')
-            ? {
-                username: 'kapeta',
-                password: accessToken,
-                serveraddress: 'docker.kapeta.com',
-            }
-            : {};
-        const stream = (await this.docker().image.create(auth, {
-            fromImage: imageName,
-            tag: tag,
-        }));
-        const chunks = {};
-        let lastEmitted = Date.now();
-        await promisifyStream(stream, (rawData) => {
-            const lines = rawData.toString().trim().split('\n');
-            lines.forEach((line) => {
-                const data = JSON.parse(line);
-                if (![
-                    'Waiting',
-                    'Downloading',
-                    'Extracting',
-                    'Download complete',
-                    'Pull complete',
-                    'Already exists',
-                ].includes(data.status)) {
-                    return;
-                }
-                if (!chunks[data.id]) {
-                    chunks[data.id] = {
-                        downloading: {
-                            total: 0,
-                            current: 0,
-                        },
-                        extracting: {
-                            total: 0,
-                            current: 0,
-                        },
-                        done: false,
-                    };
-                }
-                const chunk = chunks[data.id];
-                switch (data.status) {
-                    case 'Downloading':
-                        chunk.downloading = data.progressDetail;
-                        break;
-                    case 'Extracting':
-                        chunk.extracting = data.progressDetail;
-                        break;
-                    case 'Download complete':
-                        chunk.downloading.current = chunks[data.id].downloading.total;
-                        break;
-                    case 'Pull complete':
-                        chunk.extracting.current = chunks[data.id].extracting.total;
-                        chunk.done = true;
-                        break;
-                    case 'Already exists':
-                        // Force layer to be done
-                        chunk.downloading.current = 1;
-                        chunk.downloading.total = 1;
-                        chunk.extracting.current = 1;
-                        chunk.extracting.total = 1;
-                        chunk.done = true;
-                        break;
-                }
-            });
-            if (Date.now() - lastEmitted < 1000) {
-                return;
-            }
-            const chunkList = Object.values(chunks);
-            let totals = {
-                downloading: {
-                    total: 0,
-                    current: 0,
-                },
-                extracting: {
-                    total: 0,
-                    current: 0,
-                },
-                total: chunkList.length,
-                done: 0,
-            };
-            chunkList.forEach((chunk) => {
-                if (chunk.downloading.current > 0) {
-                    totals.downloading.current += chunk.downloading.current;
-                }
-                if (chunk.downloading.total > 0) {
-                    totals.downloading.total += chunk.downloading.total;
-                }
-                if (chunk.extracting.current > 0) {
-                    totals.extracting.current += chunk.extracting.current;
+        let friendlyImageName = image;
+        const imageParts = imageName.split('/');
+        if (imageParts.length > 2) {
+            //Strip the registry to make the name shorter
+            friendlyImageName = `${imageParts.slice(1).join('/')}:${tag}`;
+        }
+        const taskName = `Pulling image ${friendlyImageName}`;
+        const processor = async (task) => {
+            const timeStarted = Date.now();
+            const api = new KapetaAPI();
+            const accessToken = await api.getAccessToken();
+            const auth = image.startsWith('docker.kapeta.com/')
+                ? {
+                    username: 'kapeta',
+                    password: accessToken,
+                    serveraddress: 'docker.kapeta.com',
                 }
-                if (chunk.extracting.total > 0) {
-                    totals.extracting.total += chunk.extracting.total;
-                }
-                if (chunk.done) {
-                    totals.done++;
+                : {};
+            const stream = (await this.docker().image.create(auth, {
+                fromImage: imageName,
+                tag: tag,
+            }));
+            const chunks = {};
+            let lastEmitted = Date.now();
+            await promisifyStream(stream, (rawData) => {
+                const lines = rawData.toString().trim().split('\n');
+                lines.forEach((line) => {
+                    const data = JSON.parse(line);
+                    if (![
+                        'Waiting',
+                        'Downloading',
+                        'Extracting',
+                        'Download complete',
+                        'Pull complete',
+                        'Already exists',
+                    ].includes(data.status)) {
+                        return;
+                    }
+                    if (!chunks[data.id]) {
+                        chunks[data.id] = {
+                            downloading: {
+                                total: 0,
+                                current: 0,
+                            },
+                            extracting: {
+                                total: 0,
+                                current: 0,
+                            },
+                            done: false,
+                        };
+                    }
+                    const chunk = chunks[data.id];
+                    switch (data.status) {
+                        case 'Downloading':
+                            chunk.downloading = data.progressDetail;
+                            break;
+                        case 'Extracting':
+                            chunk.extracting = data.progressDetail;
+                            break;
+                        case 'Download complete':
+                            chunk.downloading.current = chunks[data.id].downloading.total;
+                            break;
+                        case 'Pull complete':
+                            chunk.extracting.current = chunks[data.id].extracting.total;
+                            chunk.done = true;
+                            break;
+                        case 'Already exists':
+                            // Force layer to be done
+                            chunk.downloading.current = 1;
+                            chunk.downloading.total = 1;
+                            chunk.extracting.current = 1;
+                            chunk.extracting.total = 1;
+                            chunk.done = true;
+                            break;
+                    }
+                });
+                if (Date.now() - lastEmitted < 1000) {
+                    return;
                 }
+                const chunkList = Object.values(chunks);
+                let totals = {
+                    downloading: {
+                        total: 0,
+                        current: 0,
+                    },
+                    extracting: {
+                        total: 0,
+                        current: 0,
+                    },
+                    total: chunkList.length,
+                    done: 0,
+                };
+                chunkList.forEach((chunk) => {
+                    if (chunk.downloading.current > 0) {
+                        totals.downloading.current += chunk.downloading.current;
+                    }
+                    if (chunk.downloading.total > 0) {
+                        totals.downloading.total += chunk.downloading.total;
+                    }
+                    if (chunk.extracting.current > 0) {
+                        totals.extracting.current += chunk.extracting.current;
+                    }
+                    if (chunk.extracting.total > 0) {
+                        totals.extracting.total += chunk.extracting.total;
+                    }
+                    if (chunk.done) {
+                        totals.done++;
+                    }
+                });
+                const progress = totals.total > 0 ? (totals.done / totals.total) * 100 : 0;
+                task.metadata = {
+                    ...task.metadata,
+                    image,
+                    progress,
+                    status: totals,
+                    timeTaken: Date.now() - timeStarted,
+                };
+                task.emitUpdate();
+                lastEmitted = Date.now();
+                //console.log('Pulling image %s: %s % [done: %s, total: %s]', image, Math.round(percent), totals.done, totals.total);
             });
-            const percent = totals.total > 0 ? (totals.done / totals.total) * 100 : 0;
-            //We emit at most every second to not spam the client
-            socketManager.emitGlobal(EVENT_IMAGE_PULL, {
+            task.metadata = {
+                ...task.metadata,
                 image,
-                percent,
-                status: totals,
+                progress: 100,
                 timeTaken: Date.now() - timeStarted,
-            });
-            lastEmitted = Date.now();
-            //console.log('Pulling image %s: %s % [done: %s, total: %s]', image, Math.round(percent), totals.done, totals.total);
+            };
+            task.emitUpdate();
+        };
+        const task = taskManager.add(`docker:image:pull:${image}`, processor, {
+            name: taskName,
+            image,
+            progress: -1,
         });
-        socketManager.emitGlobal(EVENT_IMAGE_PULL, { image, percent: 100, timeTaken: Date.now() - timeStarted });
+        await task.wait();
         return true;
     }
     toDockerMounts(mounts) {

package/dist/esm/src/instanceManager.d.ts

@@ -1,4 +1,5 @@
 import { InstanceInfo, LogEntry } from './types';
+import { Task } from './taskManager';
 export declare class InstanceManager {
     private _interval;
     private readonly _instances;
@@ -18,11 +19,11 @@ export declare class InstanceManager {
     registerInstanceFromSDK(systemId: string, instanceId: string, info: Omit<InstanceInfo, 'systemId' | 'instanceId'>): Promise<InstanceInfo | undefined>;
     private getHealthUrl;
     markAsStopped(systemId: string, instanceId: string): Promise<void>;
-    startAllForPlan(systemId: string): Promise<InstanceInfo[]>;
+    startAllForPlan(systemId: string): Promise<Task<InstanceInfo[]>>;
     stop(systemId: string, instanceId: string): Promise<void>;
     private stopInner;
-    stopAllForPlan(systemId: string): Promise<void>;
-    start(systemId: string, instanceId: string): Promise<InstanceInfo>;
+    stopAllForPlan(systemId: string): Task<void>;
+    start(systemId: string, instanceId: string): Promise<InstanceInfo | Task<InstanceInfo>>;
     /**
      * Stops an instance but does not remove it from the list of active instances
      *

package/dist/esm/src/instanceManager.js

@@ -13,6 +13,7 @@ import { getBlockInstanceContainerName, normalizeKapetaUri } from './utils/utils
 import { KIND_OPERATOR, operatorManager } from './operatorManager';
 import { parseKapetaUri } from '@kapeta/nodejs-utils';
 import { definitionsManager } from './definitionsManager';
+import { Task, taskManager } from './taskManager';
 const CHECK_INTERVAL = 5000;
 const DEFAULT_HEALTH_PORT_TYPE = 'rest';
 const EVENT_STATUS_CHANGED = 'status-changed';
@@ -211,27 +212,37 @@ export class InstanceManager {
         systemId = normalizeKapetaUri(systemId);
         const plan = await assetManager.getPlan(systemId, true);
         if (!plan) {
-            throw new Error('Plan not found: ' + systemId);
+            throw new Error(`Plan not found: ${systemId}`);
         }
         if (!plan.spec.blocks) {
-            console.warn('No blocks found in plan', systemId);
-            return [];
+            throw new Error(`No blocks found in plan: ${systemId}`);
         }
-        let promises = [];
-        let errors = [];
-        for (let blockInstance of Object.values(plan.spec.blocks)) {
-            try {
-                promises.push(this.start(systemId, blockInstance.id));
+        return taskManager.add(`plan:start:${systemId}`, async () => {
+            let promises = [];
+            let errors = [];
+            for (let blockInstance of Object.values(plan.spec.blocks)) {
+                try {
+                    promises.push(this.start(systemId, blockInstance.id).then((taskOrInstance) => {
+                        if (taskOrInstance instanceof Task) {
+                            return taskOrInstance.wait();
+                        }
+                        return taskOrInstance;
+                    }));
+                }
+                catch (e) {
+                    errors.push(e);
+                }
             }
-            catch (e) {
-                errors.push(e);
+            const settled = await Promise.allSettled(promises);
+            if (errors.length > 0) {
+                throw errors[0];
             }
-        }
-        const settled = await Promise.allSettled(promises);
-        if (errors.length > 0) {
-            throw errors[0];
-        }
-        return settled.map((p) => (p.status === 'fulfilled' ? p.value : null)).filter((p) => !!p);
+            return settled
+                .map((p) => (p.status === 'fulfilled' ? p.value : null))
+                .filter((p) => !!p);
+        }, {
+            name: `Starting plan ${systemId}`,
+        });
     }
     async stop(systemId, instanceId) {
         return this.stopInner(systemId, instanceId, true);
@@ -288,10 +299,14 @@ export class InstanceManager {
             }
         });
     }
-    async stopAllForPlan(systemId) {
+    stopAllForPlan(systemId) {
         systemId = normalizeKapetaUri(systemId);
         const instancesForPlan = this._instances.filter((instance) => instance.systemId === systemId);
-        return this.stopInstances(instancesForPlan);
+        return taskManager.add(`plan:stop:${systemId}`, async () => {
+            return this.stopInstances(instancesForPlan);
+        }, {
+            name: `Stopping plan ${systemId}`,
+        });
     }
     async start(systemId, instanceId) {
         return this.exclusive(systemId, instanceId, async () => {
@@ -367,47 +382,53 @@ export class InstanceManager {
                 }
             }
             const instanceConfig = await configManager.getConfigForSection(systemId, instanceId);
-            const runner = new BlockInstanceRunner(systemId);
-            const startTime = Date.now();
-            try {
-                const processInfo = await runner.start(blockRef, instanceId, instanceConfig);
-                instance.status = InstanceStatus.READY;
-                return this.saveInternalInstance({
-                    ...instance,
-                    type: processInfo.type,
-                    pid: processInfo.pid ?? -1,
-                    health: null,
-                    portType: processInfo.portType,
-                    status: InstanceStatus.READY,
-                });
-            }
-            catch (e) {
-                console.warn('Failed to start instance: ', systemId, instanceId, blockRef, e.message);
-                const logs = [
-                    {
-                        source: 'stdout',
-                        level: 'ERROR',
-                        message: e.message,
-                        time: Date.now(),
-                    },
-                ];
-                const out = await this.saveInternalInstance({
-                    ...instance,
-                    type: InstanceType.UNKNOWN,
-                    pid: null,
-                    health: null,
-                    portType: DEFAULT_HEALTH_PORT_TYPE,
-                    status: InstanceStatus.FAILED,
-                    errorMessage: e.message ?? 'Failed to start - Check logs for details.',
-                });
-                this.emitInstanceEvent(systemId, instanceId, EVENT_INSTANCE_LOG, logs[0]);
-                this.emitInstanceEvent(systemId, blockInstance.id, EVENT_INSTANCE_EXITED, {
-                    error: `Failed to start instance: ${e.message}`,
-                    status: EVENT_INSTANCE_EXITED,
-                    instanceId: blockInstance.id,
-                });
-                return out;
-            }
+            const task = taskManager.add(`instance:start:${systemId}:${instanceId}`, async () => {
+                const runner = new BlockInstanceRunner(systemId);
+                const startTime = Date.now();
+                try {
+                    const processInfo = await runner.start(blockRef, instanceId, instanceConfig);
+                    instance.status = InstanceStatus.READY;
+                    return this.saveInternalInstance({
+                        ...instance,
+                        type: processInfo.type,
+                        pid: processInfo.pid ?? -1,
+                        health: null,
+                        portType: processInfo.portType,
+                        status: InstanceStatus.READY,
+                    });
+                }
+                catch (e) {
+                    console.warn('Failed to start instance: ', systemId, instanceId, blockRef, e.message);
+                    const logs = [
+                        {
+                            source: 'stdout',
+                            level: 'ERROR',
+                            message: e.message,
+                            time: Date.now(),
+                        },
+                    ];
+                    const out = await this.saveInternalInstance({
+                        ...instance,
+                        type: InstanceType.UNKNOWN,
+                        pid: null,
+                        health: null,
+                        portType: DEFAULT_HEALTH_PORT_TYPE,
+                        status: InstanceStatus.FAILED,
+                        errorMessage: e.message ?? 'Failed to start - Check logs for details.',
+                    });
+                    this.emitInstanceEvent(systemId, instanceId, EVENT_INSTANCE_LOG, logs[0]);
+                    this.emitInstanceEvent(systemId, blockInstance.id, EVENT_INSTANCE_EXITED, {
+                        error: `Failed to start instance: ${e.message}`,
+                        status: EVENT_INSTANCE_EXITED,
+                        instanceId: blockInstance.id,
+                    });
+                    return out;
+                }
+            }, {
+                name: `Starting instance: ${instance.name}`,
+                systemId,
+            });
+            return task;
         });
     }
     /**

package/dist/esm/src/instances/routes.js

@@ -5,6 +5,7 @@ import { corsHandler } from '../middleware/cors';
 import { kapetaHeaders } from '../middleware/kapeta';
 import { stringBody } from '../middleware/stringBody';
 import { DesiredInstanceStatus, InstanceOwner, InstanceType } from '../types';
+import { Task } from '../taskManager';
 const router = Router();
 router.use('/', corsHandler);
 router.use('/', kapetaHeaders);
@@ -24,33 +25,40 @@ router.get('/:systemId/instances', (req, res) => {
  * Start all instances in a plan
  */
 router.post('/:systemId/start', async (req, res) => {
-    const instances = await instanceManager.startAllForPlan(req.params.systemId);
+    const task = await instanceManager.startAllForPlan(req.params.systemId);
     res.status(202).send({
         ok: true,
-        processes: instances.map((p) => {
-            return { pid: p.pid, type: p.type };
-        }),
+        taskId: task.id,
     });
 });
 /**
  * Stop all instances in plan
  */
 router.post('/:systemId/stop', async (req, res) => {
-    await instanceManager.stopAllForPlan(req.params.systemId);
+    const task = instanceManager.stopAllForPlan(req.params.systemId);
     res.status(202).send({
         ok: true,
+        taskId: task.id,
     });
 });
 /**
  * Start single instance in a plan
  */
 router.post('/:systemId/:instanceId/start', async (req, res) => {
-    const process = await instanceManager.start(req.params.systemId, req.params.instanceId);
-    res.status(202).send({
-        ok: true,
-        pid: process.pid,
-        type: process.type,
-    });
+    const result = await instanceManager.start(req.params.systemId, req.params.instanceId);
+    if (result instanceof Task) {
+        res.status(202).send({
+            ok: true,
+            taskId: result.id,
+        });
+    }
+    else {
+        res.status(202).send({
+            ok: true,
+            pid: result.pid,
+            type: result.type,
+        });
+    }
 });
 /**
  * Stop single instance in a plan

package/dist/esm/src/operatorManager.d.ts

@@ -1,10 +1,12 @@
+import { DefinitionInfo } from '@kapeta/local-cluster-config';
 import { ContainerInfo } from './containerManager';
 import { EnvironmentType, OperatorInfo } from './types';
 export declare const KIND_OPERATOR = "core/resource-type-operator";
 declare class Operator {
-    private _data;
-    constructor(data: any);
-    getData(): any;
+    private readonly _data;
+    constructor(data: DefinitionInfo);
+    getLocalData(): any;
+    getDefinitionInfo(): DefinitionInfo;
     getCredentials(): any;
 }
 declare class OperatorManager {