@kapeta/local-cluster-service 0.59.0 → 0.60.1

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [0.60.1](https://github.com/kapetacom/local-cluster-service/compare/v0.60.0...v0.60.1) (2024-08-06)
+
+
+### Bug Fixes
+
+* broke tests ([e916371](https://github.com/kapetacom/local-cluster-service/commit/e9163710178a01259723346efa346c094794de0b))
+* ensure valid base name for ai generated services ([b3a15ec](https://github.com/kapetacom/local-cluster-service/commit/b3a15ecc297b98671b3029d668b2da46113086ff))
+
+# [0.60.0](https://github.com/kapetacom/local-cluster-service/compare/v0.59.0...v0.60.0) (2024-08-05)
+
+
+### Features
+
+* Host ui pages on a temp server so we can have it on its own server ([#208](https://github.com/kapetacom/local-cluster-service/issues/208)) ([31ba4b8](https://github.com/kapetacom/local-cluster-service/commit/31ba4b8142c4618cc347037004f8fed87c69c6b7))
+
 # [0.59.0](https://github.com/kapetacom/local-cluster-service/compare/v0.58.6...v0.59.0) (2024-08-01)
 
 

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

@@ -14,9 +14,8 @@ declare class ClusterService {
     _findClusterServicePort(): Promise<void>;
     /**
      * Gets next available port
-     * @return {Promise<number>}
      */
-    getNextAvailablePort(): Promise<number>;
+    getNextAvailablePort(startPort?: number): Promise<number>;
     _checkIfPortIsUsed(port: number, host?: string): Promise<unknown>;
     /**
      * The port of this local cluster service itself

package/dist/cjs/src/clusterService.js

@@ -48,14 +48,23 @@ class ClusterService {
     }
     /**
      * Gets next available port
-     * @return {Promise<number>}
      */
-    async getNextAvailablePort() {
+    async getNextAvailablePort(startPort = -1) {
+        let receivedStartPort = startPort > 0;
+        if (!receivedStartPort) {
+            startPort = this._currentPort;
+        }
         while (true) {
-            while (this._reservedPorts.indexOf(this._currentPort) > -1) {
-                this._currentPort++;
+            while (this._reservedPorts.indexOf(startPort) > -1) {
+                startPort++;
+                if (!receivedStartPort) {
+                    this._currentPort = startPort;
+                }
+            }
+            const nextPort = startPort++;
+            if (!receivedStartPort) {
+                this._currentPort = startPort;
             }
-            const nextPort = this._currentPort++;
             const isUsed = await this._checkIfPortIsUsed(nextPort);
             if (!isUsed) {
                 return nextPort;

package/dist/cjs/src/storm/UIServer.d.ts

@@ -0,0 +1,11 @@
+import { StormEventPage } from './events';
+export declare class UIServer {
+    private readonly express;
+    private readonly systemId;
+    private port;
+    private server;
+    constructor(systemId: string);
+    start(): Promise<void>;
+    close(): void;
+    resolveUrl(screenData: StormEventPage): string;
+}

package/dist/cjs/src/storm/UIServer.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UIServer = void 0;
+/**
+ * Copyright 2023 Kapeta Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+const express_1 = __importDefault(require("express"));
+const page_utils_1 = require("./page-utils");
+const clusterService_1 = require("../clusterService");
+class UIServer {
+    express;
+    systemId;
+    port = 50000;
+    server;
+    constructor(systemId) {
+        this.systemId = systemId;
+        this.express = (0, express_1.default)();
+    }
+    async start() {
+        this.port = await clusterService_1.clusterService.getNextAvailablePort(this.port);
+        this.express.all('/*', async (req, res) => {
+            (0, page_utils_1.readPageFromDisk)(this.systemId, req.params[0], req.method, res);
+        });
+        return new Promise((resolve) => {
+            this.server = this.express.listen(this.port, () => {
+                console.log(`UI Server started on port ${this.port}`);
+                resolve();
+            });
+        });
+    }
+    close() {
+        if (this.server) {
+            console.log('UI Server closed on port: %s', this.port);
+            this.server.close();
+            this.server = undefined;
+        }
+    }
+    resolveUrl(screenData) {
+        const path = screenData.payload.path.startsWith('/') ? screenData.payload.path : `/${screenData.payload.path}`;
+        return `http://localhost:${this.port}${path}`;
+    }
+}
+exports.UIServer = UIServer;

package/dist/cjs/src/storm/event-parser.d.ts

@@ -49,6 +49,7 @@ export declare class StormEventParser {
     static toInstanceId(handle: string, blockName: string): string;
     static toInstanceIdFromRef(ref: string): string;
     static toSafeName(name: string): string;
+    static toSafeArtifactName(name: string): string;
     static toRef(handle: string, name: string): KapetaURI;
     private events;
     private planName;

package/dist/cjs/src/storm/event-parser.js

@@ -138,6 +138,13 @@ class StormEventParser {
     static toSafeName(name) {
         return name.toLowerCase().replace(/[^0-9a-z-]/gi, '');
     }
+    static toSafeArtifactName(name) {
+        let safeName = name.toLowerCase().replace(/[^0-9a-z]/g, '');
+        if (/^[0-9]/.test(safeName)) {
+            safeName = 'a' + safeName; // Prepend a letter if the string starts with a number
+        }
+        return safeName;
+    }
     static toRef(handle, name) {
         return (0, nodejs_utils_1.parseKapetaUri)(handle + '/' + this.toSafeName(name) + ':local');
     }

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

@@ -21,13 +21,18 @@ const assetManager_1 = require("../assetManager");
 const node_uuid_1 = __importDefault(require("node-uuid"));
 const PromiseQueue_1 = require("./PromiseQueue");
 const page_utils_1 = require("./page-utils");
+const UIServer_1 = require("./UIServer");
+const UI_SERVERS = {};
 const router = (0, express_promise_router_1.default)();
 router.use('/', cors_1.corsHandler);
 router.use('/', stringBody_1.stringBody);
 function convertPageEvent(screenData, innerConversationId, mainConversationId) {
     if (screenData.type === 'PAGE') {
+        const server = UI_SERVERS[mainConversationId];
+        if (!server) {
+            console.warn('No server found for conversation', mainConversationId);
+        }
         screenData.payload.conversationId = innerConversationId;
-        const path = screenData.payload.path.startsWith('/') ? screenData.payload.path : `/${screenData.payload.path}`;
         return {
             type: 'PAGE_URL',
             reason: screenData.reason,
@@ -40,7 +45,7 @@ function convertPageEvent(screenData, innerConversationId, mainConversationId) {
                 description: screenData.payload.description,
                 prompt: screenData.payload.prompt,
                 path: screenData.payload.path,
-                url: `/storm/ui/${mainConversationId}/serve/${screenData.payload.method}${path}`,
+                url: server ? server.resolveUrl(screenData) : '',
                 method: screenData.payload.method,
                 conversationId: innerConversationId,
             },
@@ -88,6 +93,18 @@ router.post('/ui/screen', async (req, res) => {
         }
     }
 });
+router.delete('/:handle/ui', async (req, res) => {
+    const conversationId = req.headers[stormClient_1.ConversationIdHeader.toLowerCase()];
+    if (!conversationId) {
+        res.status(400).send('Missing conversation id');
+        return;
+    }
+    const server = UI_SERVERS[conversationId];
+    if (server) {
+        server.close();
+        delete UI_SERVERS[conversationId];
+    }
+});
 router.post('/:handle/ui', async (req, res) => {
     const handle = req.params.handle;
     try {
@@ -105,6 +122,9 @@ router.post('/:handle/ui', async (req, res) => {
         onRequestAborted(req, res, () => {
             queue.cancel();
         });
+        const systemId = userJourneysStream.getConversationId();
+        UI_SERVERS[systemId] = new UIServer_1.UIServer(systemId);
+        await UI_SERVERS[systemId].start();
         userJourneysStream.on('data', async (data) => {
             try {
                 console.log('Processing user journey event', data);

package/dist/cjs/test/storm/event-parser.test.js

@@ -213,4 +213,8 @@ describe('event-parser', () => {
         expect(postService?.content?.spec?.providers?.length).toBe(1);
         expect(postService?.content?.spec?.providers[0].spec.source.value.startsWith('controller')).toBeTruthy();
     });
+    it('toSafeName produces valid artifact names', async () => {
+        const safeName = event_parser_1.StormEventParser.toSafeArtifactName('Browser-based CRM Application');
+        expect(safeName).toBe('browserbasedcrmapplication');
+    });
 });

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

@@ -14,9 +14,8 @@ declare class ClusterService {
     _findClusterServicePort(): Promise<void>;
     /**
      * Gets next available port
-     * @return {Promise<number>}
      */
-    getNextAvailablePort(): Promise<number>;
+    getNextAvailablePort(startPort?: number): Promise<number>;
     _checkIfPortIsUsed(port: number, host?: string): Promise<unknown>;
     /**
      * The port of this local cluster service itself

package/dist/esm/src/clusterService.js

@@ -48,14 +48,23 @@ class ClusterService {
     }
     /**
      * Gets next available port
-     * @return {Promise<number>}
      */
-    async getNextAvailablePort() {
+    async getNextAvailablePort(startPort = -1) {
+        let receivedStartPort = startPort > 0;
+        if (!receivedStartPort) {
+            startPort = this._currentPort;
+        }
         while (true) {
-            while (this._reservedPorts.indexOf(this._currentPort) > -1) {
-                this._currentPort++;
+            while (this._reservedPorts.indexOf(startPort) > -1) {
+                startPort++;
+                if (!receivedStartPort) {
+                    this._currentPort = startPort;
+                }
+            }
+            const nextPort = startPort++;
+            if (!receivedStartPort) {
+                this._currentPort = startPort;
             }
-            const nextPort = this._currentPort++;
             const isUsed = await this._checkIfPortIsUsed(nextPort);
             if (!isUsed) {
                 return nextPort;

package/dist/esm/src/storm/UIServer.d.ts

@@ -0,0 +1,11 @@
+import { StormEventPage } from './events';
+export declare class UIServer {
+    private readonly express;
+    private readonly systemId;
+    private port;
+    private server;
+    constructor(systemId: string);
+    start(): Promise<void>;
+    close(): void;
+    resolveUrl(screenData: StormEventPage): string;
+}

package/dist/esm/src/storm/UIServer.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UIServer = void 0;
+/**
+ * Copyright 2023 Kapeta Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+const express_1 = __importDefault(require("express"));
+const page_utils_1 = require("./page-utils");
+const clusterService_1 = require("../clusterService");
+class UIServer {
+    express;
+    systemId;
+    port = 50000;
+    server;
+    constructor(systemId) {
+        this.systemId = systemId;
+        this.express = (0, express_1.default)();
+    }
+    async start() {
+        this.port = await clusterService_1.clusterService.getNextAvailablePort(this.port);
+        this.express.all('/*', async (req, res) => {
+            (0, page_utils_1.readPageFromDisk)(this.systemId, req.params[0], req.method, res);
+        });
+        return new Promise((resolve) => {
+            this.server = this.express.listen(this.port, () => {
+                console.log(`UI Server started on port ${this.port}`);
+                resolve();
+            });
+        });
+    }
+    close() {
+        if (this.server) {
+            console.log('UI Server closed on port: %s', this.port);
+            this.server.close();
+            this.server = undefined;
+        }
+    }
+    resolveUrl(screenData) {
+        const path = screenData.payload.path.startsWith('/') ? screenData.payload.path : `/${screenData.payload.path}`;
+        return `http://localhost:${this.port}${path}`;
+    }
+}
+exports.UIServer = UIServer;

package/dist/esm/src/storm/event-parser.d.ts

@@ -49,6 +49,7 @@ export declare class StormEventParser {
     static toInstanceId(handle: string, blockName: string): string;
     static toInstanceIdFromRef(ref: string): string;
     static toSafeName(name: string): string;
+    static toSafeArtifactName(name: string): string;
     static toRef(handle: string, name: string): KapetaURI;
     private events;
     private planName;

package/dist/esm/src/storm/event-parser.js

@@ -138,6 +138,13 @@ class StormEventParser {
     static toSafeName(name) {
         return name.toLowerCase().replace(/[^0-9a-z-]/gi, '');
     }
+    static toSafeArtifactName(name) {
+        let safeName = name.toLowerCase().replace(/[^0-9a-z]/g, '');
+        if (/^[0-9]/.test(safeName)) {
+            safeName = 'a' + safeName; // Prepend a letter if the string starts with a number
+        }
+        return safeName;
+    }
     static toRef(handle, name) {
         return (0, nodejs_utils_1.parseKapetaUri)(handle + '/' + this.toSafeName(name) + ':local');
     }

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

@@ -21,13 +21,18 @@ const assetManager_1 = require("../assetManager");
 const node_uuid_1 = __importDefault(require("node-uuid"));
 const PromiseQueue_1 = require("./PromiseQueue");
 const page_utils_1 = require("./page-utils");
+const UIServer_1 = require("./UIServer");
+const UI_SERVERS = {};
 const router = (0, express_promise_router_1.default)();
 router.use('/', cors_1.corsHandler);
 router.use('/', stringBody_1.stringBody);
 function convertPageEvent(screenData, innerConversationId, mainConversationId) {
     if (screenData.type === 'PAGE') {
+        const server = UI_SERVERS[mainConversationId];
+        if (!server) {
+            console.warn('No server found for conversation', mainConversationId);
+        }
         screenData.payload.conversationId = innerConversationId;
-        const path = screenData.payload.path.startsWith('/') ? screenData.payload.path : `/${screenData.payload.path}`;
         return {
             type: 'PAGE_URL',
             reason: screenData.reason,
@@ -40,7 +45,7 @@ function convertPageEvent(screenData, innerConversationId, mainConversationId) {
                 description: screenData.payload.description,
                 prompt: screenData.payload.prompt,
                 path: screenData.payload.path,
-                url: `/storm/ui/${mainConversationId}/serve/${screenData.payload.method}${path}`,
+                url: server ? server.resolveUrl(screenData) : '',
                 method: screenData.payload.method,
                 conversationId: innerConversationId,
             },
@@ -88,6 +93,18 @@ router.post('/ui/screen', async (req, res) => {
         }
     }
 });
+router.delete('/:handle/ui', async (req, res) => {
+    const conversationId = req.headers[stormClient_1.ConversationIdHeader.toLowerCase()];
+    if (!conversationId) {
+        res.status(400).send('Missing conversation id');
+        return;
+    }
+    const server = UI_SERVERS[conversationId];
+    if (server) {
+        server.close();
+        delete UI_SERVERS[conversationId];
+    }
+});
 router.post('/:handle/ui', async (req, res) => {
     const handle = req.params.handle;
     try {
@@ -105,6 +122,9 @@ router.post('/:handle/ui', async (req, res) => {
         onRequestAborted(req, res, () => {
             queue.cancel();
         });
+        const systemId = userJourneysStream.getConversationId();
+        UI_SERVERS[systemId] = new UIServer_1.UIServer(systemId);
+        await UI_SERVERS[systemId].start();
         userJourneysStream.on('data', async (data) => {
             try {
                 console.log('Processing user journey event', data);

package/dist/esm/test/storm/event-parser.test.js

@@ -213,4 +213,8 @@ describe('event-parser', () => {
         expect(postService?.content?.spec?.providers?.length).toBe(1);
         expect(postService?.content?.spec?.providers[0].spec.source.value.startsWith('controller')).toBeTruthy();
     });
+    it('toSafeName produces valid artifact names', async () => {
+        const safeName = event_parser_1.StormEventParser.toSafeArtifactName('Browser-based CRM Application');
+        expect(safeName).toBe('browserbasedcrmapplication');
+    });
 });

package/package.json

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

package/src/clusterService.ts

@@ -56,15 +56,24 @@ class ClusterService {
 
     /**
      * Gets next available port
-     * @return {Promise<number>}
      */
-    async getNextAvailablePort() {
+    public async getNextAvailablePort(startPort: number = -1) {
+        let receivedStartPort = startPort > 0;
+        if (!receivedStartPort) {
+            startPort = this._currentPort;
+        }
         while (true) {
-            while (this._reservedPorts.indexOf(this._currentPort) > -1) {
-                this._currentPort++;
+            while (this._reservedPorts.indexOf(startPort) > -1) {
+                startPort++;
+                if (!receivedStartPort) {
+                    this._currentPort = startPort;
+                }
             }
 
-            const nextPort = this._currentPort++;
+            const nextPort = startPort++;
+            if (!receivedStartPort) {
+                this._currentPort = startPort;
+            }
             const isUsed = await this._checkIfPortIsUsed(nextPort);
             if (!isUsed) {
                 return nextPort;

package/src/storm/UIServer.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright 2023 Kapeta Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+import express, { Express, Request, Response } from 'express';
+import { readPageFromDisk } from './page-utils';
+import { clusterService } from '../clusterService';
+import { Server } from 'http';
+import { StormEventPage } from './events';
+
+export class UIServer {
+    private readonly express: Express;
+    private readonly systemId: string;
+
+    private port: number = 50000;
+    private server: Server | undefined;
+
+    constructor(systemId: string) {
+        this.systemId = systemId;
+        this.express = express();
+    }
+
+    public async start() {
+        this.port = await clusterService.getNextAvailablePort(this.port);
+
+        this.express.all('/*', async (req: Request, res: Response) => {
+            readPageFromDisk(this.systemId, req.params[0], req.method, res);
+        });
+
+        return new Promise<void>((resolve) => {
+            this.server = this.express.listen(this.port, () => {
+                console.log(`UI Server started on port ${this.port}`);
+                resolve();
+            });
+        });
+    }
+
+    public close() {
+        if (this.server) {
+            console.log('UI Server closed on port: %s', this.port);
+            this.server.close();
+            this.server = undefined;
+        }
+    }
+
+    resolveUrl(screenData: StormEventPage) {
+        const path = screenData.payload.path.startsWith('/') ? screenData.payload.path : `/${screenData.payload.path}`;
+        return `http://localhost:${this.port}${path}`;
+    }
+}

package/src/storm/event-parser.ts

@@ -246,6 +246,14 @@ export class StormEventParser {
         return name.toLowerCase().replace(/[^0-9a-z-]/gi, '');
     }
 
+    public static toSafeArtifactName(name: string): string {
+        let safeName = name.toLowerCase().replace(/[^0-9a-z]/g, '');
+        if (/^[0-9]/.test(safeName)) {
+            safeName = 'a' + safeName; // Prepend a letter if the string starts with a number
+        }
+        return safeName;
+    }
+
     public static toRef(handle: string, name: string) {
         return parseKapetaUri(handle + '/' + this.toSafeName(name) + ':local');
     }

package/src/storm/routes.ts

@@ -26,7 +26,9 @@ import { assetManager } from '../assetManager';
 import uuid from 'node-uuid';
 import { PromiseQueue } from './PromiseQueue';
 import { readPageFromDisk, readPageFromDiskAsString, SystemIdHeader, writePageToDisk } from './page-utils';
+import { UIServer } from './UIServer';
 
+const UI_SERVERS: { [key: string]: UIServer } = {};
 const router = Router();
 
 router.use('/', corsHandler);
@@ -34,8 +36,11 @@ router.use('/', stringBody);
 
 function convertPageEvent(screenData: StormEvent, innerConversationId: string, mainConversationId: string): StormEvent {
     if (screenData.type === 'PAGE') {
+        const server: UIServer | undefined = UI_SERVERS[mainConversationId];
+        if (!server) {
+            console.warn('No server found for conversation', mainConversationId);
+        }
         screenData.payload.conversationId = innerConversationId;
-        const path = screenData.payload.path.startsWith('/') ? screenData.payload.path : `/${screenData.payload.path}`;
         return {
             type: 'PAGE_URL',
             reason: screenData.reason,
@@ -48,7 +53,7 @@ function convertPageEvent(screenData: StormEvent, innerConversationId: string, m
                 description: screenData.payload.description,
                 prompt: screenData.payload.prompt,
                 path: screenData.payload.path,
-                url: `/storm/ui/${mainConversationId}/serve/${screenData.payload.method}${path}`,
+                url: server ? server.resolveUrl(screenData) : '',
                 method: screenData.payload.method,
                 conversationId: innerConversationId,
             },
@@ -106,6 +111,20 @@ router.post('/ui/screen', async (req: KapetaBodyRequest, res: Response) => {
     }
 });
 
+router.delete('/:handle/ui', async (req: KapetaBodyRequest, res: Response) => {
+    const conversationId = req.headers[ConversationIdHeader.toLowerCase()] as string | undefined;
+    if (!conversationId) {
+        res.status(400).send('Missing conversation id');
+        return;
+    }
+
+    const server = UI_SERVERS[conversationId];
+    if (server) {
+        server.close();
+        delete UI_SERVERS[conversationId];
+    }
+});
+
 router.post('/:handle/ui', async (req: KapetaBodyRequest, res: Response) => {
     const handle = req.params.handle as string;
     try {
@@ -130,6 +149,11 @@ router.post('/:handle/ui', async (req: KapetaBodyRequest, res: Response) => {
             queue.cancel();
         });
 
+        const systemId = userJourneysStream.getConversationId();
+
+        UI_SERVERS[systemId] = new UIServer(systemId);
+        await UI_SERVERS[systemId].start();
+
         userJourneysStream.on('data', async (data: StormEvent) => {
             try {
                 console.log('Processing user journey event', data);

package/test/storm/event-parser.test.ts

@@ -240,4 +240,9 @@ describe('event-parser', () => {
         expect(postService?.content?.spec?.providers?.length).toBe(1);
         expect(postService?.content?.spec?.providers![0].spec.source.value.startsWith('controller')).toBeTruthy();
     });
+
+    it('toSafeName produces valid artifact names', async () => {
+        const safeName = StormEventParser.toSafeArtifactName('Browser-based CRM Application');
+        expect(safeName).toBe('browserbasedcrmapplication');
+    });
 });