@kapeta/local-cluster-service 0.15.2 → 0.16.0

package/src/progressListener.ts

@@ -1,19 +1,38 @@
 import { spawn } from '@kapeta/nodejs-process';
-import { SocketManager, socketManager } from './socketManager';
-class ProgressListener {
-    private socketManager: SocketManager;
+import { socketManager } from './socketManager';
+import { LogEntry } from './types';
+import { format } from 'node:util';
 
-    constructor(socketManager: SocketManager) {
-        this.socketManager = socketManager;
+export class ProgressListener {
+    private readonly systemId: string | undefined;
+    private readonly instanceId: string | undefined;
+
+    constructor(systemId?: string, instanceId?: string) {
+        this.systemId = systemId;
+        this.instanceId = instanceId;
     }
 
-    run(command: string, directory?: string): Promise<{ exit: number; signal: NodeJS.Signals | null; output: string }> {
-        this.socketManager.emit(`install`, 'install:log', {
-            type: 'info',
-            message: `Running command "${command}"`,
-        });
+    private emitLog(payload: Omit<LogEntry, 'time' | 'source'>) {
+        const logEntry: LogEntry = {
+            ...payload,
+            source: 'stdout',
+            time: Date.now(),
+        };
+        if (this.systemId && this.instanceId) {
+            socketManager.emitInstanceLog(this.systemId, this.instanceId, logEntry);
+            return;
+        }
+
+        if (this.systemId) {
+            socketManager.emitSystemLog(this.systemId, logEntry);
+            return;
+        }
+
+        socketManager.emitGlobalLog(logEntry);
+    }
 
-        const firstCommand = command.split(' ')[0];
+    run(command: string, directory?: string): Promise<{ exit: number; signal: NodeJS.Signals | null; output: string }> {
+        this.info(`Running command "${command}"`);
 
         return new Promise(async (resolve, reject) => {
             try {
@@ -25,7 +44,10 @@ class ProgressListener {
                 });
 
                 child.onData((data) => {
-                    this.socketManager.emit(`install`, 'install:log', { type: 'info', message: data.line });
+                    this.emitLog({
+                        level: data.type === 'stdout' ? 'INFO' : 'WARN',
+                        message: data.line,
+                    });
                 });
 
                 if (child.process.stdout) {
@@ -36,25 +58,16 @@ class ProgressListener {
 
                 child.process.on('exit', (exit, signal) => {
                     if (exit !== 0) {
-                        this.socketManager.emit(`install`, 'install:log', {
-                            type: 'info',
-                            message: `"${command}" failed: "${exit}"`,
-                        });
+                        this.warn(`Command "${command}" failed: ${exit}`);
                         reject(new Error(`Command "${command}" exited with code ${exit}`));
                     } else {
-                        this.socketManager.emit(`install`, 'install:log', {
-                            type: 'info',
-                            message: `Command OK: "${command}"`,
-                        });
+                        this.info(`Command OK: "${command}"`);
                         resolve({ exit, signal, output: Buffer.concat(chunks).toString() });
                     }
                 });
 
                 child.process.on('error', (err) => {
-                    this.socketManager.emit(`install`, 'install:log', {
-                        type: 'info',
-                        message: `"${command}" failed: "${err.message}"`,
-                    });
+                    this.warn(`"${command}" failed: "${err.message}"`);
                     reject(err);
                 });
 
@@ -66,48 +79,55 @@ class ProgressListener {
     }
 
     async progress(label: string, callback: () => void | Promise<void>) {
-        this.socketManager.emit(`install`, 'install:log', { type: 'info', message: `${label}: started` });
+        this.info(`${label}: started`);
         try {
             const result = await callback();
-            this.socketManager.emit(`install`, 'install:log', { type: 'info', message: `${label}: done` });
+            this.info(`${label}: done`);
             return result;
         } catch (e: any) {
-            this.socketManager.emit(`install`, 'install:log', {
-                type: 'info',
-                message: `${label}: failed. ${e.message}`,
-            });
+            this.warn(`${label}: failed. ${e.message}`);
             throw e;
         }
     }
 
     async check(message: string, ok: boolean | Promise<boolean> | (() => Promise<boolean>)) {
         const wasOk = await ok;
-        this.socketManager.emit(`install`, 'install:log', { type: 'info', message: `${message}: ${wasOk}` });
+        this.info(`${message}: ${wasOk}`);
     }
 
     start(label: string) {
-        this.socketManager.emit(`install`, 'install:log', { type: 'info', message: label });
+        this.info(label);
     }
 
     showValue(label: string, value: any) {
-        this.socketManager.emit(`install`, 'install:log', { type: 'info', message: `${label}: ${value}` });
+        this.info(`${label}: ${value}`);
     }
 
     error(msg: string, ...args: any[]) {
-        this.socketManager.emit(`install`, 'install:log', { type: 'error', message: msg });
+        this.emitLog({
+            message: format(msg, args),
+            level: 'ERROR',
+        });
     }
 
     warn(msg: string, ...args: any[]) {
-        this.socketManager.emit(`install`, 'install:log', { type: 'warn', message: msg });
+        this.emitLog({
+            message: format(msg, args),
+            level: 'WARN',
+        });
     }
 
     info(msg: string, ...args: any[]) {
-        this.socketManager.emit(`install`, 'install:log', { type: 'info', message: msg });
+        this.emitLog({
+            message: format(msg, args),
+            level: 'INFO',
+        });
     }
 
     debug(msg: string, ...args: any[]) {
-        this.socketManager.emit(`install`, 'install:log', { type: 'debug', message: msg });
+        this.emitLog({
+            message: format(msg, args),
+            level: 'DEBUG',
+        });
     }
 }
-
-export const progressListener = new ProgressListener(socketManager);

package/src/repositoryManager.ts

@@ -1,21 +1,22 @@
-import FS from 'node:fs';
 import os from 'node:os';
-import Path from 'node:path';
-import watch from 'recursive-watch';
-import FSExtra from 'fs-extra';
-import ClusterConfiguration from '@kapeta/local-cluster-config';
-import { parseKapetaUri } from '@kapeta/nodejs-utils';
 import { socketManager } from './socketManager';
-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 { ProgressListener } from './progressListener';
+import { RepositoryWatcher } from './RepositoryWatcher';
 import { assetManager } from './assetManager';
 
-const EVENT_DEFAULT_PROVIDERS_START= 'default-providers-start';
-const EVENT_DEFAULT_PROVIDERS_END= 'default-providers-end';
+function clearAllCaches() {
+    definitionsManager.clearCache();
+    assetManager.clearCache();
+}
+
+const EVENT_DEFAULT_PROVIDERS_START = 'default-providers-start';
+const EVENT_DEFAULT_PROVIDERS_END = 'default-providers-end';
 
 const DEFAULT_PROVIDERS = [
     'kapeta/block-type-service',
@@ -35,107 +36,37 @@ const DEFAULT_PROVIDERS = [
 const INSTALL_ATTEMPTED: { [p: string]: boolean } = {};
 
 class RepositoryManager {
-    private changeEventsEnabled: boolean;
     private _registryService: RegistryService;
     private _cache: { [key: string]: boolean };
-    private watcher?: () => void;
+    private watcher: RepositoryWatcher;
 
     constructor() {
-        this.changeEventsEnabled = true;
-        this.listenForChanges();
         this._registryService = new RegistryService(Config.data.registry.url);
         this._cache = {};
-    }
-
-    setChangeEventsEnabled(enabled: boolean) {
-        this.changeEventsEnabled = enabled;
+        this.watcher = new RepositoryWatcher();
+        this.listenForChanges();
     }
 
     listenForChanges() {
-        const baseDir = ClusterConfiguration.getRepositoryBasedir();
-        if (!FS.existsSync(baseDir)) {
-            FSExtra.mkdirpSync(baseDir);
-        }
-
-        let allDefinitions = ClusterConfiguration.getDefinitions();
-
-        console.log('Watching local repository for provider changes: %s', baseDir);
-        try {
-            this.watcher = watch(baseDir, (filename: string) => {
-                if (!filename) {
-                    return;
-                }
-
-                const [handle, name, version] = filename.toString().split(/\//g);
-                if (!name || !version) {
-                    return;
-                }
-
-                if (!this.changeEventsEnabled) {
-                    return;
-                }
-
-                const ymlPath = Path.join(baseDir, handle, name, version, 'kapeta.yml');
-                const newDefinitions = ClusterConfiguration.getDefinitions();
-
-                const newDefinition = newDefinitions.find((d) => d.ymlPath === ymlPath);
-                let currentDefinition = allDefinitions.find((d) => d.ymlPath === ymlPath);
-                const ymlExists = FS.existsSync(ymlPath);
-                let type;
-                if (ymlExists) {
-                    if (currentDefinition) {
-                        type = 'updated';
-                    } else if (newDefinition) {
-                        type = 'added';
-                        currentDefinition = newDefinition;
-                    } else {
-                        //Other definition was added / updated - ignore
-                        return;
-                    }
-                } else {
-                    if (currentDefinition) {
-                        const ref = parseKapetaUri(
-                            `${currentDefinition.definition.metadata.name}:${currentDefinition.version}`
-                        ).id;
-                        delete INSTALL_ATTEMPTED[ref];
-                        //Something was removed
-                        type = 'removed';
-                    } else {
-                        //Other definition was removed - ignore
-                        return;
-                    }
-                }
+        this.watcher.watch();
+    }
 
-                const payload = {
-                    type,
-                    definition: currentDefinition?.definition,
-                    asset: { handle, name, version },
-                };
+    async stopListening() {
+        return this.watcher.unwatch();
+    }
 
-                allDefinitions = newDefinitions;
-                socketManager.emit(`assets`, 'changed', payload);
-                definitionsManager.clearCache();
-            });
-        } catch (e) {
-            // Fallback to run without watch mode due to potential platform issues.
-            // https://nodejs.org/docs/latest/api/fs.html#caveats
-            console.log('Unable to watch for changes. Changes to assets will not update automatically.', e);
-            return;
-        }
+    ignoreChangesFor(file: string) {
+        return this.watcher.ignoreChangesFor(file);
     }
 
-    stopListening() {
-        if (!this.watcher) {
-            return;
-        }
-        this.watcher();
-        this.watcher = undefined;
+    resumeChangedFor(file: string) {
+        return this.watcher.resumeChangedFor(file);
     }
 
     public ensureDefaultProviders(): void {
-        socketManager.emitGlobal(EVENT_DEFAULT_PROVIDERS_START, {providers:DEFAULT_PROVIDERS});
+        socketManager.emitGlobal(EVENT_DEFAULT_PROVIDERS_START, { providers: DEFAULT_PROVIDERS });
         const tasks = this._install(DEFAULT_PROVIDERS);
-        Promise.allSettled(tasks.map(t => t.wait())).then(() => {
+        Promise.allSettled(tasks.map((t) => t.wait())).then(() => {
             socketManager.emitGlobal(EVENT_DEFAULT_PROVIDERS_END, {});
         });
     }
@@ -157,17 +88,12 @@ class RepositoryManager {
                 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);
-                    await Actions.install(progressListener, [ref], {});
+                    await Actions.install(new ProgressListener(), [ref], {});
                 } catch (e) {
                     console.error(`Failed to install asset: ${ref}`, e);
                     throw e;
-                } finally {
-                    this.setChangeEventsEnabled(true);
                 }
-                definitionsManager.clearCache();
-                assetManager.clearCache();
+                clearAllCaches();
                 //console.log(`Asset installed: ${ref}`);
             };
         };

package/src/socketManager.ts

@@ -1,9 +1,18 @@
 import _ from 'lodash';
 import { Socket, Server } from 'socket.io';
+import { normalizeKapetaUri } from './utils/utils';
+import { LogEntry } from './types';
+export const EVENT_STATUS_CHANGED = 'status-changed';
+export const EVENT_INSTANCE_CREATED = 'instance-created';
+export const EVENT_INSTANCE_EXITED = 'instance-exited';
+export const EVENT_INSTANCE_LOG = 'instance-log';
+
+export const EVENT_SYSTEM_LOG = 'system-log';
+export const EVENT_LOG = 'log';
 
 export class SocketManager {
     private _io: Server | null;
-    private _sockets: Socket[];
+    private readonly _sockets: Socket[];
 
     constructor() {
         this._io = null;
@@ -35,16 +44,46 @@ export class SocketManager {
         this.io.emit(type, payload);
     }
 
-    _bindIO() {
+    emitSystemEvent(systemId: string, type: string, payload: any) {
+        systemId = normalizeKapetaUri(systemId);
+        try {
+            socketManager.emit(`${systemId}/instances`, type, payload);
+        } catch (e: any) {
+            console.warn('Failed to emit instance event: %s', e.message);
+        }
+    }
+
+    emitInstanceLog(systemId: string, instanceId: string, payload: LogEntry) {
+        this.emitInstanceEvent(systemId, instanceId, EVENT_INSTANCE_LOG, payload);
+    }
+
+    emitSystemLog(systemId: string, payload: LogEntry) {
+        this.emitSystemEvent(systemId, EVENT_SYSTEM_LOG, payload);
+    }
+
+    emitGlobalLog(payload: LogEntry) {
+        this.emitGlobal(EVENT_LOG, payload);
+    }
+
+    emitInstanceEvent(systemId: string, instanceId: string, type: string, payload: any) {
+        systemId = normalizeKapetaUri(systemId);
+        try {
+            socketManager.emit(`${systemId}/instances/${instanceId}`, type, payload);
+        } catch (e: any) {
+            console.warn('Failed to emit instance event: %s', e.message);
+        }
+    }
+
+    private _bindIO() {
         this.io.on('connection', (socket) => this._handleSocketCreated(socket));
     }
 
-    _handleSocketCreated(socket: Socket) {
+    private _handleSocketCreated(socket: Socket) {
         this._bindSocket(socket);
         this._sockets.push(socket);
     }
 
-    _bindSocket(socket: Socket) {
+    private _bindSocket(socket: Socket) {
         socket.on('disconnect', () => this._handleSocketDestroyed(socket));
         socket.on('join', (id) => {
             socket.join(id);
@@ -54,7 +93,7 @@ export class SocketManager {
         });
     }
 
-    _handleSocketDestroyed(socket: Socket) {
+    private _handleSocketDestroyed(socket: Socket) {
         _.pull(this._sockets, socket);
     }
 }