@kapeta/local-cluster-service 0.15.3 → 0.16.0

package/src/RepositoryWatcher.ts

@@ -0,0 +1,304 @@
+import chokidar, { FSWatcher } from 'chokidar';
+import ClusterConfiguration, { Definition, DefinitionInfo } from '@kapeta/local-cluster-config';
+import FS from 'fs-extra';
+import Path from 'node:path';
+import YAML from 'yaml';
+import { parseKapetaUri } from '@kapeta/nodejs-utils';
+import _ from 'lodash';
+import { socketManager } from './socketManager';
+import { definitionsManager } from './definitionsManager';
+import { assetManager } from './assetManager';
+
+function clearAllCaches() {
+    definitionsManager.clearCache();
+    assetManager.clearCache();
+}
+
+type WatchEventName = 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir';
+interface AssetIdentity {
+    handle: string;
+    name: string;
+    version: string;
+}
+const KAPETA_YML_RX = /^kapeta.ya?ml$/;
+export class RepositoryWatcher {
+    private watcher?: FSWatcher;
+    private disabled: boolean = false;
+    private readonly baseDir: string;
+    private allDefinitions: DefinitionInfo[] = [];
+    private symbolicLinks: { [link: string]: string } = {};
+    private ignoredFiles: Set<string> = new Set<string>();
+    constructor() {
+        this.baseDir = ClusterConfiguration.getRepositoryBasedir();
+    }
+
+    setDisabled(disabled: boolean) {
+        this.disabled = disabled;
+    }
+    public watch() {
+        if (!FS.existsSync(this.baseDir)) {
+            FS.mkdirpSync(this.baseDir);
+        }
+
+        this.allDefinitions = ClusterConfiguration.getDefinitions();
+
+        try {
+            this.watcher = chokidar.watch(this.baseDir, {
+                followSymlinks: false,
+                ignorePermissionErrors: true,
+                disableGlobbing: true,
+                persistent: true,
+                depth: 2,
+                ignored: (path) => this.ignoreFile(path),
+            });
+            this.watcher.on('all', this.handleFileChange.bind(this));
+            this.watcher.on('error', (error) => {
+                console.log('Error watching repository', error);
+            });
+            this.watcher.on('ready', () => {
+                console.log('Watching local repository for provider changes: %s', this.baseDir);
+            });
+        } 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;
+        }
+    }
+
+    async ignoreChangesFor(file: string) {
+        this.ignoredFiles.add(file);
+        const realPath = await FS.realpath(file);
+        if (realPath !== file) {
+            this.ignoredFiles.add(realPath);
+        }
+    }
+
+    async resumeChangedFor(file: string) {
+        this.ignoredFiles.delete(file);
+        const realPath = await FS.realpath(file);
+        if (realPath !== file) {
+            this.ignoredFiles.delete(realPath);
+        }
+    }
+
+    public async unwatch() {
+        if (!this.watcher) {
+            return;
+        }
+        this.symbolicLinks = {};
+        await this.watcher.close();
+        this.watcher = undefined;
+    }
+
+    private async getAssetIdentity(path: string): Promise<AssetIdentity | undefined> {
+        const baseName = Path.basename(path);
+        let handle, name, version;
+        if (path.startsWith(this.baseDir)) {
+            const relativePath = Path.relative(this.baseDir, path);
+            // Inside the repo we can use the path to determine the handle, name and version
+            [handle, name, version] = relativePath.split(/\//g);
+            if (!handle || !name || !version) {
+                // Do nothing with this
+                return;
+            }
+
+            return {
+                handle,
+                name,
+                version,
+            };
+        }
+
+        if (!KAPETA_YML_RX.test(baseName)) {
+            // Do nothing with this
+            return;
+        }
+        // Outside the repo we need to use the file content to determine the handle, name
+        // Version is always 'local'
+        version = 'local';
+
+        try {
+            const definition: Definition = YAML.parse((await FS.readFile(path)).toString());
+            const uri = parseKapetaUri(definition.metadata.name);
+            handle = uri.handle;
+            name = uri.name;
+            return {
+                handle,
+                name,
+                version,
+            };
+        } catch (e) {
+            // Ignore issues in the YML file
+            return;
+        }
+    }
+
+    private async handleFileChange(eventName: WatchEventName, path: string) {
+        if (!path) {
+            return;
+        }
+
+        if (this.ignoredFiles.has(path)) {
+            return;
+        }
+
+        //console.log('File changed', eventName, path);
+
+        const assetIdentity = await this.getAssetIdentity(path);
+        if (!assetIdentity) {
+            return;
+        }
+
+        if (this.disabled) {
+            return;
+        }
+
+        // If this is false it's because we're watching a symlink target
+        const withinRepo = path.startsWith(this.baseDir);
+        if (withinRepo && assetIdentity.version === 'local' && path.endsWith('/local')) {
+            // This is likely a symlink target
+            if (eventName === 'add') {
+                //console.log('Checking if we should add symlink target', handle, name, version, path);
+                await this.addSymlinkTarget(path);
+            }
+
+            if (eventName === 'unlink') {
+                await this.removeSymlinkTarget(path);
+            }
+
+            if (eventName === 'change') {
+                await this.updateSymlinkTarget(path);
+            }
+        }
+
+        await this.checkForChange(assetIdentity);
+    }
+
+    private async checkForChange(assetIdentity: AssetIdentity) {
+        const ymlPath = Path.join(
+            this.baseDir,
+            assetIdentity.handle,
+            assetIdentity.name,
+            assetIdentity.version,
+            'kapeta.yml'
+        );
+        const newDefinitions = ClusterConfiguration.getDefinitions();
+        const newDefinition = newDefinitions.find((d) => d.ymlPath === ymlPath);
+        let currentDefinition = this.allDefinitions.find((d) => d.ymlPath === ymlPath);
+        const ymlExists = await this.exists(ymlPath);
+        let type;
+        if (ymlExists) {
+            if (currentDefinition) {
+                if (newDefinition && _.isEqual(currentDefinition, newDefinition)) {
+                    //Definition was not changed
+                    return;
+                }
+                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;
+                //Something was removed
+                type = 'removed';
+            } else {
+                //Other definition was removed - ignore
+                return;
+            }
+        }
+
+        const payload = {
+            type,
+            definition: newDefinition?.definition ?? currentDefinition?.definition,
+            asset: assetIdentity,
+        };
+
+        this.allDefinitions = newDefinitions;
+
+        //console.log('Asset changed', payload);
+        socketManager.emitGlobal('asset-change', payload);
+        clearAllCaches();
+    }
+
+    private async exists(path: string): Promise<boolean> {
+        try {
+            await FS.access(path);
+            return true;
+        } catch (e) {
+            return false;
+        }
+    }
+    private async removeSymlinkTarget(path: string) {
+        if (this.symbolicLinks[path]) {
+            //console.log('Unwatching symlink target %s => %s', path, this.symbolicLinks[path]);
+            this.watcher?.unwatch(this.symbolicLinks[path]);
+            delete this.symbolicLinks[path];
+        }
+    }
+
+    private async updateSymlinkTarget(path: string) {
+        if (this.symbolicLinks[path]) {
+            //console.log('Updating symlink target %s => %s', path, this.symbolicLinks[path]);
+            this.watcher?.unwatch(this.symbolicLinks[path]);
+            delete this.symbolicLinks[path];
+            await this.addSymlinkTarget(path);
+        }
+    }
+
+    private async addSymlinkTarget(path: string) {
+        try {
+            // Make sure we're not watching the symlink target
+            await this.removeSymlinkTarget(path);
+            const stat = await FS.lstat(path);
+            if (stat.isSymbolicLink()) {
+                const realPath = `${await FS.realpath(path)}/kapeta.yml`;
+                if (await this.exists(realPath)) {
+                    //console.log('Watching symlink target %s => %s', path, realPath);
+                    this.watcher?.add(realPath);
+                    this.symbolicLinks[path] = realPath;
+                }
+            }
+        } catch (e) {
+            // Ignore
+            console.warn('Failed to check local symlink target', e);
+        }
+    }
+
+    private ignoreFile(path: string) {
+        if (!path.startsWith(this.baseDir)) {
+            return false;
+        }
+        if (path.includes('/node_modules/')) {
+            return true;
+        }
+
+        const filename = Path.basename(path);
+        if (filename.startsWith('.')) {
+            return true;
+        }
+
+        const relativePath = Path.relative(this.baseDir, path).split(Path.sep);
+
+        try {
+            if (FS.statSync(path).isDirectory()) {
+                if (relativePath.length > 3) {
+                    return true;
+                }
+                return false;
+            }
+        } catch (e) {
+            // Didn't exist - dont ignore
+            return false;
+        }
+
+        return !/^kapeta\.ya?ml$/.test(filename);
+    }
+}

