@kapeta/local-cluster-service 0.33.4 → 0.33.6

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [0.33.6](https://github.com/kapetacom/local-cluster-service/compare/v0.33.5...v0.33.6) (2024-01-09)
+
+
+### Bug Fixes
+
+* Catch errors when starting ([#115](https://github.com/kapetacom/local-cluster-service/issues/115)) ([00f1875](https://github.com/kapetacom/local-cluster-service/commit/00f18758063e7ea5cb20d3a70dbd1706ef9f4c42))
+* Use async when possible and check exists before using realpath ([#114](https://github.com/kapetacom/local-cluster-service/issues/114)) ([9abb498](https://github.com/kapetacom/local-cluster-service/commit/9abb498191b68952f8789a800cc6ad8b2defcb20))
+
+## [0.33.5](https://github.com/kapetacom/local-cluster-service/compare/v0.33.4...v0.33.5) (2024-01-06)
+
+
+### Bug Fixes
+
+* Include query params in forwarded requests ([#113](https://github.com/kapetacom/local-cluster-service/issues/113)) ([6ccd067](https://github.com/kapetacom/local-cluster-service/commit/6ccd067de787de0c3d9ec21d0e8289778798d00e))
+
 ## [0.33.4](https://github.com/kapetacom/local-cluster-service/compare/v0.33.3...v0.33.4) (2024-01-04)
 
 

package/dist/cjs/src/assetManager.js

@@ -25,7 +25,7 @@ const CACHE_TTL = 60 * 60 * 1000; // 1 hour
 const UPGRADE_CHECK_INTERVAL = 10 * 60 * 1000; // 10 minutes
 const toKey = (ref) => `assetManager:asset:${ref}`;
 function filterExists(asset) {
-    return fs_extra_1.default.existsSync(asset.path);
+    return fs_extra_1.default.existsSync(asset.path) && fs_extra_1.default.existsSync(asset.ymlPath);
 }
 function enrichAsset(asset) {
     return {

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

@@ -6,6 +6,7 @@ import { DefinitionInfo } from '@kapeta/local-cluster-config';
 export declare const SAMPLE_PLAN_NAME = "kapeta/sample-java-chat-plan";
 declare class DefinitionsManager {
     private resolveDefinitionsAndSamples;
+    private prepareSample;
     private applyFilters;
     getDefinitions(kindFilter?: string | string[]): Promise<DefinitionInfo[]>;
     exists(ref: string): Promise<boolean>;

package/dist/cjs/src/definitionsManager.js

@@ -58,6 +58,16 @@ class DefinitionsManager {
             // Not logged in yet, so we can't rewrite the sample plan
             return definitions;
         }
+        try {
+            await this.prepareSample(definitions, samplePlan, profile);
+        }
+        catch (e) {
+            console.warn('Failed to prepare sample plan', e);
+        }
+        // Return the rewritten definitions
+        return local_cluster_config_1.default.getDefinitions();
+    }
+    async prepareSample(definitions, samplePlan, profile) {
         const newName = getRenamed(samplePlan, profile.handle);
         if (definitions.some((d) => d.definition.metadata.name === newName && d.version === 'local')) {
             // We already have a local version of the sample plan
@@ -104,8 +114,6 @@ class DefinitionsManager {
             await nodejs_registry_utils_1.Actions.link(progressListener, asset.path);
         }
         console.log('Rewrite done for sample plan');
-        // Return the rewritten definitions
-        return local_cluster_config_1.default.getDefinitions();
     }
     applyFilters(definitions, kindFilter) {
         if (kindFilter.length === 0) {

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

@@ -40,11 +40,16 @@ router.get('/:systemId/instances/:instanceId', (req, res) => {
  * Start all instances in a plan
  */
 router.post('/:systemId/start', async (req, res) => {
-    const task = await instanceManager_1.instanceManager.startAllForPlan(req.params.systemId);
-    res.status(202).send({
-        ok: true,
-        taskId: task.id,
-    });
+    try {
+        const task = await instanceManager_1.instanceManager.startAllForPlan(req.params.systemId);
+        res.status(202).send({
+            ok: true,
+            taskId: task.id,
+        });
+    }
+    catch (e) {
+        res.status(500).send({ ok: false, error: e.message });
+    }
 });
 /**
  * Stop all instances in plan
@@ -60,19 +65,24 @@ router.post('/:systemId/stop', async (req, res) => {
  * Start single instance in a plan
  */
 router.post('/:systemId/:instanceId/start', async (req, res) => {
-    const result = await instanceManager_1.instanceManager.start(req.params.systemId, req.params.instanceId);
-    if (result instanceof taskManager_1.Task) {
-        res.status(202).send({
-            ok: true,
-            taskId: result.id,
-        });
+    try {
+        const result = await instanceManager_1.instanceManager.start(req.params.systemId, req.params.instanceId);
+        if (result instanceof taskManager_1.Task) {
+            res.status(202).send({
+                ok: true,
+                taskId: result.id,
+            });
+        }
+        else {
+            res.status(202).send({
+                ok: true,
+                pid: result.pid,
+                type: result.type,
+            });
+        }
     }
-    else {
-        res.status(202).send({
-            ok: true,
-            pid: result.pid,
-            type: result.type,
-        });
+    catch (e) {
+        res.status(500).send({ ok: false, error: e.message });
     }
 });
 /**

package/dist/cjs/src/proxy/types/rest.js

@@ -76,6 +76,9 @@ function proxyRestRequest(req, res, opts) {
     if (!providerPath.startsWith('/')) {
         providerPath = '/' + providerPath;
     }
+    if (!lodash_1.default.isEmpty(req.query)) {
+        providerPath += '?' + new URLSearchParams(req.query).toString();
+    }
     const requestHeaders = lodash_1.default.clone(req.headers);
     delete requestHeaders['content-length'];
     delete requestHeaders['content-encoding'];

package/dist/cjs/src/proxy/types/web.js

@@ -25,6 +25,9 @@ function proxyHttpRequest(req, res, opts) {
     if (opts.consumerPath.startsWith(sourceBasePath)) {
         path = path.replace(sourceBasePath, targetBasePath);
     }
+    if (!lodash_1.default.isEmpty(req.query)) {
+        path += '?' + new URLSearchParams(req.query).toString();
+    }
     console.log('Proxy request to provider: %s => %s%s [http]', opts.consumerPath, opts.address, path);
     const reqOpts = {
         method: req.method,

package/dist/cjs/src/utils/BlockInstanceRunner.js

@@ -8,7 +8,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BlockInstanceRunner = exports.resolvePortType = void 0;
-const node_fs_1 = __importDefault(require("node:fs"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
 const local_cluster_config_1 = __importDefault(require("@kapeta/local-cluster-config"));
 const utils_1 = require("./utils");
 const nodejs_utils_1 = require("@kapeta/nodejs-utils");
@@ -130,7 +130,7 @@ class BlockInstanceRunner {
      */
     async _startLocalProcess(blockInstance, blockInfo, env, assetVersion) {
         const baseDir = local_cluster_config_1.default.getRepositoryAssetPath(blockInfo.handle, blockInfo.name, blockInfo.version);
-        if (!node_fs_1.default.existsSync(baseDir)) {
+        if (!fs_extra_1.default.existsSync(baseDir)) {
             throw new Error(`Local block not registered correctly - expected symlink here: ${baseDir}.\n` +
                 `Make sure you've run "kap registry link" in your local directory to connect it to Kapeta`);
         }
@@ -173,7 +173,7 @@ class BlockInstanceRunner {
         if (localContainer.healthcheck) {
             HealthCheck = containerManager_1.containerManager.toDockerHealth({ cmd: localContainer.healthcheck });
         }
-        const realLocalPath = node_fs_1.default.realpathSync(baseDir);
+        const realLocalPath = await fs_extra_1.default.realpath(baseDir);
         const Mounts = containerManager_1.containerManager.toDockerMounts({
             [workingDir]: (0, containerManager_1.toLocalBindVolume)(realLocalPath),
         });
@@ -224,7 +224,7 @@ class BlockInstanceRunner {
     async _startDockerProcess(blockInstance, blockInfo, env, assetVersion) {
         const { versionFile } = local_cluster_config_1.default.getRepositoryAssetInfoPath(blockInfo.handle, blockInfo.name, blockInfo.version);
         const versionYml = versionFile;
-        if (!node_fs_1.default.existsSync(versionYml)) {
+        if (!fs_extra_1.default.existsSync(versionYml)) {
             throw new Error(`Did not find version info at the expected path: ${versionYml}`);
         }
         const versionInfo = (0, utils_1.readYML)(versionYml);
@@ -280,7 +280,7 @@ class BlockInstanceRunner {
     async _startOperatorProcess(blockInstance, blockUri, providerDefinition, env) {
         const { assetFile } = local_cluster_config_1.default.getRepositoryAssetInfoPath(blockUri.handle, blockUri.name, blockUri.version);
         const kapetaYmlPath = assetFile;
-        if (!node_fs_1.default.existsSync(kapetaYmlPath)) {
+        if (!fs_extra_1.default.existsSync(kapetaYmlPath)) {
             throw new Error(`Did not find kapeta.yml at the expected path: ${kapetaYmlPath}`);
         }
         const spec = providerDefinition.definition.spec;

package/dist/esm/src/assetManager.js

@@ -25,7 +25,7 @@ const CACHE_TTL = 60 * 60 * 1000; // 1 hour
 const UPGRADE_CHECK_INTERVAL = 10 * 60 * 1000; // 10 minutes
 const toKey = (ref) => `assetManager:asset:${ref}`;
 function filterExists(asset) {
-    return fs_extra_1.default.existsSync(asset.path);
+    return fs_extra_1.default.existsSync(asset.path) && fs_extra_1.default.existsSync(asset.ymlPath);
 }
 function enrichAsset(asset) {
     return {

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

@@ -6,6 +6,7 @@ import { DefinitionInfo } from '@kapeta/local-cluster-config';
 export declare const SAMPLE_PLAN_NAME = "kapeta/sample-java-chat-plan";
 declare class DefinitionsManager {
     private resolveDefinitionsAndSamples;
+    private prepareSample;
     private applyFilters;
     getDefinitions(kindFilter?: string | string[]): Promise<DefinitionInfo[]>;
     exists(ref: string): Promise<boolean>;

package/dist/esm/src/definitionsManager.js

@@ -58,6 +58,16 @@ class DefinitionsManager {
             // Not logged in yet, so we can't rewrite the sample plan
             return definitions;
         }
+        try {
+            await this.prepareSample(definitions, samplePlan, profile);
+        }
+        catch (e) {
+            console.warn('Failed to prepare sample plan', e);
+        }
+        // Return the rewritten definitions
+        return local_cluster_config_1.default.getDefinitions();
+    }
+    async prepareSample(definitions, samplePlan, profile) {
         const newName = getRenamed(samplePlan, profile.handle);
         if (definitions.some((d) => d.definition.metadata.name === newName && d.version === 'local')) {
             // We already have a local version of the sample plan
@@ -104,8 +114,6 @@ class DefinitionsManager {
             await nodejs_registry_utils_1.Actions.link(progressListener, asset.path);
         }
         console.log('Rewrite done for sample plan');
-        // Return the rewritten definitions
-        return local_cluster_config_1.default.getDefinitions();
     }
     applyFilters(definitions, kindFilter) {
         if (kindFilter.length === 0) {

package/dist/esm/src/instances/routes.js

@@ -40,11 +40,16 @@ router.get('/:systemId/instances/:instanceId', (req, res) => {
  * Start all instances in a plan
  */
 router.post('/:systemId/start', async (req, res) => {
-    const task = await instanceManager_1.instanceManager.startAllForPlan(req.params.systemId);
-    res.status(202).send({
-        ok: true,
-        taskId: task.id,
-    });
+    try {
+        const task = await instanceManager_1.instanceManager.startAllForPlan(req.params.systemId);
+        res.status(202).send({
+            ok: true,
+            taskId: task.id,
+        });
+    }
+    catch (e) {
+        res.status(500).send({ ok: false, error: e.message });
+    }
 });
 /**
  * Stop all instances in plan
@@ -60,19 +65,24 @@ router.post('/:systemId/stop', async (req, res) => {
  * Start single instance in a plan
  */
 router.post('/:systemId/:instanceId/start', async (req, res) => {
-    const result = await instanceManager_1.instanceManager.start(req.params.systemId, req.params.instanceId);
-    if (result instanceof taskManager_1.Task) {
-        res.status(202).send({
-            ok: true,
-            taskId: result.id,
-        });
+    try {
+        const result = await instanceManager_1.instanceManager.start(req.params.systemId, req.params.instanceId);
+        if (result instanceof taskManager_1.Task) {
+            res.status(202).send({
+                ok: true,
+                taskId: result.id,
+            });
+        }
+        else {
+            res.status(202).send({
+                ok: true,
+                pid: result.pid,
+                type: result.type,
+            });
+        }
     }
-    else {
-        res.status(202).send({
-            ok: true,
-            pid: result.pid,
-            type: result.type,
-        });
+    catch (e) {
+        res.status(500).send({ ok: false, error: e.message });
     }
 });
 /**

package/dist/esm/src/proxy/types/rest.js

@@ -76,6 +76,9 @@ function proxyRestRequest(req, res, opts) {
     if (!providerPath.startsWith('/')) {
         providerPath = '/' + providerPath;
     }
+    if (!lodash_1.default.isEmpty(req.query)) {
+        providerPath += '?' + new URLSearchParams(req.query).toString();
+    }
     const requestHeaders = lodash_1.default.clone(req.headers);
     delete requestHeaders['content-length'];
     delete requestHeaders['content-encoding'];

package/dist/esm/src/proxy/types/web.js

@@ -25,6 +25,9 @@ function proxyHttpRequest(req, res, opts) {
     if (opts.consumerPath.startsWith(sourceBasePath)) {
         path = path.replace(sourceBasePath, targetBasePath);
     }
+    if (!lodash_1.default.isEmpty(req.query)) {
+        path += '?' + new URLSearchParams(req.query).toString();
+    }
     console.log('Proxy request to provider: %s => %s%s [http]', opts.consumerPath, opts.address, path);
     const reqOpts = {
         method: req.method,

package/dist/esm/src/utils/BlockInstanceRunner.js

@@ -8,7 +8,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BlockInstanceRunner = exports.resolvePortType = void 0;
-const node_fs_1 = __importDefault(require("node:fs"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
 const local_cluster_config_1 = __importDefault(require("@kapeta/local-cluster-config"));
 const utils_1 = require("./utils");
 const nodejs_utils_1 = require("@kapeta/nodejs-utils");
@@ -130,7 +130,7 @@ class BlockInstanceRunner {
      */
     async _startLocalProcess(blockInstance, blockInfo, env, assetVersion) {
         const baseDir = local_cluster_config_1.default.getRepositoryAssetPath(blockInfo.handle, blockInfo.name, blockInfo.version);
-        if (!node_fs_1.default.existsSync(baseDir)) {
+        if (!fs_extra_1.default.existsSync(baseDir)) {
             throw new Error(`Local block not registered correctly - expected symlink here: ${baseDir}.\n` +
                 `Make sure you've run "kap registry link" in your local directory to connect it to Kapeta`);
         }
@@ -173,7 +173,7 @@ class BlockInstanceRunner {
         if (localContainer.healthcheck) {
             HealthCheck = containerManager_1.containerManager.toDockerHealth({ cmd: localContainer.healthcheck });
         }
-        const realLocalPath = node_fs_1.default.realpathSync(baseDir);
+        const realLocalPath = await fs_extra_1.default.realpath(baseDir);
         const Mounts = containerManager_1.containerManager.toDockerMounts({
             [workingDir]: (0, containerManager_1.toLocalBindVolume)(realLocalPath),
         });
@@ -224,7 +224,7 @@ class BlockInstanceRunner {
     async _startDockerProcess(blockInstance, blockInfo, env, assetVersion) {
         const { versionFile } = local_cluster_config_1.default.getRepositoryAssetInfoPath(blockInfo.handle, blockInfo.name, blockInfo.version);
         const versionYml = versionFile;
-        if (!node_fs_1.default.existsSync(versionYml)) {
+        if (!fs_extra_1.default.existsSync(versionYml)) {
             throw new Error(`Did not find version info at the expected path: ${versionYml}`);
         }
         const versionInfo = (0, utils_1.readYML)(versionYml);
@@ -280,7 +280,7 @@ class BlockInstanceRunner {
     async _startOperatorProcess(blockInstance, blockUri, providerDefinition, env) {
         const { assetFile } = local_cluster_config_1.default.getRepositoryAssetInfoPath(blockUri.handle, blockUri.name, blockUri.version);
         const kapetaYmlPath = assetFile;
-        if (!node_fs_1.default.existsSync(kapetaYmlPath)) {
+        if (!fs_extra_1.default.existsSync(kapetaYmlPath)) {
             throw new Error(`Did not find kapeta.yml at the expected path: ${kapetaYmlPath}`);
         }
         const spec = providerDefinition.definition.spec;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kapeta/local-cluster-service",
-    "version": "0.33.4",
+    "version": "0.33.6",
     "description": "Manages configuration, ports and service discovery for locally running Kapeta systems",
     "type": "commonjs",
     "exports": {

package/src/assetManager.ts

@@ -37,7 +37,7 @@ export interface EnrichedAsset {
 }
 
 function filterExists(asset: DefinitionInfo): boolean {
-    return FS.existsSync(asset.path);
+    return FS.existsSync(asset.path) && FS.existsSync(asset.ymlPath);
 }
 
 function enrichAsset(asset: DefinitionInfo): EnrichedAsset {

package/src/definitionsManager.ts

@@ -6,7 +6,7 @@
 import ClusterConfiguration, { DefinitionInfo } from '@kapeta/local-cluster-config';
 import { parseKapetaUri, normalizeKapetaUri, parseVersion } from '@kapeta/nodejs-utils';
 import { cacheManager, doCached } from './cacheManager';
-import { KapetaAPI } from '@kapeta/nodejs-api-client';
+import { ExtendedIdentity, KapetaAPI } from '@kapeta/nodejs-api-client';
 import { Plan } from '@kapeta/schemas';
 import FS from 'fs-extra';
 import YAML from 'yaml';
@@ -58,12 +58,24 @@ class DefinitionsManager {
             // Not logged in yet, so we can't rewrite the sample plan
             return definitions;
         }
+
         const profile = await api.getCurrentIdentity();
         if (!profile) {
             // Not logged in yet, so we can't rewrite the sample plan
             return definitions;
         }
 
+        try {
+            await this.prepareSample(definitions, samplePlan, profile);
+        } catch (e) {
+            console.warn('Failed to prepare sample plan', e);
+        }
+
+        // Return the rewritten definitions
+        return ClusterConfiguration.getDefinitions();
+    }
+
+    private async prepareSample(definitions: DefinitionInfo[], samplePlan: DefinitionInfo, profile: ExtendedIdentity) {
         const newName = getRenamed(samplePlan, profile.handle);
 
         if (definitions.some((d) => d.definition.metadata.name === newName && d.version === 'local')) {
@@ -124,9 +136,6 @@ class DefinitionsManager {
         }
 
         console.log('Rewrite done for sample plan');
-
-        // Return the rewritten definitions
-        return ClusterConfiguration.getDefinitions();
     }
 
     private applyFilters(definitions: DefinitionInfo[], kindFilter: string[]): DefinitionInfo[] {

package/src/instances/routes.ts

@@ -41,12 +41,16 @@ router.get('/:systemId/instances/:instanceId', (req: Request, res: Response) =>
  * Start all instances in a plan
  */
 router.post('/:systemId/start', async (req: Request, res: Response) => {
-    const task = await instanceManager.startAllForPlan(req.params.systemId);
+    try {
+        const task = await instanceManager.startAllForPlan(req.params.systemId);
 
-    res.status(202).send({
-        ok: true,
-        taskId: task.id,
-    });
+        res.status(202).send({
+            ok: true,
+            taskId: task.id,
+        });
+    } catch (e: any) {
+        res.status(500).send({ ok: false, error: e.message });
+    }
 });
 
 /**
@@ -65,18 +69,22 @@ router.post('/:systemId/stop', async (req: Request, res: Response) => {
  * Start single instance in a plan
  */
 router.post('/:systemId/:instanceId/start', async (req: Request, res: Response) => {
-    const result = await instanceManager.start(req.params.systemId, req.params.instanceId);
-    if (result instanceof Task) {
-        res.status(202).send({
-            ok: true,
-            taskId: result.id,
-        });
-    } else {
-        res.status(202).send({
-            ok: true,
-            pid: result.pid,
-            type: result.type,
-        });
+    try {
+        const result = await instanceManager.start(req.params.systemId, req.params.instanceId);
+        if (result instanceof Task) {
+            res.status(202).send({
+                ok: true,
+                taskId: result.id,
+            });
+        } else {
+            res.status(202).send({
+                ok: true,
+                pid: result.pid,
+                type: result.type,
+            });
+        }
+    } catch (e: any) {
+        res.status(500).send({ ok: false, error: e.message });
     }
 });
 

package/src/proxy/types/rest.ts

@@ -104,6 +104,10 @@ export function proxyRestRequest(req: StringBodyRequest, res: Response, opts: Pr
         providerPath = '/' + providerPath;
     }
 
+    if (!_.isEmpty(req.query)) {
+        providerPath += '?' + new URLSearchParams(req.query as any).toString();
+    }
+
     const requestHeaders = _.clone(req.headers);
 
     delete requestHeaders['content-length'];

package/src/proxy/types/web.ts

@@ -27,6 +27,10 @@ export function proxyHttpRequest(req: StringBodyRequest, res: Response, opts: Pr
         path = path.replace(sourceBasePath, targetBasePath);
     }
 
+    if (!_.isEmpty(req.query)) {
+        path += '?' + new URLSearchParams(req.query as any).toString();
+    }
+
     console.log('Proxy request to provider: %s => %s%s [http]', opts.consumerPath, opts.address, path);
 
     const reqOpts: SimpleRequest = {

package/src/utils/BlockInstanceRunner.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: BUSL-1.1
  */
 
-import FS from 'node:fs';
+import FSExtra from 'fs-extra';
 import ClusterConfig, { DefinitionInfo } from '@kapeta/local-cluster-config';
 import { getBindHost, getBlockInstanceContainerName, readYML } from './utils';
 import { KapetaURI, parseKapetaUri, normalizeKapetaUri } from '@kapeta/nodejs-utils';
@@ -162,7 +162,7 @@ export class BlockInstanceRunner {
     ): Promise<ProcessInfo> {
         const baseDir = ClusterConfig.getRepositoryAssetPath(blockInfo.handle, blockInfo.name, blockInfo.version);
 
-        if (!FS.existsSync(baseDir)) {
+        if (!FSExtra.existsSync(baseDir)) {
             throw new Error(
                 `Local block not registered correctly - expected symlink here: ${baseDir}.\n` +
                     `Make sure you've run "kap registry link" in your local directory to connect it to Kapeta`
@@ -226,7 +226,7 @@ export class BlockInstanceRunner {
             HealthCheck = containerManager.toDockerHealth({ cmd: localContainer.healthcheck });
         }
 
-        const realLocalPath = FS.realpathSync(baseDir);
+        const realLocalPath = await FSExtra.realpath(baseDir);
 
         const Mounts = containerManager.toDockerMounts({
             [workingDir]: toLocalBindVolume(realLocalPath),
@@ -293,7 +293,7 @@ export class BlockInstanceRunner {
         );
 
         const versionYml = versionFile;
-        if (!FS.existsSync(versionYml)) {
+        if (!FSExtra.existsSync(versionYml)) {
             throw new Error(`Did not find version info at the expected path: ${versionYml}`);
         }
 
@@ -373,7 +373,7 @@ export class BlockInstanceRunner {
         );
 
         const kapetaYmlPath = assetFile;
-        if (!FS.existsSync(kapetaYmlPath)) {
+        if (!FSExtra.existsSync(kapetaYmlPath)) {
             throw new Error(`Did not find kapeta.yml at the expected path: ${kapetaYmlPath}`);
         }