@kapeta/local-cluster-service 0.11.0 → 0.11.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [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/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,9 +17,10 @@ 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>;

package/dist/cjs/src/instanceManager.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.instanceManager = exports.InstanceManager = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const request_1 = __importDefault(require("request"));
+const async_lock_1 = __importDefault(require("async-lock"));
 const BlockInstanceRunner_1 = require("./utils/BlockInstanceRunner");
 const storageService_1 = require("./storageService");
 const socketManager_1 = require("./socketManager");
@@ -25,6 +26,7 @@ const MIN_TIME_RUNNING = 30000; //If something didnt run for more than 30 secs -
 class InstanceManager {
     _interval = undefined;
     _instances = [];
+    instanceLocks = new async_lock_1.default();
     constructor() {
         this._instances = storageService_1.storageService.section('instances', []);
         // We need to wait a bit before running the first check
@@ -56,6 +58,11 @@ class InstanceManager {
         systemId = (0, utils_1.normalizeKapetaUri)(systemId);
         return this._instances.find((i) => i.systemId === systemId && i.instanceId === instanceId);
     }
+    async exclusive(systemId, instanceId, fn) {
+        systemId = (0, utils_1.normalizeKapetaUri)(systemId);
+        const key = `${systemId}/${instanceId}`;
+        return this.instanceLocks.acquire(key, fn);
+    }
     async getLogs(systemId, instanceId) {
         const instance = this.getInstance(systemId, instanceId);
         if (!instance) {
@@ -111,57 +118,59 @@ class InstanceManager {
      * which self-registers with the cluster service locally on startup.
      */
     async registerInstanceFromSDK(systemId, instanceId, info) {
-        systemId = (0, utils_1.normalizeKapetaUri)(systemId);
-        let instance = this.getInstance(systemId, instanceId);
-        //Get target address
-        const address = await serviceManager_1.serviceManager.getProviderAddress(systemId, instanceId, info.portType ?? DEFAULT_HEALTH_PORT_TYPE);
-        const healthUrl = this.getHealthUrl(info, address);
-        if (instance) {
-            if (instance.status === types_1.InstanceStatus.STOPPING && instance.desiredStatus === types_1.DesiredInstanceStatus.STOP) {
-                //If instance is stopping do not interfere
-                return;
-            }
-            if (info.owner === types_1.InstanceOwner.EXTERNAL) {
-                //If instance was started externally - then we want to replace the internal instance with that
-                if (instance.owner === types_1.InstanceOwner.INTERNAL &&
-                    (instance.status === types_1.InstanceStatus.READY ||
-                        instance.status === types_1.InstanceStatus.STARTING ||
-                        instance.status === types_1.InstanceStatus.UNHEALTHY)) {
-                    throw new Error(`Instance ${instanceId} is already running`);
+        return this.exclusive(systemId, instanceId, async () => {
+            systemId = (0, utils_1.normalizeKapetaUri)(systemId);
+            let instance = this.getInstance(systemId, instanceId);
+            //Get target address
+            const address = await serviceManager_1.serviceManager.getProviderAddress(systemId, instanceId, info.portType ?? DEFAULT_HEALTH_PORT_TYPE);
+            const healthUrl = this.getHealthUrl(info, address);
+            if (instance) {
+                if (instance.status === types_1.InstanceStatus.STOPPING && instance.desiredStatus === types_1.DesiredInstanceStatus.STOP) {
+                    //If instance is stopping do not interfere
+                    return;
                 }
-                instance.desiredStatus = info.desiredStatus;
-                instance.owner = info.owner;
-                instance.status = types_1.InstanceStatus.STARTING;
-                instance.startedAt = Date.now();
-            }
-            instance.pid = info.pid;
-            instance.address = address;
-            if (info.type) {
-                instance.type = info.type;
+                if (info.owner === types_1.InstanceOwner.EXTERNAL) {
+                    //If instance was started externally - then we want to replace the internal instance with that
+                    if (instance.owner === types_1.InstanceOwner.INTERNAL &&
+                        (instance.status === types_1.InstanceStatus.READY ||
+                            instance.status === types_1.InstanceStatus.STARTING ||
+                            instance.status === types_1.InstanceStatus.UNHEALTHY)) {
+                        throw new Error(`Instance ${instanceId} is already running`);
+                    }
+                    instance.desiredStatus = info.desiredStatus;
+                    instance.owner = info.owner;
+                    instance.status = types_1.InstanceStatus.STARTING;
+                    instance.startedAt = Date.now();
+                }
+                instance.pid = info.pid;
+                instance.address = address;
+                if (info.type) {
+                    instance.type = info.type;
+                }
+                if (healthUrl) {
+                    instance.health = healthUrl;
+                }
+                this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
             }
-            if (healthUrl) {
-                instance.health = healthUrl;
+            else {
+                //If instance was not found - then we're receiving an externally started instance
+                instance = {
+                    ...info,
+                    systemId,
+                    instanceId,
+                    status: types_1.InstanceStatus.STARTING,
+                    startedAt: Date.now(),
+                    desiredStatus: types_1.DesiredInstanceStatus.EXTERNAL,
+                    owner: types_1.InstanceOwner.EXTERNAL,
+                    health: healthUrl,
+                    address,
+                };
+                this._instances.push(instance);
+                this.emitSystemEvent(systemId, EVENT_INSTANCE_CREATED, instance);
             }
-            this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
-        }
-        else {
-            //If instance was not found - then we're receiving an externally started instance
-            instance = {
-                ...info,
-                systemId,
-                instanceId,
-                status: types_1.InstanceStatus.STARTING,
-                startedAt: Date.now(),
-                desiredStatus: types_1.DesiredInstanceStatus.EXTERNAL,
-                owner: types_1.InstanceOwner.EXTERNAL,
-                health: healthUrl,
-                address,
-            };
-            this._instances.push(instance);
-            this.emitSystemEvent(systemId, EVENT_INSTANCE_CREATED, instance);
-        }
-        this.save();
-        return instance;
+            this.save();
+            return instance;
+        });
     }
     getHealthUrl(info, address) {
         let healthUrl = null;
@@ -175,15 +184,17 @@ class InstanceManager {
         return healthUrl;
     }
     markAsStopped(systemId, instanceId) {
-        systemId = (0, utils_1.normalizeKapetaUri)(systemId);
-        const instance = lodash_1.default.find(this._instances, { systemId, instanceId });
-        if (instance && instance.owner === types_1.InstanceOwner.EXTERNAL && instance.status !== types_1.InstanceStatus.STOPPED) {
-            instance.status = types_1.InstanceStatus.STOPPED;
-            instance.pid = null;
-            instance.health = null;
-            this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
-            this.save();
-        }
+        return this.exclusive(systemId, instanceId, async () => {
+            systemId = (0, utils_1.normalizeKapetaUri)(systemId);
+            const instance = lodash_1.default.find(this._instances, { systemId, instanceId });
+            if (instance && instance.owner === types_1.InstanceOwner.EXTERNAL && instance.status !== types_1.InstanceStatus.STOPPED) {
+                instance.status = types_1.InstanceStatus.STOPPED;
+                instance.pid = null;
+                instance.health = null;
+                this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
+                this.save();
+            }
+        });
     }
     async startAllForPlan(systemId) {
         systemId = (0, utils_1.normalizeKapetaUri)(systemId);
@@ -212,54 +223,60 @@ class InstanceManager {
         return settled.map((p) => (p.status === 'fulfilled' ? p.value : null)).filter((p) => !!p);
     }
     async stop(systemId, instanceId) {
-        systemId = (0, utils_1.normalizeKapetaUri)(systemId);
-        const instance = this.getInstance(systemId, instanceId);
-        if (!instance) {
-            return;
-        }
-        if (instance.status === types_1.InstanceStatus.STOPPED) {
-            return;
-        }
-        if (instance.desiredStatus !== types_1.DesiredInstanceStatus.EXTERNAL) {
-            instance.desiredStatus = types_1.DesiredInstanceStatus.STOP;
-        }
-        instance.status = types_1.InstanceStatus.STOPPING;
-        this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
-        console.log('Stopping instance: %s::%s [desired: %s]', systemId, instanceId, instance.desiredStatus);
-        this.save();
-        try {
-            if (instance.type === 'docker') {
-                const containerName = (0, utils_1.getBlockInstanceContainerName)(instance.systemId, instance.instanceId);
-                const container = await containerManager_1.containerManager.getContainerByName(containerName);
-                if (container) {
-                    try {
-                        await container.stop();
-                        instance.status = types_1.InstanceStatus.STOPPED;
-                        this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
-                        this.save();
+        return this.stopInner(systemId, instanceId, true);
+    }
+    async stopInner(systemId, instanceId, changeDesired = false) {
+        return this.exclusive(systemId, instanceId, async () => {
+            systemId = (0, utils_1.normalizeKapetaUri)(systemId);
+            const instance = this.getInstance(systemId, instanceId);
+            if (!instance) {
+                return;
+            }
+            if (instance.status === types_1.InstanceStatus.STOPPED) {
+                return;
+            }
+            if (changeDesired &&
+                instance.desiredStatus !== types_1.DesiredInstanceStatus.EXTERNAL) {
+                instance.desiredStatus = types_1.DesiredInstanceStatus.STOP;
+            }
+            instance.status = types_1.InstanceStatus.STOPPING;
+            this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
+            console.log('Stopping instance: %s::%s [desired: %s]', systemId, instanceId, instance.desiredStatus);
+            this.save();
+            try {
+                if (instance.type === 'docker') {
+                    const containerName = (0, utils_1.getBlockInstanceContainerName)(instance.systemId, instance.instanceId);
+                    const container = await containerManager_1.containerManager.getContainerByName(containerName);
+                    if (container) {
+                        try {
+                            await container.stop();
+                            instance.status = types_1.InstanceStatus.STOPPED;
+                            this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
+                            this.save();
+                        }
+                        catch (e) {
+                            console.error('Failed to stop container', e);
+                        }
                     }
-                    catch (e) {
-                        console.error('Failed to stop container', e);
+                    else {
+                        console.warn('Container not found', containerName);
                     }
+                    return;
                 }
-                else {
-                    console.warn('Container not found', containerName);
+                if (!instance.pid) {
+                    instance.status = types_1.InstanceStatus.STOPPED;
+                    this.save();
+                    return;
                 }
-                return;
-            }
-            if (!instance.pid) {
+                process.kill(instance.pid, 'SIGTERM');
                 instance.status = types_1.InstanceStatus.STOPPED;
+                this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
                 this.save();
-                return;
             }
-            process.kill(instance.pid, 'SIGTERM');
-            instance.status = types_1.InstanceStatus.STOPPED;
-            this.emitSystemEvent(systemId, EVENT_STATUS_CHANGED, instance);
-            this.save();
-        }
-        catch (e) {
-            console.error('Failed to stop process', e);
-        }
+            catch (e) {
+                console.error('Failed to stop process', e);
+            }
+        });
     }
     async stopAllForPlan(systemId) {
         systemId = (0, utils_1.normalizeKapetaUri)(systemId);
@@ -267,104 +284,111 @@ class InstanceManager {
         return this.stopInstances(instancesForPlan);
     }
     async start(systemId, instanceId) {
-        systemId = (0, utils_1.normalizeKapetaUri)(systemId);
-        const plan = await assetManager_1.assetManager.getPlan(systemId, true);
-        if (!plan) {
-            throw new Error('Plan not found: ' + systemId);
-        }
-        const blockInstance = plan.spec && plan.spec.blocks ? lodash_1.default.find(plan.spec.blocks, { id: instanceId }) : null;
-        if (!blockInstance) {
-            throw new Error('Block instance not found: ' + instanceId);
-        }
-        const blockRef = (0, utils_1.normalizeKapetaUri)(blockInstance.block.ref);
-        const blockAsset = await assetManager_1.assetManager.getAsset(blockRef, true);
-        if (!blockAsset) {
-            throw new Error('Block not found: ' + blockRef);
-        }
-        const existingInstance = this.getInstance(systemId, instanceId);
-        if (existingInstance) {
-            if (existingInstance.status === types_1.InstanceStatus.READY) {
-                // Instance is already running
-                return existingInstance;
+        return this.exclusive(systemId, instanceId, async () => {
+            systemId = (0, utils_1.normalizeKapetaUri)(systemId);
+            const plan = await assetManager_1.assetManager.getPlan(systemId, true);
+            if (!plan) {
+                throw new Error('Plan not found: ' + systemId);
             }
-            if (existingInstance.desiredStatus === types_1.DesiredInstanceStatus.RUN &&
-                existingInstance.status === types_1.InstanceStatus.STARTING) {
-                // Internal instance is already starting - don't start it again
-                return existingInstance;
+            const blockInstance = plan.spec && plan.spec.blocks ? lodash_1.default.find(plan.spec.blocks, { id: instanceId }) : null;
+            if (!blockInstance) {
+                throw new Error('Block instance not found: ' + instanceId);
             }
-            if (existingInstance.owner === types_1.InstanceOwner.EXTERNAL &&
-                existingInstance.status === types_1.InstanceStatus.STARTING) {
-                // External instance is already starting - don't start it again
-                return existingInstance;
+            const blockRef = (0, utils_1.normalizeKapetaUri)(blockInstance.block.ref);
+            const blockAsset = await assetManager_1.assetManager.getAsset(blockRef, true);
+            if (!blockAsset) {
+                throw new Error('Block not found: ' + blockRef);
             }
-        }
-        let instance = {
-            systemId,
-            instanceId,
-            ref: blockRef,
-            name: blockAsset.data.metadata.name,
-            desiredStatus: types_1.DesiredInstanceStatus.RUN,
-            owner: types_1.InstanceOwner.INTERNAL,
-            type: existingInstance?.type ?? types_1.InstanceType.UNKNOWN,
-            status: types_1.InstanceStatus.STARTING,
-            startedAt: Date.now(),
-        };
-        console.log('Starting instance: %s::%s [desired: %s]', systemId, instanceId, instance.desiredStatus);
-        // Save the instance before starting it, so that we can track the status
-        await this.saveInternalInstance(instance);
-        if (existingInstance) {
-            // Check if the instance is already running - but after we've commmuicated the desired status
-            const currentStatus = await this.requestInstanceStatus(existingInstance);
-            if (currentStatus === types_1.InstanceStatus.READY) {
-                // Instance is already running
-                return existingInstance;
+            const existingInstance = this.getInstance(systemId, instanceId);
+            if (existingInstance) {
+                if (existingInstance.status === types_1.InstanceStatus.READY) {
+                    // Instance is already running
+                    return existingInstance;
+                }
+                if (existingInstance.desiredStatus === types_1.DesiredInstanceStatus.RUN &&
+                    existingInstance.status === types_1.InstanceStatus.STARTING) {
+                    // Internal instance is already starting - don't start it again
+                    return existingInstance;
+                }
+                if (existingInstance.owner === types_1.InstanceOwner.EXTERNAL &&
+                    existingInstance.status === types_1.InstanceStatus.STARTING) {
+                    // External instance is already starting - don't start it again
+                    return existingInstance;
+                }
             }
-        }
-        const instanceConfig = await configManager_1.configManager.getConfigForSection(systemId, instanceId);
-        const runner = new BlockInstanceRunner_1.BlockInstanceRunner(systemId);
-        const startTime = Date.now();
-        try {
-            const processInfo = await runner.start(blockRef, instanceId, instanceConfig);
-            instance.status = types_1.InstanceStatus.READY;
-            return this.saveInternalInstance({
-                ...instance,
-                type: processInfo.type,
-                pid: processInfo.pid ?? -1,
-                health: null,
-                portType: processInfo.portType,
-                status: types_1.InstanceStatus.READY,
-            });
-        }
-        catch (e) {
-            console.warn('Failed to start instance', e);
-            const logs = [
-                {
-                    source: 'stdout',
-                    level: 'ERROR',
-                    message: e.message,
-                    time: Date.now(),
-                },
-            ];
-            const out = await this.saveInternalInstance({
-                ...instance,
-                type: types_1.InstanceType.LOCAL,
-                pid: null,
-                health: null,
-                portType: DEFAULT_HEALTH_PORT_TYPE,
-                status: types_1.InstanceStatus.FAILED,
-            });
-            this.emitInstanceEvent(systemId, instanceId, EVENT_INSTANCE_LOG, logs[0]);
-            this.emitInstanceEvent(systemId, blockInstance.id, EVENT_INSTANCE_EXITED, {
-                error: `Failed to start instance: ${e.message}`,
-                status: EVENT_INSTANCE_EXITED,
-                instanceId: blockInstance.id,
-            });
-            return out;
-        }
+            let instance = {
+                systemId,
+                instanceId,
+                ref: blockRef,
+                name: blockAsset.data.metadata.name,
+                desiredStatus: types_1.DesiredInstanceStatus.RUN,
+                owner: types_1.InstanceOwner.INTERNAL,
+                type: existingInstance?.type ?? types_1.InstanceType.UNKNOWN,
+                status: types_1.InstanceStatus.STARTING,
+                startedAt: Date.now(),
+            };
+            console.log('Starting instance: %s::%s [desired: %s]', systemId, instanceId, instance.desiredStatus);
+            // Save the instance before starting it, so that we can track the status
+            await this.saveInternalInstance(instance);
+            if (existingInstance) {
+                // Check if the instance is already running - but after we've commmuicated the desired status
+                const currentStatus = await this.requestInstanceStatus(existingInstance);
+                if (currentStatus === types_1.InstanceStatus.READY) {
+                    // Instance is already running
+                    return existingInstance;
+                }
+            }
+            const instanceConfig = await configManager_1.configManager.getConfigForSection(systemId, instanceId);
+            const runner = new BlockInstanceRunner_1.BlockInstanceRunner(systemId);
+            const startTime = Date.now();
+            try {
+                const processInfo = await runner.start(blockRef, instanceId, instanceConfig);
+                instance.status = types_1.InstanceStatus.READY;
+                return this.saveInternalInstance({
+                    ...instance,
+                    type: processInfo.type,
+                    pid: processInfo.pid ?? -1,
+                    health: null,
+                    portType: processInfo.portType,
+                    status: types_1.InstanceStatus.READY,
+                });
+            }
+            catch (e) {
+                console.warn('Failed to start instance', e);
+                const logs = [
+                    {
+                        source: 'stdout',
+                        level: 'ERROR',
+                        message: e.message,
+                        time: Date.now(),
+                    },
+                ];
+                const out = await this.saveInternalInstance({
+                    ...instance,
+                    type: types_1.InstanceType.LOCAL,
+                    pid: null,
+                    health: null,
+                    portType: DEFAULT_HEALTH_PORT_TYPE,
+                    status: types_1.InstanceStatus.FAILED,
+                });
+                this.emitInstanceEvent(systemId, instanceId, EVENT_INSTANCE_LOG, logs[0]);
+                this.emitInstanceEvent(systemId, blockInstance.id, EVENT_INSTANCE_EXITED, {
+                    error: `Failed to start instance: ${e.message}`,
+                    status: EVENT_INSTANCE_EXITED,
+                    instanceId: blockInstance.id,
+                });
+                return out;
+            }
+        });
     }
     async restart(systemId, instanceId) {
         systemId = (0, utils_1.normalizeKapetaUri)(systemId);
-        await this.stop(systemId, instanceId);
+        await this.stopInner(systemId, instanceId);
+        const existingInstance = this.getInstance(systemId, instanceId);
+        if (existingInstance?.desiredStatus === types_1.DesiredInstanceStatus.STOP) {
+            // Internal instance was marked as stopped - abort restart
+            return existingInstance;
+        }
         return this.start(systemId, instanceId);
     }
     async stopAll() {
@@ -391,7 +415,7 @@ class InstanceManager {
         const all = [...this._instances];
         while (all.length > 0) {
             // Check a few instances at a time - docker doesn't like too many concurrent requests
-            const chunk = all.splice(0, 20);
+            const chunk = all.splice(0, 30);
             const promises = chunk.map(async (instance) => {
                 if (!instance.systemId) {
                     return;
@@ -451,7 +475,7 @@ class InstanceManager {
                     [types_1.InstanceStatus.READY, types_1.InstanceStatus.STARTING, types_1.InstanceStatus.UNHEALTHY].includes(newStatus)) {
                     //If the instance is running but we want it to stop, stop it
                     try {
-                        await this.stop(instance.systemId, instance.instanceId);
+                        await this.stopInner(instance.systemId, instance.instanceId);
                     }
                     catch (e) {
                         console.warn('Failed to stop instance', instance.systemId, instance.instanceId, e);

package/dist/esm/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,9 +17,10 @@ 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>;