@kapeta/local-cluster-service 0.19.4 → 0.19.6

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.19.6](https://github.com/kapetacom/local-cluster-service/compare/v0.19.5...v0.19.6) (2023-09-08)
+
+
+### Bug Fixes
+
+* Allow more docker opts from language targets ([#71](https://github.com/kapetacom/local-cluster-service/issues/71)) ([dd9e9bb](https://github.com/kapetacom/local-cluster-service/commit/dd9e9bb91fb6aa6d082b1864b268234ece9b8920))
+
+## [0.19.5](https://github.com/kapetacom/local-cluster-service/compare/v0.19.4...v0.19.5) (2023-09-07)
+
+
+### Bug Fixes
+
+* Handle query and hash in path matching ([#70](https://github.com/kapetacom/local-cluster-service/issues/70)) ([e743cf8](https://github.com/kapetacom/local-cluster-service/commit/e743cf80c6754f43c948fd25967f04808429a784))
+
 ## [0.19.4](https://github.com/kapetacom/local-cluster-service/compare/v0.19.3...v0.19.4) (2023-09-05)
 
 

package/dist/cjs/src/proxy/types/rest.d.ts

@@ -1,4 +1,6 @@
 import { Response } from 'express';
 import { ProxyRequestInfo } from '../../types';
 import { StringBodyRequest } from '../../middleware/stringBody';
+import { Resource } from '@kapeta/schemas';
+export declare function getRestMethodId(restResource: Resource, httpMethod: string, httpPath: string): string | undefined;
 export declare function proxyRestRequest(req: StringBodyRequest, res: Response, opts: ProxyRequestInfo): void;

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.proxyRestRequest = void 0;
+exports.proxyRestRequest = exports.getRestMethodId = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const request_1 = __importDefault(require("request"));
 const path_1 = __importDefault(require("path"));
@@ -24,6 +24,7 @@ function getRestMethodId(restResource, httpMethod, httpPath) {
         return pathTemplate.matches(httpPath);
     });
 }
+exports.getRestMethodId = getRestMethodId;
 /**
  *
  * @param req {Request}

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

@@ -135,22 +135,31 @@ class BlockInstanceRunner {
         const dockerOpts = localContainer.options ?? {};
         const homeDir = localContainer.userHome ? localContainer.userHome : '/root';
         const workingDir = localContainer.workingDir ? localContainer.workingDir : '/workspace';
+        const customHostConfigs = localContainer.HostConfig ?? {};
+        const customLabels = localContainer.Labels ?? {};
+        const customEnvs = localContainer.Env ?? [];
+        delete localContainer.HostConfig;
+        delete localContainer.Labels;
+        delete localContainer.Env;
         const { PortBindings, ExposedPorts, addonEnv } = await this.getDockerPortBindings(blockInstance, assetVersion);
         let HealthCheck = undefined;
         if (localContainer.healthcheck) {
             HealthCheck = containerManager_1.containerManager.toDockerHealth({ cmd: localContainer.healthcheck });
         }
         return this.ensureContainer({
+            ...dockerOpts,
             Image: dockerImage,
             name: containerName,
             WorkingDir: workingDir,
             Labels: {
+                ...customLabels,
                 instance: blockInstance.id,
             },
             HealthCheck,
             ExposedPorts,
             Cmd: startCmd ? startCmd.split(/\s+/g) : [],
             Env: [
+                ...customEnvs,
                 ...DOCKER_ENV_VARS,
                 `KAPETA_LOCAL_CLUSTER_PORT=${clusterService_1.clusterService.getClusterServicePort()}`,
                 ...Object.entries({
@@ -159,13 +168,13 @@ class BlockInstanceRunner {
                 }).map(([key, value]) => `${key}=${value}`),
             ],
             HostConfig: {
+                ...customHostConfigs,
                 Binds: [
                     `${(0, containerManager_1.toLocalBindVolume)(local_cluster_config_1.default.getKapetaBasedir())}:${homeDir}/.kapeta`,
                     `${(0, containerManager_1.toLocalBindVolume)(baseDir)}:${workingDir}`,
                 ],
                 PortBindings,
             },
-            ...dockerOpts,
         });
     }
     async _startDockerProcess(blockInstance, blockInfo, env, assetVersion) {

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

@@ -3,6 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.pathTemplateParser = exports.PathTemplate = void 0;
 const TYPE_VARIABLE = 'variable';
 const TYPE_PATH = 'path';
+function normalizePath(path) {
+    if (!path.startsWith('/')) {
+        path = '/' + path;
+    }
+    if (path.includes('#')) {
+        path = path.split('#')[0];
+    }
+    if (path.includes('?')) {
+        path = path.split('?')[0];
+    }
+    return path;
+}
 /**
  * A path template is a string that can be used to match a path and extract variables from it.
  *
@@ -62,9 +74,7 @@ class PathTemplate {
         return this.parse(path) !== null;
     }
     parse(path) {
-        if (!path.startsWith('/')) {
-            path = '/' + path;
-        }
+        path = normalizePath(path);
         const values = {};
         for (let i = 0; i < this._parts.length; i++) {
             const part = this._parts[i];

package/dist/cjs/test/proxy/types/rest.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const rest_1 = require("../../../src/proxy/types/rest");
+describe('getRestMethodId', () => {
+    it('should match @Query in url', () => {
+        const restResource = new TestResource();
+        const restMethodId = (0, rest_1.getRestMethodId)(restResource, "POST", "/names?name=Ib");
+        expect(restMethodId).toBeDefined();
+    });
+});
+class TestResource {
+    kind = "";
+    metadata = new TestResourceMetaData();
+    get spec() {
+        return {
+            methods: [
+                {
+                    responseType: {
+                        ref: "Name[]"
+                    },
+                    method: "GET",
+                    path: "/names",
+                    arguments: {}
+                },
+                {
+                    responseType: {
+                        ref: "Name"
+                    },
+                    method: "POST",
+                    path: "/names",
+                    arguments: {
+                        name: {
+                            type: "string",
+                            transport: "QUERY"
+                        }
+                    }
+                }
+            ]
+        };
+    }
+    ;
+}
+class TestResourceMetaData {
+    name = "";
+}

package/dist/cjs/test/utils/pathTemplateParser.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/test/utils/pathTemplateParser.test.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const pathTemplateParser_1 = require("../../src/utils/pathTemplateParser");
+describe('pathTemplateParser', () => {
+    it('must return parameters for query parameters from parse', () => {
+        const template = new pathTemplateParser_1.PathTemplate('/names');
+        const parse = template.parse('/names?name=Ib#test');
+        console.log(parse);
+        expect(parse).toBeTruthy();
+    });
+    it('must return parameters defined in url', () => {
+        const template = new pathTemplateParser_1.PathTemplate('/names/{identityId}');
+        const parse = template.parse('/names/idn_xxyyzz');
+        expect(parse).toBeTruthy();
+        expect(parse).toMatchObject({ identityId: 'idn_xxyyzz' });
+    });
+    it('must return parameters defined in url regardless of query parameters', () => {
+        const template = new pathTemplateParser_1.PathTemplate('/names/{identityId}');
+        const parse = template.parse('/names/idn_xxyyzz?name=Ib#test');
+        expect(parse).toBeTruthy();
+        expect(parse).toMatchObject({ identityId: 'idn_xxyyzz' });
+    });
+});

package/dist/esm/src/proxy/types/rest.d.ts

@@ -1,4 +1,6 @@
 import { Response } from 'express';
 import { ProxyRequestInfo } from '../../types';
 import { StringBodyRequest } from '../../middleware/stringBody';
+import { Resource } from '@kapeta/schemas';
+export declare function getRestMethodId(restResource: Resource, httpMethod: string, httpPath: string): string | undefined;
 export declare function proxyRestRequest(req: StringBodyRequest, res: Response, opts: ProxyRequestInfo): void;

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.proxyRestRequest = void 0;
+exports.proxyRestRequest = exports.getRestMethodId = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const request_1 = __importDefault(require("request"));
 const path_1 = __importDefault(require("path"));
@@ -24,6 +24,7 @@ function getRestMethodId(restResource, httpMethod, httpPath) {
         return pathTemplate.matches(httpPath);
     });
 }
+exports.getRestMethodId = getRestMethodId;
 /**
  *
  * @param req {Request}

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

@@ -135,22 +135,31 @@ class BlockInstanceRunner {
         const dockerOpts = localContainer.options ?? {};
         const homeDir = localContainer.userHome ? localContainer.userHome : '/root';
         const workingDir = localContainer.workingDir ? localContainer.workingDir : '/workspace';
+        const customHostConfigs = localContainer.HostConfig ?? {};
+        const customLabels = localContainer.Labels ?? {};
+        const customEnvs = localContainer.Env ?? [];
+        delete localContainer.HostConfig;
+        delete localContainer.Labels;
+        delete localContainer.Env;
         const { PortBindings, ExposedPorts, addonEnv } = await this.getDockerPortBindings(blockInstance, assetVersion);
         let HealthCheck = undefined;
         if (localContainer.healthcheck) {
             HealthCheck = containerManager_1.containerManager.toDockerHealth({ cmd: localContainer.healthcheck });
         }
         return this.ensureContainer({
+            ...dockerOpts,
             Image: dockerImage,
             name: containerName,
             WorkingDir: workingDir,
             Labels: {
+                ...customLabels,
                 instance: blockInstance.id,
             },
             HealthCheck,
             ExposedPorts,
             Cmd: startCmd ? startCmd.split(/\s+/g) : [],
             Env: [
+                ...customEnvs,
                 ...DOCKER_ENV_VARS,
                 `KAPETA_LOCAL_CLUSTER_PORT=${clusterService_1.clusterService.getClusterServicePort()}`,
                 ...Object.entries({
@@ -159,13 +168,13 @@ class BlockInstanceRunner {
                 }).map(([key, value]) => `${key}=${value}`),
             ],
             HostConfig: {
+                ...customHostConfigs,
                 Binds: [
                     `${(0, containerManager_1.toLocalBindVolume)(local_cluster_config_1.default.getKapetaBasedir())}:${homeDir}/.kapeta`,
                     `${(0, containerManager_1.toLocalBindVolume)(baseDir)}:${workingDir}`,
                 ],
                 PortBindings,
             },
-            ...dockerOpts,
         });
     }
     async _startDockerProcess(blockInstance, blockInfo, env, assetVersion) {

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

@@ -3,6 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.pathTemplateParser = exports.PathTemplate = void 0;
 const TYPE_VARIABLE = 'variable';
 const TYPE_PATH = 'path';
+function normalizePath(path) {
+    if (!path.startsWith('/')) {
+        path = '/' + path;
+    }
+    if (path.includes('#')) {
+        path = path.split('#')[0];
+    }
+    if (path.includes('?')) {
+        path = path.split('?')[0];
+    }
+    return path;
+}
 /**
  * A path template is a string that can be used to match a path and extract variables from it.
  *
@@ -62,9 +74,7 @@ class PathTemplate {
         return this.parse(path) !== null;
     }
     parse(path) {
-        if (!path.startsWith('/')) {
-            path = '/' + path;
-        }
+        path = normalizePath(path);
         const values = {};
         for (let i = 0; i < this._parts.length; i++) {
             const part = this._parts[i];

package/dist/esm/test/proxy/types/rest.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const rest_1 = require("../../../src/proxy/types/rest");
+describe('getRestMethodId', () => {
+    it('should match @Query in url', () => {
+        const restResource = new TestResource();
+        const restMethodId = (0, rest_1.getRestMethodId)(restResource, "POST", "/names?name=Ib");
+        expect(restMethodId).toBeDefined();
+    });
+});
+class TestResource {
+    kind = "";
+    metadata = new TestResourceMetaData();
+    get spec() {
+        return {
+            methods: [
+                {
+                    responseType: {
+                        ref: "Name[]"
+                    },
+                    method: "GET",
+                    path: "/names",
+                    arguments: {}
+                },
+                {
+                    responseType: {
+                        ref: "Name"
+                    },
+                    method: "POST",
+                    path: "/names",
+                    arguments: {
+                        name: {
+                            type: "string",
+                            transport: "QUERY"
+                        }
+                    }
+                }
+            ]
+        };
+    }
+    ;
+}
+class TestResourceMetaData {
+    name = "";
+}

package/dist/esm/test/utils/pathTemplateParser.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/test/utils/pathTemplateParser.test.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const pathTemplateParser_1 = require("../../src/utils/pathTemplateParser");
+describe('pathTemplateParser', () => {
+    it('must return parameters for query parameters from parse', () => {
+        const template = new pathTemplateParser_1.PathTemplate('/names');
+        const parse = template.parse('/names?name=Ib#test');
+        console.log(parse);
+        expect(parse).toBeTruthy();
+    });
+    it('must return parameters defined in url', () => {
+        const template = new pathTemplateParser_1.PathTemplate('/names/{identityId}');
+        const parse = template.parse('/names/idn_xxyyzz');
+        expect(parse).toBeTruthy();
+        expect(parse).toMatchObject({ identityId: 'idn_xxyyzz' });
+    });
+    it('must return parameters defined in url regardless of query parameters', () => {
+        const template = new pathTemplateParser_1.PathTemplate('/names/{identityId}');
+        const parse = template.parse('/names/idn_xxyyzz?name=Ib#test');
+        expect(parse).toBeTruthy();
+        expect(parse).toMatchObject({ identityId: 'idn_xxyyzz' });
+    });
+});

package/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    transform: {
+        '^.+\\.ts?$': 'ts-jest',
+    },
+    transformIgnorePatterns: ['<rootDir>/node_modules/'],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kapeta/local-cluster-service",
-    "version": "0.19.4",
+    "version": "0.19.6",
     "description": "Manages configuration, ports and service discovery for locally running Kapeta systems",
     "type": "commonjs",
     "exports": {
@@ -32,7 +32,7 @@
     "scripts": {
         "start": "node ./dist/cjs/start.js",
         "dev": "nodemon -e js,ts,json ./start.ts",
-        "test": "echo its fine",
+        "test": "jest",
         "clean": "rm -rf ./dist",
         "build:esm": "tsc --module nodenext --moduleResolution nodenext --outDir ./dist/esm && echo '{\"type\":\"module\"}' > ./dist/esm/package.json",
         "build:cjs": "tsc  --outDir ./dist/cjs && echo '{\"type\":\"commonjs\"}' > ./dist/cjs/package.json",
@@ -80,6 +80,7 @@
         "@types/fs-extra": "^11.0.1",
         "@types/glob": "^8.1.0",
         "@types/gunzip-maybe": "^1.4.0",
+        "@types/jest": "^29.5.4",
         "@types/lodash": "^4.14.195",
         "@types/md5": "^2.3.2",
         "@types/node": "^20.5.8",
@@ -88,8 +89,10 @@
         "@types/tar-stream": "^2.2.2",
         "eslint": "^8.42.0",
         "eslint-config-prettier": "^8.8.0",
+        "jest": "^29.6.4",
         "nodemon": "^2.0.2",
         "prettier": "^2.8.8",
+        "ts-jest": "^29.1.1",
         "ts-node": "^10.9.1"
     },
     "prettier": "@kapeta/prettier-config",

package/src/proxy/types/rest.ts

@@ -10,7 +10,7 @@ import { ProxyRequestInfo, SimpleRequest, StringMap } from '../../types';
 import { StringBodyRequest } from '../../middleware/stringBody';
 import { Resource } from '@kapeta/schemas';
 
-function getRestMethodId(restResource: Resource, httpMethod: string, httpPath: string) {
+export function getRestMethodId(restResource: Resource, httpMethod: string, httpPath: string) {
     return _.findKey(restResource.spec.methods, (method) => {
         let methodType = method.method ? method.method.toUpperCase() : 'GET';
 

package/src/utils/BlockInstanceRunner.ts

@@ -171,6 +171,13 @@ export class BlockInstanceRunner {
         const homeDir = localContainer.userHome ? localContainer.userHome : '/root';
         const workingDir = localContainer.workingDir ? localContainer.workingDir : '/workspace';
 
+        const customHostConfigs = localContainer.HostConfig ?? {};
+        const customLabels = localContainer.Labels ?? {};
+        const customEnvs = localContainer.Env ?? [];
+        delete localContainer.HostConfig;
+        delete localContainer.Labels;
+        delete localContainer.Env;
+
         const { PortBindings, ExposedPorts, addonEnv } = await this.getDockerPortBindings(blockInstance, assetVersion);
 
         let HealthCheck = undefined;
@@ -179,16 +186,19 @@ export class BlockInstanceRunner {
         }
 
         return this.ensureContainer({
+            ...dockerOpts,
             Image: dockerImage,
             name: containerName,
             WorkingDir: workingDir,
             Labels: {
+                ...customLabels,
                 instance: blockInstance.id,
             },
             HealthCheck,
             ExposedPorts,
             Cmd: startCmd ? startCmd.split(/\s+/g) : [],
             Env: [
+                ...customEnvs,
                 ...DOCKER_ENV_VARS,
                 `KAPETA_LOCAL_CLUSTER_PORT=${clusterService.getClusterServicePort()}`,
                 ...Object.entries({
@@ -197,13 +207,13 @@ export class BlockInstanceRunner {
                 }).map(([key, value]) => `${key}=${value}`),
             ],
             HostConfig: {
+                ...customHostConfigs,
                 Binds: [
                     `${toLocalBindVolume(ClusterConfig.getKapetaBasedir())}:${homeDir}/.kapeta`,
                     `${toLocalBindVolume(baseDir)}:${workingDir}`,
                 ],
                 PortBindings,
             },
-            ...dockerOpts,
         });
     }
 

package/src/utils/pathTemplateParser.ts

@@ -3,6 +3,22 @@ import { StringMap } from '../types';
 const TYPE_VARIABLE = 'variable';
 const TYPE_PATH = 'path';
 
+function normalizePath(path: string) {
+    if (!path.startsWith('/')) {
+        path = '/' + path;
+    }
+
+    if (path.includes('#')) {
+        path = path.split('#')[0];
+    }
+
+    if (path.includes('?')) {
+        path = path.split('?')[0];
+    }
+
+    return path;
+}
+
 /**
  * A path template is a string that can be used to match a path and extract variables from it.
  *
@@ -71,9 +87,7 @@ export class PathTemplate {
     }
 
     parse(path: string) {
-        if (!path.startsWith('/')) {
-            path = '/' + path;
-        }
+        path = normalizePath(path);
 
         const values: StringMap = {};
 

package/test/proxy/types/rest.test.ts

@@ -0,0 +1,49 @@
+import {getRestMethodId} from "../../../src/proxy/types/rest";
+import {Resource, ResourceMetadata} from '@kapeta/schemas';
+
+describe('getRestMethodId', () => {
+    it('should match @Query in url', () => {
+        const restResource = new TestResource();
+
+        const restMethodId = getRestMethodId(restResource, "POST", "/names?name=Ib");
+        expect(restMethodId).toBeDefined();
+    })
+});
+
+class TestResource implements Resource {
+    kind = "";
+    metadata = new TestResourceMetaData();
+
+    get spec(): { [p: string]: any } {
+        return {
+            methods: [
+                {
+                    responseType: {
+                        ref: "Name[]"
+                    },
+                    method: "GET",
+                    path: "/names",
+                    arguments: {}
+                },
+                {
+                    responseType: {
+                        ref: "Name"
+                    },
+                    method: "POST",
+                    path: "/names",
+                    arguments: {
+                        name: {
+                            type: "string",
+                            transport: "QUERY"
+                        }
+                    }
+                }
+            ]
+        }
+    };
+}
+
+class TestResourceMetaData implements ResourceMetadata {
+    [property: string]: any;
+    name: string = "";
+}

package/test/utils/pathTemplateParser.test.ts

@@ -0,0 +1,24 @@
+import { PathTemplate } from '../../src/utils/pathTemplateParser';
+
+describe('pathTemplateParser', () => {
+    it('must return parameters for query parameters from parse', () => {
+        const template = new PathTemplate('/names');
+        const parse = template.parse('/names?name=Ib#test');
+        console.log(parse);
+        expect(parse).toBeTruthy();
+    });
+
+    it('must return parameters defined in url', () => {
+        const template = new PathTemplate('/names/{identityId}');
+        const parse = template.parse('/names/idn_xxyyzz');
+        expect(parse).toBeTruthy();
+        expect(parse).toMatchObject({ identityId: 'idn_xxyyzz' });
+    });
+
+    it('must return parameters defined in url regardless of query parameters', () => {
+        const template = new PathTemplate('/names/{identityId}');
+        const parse = template.parse('/names/idn_xxyyzz?name=Ib#test');
+        expect(parse).toBeTruthy();
+        expect(parse).toMatchObject({ identityId: 'idn_xxyyzz' });
+    });
+});

package/tsconfig.json

@@ -9,6 +9,6 @@
     "ts-node": {
         "files": true
     },
-    "include": ["definitions.d.ts", "src/**/*", "index.ts", "start.ts"],
+    "include": ["definitions.d.ts", "src/**/*", "index.ts", "start.ts", "test/**/*.ts"],
     "exclude": ["node_modules", "dist"]
 }