@kapeta/local-cluster-service 0.62.2 → 0.63.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.63.1](https://github.com/kapetacom/local-cluster-service/compare/v0.63.0...v0.63.1) (2024-08-20)
+
+
+### Bug Fixes
+
+* handle port conflict and hanging response on close ([#219](https://github.com/kapetacom/local-cluster-service/issues/219)) ([e4f3b26](https://github.com/kapetacom/local-cluster-service/commit/e4f3b268fec9958aa315a186a306d2350354452b))
+
+# [0.63.0](https://github.com/kapetacom/local-cluster-service/compare/v0.62.2...v0.63.0) (2024-08-15)
+
+
+### Features
+
+* Add reset endpoint for resetting localStorage in UI server ([#218](https://github.com/kapetacom/local-cluster-service/issues/218)) ([1dd1edc](https://github.com/kapetacom/local-cluster-service/commit/1dd1edcba982f40b853569fd408e6ed561495686))
+
 ## [0.62.2](https://github.com/kapetacom/local-cluster-service/compare/v0.62.1...v0.62.2) (2024-08-14)
 
 

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

@@ -1,4 +1,11 @@
+/// <reference types="node" />
+import { Server } from 'http';
 import { StormEventPage } from './events';
+declare module 'express-serve-static-core' {
+    interface Application {
+        listen(port: number, callback?: (err?: Error) => void): Server;
+    }
+}
 export declare class UIServer {
     private readonly express;
     private readonly systemId;
@@ -8,4 +15,5 @@ export declare class UIServer {
     start(): Promise<void>;
     close(): void;
     resolveUrl(screenData: StormEventPage): string;
+    resolveUrlFromPath(path: string): string;
 }

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

@@ -22,11 +22,23 @@ class UIServer {
     }
     async start() {
         this.port = await clusterService_1.clusterService.getNextAvailablePort(this.port);
-        this.express.all('/*', async (req, res) => {
+        this.express.get('/_reset', (req, res) => {
+            res.send(`
+                <script>
+                    window.localStorage.clear();
+                    window.sessionStorage.clear();
+                </script>`);
+        });
+        this.express.all('/*', (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, () => {
+        return new Promise((resolve, reject) => {
+            this.server = this.express.listen(this.port, (err) => {
+                if (err) {
+                    console.error('Failed to start UI server', err);
+                    reject(err);
+                    return;
+                }
                 console.log(`UI Server started on port ${this.port}`);
                 resolve();
             });
@@ -40,8 +52,11 @@ class UIServer {
         }
     }
     resolveUrl(screenData) {
-        const path = screenData.payload.path.startsWith('/') ? screenData.payload.path : `/${screenData.payload.path}`;
-        return `http://localhost:${this.port}${path}`;
+        return this.resolveUrlFromPath(screenData.payload.path);
+    }
+    resolveUrlFromPath(path) {
+        const resolvedPath = path.startsWith('/') ? path : `/${path}`;
+        return `http://localhost:${this.port}${resolvedPath}`;
     }
 }
 exports.UIServer = UIServer;

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

@@ -375,5 +375,14 @@ export interface StormEventReferenceClassification {
     created: number;
     payload: ReferenceClassification;
 }
-export type StormEvent = StormEventCreateBlock | StormEventCreateConnection | StormEventCreatePlanProperties | StormEventInvalidResponse | StormEventPlanRetry | StormEventCreateDSL | StormEventCreateDSLResource | StormEventError | StormEventScreen | StormEventScreenCandidate | StormEventFileLogical | StormEventFileState | StormEventFileDone | StormEventFileFailed | StormEventFileChunk | StormEventDone | StormEventDefinitionChange | StormEventErrorClassifier | StormEventCodeFix | StormEventErrorDetails | StormEventBlockReady | StormEventPhases | StormEventBlockStatus | StormEventCreateDSLRetry | StormEventUserJourney | StormEventUIShell | StormEventPage | StormEventPageUrl | StormEventPromptImprove | StormEventLandingPage | StormEventReferenceClassification | StormEventApiBase;
+export interface StormEventUIStarted {
+    type: 'UI_SERVER_STARTED';
+    reason: string;
+    created: number;
+    payload: {
+        conversationId: string;
+        resetUrl: string;
+    };
+}
+export type StormEvent = StormEventCreateBlock | StormEventCreateConnection | StormEventCreatePlanProperties | StormEventInvalidResponse | StormEventPlanRetry | StormEventCreateDSL | StormEventCreateDSLResource | StormEventError | StormEventScreen | StormEventScreenCandidate | StormEventFileLogical | StormEventFileState | StormEventFileDone | StormEventFileFailed | StormEventFileChunk | StormEventDone | StormEventDefinitionChange | StormEventErrorClassifier | StormEventCodeFix | StormEventErrorDetails | StormEventBlockReady | StormEventPhases | StormEventBlockStatus | StormEventCreateDSLRetry | StormEventUserJourney | StormEventUIShell | StormEventPage | StormEventPageUrl | StormEventPromptImprove | StormEventLandingPage | StormEventReferenceClassification | StormEventApiBase | StormEventUIStarted;
 export {};

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

@@ -100,6 +100,7 @@ router.delete('/:handle/ui', async (req, res) => {
         server.close();
         delete UI_SERVERS[conversationId];
     }
+    res.status(200).json({ status: 'ok' });
 });
 router.post('/:handle/ui/iterative', async (req, res) => {
     const handle = req.params.handle;
@@ -247,6 +248,15 @@ router.post('/:handle/ui', async (req, res) => {
         await waitForStormStream(shellsStream);
         UI_SERVERS[outerConversationId] = new UIServer_1.UIServer(outerConversationId);
         await UI_SERVERS[outerConversationId].start();
+        sendEvent(res, {
+            type: 'UI_SERVER_STARTED',
+            reason: '',
+            payload: {
+                conversationId: outerConversationId,
+                resetUrl: UI_SERVERS[outerConversationId].resolveUrlFromPath('/_reset'),
+            },
+            created: Date.now(),
+        });
         // Get the pages (5 at a time)
         const pagePromises = [];
         onRequestAborted(req, res, () => {

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

@@ -1,4 +1,11 @@
+/// <reference types="node" />
+import { Server } from 'http';
 import { StormEventPage } from './events';
+declare module 'express-serve-static-core' {
+    interface Application {
+        listen(port: number, callback?: (err?: Error) => void): Server;
+    }
+}
 export declare class UIServer {
     private readonly express;
     private readonly systemId;
@@ -8,4 +15,5 @@ export declare class UIServer {
     start(): Promise<void>;
     close(): void;
     resolveUrl(screenData: StormEventPage): string;
+    resolveUrlFromPath(path: string): string;
 }

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

@@ -22,11 +22,23 @@ class UIServer {
     }
     async start() {
         this.port = await clusterService_1.clusterService.getNextAvailablePort(this.port);
-        this.express.all('/*', async (req, res) => {
+        this.express.get('/_reset', (req, res) => {
+            res.send(`
+                <script>
+                    window.localStorage.clear();
+                    window.sessionStorage.clear();
+                </script>`);
+        });
+        this.express.all('/*', (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, () => {
+        return new Promise((resolve, reject) => {
+            this.server = this.express.listen(this.port, (err) => {
+                if (err) {
+                    console.error('Failed to start UI server', err);
+                    reject(err);
+                    return;
+                }
                 console.log(`UI Server started on port ${this.port}`);
                 resolve();
             });
@@ -40,8 +52,11 @@ class UIServer {
         }
     }
     resolveUrl(screenData) {
-        const path = screenData.payload.path.startsWith('/') ? screenData.payload.path : `/${screenData.payload.path}`;
-        return `http://localhost:${this.port}${path}`;
+        return this.resolveUrlFromPath(screenData.payload.path);
+    }
+    resolveUrlFromPath(path) {
+        const resolvedPath = path.startsWith('/') ? path : `/${path}`;
+        return `http://localhost:${this.port}${resolvedPath}`;
     }
 }
 exports.UIServer = UIServer;

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

@@ -375,5 +375,14 @@ export interface StormEventReferenceClassification {
     created: number;
     payload: ReferenceClassification;
 }
-export type StormEvent = StormEventCreateBlock | StormEventCreateConnection | StormEventCreatePlanProperties | StormEventInvalidResponse | StormEventPlanRetry | StormEventCreateDSL | StormEventCreateDSLResource | StormEventError | StormEventScreen | StormEventScreenCandidate | StormEventFileLogical | StormEventFileState | StormEventFileDone | StormEventFileFailed | StormEventFileChunk | StormEventDone | StormEventDefinitionChange | StormEventErrorClassifier | StormEventCodeFix | StormEventErrorDetails | StormEventBlockReady | StormEventPhases | StormEventBlockStatus | StormEventCreateDSLRetry | StormEventUserJourney | StormEventUIShell | StormEventPage | StormEventPageUrl | StormEventPromptImprove | StormEventLandingPage | StormEventReferenceClassification | StormEventApiBase;
+export interface StormEventUIStarted {
+    type: 'UI_SERVER_STARTED';
+    reason: string;
+    created: number;
+    payload: {
+        conversationId: string;
+        resetUrl: string;
+    };
+}
+export type StormEvent = StormEventCreateBlock | StormEventCreateConnection | StormEventCreatePlanProperties | StormEventInvalidResponse | StormEventPlanRetry | StormEventCreateDSL | StormEventCreateDSLResource | StormEventError | StormEventScreen | StormEventScreenCandidate | StormEventFileLogical | StormEventFileState | StormEventFileDone | StormEventFileFailed | StormEventFileChunk | StormEventDone | StormEventDefinitionChange | StormEventErrorClassifier | StormEventCodeFix | StormEventErrorDetails | StormEventBlockReady | StormEventPhases | StormEventBlockStatus | StormEventCreateDSLRetry | StormEventUserJourney | StormEventUIShell | StormEventPage | StormEventPageUrl | StormEventPromptImprove | StormEventLandingPage | StormEventReferenceClassification | StormEventApiBase | StormEventUIStarted;
 export {};

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

@@ -100,6 +100,7 @@ router.delete('/:handle/ui', async (req, res) => {
         server.close();
         delete UI_SERVERS[conversationId];
     }
+    res.status(200).json({ status: 'ok' });
 });
 router.post('/:handle/ui/iterative', async (req, res) => {
     const handle = req.params.handle;
@@ -247,6 +248,15 @@ router.post('/:handle/ui', async (req, res) => {
         await waitForStormStream(shellsStream);
         UI_SERVERS[outerConversationId] = new UIServer_1.UIServer(outerConversationId);
         await UI_SERVERS[outerConversationId].start();
+        sendEvent(res, {
+            type: 'UI_SERVER_STARTED',
+            reason: '',
+            payload: {
+                conversationId: outerConversationId,
+                resetUrl: UI_SERVERS[outerConversationId].resolveUrlFromPath('/_reset'),
+            },
+            created: Date.now(),
+        });
         // Get the pages (5 at a time)
         const pagePromises = [];
         onRequestAborted(req, res, () => {

package/package.json

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

package/src/storm/UIServer.ts

@@ -8,6 +8,15 @@ import { clusterService } from '../clusterService';
 import { Server } from 'http';
 import { StormEventPage } from './events';
 
+declare module 'express-serve-static-core' {
+    interface Application {
+        // Adds error callback support
+        // From the docs:
+        // All the forms of Node’s http.Server.listen() method are in fact actually supported.
+        listen(port: number, callback?: (err?: Error) => void): Server;
+    }
+}
+
 export class UIServer {
     private readonly express: Express;
     private readonly systemId: string;
@@ -23,12 +32,27 @@ export class UIServer {
     public async start() {
         this.port = await clusterService.getNextAvailablePort(this.port);
 
-        this.express.all('/*', async (req: Request, res: Response) => {
+        this.express.get('/_reset', (req: Request, res: Response) => {
+            res.send(
+                `
+                <script>
+                    window.localStorage.clear();
+                    window.sessionStorage.clear();
+                </script>`
+            );
+        });
+
+        this.express.all('/*', (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, () => {
+        return new Promise<void>((resolve, reject) => {
+            this.server = this.express.listen(this.port, (err) => {
+                if (err) {
+                    console.error('Failed to start UI server', err);
+                    reject(err);
+                    return;
+                }
                 console.log(`UI Server started on port ${this.port}`);
                 resolve();
             });
@@ -44,7 +68,11 @@ export class UIServer {
     }
 
     resolveUrl(screenData: StormEventPage) {
-        const path = screenData.payload.path.startsWith('/') ? screenData.payload.path : `/${screenData.payload.path}`;
-        return `http://localhost:${this.port}${path}`;
+        return this.resolveUrlFromPath(screenData.payload.path);
+    }
+
+    resolveUrlFromPath(path: string) {
+        const resolvedPath = path.startsWith('/') ? path : `/${path}`;
+        return `http://localhost:${this.port}${resolvedPath}`;
     }
 }

package/src/storm/events.ts

@@ -264,7 +264,13 @@ export interface StormEventFileChunk extends StormEventFileBase {
 }
 
 export interface StormEventApiBase {
-    type: 'API_STREAM_CHUNK' | 'API_STREAM_DONE' | 'API_STREAM_FAILED' | 'API_STREAM_STATE' | 'API_STREAM_START' | 'API_STREAM_CHUNK_RESET';
+    type:
+        | 'API_STREAM_CHUNK'
+        | 'API_STREAM_DONE'
+        | 'API_STREAM_FAILED'
+        | 'API_STREAM_STATE'
+        | 'API_STREAM_START'
+        | 'API_STREAM_CHUNK_RESET';
     payload: StormEventFileBasePayload;
 }
 
@@ -445,6 +451,16 @@ export interface StormEventReferenceClassification {
     payload: ReferenceClassification;
 }
 
+export interface StormEventUIStarted {
+    type: 'UI_SERVER_STARTED';
+    reason: string;
+    created: number;
+    payload: {
+        conversationId: string;
+        resetUrl: string;
+    };
+}
+
 export type StormEvent =
     | StormEventCreateBlock
     | StormEventCreateConnection
@@ -477,4 +493,5 @@ export type StormEvent =
     | StormEventPromptImprove
     | StormEventLandingPage
     | StormEventReferenceClassification
-    | StormEventApiBase;
+    | StormEventApiBase
+    | StormEventUIStarted;

package/src/storm/routes.ts

@@ -13,15 +13,8 @@ import { stringBody } from '../middleware/stringBody';
 import { KapetaBodyRequest } from '../types';
 import { StormCodegenRequest, StormContextRequest, StormCreateBlockRequest, StormStream } from './stream';
 
-import {
-    ConversationIdHeader,
-    stormClient,
-    UIPagePrompt,
-    UIPageEditPrompt,
-    UIPageEditRequest,
-    UIPageSamplePrompt,
-} from './stormClient';
-import { Page, StormEvent, StormEventPage, StormEventPhaseType, UIShell, UserJourneyScreen } from './events';
+import { ConversationIdHeader, stormClient, UIPagePrompt, UIPageEditPrompt, UIPageEditRequest } from './stormClient';
+import { Page, StormEvent, StormEventPage, StormEventPhaseType, UserJourneyScreen } from './events';
 
 import {
     createPhaseEndEvent,
@@ -33,18 +26,9 @@ import {
 import { StormCodegen } from './codegen';
 import { assetManager } from '../assetManager';
 import uuid from 'node-uuid';
-import { PromiseQueue } from './PromiseQueue';
-import {
-    readConversationFromFile,
-    readPageFromDisk,
-    readPageFromDiskAsString,
-    SystemIdHeader,
-    writeConversationToFile,
-    writePageToDisk,
-} from './page-utils';
+import { readPageFromDisk, readPageFromDiskAsString, SystemIdHeader, writePageToDisk } from './page-utils';
 import { UIServer } from './UIServer';
 import { PageQueue } from './PageGenerator';
-import FSExtra from 'fs-extra';
 
 const UI_SERVERS: { [key: string]: UIServer } = {};
 const router = Router();
@@ -140,6 +124,7 @@ router.delete('/:handle/ui', async (req: KapetaBodyRequest, res: Response) => {
         server.close();
         delete UI_SERVERS[conversationId];
     }
+    res.status(200).json({ status: 'ok' });
 });
 
 router.post('/:handle/ui/iterative', async (req: KapetaBodyRequest, res: Response) => {
@@ -325,6 +310,16 @@ router.post('/:handle/ui', async (req: KapetaBodyRequest, res: Response) => {
         UI_SERVERS[outerConversationId] = new UIServer(outerConversationId);
         await UI_SERVERS[outerConversationId].start();
 
+        sendEvent(res, {
+            type: 'UI_SERVER_STARTED',
+            reason: '',
+            payload: {
+                conversationId: outerConversationId,
+                resetUrl: UI_SERVERS[outerConversationId].resolveUrlFromPath('/_reset'),
+            },
+            created: Date.now(),
+        });
+
         // Get the pages (5 at a time)
 
         const pagePromises: Promise<void>[] = [];