@kapeta/local-cluster-service 0.11.1 → 0.12.0

package/dist/esm/src/utils/BlockInstanceRunner.js

@@ -194,7 +194,7 @@ export class BlockInstanceRunner {
                 `KAPETA_LOCAL_CLUSTER_PORT=${clusterService.getClusterServicePort()}`,
                 ...Object.entries({
                     ...env,
-                    ...addonEnv
+                    ...addonEnv,
                 }).map(([key, value]) => `${key}=${value}`),
             ],
             HostConfig: {
@@ -324,7 +324,7 @@ export class BlockInstanceRunner {
     async _handleContainer(container) {
         return {
             type: InstanceType.DOCKER,
-            pid: container.id
+            pid: container.id,
         };
     }
 }

package/dist/esm/src/utils/utils.js

@@ -1,7 +1,7 @@
 import FS from 'node:fs';
 import YAML from 'yaml';
 import { parseKapetaUri } from '@kapeta/nodejs-utils';
-import md5 from "md5";
+import md5 from 'md5';
 export function getBlockInstanceContainerName(systemId, instanceId) {
     return `kapeta-block-instance-${md5(systemId + instanceId)}`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kapeta/local-cluster-service",
-    "version": "0.11.1",
+    "version": "0.12.0",
     "description": "Manages configuration, ports and service discovery for locally running Kapeta systems",
     "type": "commonjs",
     "exports": {

package/src/config/routes.ts

@@ -41,7 +41,7 @@ router.put('/instance', async (req: KapetaBodyRequest, res) => {
         if (req.kapeta!.instanceId) {
             configManager.setConfigForSection(req.kapeta!.systemId, req.kapeta!.instanceId, config);
             //Restart the instance if it is running after config change
-            await instanceManager.restart(req.kapeta!.systemId, req.kapeta!.instanceId);
+            await instanceManager.prepareForRestart(req.kapeta!.systemId, req.kapeta!.instanceId);
         } else {
             configManager.setConfigForSystem(req.kapeta!.systemId, config);
         }

package/src/containerManager.ts

@@ -9,10 +9,14 @@ import ClusterConfiguration from '@kapeta/local-cluster-config';
 import { Container } from 'node-docker-api/lib/container';
 import uuid from 'node-uuid';
 import md5 from 'md5';
-import {getBlockInstanceContainerName} from "./utils/utils";
-import {InstanceInfo, LogEntry, LogSource} from "./types";
-import EventEmitter from "events";
-import {LogData} from "./utils/LogData";
+import { getBlockInstanceContainerName } from './utils/utils';
+import { InstanceInfo, LogEntry, LogSource } from './types';
+import { socketManager } from './socketManager';
+import { handlers as ArtifactHandlers } from '@kapeta/nodejs-registry-utils';
+import { progressListener } from './progressListener';
+import { KapetaAPI } from '@kapeta/nodejs-api-client';
+
+const EVENT_IMAGE_PULL = 'docker-image-pull';
 
 type StringMap = { [key: string]: string };
 
@@ -67,7 +71,7 @@ const IMAGE_PULL_CACHE: { [key: string]: number } = {};
 
 export const HEALTH_CHECK_TIMEOUT = HEALTH_CHECK_INTERVAL * HEALTH_CHECK_MAX * 2;
 
-const promisifyStream = (stream: ReadStream, handler:(d:string|Buffer) => void) =>
+const promisifyStream = (stream: ReadStream, handler: (d: string | Buffer) => void) =>
     new Promise((resolve, reject) => {
         stream.on('data', handler);
         stream.on('end', resolve);
@@ -79,6 +83,7 @@ class ContainerManager {
     private _alive: boolean;
     private _mountDir: string;
     private _version: string;
+    private _lastDockerAccessCheck: number = 0;
 
     constructor() {
         this._docker = null;
@@ -155,24 +160,27 @@ class ContainerManager {
         return this._alive;
     }
 
-    getMountPoint(systemId:string, ref: string, mountName: string) {
+    getMountPoint(systemId: string, ref: string, mountName: string) {
         const kindUri = parseKapetaUri(ref);
-        const systemUri = parseKapetaUri(systemId)
-        return Path.join(this._mountDir,
+        const systemUri = parseKapetaUri(systemId);
+        return Path.join(
+            this._mountDir,
             systemUri.handle,
             systemUri.name,
             systemUri.version,
             kindUri.handle,
             kindUri.name,
-            kindUri.version, mountName);
+            kindUri.version,
+            mountName
+        );
     }
 
-    async createMounts(systemId:string, kind: string, mountOpts: StringMap|null|undefined): Promise<StringMap> {
+    async createMounts(systemId: string, kind: string, mountOpts: StringMap | null | undefined): Promise<StringMap> {
         const mounts: StringMap = {};
 
         if (mountOpts) {
             const mountOptList = Object.entries(mountOpts);
-            for(const [mountName, containerPath] of mountOptList) {
+            for (const [mountName, containerPath] of mountOptList) {
                 const hostPath = this.getMountPoint(systemId, kind, mountName);
                 await FSExtra.mkdirp(hostPath);
                 mounts[containerPath] = hostPath;
@@ -238,23 +246,153 @@ class ContainerManager {
             return false;
         }
 
-        console.log('Pulling image: %s', image);
-        const stream = await this.docker()
-            .image.create(
-                {},
-                {
-                    fromImage: imageName,
-                    tag: tag,
+        const timeStarted = Date.now();
+        socketManager.emitGlobal(EVENT_IMAGE_PULL, { image, percent: 0 });
+
+        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,
+        })) as ReadStream;
+
+        const chunks: {
+            [p: string]: {
+                downloading: {
+                    total: number;
+                    current: number;
+                };
+                extracting: {
+                    total: number;
+                    current: number;
+                };
+                done: boolean;
+            };
+        } = {};
+
+        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++;
                 }
-            ) as ReadStream;
+            });
 
-        await promisifyStream(stream, (chunk) => {
-            console.log('Data from docker: "%s"', chunk.toString());
+            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, {
+                image,
+                percent,
+                status: totals,
+                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);
         });
 
         IMAGE_PULL_CACHE[image] = Date.now();
 
-        console.log('Image pulled: %s', image);
+        socketManager.emitGlobal(EVENT_IMAGE_PULL, { image, percent: 100, timeTaken: Date.now() - timeStarted });
 
         return true;
     }
@@ -305,12 +443,7 @@ class ContainerManager {
     }
 
     private async createOrUpdateContainer(opts: any) {
-        let imagePulled = false;
-        try {
-            imagePulled = await this.pull(opts.Image);
-        } catch (e) {
-            console.warn('Failed to pull image. Continuing...', e);
-        }
+        let imagePulled = await this.pull(opts.Image);
 
         this.applyHash(opts);
         if (!opts.name) {
@@ -448,24 +581,27 @@ class ContainerManager {
         return new ContainerInfo(dockerContainer);
     }
 
-    async getLogs(instance: InstanceInfo):Promise<LogEntry[]> {
+    async getLogs(instance: InstanceInfo): Promise<LogEntry[]> {
         const containerName = getBlockInstanceContainerName(instance.systemId, instance.instanceId);
         const containerInfo = await this.getContainerByName(containerName);
         if (!containerInfo) {
-            return [{
-                source: "stdout",
-                level: "ERROR",
-                time: Date.now(),
-                message: "Container not found"
-            }];
+            return [
+                {
+                    source: 'stdout',
+                    level: 'ERROR',
+                    time: Date.now(),
+                    message: 'Container not found',
+                },
+            ];
         }
 
-        return containerInfo.getLogs()
+        return containerInfo.getLogs();
     }
 }
 
 export class ContainerInfo {
     private readonly _container: Container;
+
     /**
      *
      * @param {Container} dockerContainer
@@ -572,21 +708,20 @@ export class ContainerInfo {
         return ports;
     }
 
-    async getLogs():Promise<LogEntry[]> {
-
-        const logStream = await this.native.logs({
+    async getLogs(): Promise<LogEntry[]> {
+        const logStream = (await this.native.logs({
             stdout: true,
             stderr: true,
             follow: false,
             tail: 100,
             timestamps: true,
-        })  as ReadStream;
+        })) as ReadStream;
 
         const out = [] as LogEntry[];
         await promisifyStream(logStream, (data) => {
             const buf = data as Buffer;
             let offset = 0;
-            while(offset < buf.length) {
+            while (offset < buf.length) {
                 try {
                     // Read the docker log format - explained here:
                     // https://docs.docker.com/engine/api/v1.41/#operation/ContainerAttach
@@ -594,7 +729,7 @@ export class ContainerInfo {
 
                     // First byte is stream type
                     const streamTypeInt = buf.readInt8(offset);
-                    const streamType:LogSource = streamTypeInt === 1 ? 'stdout' : 'stderr';
+                    const streamType: LogSource = streamTypeInt === 1 ? 'stdout' : 'stderr';
 
                     // Bytes 4-8 is frame size
                     const messageLength = buf.readInt32BE(offset + 4);
@@ -619,7 +754,7 @@ export class ContainerInfo {
                     });
                 } catch (err) {
                     console.error('Error parsing log entry', err);
-                    offset = buf.length
+                    offset = buf.length;
                 }
             }
         });

package/src/definitionsManager.ts

@@ -1,5 +1,5 @@
 import ClusterConfiguration, { DefinitionInfo } from '@kapeta/local-cluster-config';
-import {parseKapetaUri} from "@kapeta/nodejs-utils";
+import { parseKapetaUri } from '@kapeta/nodejs-utils';
 
 const CACHE_TTL = 60 * 1000; // 1 min
 
@@ -48,15 +48,19 @@ class DefinitionsManager {
     }
 
     public exists(ref: string) {
-        const uri = parseKapetaUri(ref);
-        return !!this.getDefinitions().find((d) => {
-            return parseKapetaUri(`${d.definition.metadata.name}:${d.version}`).id === uri.id;
-        });
+        return !!this.getDefinition(ref);
     }
 
     public getProviderDefinitions() {
         return this.doCached('providers', () => ClusterConfiguration.getProviderDefinitions());
     }
+
+    public getDefinition(ref: string) {
+        const uri = parseKapetaUri(ref);
+        return this.getDefinitions().find((d) => {
+            return parseKapetaUri(`${d.definition.metadata.name}:${d.version}`).id === uri.id;
+        });
+    }
 }
 
 export const definitionsManager = new DefinitionsManager();

package/src/instanceManager.ts

@@ -9,8 +9,11 @@ import { assetManager } from './assetManager';
 import { containerManager, HEALTH_CHECK_TIMEOUT } from './containerManager';
 import { configManager } from './configManager';
 import { DesiredInstanceStatus, InstanceInfo, InstanceOwner, InstanceStatus, InstanceType, LogEntry } from './types';
-import { BlockInstance } from '@kapeta/schemas';
+import { BlockDefinitionSpec, BlockInstance } from '@kapeta/schemas';
 import { getBlockInstanceContainerName, normalizeKapetaUri } from './utils/utils';
+import { KIND_OPERATOR, operatorManager } from './operatorManager';
+import { parseKapetaUri } from '@kapeta/nodejs-utils';
+import { definitionsManager } from './definitionsManager';
 
 const CHECK_INTERVAL = 5000;
 const DEFAULT_HEALTH_PORT_TYPE = 'rest';
@@ -26,7 +29,7 @@ export class InstanceManager {
 
     private readonly _instances: InstanceInfo[] = [];
 
-    private readonly instanceLocks:AsyncLock = new AsyncLock();
+    private readonly instanceLocks: AsyncLock = new AsyncLock();
 
     constructor() {
         this._instances = storageService.section('instances', []);
@@ -70,15 +73,16 @@ export class InstanceManager {
         return this._instances.find((i) => i.systemId === systemId && i.instanceId === instanceId);
     }
 
-
     private async exclusive<T = any>(systemId: string, instanceId: string, fn: () => Promise<T>) {
         systemId = normalizeKapetaUri(systemId);
         const key = `${systemId}/${instanceId}`;
-        return this.instanceLocks.acquire(key, fn);
+        //console.log(`Acquiring lock for ${key}`, this.instanceLocks.isBusy(key));
+        const result = await this.instanceLocks.acquire(key, fn);
+        //console.log(`Releasing lock for ${key}`, this.instanceLocks.isBusy(key));
+        return result;
     }
 
-
-    public async getLogs(systemId: string, instanceId: string):Promise<LogEntry[]> {
+    public async getLogs(systemId: string, instanceId: string): Promise<LogEntry[]> {
         const instance = this.getInstance(systemId, instanceId);
         if (!instance) {
             throw new Error(`Instance ${systemId}/${instanceId} not found`);
@@ -86,23 +90,27 @@ export class InstanceManager {
 
         switch (instance.type) {
             case InstanceType.DOCKER:
-                 return await containerManager.getLogs(instance);
+                return await containerManager.getLogs(instance);
 
             case InstanceType.UNKNOWN:
-                return [{
-                    level: 'INFO',
-                    message: 'Instance is starting...',
-                    time: Date.now(),
-                    source: 'stdout',
-                }];
+                return [
+                    {
+                        level: 'INFO',
+                        message: 'Instance is starting...',
+                        time: Date.now(),
+                        source: 'stdout',
+                    },
+                ];
 
             case InstanceType.LOCAL:
-                return [{
-                    level: 'INFO',
-                    message: 'Instance started outside Kapeta - logs not available...',
-                    time: Date.now(),
-                    source: 'stdout',
-                }];
+                return [
+                    {
+                        level: 'INFO',
+                        message: 'Instance started outside Kapeta - logs not available...',
+                        time: Date.now(),
+                        source: 'stdout',
+                    },
+                ];
         }
 
         return [];
@@ -167,7 +175,10 @@ export class InstanceManager {
             const healthUrl = this.getHealthUrl(info, address);
 
             if (instance) {
-                if (instance.status === InstanceStatus.STOPPING && instance.desiredStatus === DesiredInstanceStatus.STOP) {
+                if (
+                    instance.status === InstanceStatus.STOPPING &&
+                    instance.desiredStatus === DesiredInstanceStatus.STOP
+                ) {
                     //If instance is stopping do not interfere
                     return;
                 }
@@ -239,7 +250,7 @@ export class InstanceManager {
     public markAsStopped(systemId: string, instanceId: string) {
         return this.exclusive(systemId, instanceId, async () => {
             systemId = normalizeKapetaUri(systemId);
-            const instance = _.find(this._instances, {systemId, instanceId});
+            const instance = _.find(this._instances, { systemId, instanceId });
             if (instance && instance.owner === InstanceOwner.EXTERNAL && instance.status !== InstanceStatus.STOPPED) {
                 instance.status = InstanceStatus.STOPPED;
                 instance.pid = null;
@@ -247,7 +258,7 @@ export class InstanceManager {
                 this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
                 this.save();
             }
-        })
+        });
     }
 
     public async startAllForPlan(systemId: string): Promise<InstanceInfo[]> {
@@ -281,12 +292,11 @@ export class InstanceManager {
         return settled.map((p) => (p.status === 'fulfilled' ? p.value : null)).filter((p) => !!p) as InstanceInfo[];
     }
 
-
     public async stop(systemId: string, instanceId: string) {
         return this.stopInner(systemId, instanceId, true);
     }
 
-    private async stopInner(systemId: string, instanceId: string, changeDesired:boolean = false) {
+    private async stopInner(systemId: string, instanceId: string, changeDesired: boolean = false) {
         return this.exclusive(systemId, instanceId, async () => {
             systemId = normalizeKapetaUri(systemId);
             const instance = this.getInstance(systemId, instanceId);
@@ -298,8 +308,7 @@ export class InstanceManager {
                 return;
             }
 
-            if (changeDesired &&
-                instance.desiredStatus !== DesiredInstanceStatus.EXTERNAL) {
+            if (changeDesired && instance.desiredStatus !== DesiredInstanceStatus.EXTERNAL) {
                 instance.desiredStatus = DesiredInstanceStatus.STOP;
             }
 
@@ -359,7 +368,7 @@ export class InstanceManager {
                 throw new Error('Plan not found: ' + systemId);
             }
 
-            const blockInstance = plan.spec && plan.spec.blocks ? _.find(plan.spec.blocks, {id: instanceId}) : null;
+            const blockInstance = plan.spec && plan.spec.blocks ? _.find(plan.spec.blocks, { id: instanceId }) : null;
             if (!blockInstance) {
                 throw new Error('Block instance not found: ' + instanceId);
             }
@@ -412,6 +421,28 @@ export class InstanceManager {
             // Save the instance before starting it, so that we can track the status
             await this.saveInternalInstance(instance);
 
+            const blockSpec = blockAsset.data.spec as BlockDefinitionSpec;
+            if (blockSpec.consumers) {
+                const promises = blockSpec.consumers.map((consumer) => {
+                    const consumerUri = parseKapetaUri(consumer.kind);
+                    const asset = definitionsManager.getDefinition(consumer.kind);
+                    if (!asset) {
+                        // Definition not found
+                        return Promise.resolve();
+                    }
+
+                    if (KIND_OPERATOR.toLowerCase() !== asset.definition.kind.toLowerCase()) {
+                        // Not an operator
+                        return Promise.resolve();
+                    }
+
+                    console.log('Ensuring resource: %s in %s', consumerUri.id, systemId);
+                    return operatorManager.ensureResource(systemId, consumerUri.fullName, consumerUri.version);
+                });
+
+                await Promise.all(promises);
+            }
+
             if (existingInstance) {
                 // Check if the instance is already running - but after we've commmuicated the desired status
                 const currentStatus = await this.requestInstanceStatus(existingInstance);
@@ -439,7 +470,7 @@ export class InstanceManager {
                     status: InstanceStatus.READY,
                 });
             } catch (e: any) {
-                console.warn('Failed to start instance', e);
+                console.warn('Failed to start instance: ', systemId, instanceId, blockRef, e.message);
                 const logs: LogEntry[] = [
                     {
                         source: 'stdout',
@@ -456,6 +487,7 @@ export class InstanceManager {
                     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]);
@@ -471,17 +503,16 @@ export class InstanceManager {
         });
     }
 
-    public async restart(systemId: string, instanceId: string) {
+    /**
+     * Stops an instance but does not remove it from the list of active instances
+     *
+     * It will be started again next time the system checks the status of the instance
+     *
+     * We do it this way to not cause the user to wait for the instance to start again
+     */
+    public async prepareForRestart(systemId: string, instanceId: string) {
         systemId = normalizeKapetaUri(systemId);
         await this.stopInner(systemId, instanceId);
-
-        const existingInstance = this.getInstance(systemId, instanceId);
-        if (existingInstance?.desiredStatus === DesiredInstanceStatus.STOP) {
-            // Internal instance was marked as stopped - abort restart
-            return existingInstance;
-        }
-
-        return this.start(systemId, instanceId);
     }
 
     public async stopAll() {
@@ -553,8 +584,7 @@ export class InstanceManager {
                     const skipUpdate =
                         (newStatus === InstanceStatus.STOPPED && instance.status === InstanceStatus.FAILED) ||
                         ([InstanceStatus.READY, InstanceStatus.UNHEALTHY].includes(newStatus) &&
-                            instance.status === InstanceStatus.STOPPING &&
-                            instance.desiredStatus === DesiredInstanceStatus.STOP) ||
+                            instance.status === InstanceStatus.STOPPING) ||
                         (newStatus === InstanceStatus.STOPPED &&
                             instance.status === InstanceStatus.STARTING &&
                             instance.desiredStatus === DesiredInstanceStatus.RUN);
@@ -608,7 +638,7 @@ export class InstanceManager {
                     //If the instance is unhealthy, try to restart it
                     console.log('Restarting unhealthy instance', instance);
                     try {
-                        await this.restart(instance.systemId, instance.instanceId);
+                        await this.prepareForRestart(instance.systemId, instance.instanceId);
                     } catch (e) {
                         console.warn('Failed to restart instance', instance.systemId, instance.instanceId, e);
                     }

package/src/instances/routes.ts

@@ -86,7 +86,7 @@ router.get('/:systemId/:instanceId/logs', async (req: Request, res: Response) =>
         res.status(200).send({
             logs,
         });
-    } catch (e:any) {
+    } catch (e: any) {
         res.status(500).send({ ok: false, error: e.message });
     }
 });