@kapeta/local-cluster-service 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [0.12.0](https://github.com/kapetacom/local-cluster-service/compare/v0.11.1...v0.12.0) (2023-07-31)
+
+
+### Features
+
+* Send status events to client when pulling image ([#54](https://github.com/kapetacom/local-cluster-service/issues/54)) ([6c6f1b0](https://github.com/kapetacom/local-cluster-service/commit/6c6f1b0cf31d4bbd1fccf10f4a66a3ac97ff7171))
+
+## [0.11.1](https://github.com/kapetacom/local-cluster-service/compare/v0.11.0...v0.11.1) (2023-07-31)
+
+
+### Bug Fixes
+
+* Ensure we do not attempt to start / stop the same instance at the ([493e077](https://github.com/kapetacom/local-cluster-service/commit/493e077d0c6acdbcc371dae2ef8b6fbf2478c950))
+
 # [0.11.0](https://github.com/kapetacom/local-cluster-service/compare/v0.10.1...v0.11.0) (2023-07-31)
 
 

package/definitions.d.ts

@@ -18,4 +18,11 @@ declare module '@kapeta/nodejs-registry-utils' {
 
     export const Config: any;
     export const Actions: any;
+
+    export const handlers: {
+        DockerHandler: ArtifactHandlerFactory;
+        NPMHandler: ArtifactHandlerFactory;
+        MavenHandler: ArtifactHandlerFactory;
+        YAMLHandler: ArtifactHandlerFactory;
+    };
 }

package/dist/cjs/src/config/routes.js

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

package/dist/cjs/src/containerManager.d.ts

@@ -1,6 +1,6 @@
 import { Docker } from 'node-docker-api';
 import { Container } from 'node-docker-api/lib/container';
-import { InstanceInfo, LogEntry } from "./types";
+import { InstanceInfo, LogEntry } from './types';
 type StringMap = {
     [key: string]: string;
 };
@@ -49,6 +49,7 @@ declare class ContainerManager {
     private _alive;
     private _mountDir;
     private _version;
+    private _lastDockerAccessCheck;
     constructor();
     initialize(): Promise<void>;
     checkAlive(): Promise<boolean>;

package/dist/cjs/src/containerManager.js

@@ -15,6 +15,9 @@ const local_cluster_config_1 = __importDefault(require("@kapeta/local-cluster-co
 const node_uuid_1 = __importDefault(require("node-uuid"));
 const md5_1 = __importDefault(require("md5"));
 const utils_1 = require("./utils/utils");
+const socketManager_1 = require("./socketManager");
+const nodejs_api_client_1 = require("@kapeta/nodejs-api-client");
+const EVENT_IMAGE_PULL = 'docker-image-pull';
 exports.CONTAINER_LABEL_PORT_PREFIX = 'kapeta_port-';
 const NANO_SECOND = 1000000;
 const HEALTH_CHECK_INTERVAL = 3000;
@@ -32,6 +35,7 @@ class ContainerManager {
     _alive;
     _mountDir;
     _version;
+    _lastDockerAccessCheck = 0;
     constructor() {
         this._docker = null;
         this._alive = false;
@@ -166,17 +170,121 @@ class ContainerManager {
             console.log('Image found: %s', image);
             return false;
         }
-        console.log('Pulling image: %s', image);
-        const stream = await this.docker()
-            .image.create({}, {
+        const timeStarted = Date.now();
+        socketManager_1.socketManager.emitGlobal(EVENT_IMAGE_PULL, { image, percent: 0 });
+        const api = new nodejs_api_client_1.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,
-        });
-        await promisifyStream(stream, (chunk) => {
-            console.log('Data from docker: "%s"', chunk.toString());
+        }));
+        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 percent = totals.total > 0 ? (totals.done / totals.total) * 100 : 0;
+            //We emit at most every second to not spam the client
+            socketManager_1.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_1.socketManager.emitGlobal(EVENT_IMAGE_PULL, { image, percent: 100, timeTaken: Date.now() - timeStarted });
         return true;
     }
     toDockerMounts(mounts) {
@@ -216,13 +324,7 @@ class ContainerManager {
         return container;
     }
     async createOrUpdateContainer(opts) {
-        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) {
             console.log('Starting unnamed container: %s', opts.Image);
@@ -347,12 +449,14 @@ class ContainerManager {
         const containerName = (0, utils_1.getBlockInstanceContainerName)(instance.systemId, instance.instanceId);
         const containerInfo = await this.getContainerByName(containerName);
         if (!containerInfo) {
-            return [{
-                    source: "stdout",
-                    level: "ERROR",
+            return [
+                {
+                    source: 'stdout',
+                    level: 'ERROR',
                     time: Date.now(),
-                    message: "Container not found"
-                }];
+                    message: 'Container not found',
+                },
+            ];
         }
         return containerInfo.getLogs();
     }
@@ -440,13 +544,13 @@ class ContainerInfo {
         return ports;
     }
     async getLogs() {
-        const logStream = await this.native.logs({
+        const logStream = (await this.native.logs({
             stdout: true,
             stderr: true,
             follow: false,
             tail: 100,
             timestamps: true,
-        });
+        }));
         const out = [];
         await promisifyStream(logStream, (data) => {
             const buf = data;

package/dist/cjs/src/definitionsManager.d.ts

@@ -7,6 +7,7 @@ declare class DefinitionsManager {
     getDefinitions(kindFilter?: string | string[]): DefinitionInfo[];
     exists(ref: string): boolean;
     getProviderDefinitions(): DefinitionInfo[];
+    getDefinition(ref: string): DefinitionInfo | undefined;
 }
 export declare const definitionsManager: DefinitionsManager;
 export {};

package/dist/cjs/src/definitionsManager.js

@@ -39,13 +39,16 @@ class DefinitionsManager {
         return this.doCached(key, () => local_cluster_config_1.default.getDefinitions(kindFilter));
     }
     exists(ref) {
-        const uri = (0, nodejs_utils_1.parseKapetaUri)(ref);
-        return !!this.getDefinitions().find((d) => {
-            return (0, nodejs_utils_1.parseKapetaUri)(`${d.definition.metadata.name}:${d.version}`).id === uri.id;
-        });
+        return !!this.getDefinition(ref);
     }
     getProviderDefinitions() {
         return this.doCached('providers', () => local_cluster_config_1.default.getProviderDefinitions());
     }
+    getDefinition(ref) {
+        const uri = (0, nodejs_utils_1.parseKapetaUri)(ref);
+        return this.getDefinitions().find((d) => {
+            return (0, nodejs_utils_1.parseKapetaUri)(`${d.definition.metadata.name}:${d.version}`).id === uri.id;
+        });
+    }
 }
 exports.definitionsManager = new DefinitionsManager();

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

@@ -2,11 +2,13 @@ import { InstanceInfo, LogEntry } from './types';
 export declare class InstanceManager {
     private _interval;
     private readonly _instances;
+    private readonly instanceLocks;
     constructor();
     private checkInstancesLater;
     getInstances(): InstanceInfo[];
     getInstancesForPlan(systemId: string): InstanceInfo[];
     getInstance(systemId: string, instanceId: string): InstanceInfo | undefined;
+    private exclusive;
     getLogs(systemId: string, instanceId: string): Promise<LogEntry[]>;
     saveInternalInstance(instance: InstanceInfo): Promise<InstanceInfo>;
     /**
@@ -15,12 +17,20 @@ export declare class InstanceManager {
      */
     registerInstanceFromSDK(systemId: string, instanceId: string, info: Omit<InstanceInfo, 'systemId' | 'instanceId'>): Promise<InstanceInfo | undefined>;
     private getHealthUrl;
-    markAsStopped(systemId: string, instanceId: string): void;
+    markAsStopped(systemId: string, instanceId: string): Promise<void>;
     startAllForPlan(systemId: string): Promise<InstanceInfo[]>;
     stop(systemId: string, instanceId: string): Promise<void>;
+    private stopInner;
     stopAllForPlan(systemId: string): Promise<void>;
     start(systemId: string, instanceId: string): Promise<InstanceInfo>;
-    restart(systemId: string, instanceId: string): Promise<InstanceInfo>;
+    /**
+     * 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
+     */
+    prepareForRestart(systemId: string, instanceId: string): Promise<void>;
     stopAll(): Promise<void>;
     private stopInstances;
     private save;