@kapeta/local-cluster-service 0.18.0 → 0.19.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.19.1](https://github.com/kapetacom/local-cluster-service/compare/v0.19.0...v0.19.1) (2023-09-03)
+
+
+### Bug Fixes
+
+* Removed debug ([feeac46](https://github.com/kapetacom/local-cluster-service/commit/feeac462856a6a375d0f80e1098a25bbcaba0a70))
+
+# [0.19.0](https://github.com/kapetacom/local-cluster-service/compare/v0.18.0...v0.19.0) (2023-09-03)
+
+
+### Features
+
+* Listen for docker logs when user joins room ([#67](https://github.com/kapetacom/local-cluster-service/issues/67)) ([53bd6b6](https://github.com/kapetacom/local-cluster-service/commit/53bd6b6b6de27dc2f9011887176f270d60a0d9dc))
+
 # [0.18.0](https://github.com/kapetacom/local-cluster-service/compare/v0.17.0...v0.18.0) (2023-09-02)
 
 

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

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import FSExtra from 'fs-extra';
 import { Docker } from 'node-docker-api';
 import { Container } from 'node-docker-api/lib/container';
 import { InstanceInfo, LogEntry } from './types';
@@ -50,6 +52,7 @@ declare class ContainerManager {
     private _mountDir;
     private _version;
     private _lastDockerAccessCheck;
+    private logStreams;
     constructor();
     initialize(): Promise<void>;
     checkAlive(): Promise<boolean>;
@@ -83,6 +86,17 @@ declare class ContainerManager {
      */
     get(name: string): Promise<ContainerInfo | null>;
     getLogs(instance: InstanceInfo): Promise<LogEntry[]>;
+    stopLogListening(systemId: string, instanceId: string): Promise<void>;
+    ensureLogListening(systemId: string, instanceId: string, handler: (log: LogEntry) => void): Promise<void>;
+}
+declare class ClosableLogStream {
+    private readonly stream;
+    private readonly eventEmitter;
+    constructor(stream: FSExtra.ReadStream);
+    onLog(listener: (log: LogEntry) => void): () => void;
+    onEnd(listener: () => void): () => void;
+    onError(listener: (error: Error) => void): () => void;
+    close(): Promise<void>;
 }
 export declare class ContainerInfo {
     private readonly _container;
@@ -107,6 +121,7 @@ export declare class ContainerInfo {
     inspect(): Promise<any>;
     status(): Promise<DockerState>;
     getPorts(): Promise<PortMap | false>;
+    getLogStream(): Promise<ClosableLogStream>;
     getLogs(): Promise<LogEntry[]>;
 }
 export declare function getExtraHosts(dockerVersion: string): string[] | undefined;

package/dist/cjs/src/containerManager.js

@@ -17,6 +17,7 @@ const md5_1 = __importDefault(require("md5"));
 const utils_1 = require("./utils/utils");
 const nodejs_api_client_1 = require("@kapeta/nodejs-api-client");
 const taskManager_1 = require("./taskManager");
+const node_events_1 = require("node:events");
 exports.CONTAINER_LABEL_PORT_PREFIX = 'kapeta_port-';
 const NANO_SECOND = 1000000;
 const HEALTH_CHECK_INTERVAL = 3000;
@@ -33,6 +34,7 @@ class ContainerManager {
     _mountDir;
     _version;
     _lastDockerAccessCheck = 0;
+    logStreams = {};
     constructor() {
         this._docker = null;
         this._alive = false;
@@ -472,6 +474,174 @@ class ContainerManager {
         }
         return containerInfo.getLogs();
     }
+    async stopLogListening(systemId, instanceId) {
+        const containerName = (0, utils_1.getBlockInstanceContainerName)(systemId, instanceId);
+        if (this.logStreams[containerName]) {
+            if (this.logStreams[containerName]?.timer) {
+                clearTimeout(this.logStreams[containerName].timer);
+            }
+            try {
+                const stream = this.logStreams[containerName].stream;
+                if (stream) {
+                    await stream.close();
+                }
+            }
+            catch (err) {
+                // Ignore
+            }
+            delete this.logStreams[containerName];
+        }
+    }
+    async ensureLogListening(systemId, instanceId, handler) {
+        const containerName = (0, utils_1.getBlockInstanceContainerName)(systemId, instanceId);
+        try {
+            if (this.logStreams[containerName]?.stream) {
+                // Already listening - will shut itself down
+                return;
+            }
+            if (this.logStreams[containerName]?.timer) {
+                clearTimeout(this.logStreams[containerName].timer);
+            }
+            const tryLater = () => {
+                this.logStreams[containerName] = {
+                    timer: setTimeout(() => {
+                        // Keep trying until user decides to not listen anymore
+                        this.ensureLogListening(systemId, instanceId, handler);
+                    }, 5000),
+                };
+            };
+            const containerInfo = await this.getContainerByName(containerName);
+            if (!containerInfo || !(await containerInfo.isRunning())) {
+                // Container not currently running - try again in 5 seconds
+                tryLater();
+                return;
+            }
+            const stream = await containerInfo.getLogStream();
+            stream.onLog((log) => {
+                try {
+                    handler(log);
+                }
+                catch (err) {
+                    console.warn('Error handling log', err);
+                }
+            });
+            stream.onEnd(() => {
+                // We get here if the container is stopped
+                delete this.logStreams[containerName];
+                tryLater();
+            });
+            stream.onError((err) => {
+                // We get here if the container crashes
+                delete this.logStreams[containerName];
+                tryLater();
+            });
+            this.logStreams[containerName] = {
+                stream,
+            };
+        }
+        catch (err) {
+            // Ignore
+        }
+    }
+}
+function readLogBuffer(logBuffer) {
+    const out = [];
+    let offset = 0;
+    while (offset < logBuffer.length) {
+        try {
+            // Read the docker log format - explained here:
+            // https://docs.docker.com/engine/api/v1.41/#operation/ContainerAttach
+            // or here : https://ahmet.im/blog/docker-logs-api-binary-format-explained/
+            // First byte is stream type
+            const streamTypeInt = logBuffer.readInt8(offset);
+            const streamType = streamTypeInt === 1 ? 'stdout' : 'stderr';
+            if (streamTypeInt !== 1 && streamTypeInt !== 2) {
+                console.error('Unknown stream type: %s', streamTypeInt, out[out.length - 1]);
+                break;
+            }
+            // Bytes 4-8 is frame size
+            const messageLength = logBuffer.readInt32BE(offset + 4);
+            // After that is the message - with the message length
+            const dataWithoutStreamType = logBuffer.subarray(offset + 8, offset + 8 + messageLength);
+            const raw = dataWithoutStreamType.toString();
+            // Split the message into date and message
+            const firstSpaceIx = raw.indexOf(' ');
+            const dateString = raw.substring(0, firstSpaceIx);
+            const line = raw.substring(firstSpaceIx + 1);
+            offset = offset + messageLength + 8;
+            if (!dateString) {
+                break;
+            }
+            out.push({
+                time: new Date(dateString).getTime(),
+                message: line,
+                level: 'INFO',
+                source: streamType,
+            });
+        }
+        catch (err) {
+            console.error('Error parsing log entry', err);
+            offset = logBuffer.length;
+            break;
+        }
+    }
+    return out;
+}
+class ClosableLogStream {
+    stream;
+    eventEmitter;
+    constructor(stream) {
+        this.stream = stream;
+        this.eventEmitter = new node_events_1.EventEmitter();
+        stream.on('data', (data) => {
+            const logs = readLogBuffer(data);
+            logs.forEach((log) => {
+                this.eventEmitter.emit('log', log);
+            });
+        });
+        stream.on('end', () => {
+            this.eventEmitter.emit('end');
+        });
+        stream.on('error', (error) => {
+            this.eventEmitter.emit('error', error);
+        });
+        stream.on('close', () => {
+            this.eventEmitter.emit('end');
+        });
+    }
+    onLog(listener) {
+        this.eventEmitter.on('log', listener);
+        return () => {
+            this.eventEmitter.removeListener('log', listener);
+        };
+    }
+    onEnd(listener) {
+        this.eventEmitter.on('end', listener);
+        return () => {
+            this.eventEmitter.removeListener('end', listener);
+        };
+    }
+    onError(listener) {
+        this.eventEmitter.on('error', listener);
+        return () => {
+            this.eventEmitter.removeListener('error', listener);
+        };
+    }
+    close() {
+        return new Promise((resolve, reject) => {
+            try {
+                this.stream.close((err) => {
+                    if (err) {
+                        console.warn('Error closing log stream', err);
+                    }
+                    resolve();
+                });
+            }
+            catch (err) {
+                // Ignore
+            }
+        });
+    }
 }
 class ContainerInfo {
     _container;
@@ -555,52 +725,34 @@ class ContainerInfo {
         });
         return ports;
     }
+    async getLogStream() {
+        try {
+            const logStream = (await this.native.logs({
+                stdout: true,
+                stderr: true,
+                follow: true,
+                tail: 0,
+                timestamps: true,
+            }));
+            return new ClosableLogStream(logStream);
+        }
+        catch (err) {
+            console.log('Error getting log stream', err);
+            throw err;
+        }
+    }
     async getLogs() {
         const logStream = (await this.native.logs({
             stdout: true,
             stderr: true,
             follow: false,
-            tail: 100,
             timestamps: true,
         }));
-        const out = [];
+        const chunks = [];
         await promisifyStream(logStream, (data) => {
-            const buf = data;
-            let offset = 0;
-            while (offset < buf.length) {
-                try {
-                    // Read the docker log format - explained here:
-                    // https://docs.docker.com/engine/api/v1.41/#operation/ContainerAttach
-                    // or here : https://ahmet.im/blog/docker-logs-api-binary-format-explained/
-                    // First byte is stream type
-                    const streamTypeInt = buf.readInt8(offset);
-                    const streamType = streamTypeInt === 1 ? 'stdout' : 'stderr';
-                    // Bytes 4-8 is frame size
-                    const messageLength = buf.readInt32BE(offset + 4);
-                    // After that is the message - with the message length
-                    const dataWithoutStreamType = buf.subarray(offset + 8, offset + 8 + messageLength);
-                    const raw = dataWithoutStreamType.toString();
-                    // Split the message into date and message
-                    const firstSpaceIx = raw.indexOf(' ');
-                    const dateString = raw.substring(0, firstSpaceIx);
-                    const line = raw.substring(firstSpaceIx + 1);
-                    offset = offset + messageLength + 8;
-                    if (!dateString) {
-                        continue;
-                    }
-                    out.push({
-                        time: new Date(dateString).getTime(),
-                        message: line,
-                        level: 'INFO',
-                        source: streamType,
-                    });
-                }
-                catch (err) {
-                    console.error('Error parsing log entry', err);
-                    offset = buf.length;
-                }
-            }
+            chunks.push(data);
         });
+        const out = readLogBuffer(Buffer.concat(chunks));
         if (out.length === 0) {
             out.push({
                 time: Date.now(),

package/dist/cjs/src/instanceManager.js

@@ -422,11 +422,6 @@ class InstanceManager {
                         errorMessage: e.message ?? 'Failed to start - Check logs for details.',
                     });
                     socketManager_1.socketManager.emitInstanceLog(systemId, instanceId, logs[0]);
-                    socketManager_1.socketManager.emitInstanceEvent(systemId, blockInstance.id, socketManager_1.EVENT_INSTANCE_EXITED, {
-                        error: `Failed to start instance: ${e.message}`,
-                        status: socketManager_1.EVENT_INSTANCE_EXITED,
-                        instanceId: blockInstance.id,
-                    });
                     return out;
                 }
             }, {
@@ -486,6 +481,7 @@ class InstanceManager {
                     try {
                         const plan = await assetManager_1.assetManager.getAsset(instance.systemId, true, false);
                         if (!plan) {
+                            console.log('Plan not found - reset to stop', instance.ref, instance.systemId);
                             instance.desiredStatus = types_1.DesiredInstanceStatus.STOP;
                             changed = true;
                             return;
@@ -493,12 +489,14 @@ class InstanceManager {
                         const planData = plan.data;
                         const planInstance = planData?.spec?.blocks?.find((b) => b.id === instance.instanceId);
                         if (!planInstance || !planInstance?.block?.ref) {
+                            console.log('Plan instance not found - reset to stop', instance.ref, instance.systemId);
                             instance.desiredStatus = types_1.DesiredInstanceStatus.STOP;
                             changed = true;
                             return;
                         }
                         const blockDef = await assetManager_1.assetManager.getAsset(instance.ref, true, false);
                         if (!blockDef) {
+                            console.log('Block definition not found - reset to stop', instance.ref, instance.systemId);
                             instance.desiredStatus = types_1.DesiredInstanceStatus.STOP;
                             changed = true;
                             return;
@@ -676,6 +674,3 @@ class InstanceManager {
 }
 exports.InstanceManager = InstanceManager;
 exports.instanceManager = new InstanceManager();
-process.on('exit', async () => {
-    await exports.instanceManager.stopAll();
-});

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

@@ -19,10 +19,10 @@ export declare class SocketManager {
     emitInstanceLog(systemId: string, instanceId: string, payload: LogEntry): void;
     emitSystemLog(systemId: string, payload: LogEntry): void;
     emitGlobalLog(payload: LogEntry): void;
-    emitInstanceEvent(systemId: string, instanceId: string, type: string, payload: any): void;
     private _bindIO;
     private _handleSocketCreated;
     private _bindSocket;
-    private _handleSocketDestroyed;
+    private handleJoinRoom;
+    private handleLeaveRoom;
 }
 export declare const socketManager: SocketManager;

package/dist/cjs/src/socketManager.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.socketManager = exports.SocketManager = exports.EVENT_LOG = exports.EVENT_SYSTEM_LOG = exports.EVENT_INSTANCE_LOG = exports.EVENT_INSTANCE_EXITED = exports.EVENT_INSTANCE_CREATED = exports.EVENT_STATUS_CHANGED = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const utils_1 = require("./utils/utils");
+const containerManager_1 = require("./containerManager");
 exports.EVENT_STATUS_CHANGED = 'status-changed';
 exports.EVENT_INSTANCE_CREATED = 'instance-created';
 exports.EVENT_INSTANCE_EXITED = 'instance-exited';
@@ -48,30 +49,28 @@ class SocketManager {
     emitSystemEvent(systemId, type, payload) {
         systemId = (0, utils_1.normalizeKapetaUri)(systemId);
         try {
-            exports.socketManager.emit(`${systemId}/instances`, type, payload);
+            const contextId = `system-events/${encodeURIComponent(systemId)}`;
+            this.emit(contextId, type, payload);
         }
         catch (e) {
             console.warn('Failed to emit instance event: %s', e.message);
         }
     }
     emitInstanceLog(systemId, instanceId, payload) {
-        this.emitInstanceEvent(systemId, instanceId, exports.EVENT_INSTANCE_LOG, payload);
-    }
-    emitSystemLog(systemId, payload) {
-        this.emitSystemEvent(systemId, exports.EVENT_SYSTEM_LOG, payload);
-    }
-    emitGlobalLog(payload) {
-        this.emitGlobal(exports.EVENT_LOG, payload);
-    }
-    emitInstanceEvent(systemId, instanceId, type, payload) {
         systemId = (0, utils_1.normalizeKapetaUri)(systemId);
         try {
-            exports.socketManager.emit(`${systemId}/instances/${instanceId}`, type, payload);
+            this.emit(`instance-logs/${encodeURIComponent(systemId)}/${encodeURIComponent(instanceId)}`, exports.EVENT_INSTANCE_LOG, payload);
         }
         catch (e) {
             console.warn('Failed to emit instance event: %s', e.message);
         }
     }
+    emitSystemLog(systemId, payload) {
+        this.emitSystemEvent(systemId, exports.EVENT_SYSTEM_LOG, payload);
+    }
+    emitGlobalLog(payload) {
+        this.emitGlobal(exports.EVENT_LOG, payload);
+    }
     _bindIO() {
         this.io.on('connection', (socket) => this._handleSocketCreated(socket));
     }
@@ -80,16 +79,42 @@ class SocketManager {
         this._sockets.push(socket);
     }
     _bindSocket(socket) {
-        socket.on('disconnect', () => this._handleSocketDestroyed(socket));
+        socket.on('disconnect', () => {
+            lodash_1.default.pull(this._sockets, socket);
+            socket.rooms.forEach((roomId) => {
+                this.handleLeaveRoom(roomId);
+            });
+        });
         socket.on('join', (id) => {
             socket.join(id);
+            this.handleJoinRoom(id);
         });
         socket.on('leave', (id) => {
             socket.leave(id);
+            this.handleLeaveRoom(id);
         });
     }
-    _handleSocketDestroyed(socket) {
-        lodash_1.default.pull(this._sockets, socket);
+    handleJoinRoom(id) {
+        if (id.startsWith('instance-logs/')) {
+            let [, systemId, instanceId] = id.split(/\//g);
+            systemId = decodeURIComponent(systemId);
+            instanceId = decodeURIComponent(instanceId);
+            console.log('Start listening for logs', systemId, instanceId);
+            containerManager_1.containerManager
+                .ensureLogListening(systemId, instanceId, (log) => {
+                this.emitInstanceLog(systemId, instanceId, log);
+            })
+                .catch((e) => { });
+        }
+    }
+    handleLeaveRoom(id) {
+        if (id.startsWith('instance-logs/')) {
+            let [, systemId, instanceId] = id.split(/\//g);
+            systemId = decodeURIComponent(systemId);
+            instanceId = decodeURIComponent(instanceId);
+            console.log('Stop listening for logs', systemId, instanceId);
+            containerManager_1.containerManager.stopLogListening(systemId, instanceId).catch((e) => { });
+        }
     }
 }
 exports.SocketManager = SocketManager;

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

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import FSExtra from 'fs-extra';
 import { Docker } from 'node-docker-api';
 import { Container } from 'node-docker-api/lib/container';
 import { InstanceInfo, LogEntry } from './types';
@@ -50,6 +52,7 @@ declare class ContainerManager {
     private _mountDir;
     private _version;
     private _lastDockerAccessCheck;
+    private logStreams;
     constructor();
     initialize(): Promise<void>;
     checkAlive(): Promise<boolean>;
@@ -83,6 +86,17 @@ declare class ContainerManager {
      */
     get(name: string): Promise<ContainerInfo | null>;
     getLogs(instance: InstanceInfo): Promise<LogEntry[]>;
+    stopLogListening(systemId: string, instanceId: string): Promise<void>;
+    ensureLogListening(systemId: string, instanceId: string, handler: (log: LogEntry) => void): Promise<void>;
+}
+declare class ClosableLogStream {
+    private readonly stream;
+    private readonly eventEmitter;
+    constructor(stream: FSExtra.ReadStream);
+    onLog(listener: (log: LogEntry) => void): () => void;
+    onEnd(listener: () => void): () => void;
+    onError(listener: (error: Error) => void): () => void;
+    close(): Promise<void>;
 }
 export declare class ContainerInfo {
     private readonly _container;
@@ -107,6 +121,7 @@ export declare class ContainerInfo {
     inspect(): Promise<any>;
     status(): Promise<DockerState>;
     getPorts(): Promise<PortMap | false>;
+    getLogStream(): Promise<ClosableLogStream>;
     getLogs(): Promise<LogEntry[]>;
 }
 export declare function getExtraHosts(dockerVersion: string): string[] | undefined;