package/src/assetManager.ts

@@ -1,6 +1,5 @@
 import Path from 'node:path';
-import FS from 'node:fs';
-import FSExtra from 'fs-extra';
+import FS from 'fs-extra';
 import YAML from 'yaml';
 import NodeCache from 'node-cache';
 import { Definition, DefinitionInfo } from '@kapeta/local-cluster-config';
@@ -14,6 +13,11 @@ import { definitionsManager } from './definitionsManager';
 import { normalizeKapetaUri } from './utils/utils';
 import { taskManager } from './taskManager';
 
+function clearAllCaches() {
+    definitionsManager.clearCache();
+    assetManager.clearCache();
+}
+
 export interface EnrichedAsset {
     ref: string;
     editable: boolean;
@@ -133,23 +137,19 @@ class AssetManager {
     }
 
     async createAsset(path: string, yaml: BlockDefinition): Promise<EnrichedAsset[]> {
-        if (FS.existsSync(path)) {
+        if (await FS.pathExists(path)) {
             throw new Error('File already exists: ' + path);
         }
 
         const dirName = Path.dirname(path);
-        if (!FS.existsSync(dirName)) {
-            FSExtra.mkdirpSync(dirName);
+        if (!(await FS.pathExists(dirName))) {
+            await FS.mkdirp(dirName);
         }
 
-        console.log('Wrote to ' + path);
-        FS.writeFileSync(path, YAML.stringify(yaml));
-
+        await FS.writeFile(path, YAML.stringify(yaml));
         const asset = await this.importFile(path);
-        console.log('Imported');
 
-        this.cache.flushAll();
-        definitionsManager.clearCache();
+        clearAllCaches();
 
         const ref = `kapeta://${yaml.metadata.name}:local`;
 
@@ -172,12 +172,21 @@ class AssetManager {
             throw new Error('Attempted to update corrupted asset: ' + ref);
         }
 
-        console.log('Wrote to ' + asset.ymlPath);
-        FS.writeFileSync(asset.ymlPath, YAML.stringify(yaml));
-        this.cache.flushAll();
-        definitionsManager.clearCache();
-
-        this.maybeGenerateCode(asset.ref, asset.ymlPath, yaml);
+        const path = asset.ymlPath;
+        try {
+            await repositoryManager.ignoreChangesFor(path);
+            await FS.writeFile(asset.ymlPath, YAML.stringify(yaml));
+            console.log('Wrote to ' + asset.ymlPath);
+            clearAllCaches();
+            this.maybeGenerateCode(asset.ref, asset.ymlPath, yaml);
+        } finally {
+            //We need to wait a bit for the disk to settle before we can resume watching
+            setTimeout(async () => {
+                try {
+                    await repositoryManager.resumeChangedFor(path);
+                } catch (e) {}
+            }, 500);
+        }
     }
 
     private maybeGenerateCode(ref: string, ymlPath: string, block: BlockDefinition) {
@@ -203,17 +212,20 @@ class AssetManager {
             filePath = filePath.substring('file://'.length);
         }
 
-        if (!FS.existsSync(filePath)) {
+        if (!(await FS.pathExists(filePath))) {
             throw new Error('File not found: ' + filePath);
         }
+        const content = await FS.readFile(filePath);
 
-        const assetInfos = YAML.parseAllDocuments(FS.readFileSync(filePath).toString()).map((doc) => doc.toJSON());
+        const assetInfos = YAML.parseAllDocuments(content.toString()).map((doc) => doc.toJSON());
 
         await Actions.link(new ProgressListener(), Path.dirname(filePath));
 
         const version = 'local';
         const refs = assetInfos.map((assetInfo) => `kapeta://${assetInfo.metadata.name}:${version}`);
-        this.cache.flushAll();
+
+        clearAllCaches();
+
         return this.getAssets().filter((a) => refs.some((ref) => compareRefs(ref, a.ref)));
     }
 
@@ -222,7 +234,9 @@ class AssetManager {
         if (!asset) {
             throw new Error('Asset does not exists: ' + ref);
         }
-        this.cache.flushAll();
+
+        clearAllCaches();
+
         await Actions.uninstall(new ProgressListener(), [asset.ref]);
     }
 

package/src/identities/routes.ts

@@ -6,7 +6,6 @@ import { Request, Response } from 'express';
 
 const router = Router();
 
-
 router.use('/', corsHandler);
 
 router.get('/current', async (req: Request, res: Response) => {

package/src/instanceManager.ts

@@ -74,8 +74,11 @@ export class InstanceManager {
         }
 
         const plan = planInfo.definition as Plan;
+        if (!plan?.spec?.blocks) {
+            return [];
+        }
 
-        const instanceIds = plan.spec.blocks.map((block) => block.id);
+        const instanceIds = plan.spec?.blocks?.map((block) => block.id) || [];
 
         return this._instances.filter(
             (instance) => instance.systemId === systemId && instanceIds.includes(instance.instanceId)

package/src/repositoryManager.ts

@@ -1,18 +1,19 @@
-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 { 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 { assetManager } from './assetManager';
+
 import { ProgressListener } from './progressListener';
+import { RepositoryWatcher } from './RepositoryWatcher';
+import { assetManager } from './assetManager';
+
+function clearAllCaches() {
+    definitionsManager.clearCache();
+    assetManager.clearCache();
+}
 
 const EVENT_DEFAULT_PROVIDERS_START = 'default-providers-start';
 const EVENT_DEFAULT_PROVIDERS_END = 'default-providers-end';
@@ -35,101 +36,31 @@ 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 {
@@ -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(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}`);
             };
         };