@kapeta/local-cluster-service 0.40.0 → 0.40.2

package/.github/workflows/main.yml

@@ -8,9 +8,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           token: ${{ secrets.BOT_TOKEN }}
+          fetch-depth: 0
       - uses: actions/setup-node@v3
       - run: npm ci
       - run: npm run build --if-present

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.40.2](https://github.com/kapetacom/local-cluster-service/compare/v0.40.1...v0.40.2) (2024-03-11)
+
+
+### Bug Fixes
+
+* Several issues when running external docker images ([#132](https://github.com/kapetacom/local-cluster-service/issues/132)) ([5218368](https://github.com/kapetacom/local-cluster-service/commit/521836819aa39084fe1c4f781fb560682e42fc8f))
+
+## [0.40.1](https://github.com/kapetacom/local-cluster-service/compare/v0.40.0...v0.40.1) (2024-02-28)
+
+
+### Bug Fixes
+
+* bump release ([1a6fbb2](https://github.com/kapetacom/local-cluster-service/commit/1a6fbb2d8095e1bc7878e35e52fe40a5a498f9e6))
+
 # [0.40.0](https://github.com/kapetacom/local-cluster-service/compare/v0.39.2...v0.40.0) (2024-02-28)
 
 

package/dist/cjs/src/containerManager.js

@@ -216,6 +216,10 @@ class ContainerManager {
         if (!tag) {
             tag = 'latest';
         }
+        if (tag === 'local') {
+            // Local image - no need to pull
+            return false;
+        }
         const imageTagList = (await this.docker().listImages({}))
             .filter((imageData) => !!imageData.RepoTags)
             .map((imageData) => imageData.RepoTags);
@@ -619,16 +623,22 @@ class ContainerManager {
     buildDockerImage(dockerFile, imageName) {
         const taskName = `Building docker image: ${imageName}`;
         const processor = async (task) => {
-            const timeStarted = Date.now();
-            const stream = await this.docker().buildImage({
+            const baseDir = path_1.default.dirname(dockerFile);
+            const entries = await fs_extra_1.default.readdir(baseDir);
+            const contextInfo = {
                 context: path_1.default.dirname(dockerFile),
-                src: [path_1.default.basename(dockerFile)],
-            }, {
+                src: entries,
+            };
+            const stream = await this.docker().buildImage(contextInfo, {
                 t: imageName,
                 dockerfile: path_1.default.basename(dockerFile),
             });
             await processJsonStream(`image:build:${imageName}`, stream, (data) => {
-                if (data.stream) {
+                if (data.error) {
+                    task.future.reject(new Error(data.error));
+                    task.addLog(data.error, 'ERROR');
+                }
+                else if (data.stream) {
                     // Emit raw output to the task log
                     task.addLog(data.stream);
                 }

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

@@ -15,6 +15,7 @@ const pathTemplateParser_1 = require("../../utils/pathTemplateParser");
 const networkManager_1 = require("../../networkManager");
 const socketManager_1 = require("../../socketManager");
 const qs_1 = require("qs");
+const web_1 = require("./web");
 function getRestMethodId(restResource, httpMethod, httpPath) {
     return lodash_1.default.findKey(restResource.spec.methods, (method) => {
         let methodType = method.method ? method.method.toUpperCase() : 'GET';
@@ -63,6 +64,10 @@ function resolveMethods(req, opts) {
     };
 }
 function proxyRestRequest(req, res, opts) {
+    if (lodash_1.default.isEmpty(opts.consumerResource.spec.methods) && lodash_1.default.isEmpty(opts.providerResource.spec.methods)) {
+        // If there are no methods defined, we assume the user controls the path and we just proxy the raw request
+        return (0, web_1.proxyHttpRequest)(req, res, opts);
+    }
     let { consumerMethod, providerMethod } = resolveMethods(req, opts);
     const consumerPathTemplate = (0, pathTemplateParser_1.pathTemplateParser)(consumerMethod.path);
     const providerPathTemplate = (0, pathTemplateParser_1.pathTemplateParser)(providerMethod.path);

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

@@ -20,8 +20,8 @@ function proxyHttpRequest(req, res, opts) {
     delete requestHeaders['connection'];
     delete requestHeaders['host'];
     delete requestHeaders['origin'];
-    const sourceBasePath = opts.consumerResource.spec.path;
-    const targetBasePath = opts.providerResource.spec.path;
+    const sourceBasePath = opts.consumerResource.spec.path ?? '/';
+    const targetBasePath = opts.providerResource.spec.path ?? '/';
     let path = opts.consumerPath;
     if (opts.consumerPath.startsWith(sourceBasePath)) {
         path = path.replace(sourceBasePath, targetBasePath);

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

@@ -34,7 +34,7 @@ const DOCKER_ENV_VARS = [
     `KAPETA_LOCAL_SERVER=0.0.0.0`,
     `KAPETA_LOCAL_CLUSTER_HOST=${types_1.DOCKER_HOST_INTERNAL}`,
     `KAPETA_ENVIRONMENT_TYPE=docker`,
-    `KAPETA_ENVIRONMENT_PLATFORM=${node_os_1.default.platform()}`
+    `KAPETA_ENVIRONMENT_PLATFORM=${node_os_1.default.platform()}`,
 ];
 async function getProvider(uri) {
     const providers = await definitionsManager_1.definitionsManager.getProviderDefinitions();
@@ -172,8 +172,15 @@ class BlockInstanceRunner {
             if (!fs_extra_1.default.existsSync(dockerFile)) {
                 throw new Error(`Dockerfile not found at: ${dockerFile}`);
             }
-            const task = containerManager_1.containerManager.buildDockerImage(dockerFile, blockInfo.fullName + ':local');
-            await task.wait();
+            console.log('Building docker image from Dockerfile "%s": %s ', dockerFile, dockerImage);
+            try {
+                const task = containerManager_1.containerManager.buildDockerImage(dockerFile, dockerImage);
+                await task.wait();
+            }
+            catch (err) {
+                throw new Error(`Error building docker image: ${err}`);
+            }
+            console.log('Docker images was build from file "%s": %s', dockerFile, dockerImage);
         }
         const containerName = await (0, utils_1.getBlockInstanceContainerName)(this._systemId, blockInstance.id, targetKindUri.id);
         const startCmd = localContainer.handlers?.onCreate ? localContainer.handlers.onCreate : '';
@@ -205,7 +212,7 @@ class BlockInstanceRunner {
             ...dockerOpts,
             Image: dockerImage,
             name: containerName,
-            WorkingDir: workingDir,
+            WorkingDir: isDockerImage ? workingDir : undefined,
             Labels: {
                 ...customLabels,
                 instance: blockInstance.id,

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

@@ -41,8 +41,8 @@ class InternalConfigProvider {
     getInstanceId() {
         return this.instanceId;
     }
-    getServerPort(portType) {
-        return serviceManager_1.serviceManager.ensureServicePort(this.systemId, this.instanceId, portType);
+    async getServerPort(portType) {
+        return '80';
     }
     async getServiceAddress(serviceName, portType) {
         return serviceManager_1.serviceManager.getConsumerAddress(this.systemId, this.instanceId, serviceName, portType, this.environment);

package/dist/esm/src/containerManager.js

@@ -216,6 +216,10 @@ class ContainerManager {
         if (!tag) {
             tag = 'latest';
         }
+        if (tag === 'local') {
+            // Local image - no need to pull
+            return false;
+        }
         const imageTagList = (await this.docker().listImages({}))
             .filter((imageData) => !!imageData.RepoTags)
             .map((imageData) => imageData.RepoTags);
@@ -619,16 +623,22 @@ class ContainerManager {
     buildDockerImage(dockerFile, imageName) {
         const taskName = `Building docker image: ${imageName}`;
         const processor = async (task) => {
-            const timeStarted = Date.now();
-            const stream = await this.docker().buildImage({
+            const baseDir = path_1.default.dirname(dockerFile);
+            const entries = await fs_extra_1.default.readdir(baseDir);
+            const contextInfo = {
                 context: path_1.default.dirname(dockerFile),
-                src: [path_1.default.basename(dockerFile)],
-            }, {
+                src: entries,
+            };
+            const stream = await this.docker().buildImage(contextInfo, {
                 t: imageName,
                 dockerfile: path_1.default.basename(dockerFile),
             });
             await processJsonStream(`image:build:${imageName}`, stream, (data) => {
-                if (data.stream) {
+                if (data.error) {
+                    task.future.reject(new Error(data.error));
+                    task.addLog(data.error, 'ERROR');
+                }
+                else if (data.stream) {
                     // Emit raw output to the task log
                     task.addLog(data.stream);
                 }

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

@@ -15,6 +15,7 @@ const pathTemplateParser_1 = require("../../utils/pathTemplateParser");
 const networkManager_1 = require("../../networkManager");
 const socketManager_1 = require("../../socketManager");
 const qs_1 = require("qs");
+const web_1 = require("./web");
 function getRestMethodId(restResource, httpMethod, httpPath) {
     return lodash_1.default.findKey(restResource.spec.methods, (method) => {
         let methodType = method.method ? method.method.toUpperCase() : 'GET';
@@ -63,6 +64,10 @@ function resolveMethods(req, opts) {
     };
 }
 function proxyRestRequest(req, res, opts) {
+    if (lodash_1.default.isEmpty(opts.consumerResource.spec.methods) && lodash_1.default.isEmpty(opts.providerResource.spec.methods)) {
+        // If there are no methods defined, we assume the user controls the path and we just proxy the raw request
+        return (0, web_1.proxyHttpRequest)(req, res, opts);
+    }
     let { consumerMethod, providerMethod } = resolveMethods(req, opts);
     const consumerPathTemplate = (0, pathTemplateParser_1.pathTemplateParser)(consumerMethod.path);
     const providerPathTemplate = (0, pathTemplateParser_1.pathTemplateParser)(providerMethod.path);

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

@@ -20,8 +20,8 @@ function proxyHttpRequest(req, res, opts) {
     delete requestHeaders['connection'];
     delete requestHeaders['host'];
     delete requestHeaders['origin'];
-    const sourceBasePath = opts.consumerResource.spec.path;
-    const targetBasePath = opts.providerResource.spec.path;
+    const sourceBasePath = opts.consumerResource.spec.path ?? '/';
+    const targetBasePath = opts.providerResource.spec.path ?? '/';
     let path = opts.consumerPath;
     if (opts.consumerPath.startsWith(sourceBasePath)) {
         path = path.replace(sourceBasePath, targetBasePath);

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

@@ -34,7 +34,7 @@ const DOCKER_ENV_VARS = [
     `KAPETA_LOCAL_SERVER=0.0.0.0`,
     `KAPETA_LOCAL_CLUSTER_HOST=${types_1.DOCKER_HOST_INTERNAL}`,
     `KAPETA_ENVIRONMENT_TYPE=docker`,
-    `KAPETA_ENVIRONMENT_PLATFORM=${node_os_1.default.platform()}`
+    `KAPETA_ENVIRONMENT_PLATFORM=${node_os_1.default.platform()}`,
 ];
 async function getProvider(uri) {
     const providers = await definitionsManager_1.definitionsManager.getProviderDefinitions();
@@ -172,8 +172,15 @@ class BlockInstanceRunner {
             if (!fs_extra_1.default.existsSync(dockerFile)) {
                 throw new Error(`Dockerfile not found at: ${dockerFile}`);
             }
-            const task = containerManager_1.containerManager.buildDockerImage(dockerFile, blockInfo.fullName + ':local');
-            await task.wait();
+            console.log('Building docker image from Dockerfile "%s": %s ', dockerFile, dockerImage);
+            try {
+                const task = containerManager_1.containerManager.buildDockerImage(dockerFile, dockerImage);
+                await task.wait();
+            }
+            catch (err) {
+                throw new Error(`Error building docker image: ${err}`);
+            }
+            console.log('Docker images was build from file "%s": %s', dockerFile, dockerImage);
         }
         const containerName = await (0, utils_1.getBlockInstanceContainerName)(this._systemId, blockInstance.id, targetKindUri.id);
         const startCmd = localContainer.handlers?.onCreate ? localContainer.handlers.onCreate : '';
@@ -205,7 +212,7 @@ class BlockInstanceRunner {
             ...dockerOpts,
             Image: dockerImage,
             name: containerName,
-            WorkingDir: workingDir,
+            WorkingDir: isDockerImage ? workingDir : undefined,
             Labels: {
                 ...customLabels,
                 instance: blockInstance.id,

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

@@ -41,8 +41,8 @@ class InternalConfigProvider {
     getInstanceId() {
         return this.instanceId;
     }
-    getServerPort(portType) {
-        return serviceManager_1.serviceManager.ensureServicePort(this.systemId, this.instanceId, portType);
+    async getServerPort(portType) {
+        return '80';
     }
     async getServiceAddress(serviceName, portType) {
         return serviceManager_1.serviceManager.getConsumerAddress(this.systemId, this.instanceId, serviceName, portType, this.environment);

package/package.json

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

package/src/containerManager.ts

@@ -306,6 +306,11 @@ class ContainerManager {
             tag = 'latest';
         }
 
+        if (tag === 'local') {
+            // Local image - no need to pull
+            return false;
+        }
+
         const imageTagList = (await this.docker().listImages({}))
             .filter((imageData) => !!imageData.RepoTags)
             .map((imageData) => imageData.RepoTags as string[]);
@@ -786,20 +791,23 @@ class ContainerManager {
     buildDockerImage(dockerFile: string, imageName: string) {
         const taskName = `Building docker image: ${imageName}`;
         const processor = async (task: Task) => {
-            const timeStarted = Date.now();
-            const stream = await this.docker().buildImage(
-                {
-                    context: Path.dirname(dockerFile),
-                    src: [Path.basename(dockerFile)],
-                },
-                {
-                    t: imageName,
-                    dockerfile: Path.basename(dockerFile),
-                }
-            );
+            const baseDir = Path.dirname(dockerFile);
+            const entries = await FSExtra.readdir(baseDir);
+            const contextInfo = {
+                context: Path.dirname(dockerFile),
+                src: entries,
+            };
+
+            const stream = await this.docker().buildImage(contextInfo, {
+                t: imageName,
+                dockerfile: Path.basename(dockerFile),
+            });
 
             await processJsonStream<string>(`image:build:${imageName}`, stream, (data) => {
-                if (data.stream) {
+                if (data.error) {
+                    task.future.reject(new Error(data.error));
+                    task.addLog(data.error, 'ERROR');
+                } else if (data.stream) {
                     // Emit raw output to the task log
                     task.addLog(data.stream);
                 }

package/src/proxy/types/rest.ts

@@ -15,6 +15,7 @@ import { ProxyRequestInfo, SimpleRequest, StringMap } from '../../types';
 import { StringBodyRequest } from '../../middleware/stringBody';
 import { Resource } from '@kapeta/schemas';
 import { stringify } from 'qs';
+import { proxyHttpRequest } from './web';
 
 export function getRestMethodId(restResource: Resource, httpMethod: string, httpPath: string) {
     return _.findKey(restResource.spec.methods, (method) => {
@@ -86,6 +87,10 @@ function resolveMethods(req: Request, opts: ProxyRequestInfo) {
 }
 
 export function proxyRestRequest(req: StringBodyRequest, res: Response, opts: ProxyRequestInfo) {
+    if (_.isEmpty(opts.consumerResource.spec.methods) && _.isEmpty(opts.providerResource.spec.methods)) {
+        // If there are no methods defined, we assume the user controls the path and we just proxy the raw request
+        return proxyHttpRequest(req, res, opts);
+    }
     let { consumerMethod, providerMethod } = resolveMethods(req, opts);
 
     const consumerPathTemplate = pathTemplateParser(consumerMethod.path);

package/src/proxy/types/web.ts

@@ -21,8 +21,8 @@ export function proxyHttpRequest(req: StringBodyRequest, res: Response, opts: Pr
     delete requestHeaders['host'];
     delete requestHeaders['origin'];
 
-    const sourceBasePath = opts.consumerResource.spec.path;
-    const targetBasePath = opts.providerResource.spec.path;
+    const sourceBasePath = opts.consumerResource.spec.path ?? '/';
+    const targetBasePath = opts.providerResource.spec.path ?? '/';
     let path = opts.consumerPath;
     if (opts.consumerPath.startsWith(sourceBasePath)) {
         path = path.replace(sourceBasePath, targetBasePath);

package/src/utils/BlockInstanceRunner.ts

@@ -48,7 +48,7 @@ const DOCKER_ENV_VARS = [
     `KAPETA_LOCAL_SERVER=0.0.0.0`,
     `KAPETA_LOCAL_CLUSTER_HOST=${DOCKER_HOST_INTERNAL}`,
     `KAPETA_ENVIRONMENT_TYPE=docker`,
-    `KAPETA_ENVIRONMENT_PLATFORM=${OS.platform()}`
+    `KAPETA_ENVIRONMENT_PLATFORM=${OS.platform()}`,
 ];
 
 async function getProvider(uri: KapetaURI) {
@@ -231,8 +231,16 @@ export class BlockInstanceRunner {
             if (!FSExtra.existsSync(dockerFile)) {
                 throw new Error(`Dockerfile not found at: ${dockerFile}`);
             }
-            const task = containerManager.buildDockerImage(dockerFile, blockInfo.fullName + ':local');
-            await task.wait();
+
+            console.log('Building docker image from Dockerfile "%s": %s ', dockerFile, dockerImage);
+            try {
+                const task = containerManager.buildDockerImage(dockerFile, dockerImage);
+                await task.wait();
+            } catch (err: any) {
+                throw new Error(`Error building docker image: ${err}`);
+            }
+
+            console.log('Docker images was build from file "%s": %s', dockerFile, dockerImage);
         }
 
         const containerName = await getBlockInstanceContainerName(this._systemId, blockInstance.id, targetKindUri.id);
@@ -275,7 +283,7 @@ export class BlockInstanceRunner {
             ...dockerOpts,
             Image: dockerImage,
             name: containerName,
-            WorkingDir: workingDir,
+            WorkingDir: isDockerImage ? workingDir : undefined,
             Labels: {
                 ...customLabels,
                 instance: blockInstance.id,

package/src/utils/InternalConfigProvider.ts

@@ -59,8 +59,8 @@ export class InternalConfigProvider implements ConfigProvider {
     getInstanceId(): string {
         return this.instanceId;
     }
-    getServerPort(portType?: string | undefined): Promise<string> {
-        return serviceManager.ensureServicePort(this.systemId, this.instanceId, portType);
+    async getServerPort(portType?: string | undefined): Promise<string> {
+        return '80';
     }
     async getServiceAddress(serviceName: string, portType: string): Promise<string | null> {
         return serviceManager.getConsumerAddress(