@kapeta/local-cluster-service 0.49.0 → 0.51.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [0.51.0](https://github.com/kapetacom/local-cluster-service/compare/v0.50.0...v0.51.0) (2024-06-05)
+
+
+### Features
+
+* Handle file streaming events ([#164](https://github.com/kapetacom/local-cluster-service/issues/164)) ([441847a](https://github.com/kapetacom/local-cluster-service/commit/441847a12d20826d843e62627ea9bf584043effb))
+
+# [0.50.0](https://github.com/kapetacom/local-cluster-service/compare/v0.49.0...v0.50.0) (2024-06-05)
+
+
+### Features
+
+* Handle aborted requests ([#162](https://github.com/kapetacom/local-cluster-service/issues/162)) ([a9323d4](https://github.com/kapetacom/local-cluster-service/commit/a9323d46423361c2de63e40b4b61927b9b4198b7))
+
 # [0.49.0](https://github.com/kapetacom/local-cluster-service/compare/v0.48.5...v0.49.0) (2024-06-05)
 
 

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

@@ -14,10 +14,12 @@ export declare class StormCodegen {
     private readonly conversationId;
     constructor(conversationId: string, userPrompt: string, blocks: BlockDefinitionInfo[], events: StormEvent[]);
     process(): Promise<void>;
+    isAborted(): boolean;
     getStream(): StormStream;
     private handleTemplateFileOutput;
     private handleUiOutput;
-    private handleFileOutput;
+    private handleFileEvents;
+    private handleFileDoneOutput;
     private getBasePath;
     /**
      * Generates the code for a block and sends it to the AI
@@ -33,7 +35,7 @@ export declare class StormCodegen {
     /**
      * Emits the text-based files to the stream
      */
-    private emitFiles;
+    private emitStaticFiles;
     private emitFile;
     /**
      * Sends the template to the AI and processes the response
@@ -47,4 +49,5 @@ export declare class StormCodegen {
      * Generates the code using codegen for a given block.
      */
     private generateBlock;
+    abort(): void;
 }

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

@@ -42,6 +42,49 @@ const path_1 = __importStar(require("path"));
 const node_os_1 = __importDefault(require("node:os"));
 const fs_1 = require("fs");
 const path_2 = __importDefault(require("path"));
+const SIMULATED_DELAY = 1000;
+class SimulatedFileDelay {
+    file;
+    stream;
+    constructor(file, stream) {
+        this.file = file;
+        this.stream = stream;
+    }
+    async start() {
+        const commonPayload = {
+            filename: this.file.payload.filename,
+            path: this.file.payload.path,
+            blockName: this.file.payload.blockName,
+            blockRef: this.file.payload.blockRef,
+            instanceId: this.file.payload.instanceId,
+        };
+        this.stream.emit('data', {
+            type: 'FILE_START',
+            created: Date.now(),
+            reason: 'File start',
+            payload: commonPayload,
+        });
+        const lines = this.file.payload.content.split('\n');
+        const delayPerLine = SIMULATED_DELAY / lines.length;
+        for (const line of lines) {
+            await new Promise((resolve) => {
+                setTimeout(() => {
+                    this.stream.emit('data', {
+                        type: 'FILE_CHUNK',
+                        created: Date.now(),
+                        reason: 'File chunk',
+                        payload: {
+                            ...commonPayload,
+                            content: line,
+                        },
+                    });
+                    resolve();
+                }, delayPerLine);
+            });
+        }
+        this.stream.emit('data', this.file);
+    }
+}
 class StormCodegen {
     userPrompt;
     blocks;
@@ -63,46 +106,139 @@ class StormCodegen {
         await Promise.all(promises);
         this.out.end();
     }
+    isAborted() {
+        return this.out.isAborted();
+    }
     getStream() {
         return this.out;
     }
     handleTemplateFileOutput(blockUri, aiName, template, data) {
+        if (this.handleFileEvents(blockUri, aiName, data)) {
+            return;
+        }
         switch (data.type) {
-            case 'FILE':
+            case 'FILE_DONE':
                 template.filename = data.payload.filename;
                 template.content = data.payload.content;
-                return this.handleFileOutput(blockUri, aiName, data);
+                this.handleFileDoneOutput(blockUri, aiName, data);
+                break;
         }
     }
-    handleUiOutput(blockUri, aiName, data) {
+    handleUiOutput(blockUri, blockName, data) {
+        const blockRef = blockUri.toNormalizedString();
+        const instanceId = event_parser_1.StormEventParser.toInstanceIdFromRef(blockRef);
+        if (this.handleFileEvents(blockUri, blockName, data)) {
+            return;
+        }
         switch (data.type) {
             case 'SCREEN':
-                const ref = blockUri.toNormalizedString();
                 this.out.emit('data', {
                     type: 'SCREEN',
                     reason: data.reason,
                     created: Date.now(),
                     payload: {
                         ...data.payload,
-                        blockName: aiName,
-                        blockRef: ref,
-                        instanceId: event_parser_1.StormEventParser.toInstanceIdFromRef(ref),
+                        blockName,
+                        blockRef,
+                        instanceId,
+                    },
+                });
+                break;
+            case 'FILE_START':
+            case 'FILE_CHUNK_RESET':
+                this.out.emit('data', {
+                    ...data,
+                    payload: {
+                        ...data.payload,
+                        blockName,
+                        blockRef,
+                        instanceId,
+                    },
+                });
+                break;
+            case 'FILE_CHUNK':
+                this.out.emit('data', {
+                    ...data,
+                    payload: {
+                        ...data.payload,
+                        blockName,
+                        blockRef,
+                        instanceId,
                     },
                 });
-            case 'FILE':
-                return this.handleFileOutput(blockUri, aiName, data);
+                break;
+            case 'FILE_STATE':
+                this.out.emit('data', {
+                    ...data,
+                    payload: {
+                        ...data.payload,
+                        blockName,
+                        blockRef,
+                        instanceId,
+                    },
+                });
+                break;
+            case 'FILE_DONE':
+                this.handleFileDoneOutput(blockUri, blockName, data);
+                break;
         }
     }
-    handleFileOutput(blockUri, aiName, data) {
+    handleFileEvents(blockUri, blockName, data) {
+        const blockRef = blockUri.toNormalizedString();
+        const instanceId = event_parser_1.StormEventParser.toInstanceIdFromRef(blockRef);
+        const basePath = this.getBasePath(blockUri.fullName);
         switch (data.type) {
-            case 'FILE':
+            case 'FILE_START':
+            case 'FILE_CHUNK_RESET':
+                this.out.emit('data', {
+                    ...data,
+                    payload: {
+                        ...data.payload,
+                        path: (0, path_1.join)(basePath, data.payload.filename),
+                        blockName,
+                        blockRef,
+                        instanceId,
+                    },
+                });
+                return true;
+            case 'FILE_CHUNK':
+                this.out.emit('data', {
+                    ...data,
+                    payload: {
+                        ...data.payload,
+                        path: (0, path_1.join)(basePath, data.payload.filename),
+                        blockName,
+                        blockRef,
+                        instanceId,
+                    },
+                });
+                return true;
+            case 'FILE_STATE':
+                this.out.emit('data', {
+                    ...data,
+                    payload: {
+                        ...data.payload,
+                        path: (0, path_1.join)(basePath, data.payload.filename),
+                        blockName,
+                        blockRef,
+                        instanceId,
+                    },
+                });
+                return true;
+        }
+        return false;
+    }
+    handleFileDoneOutput(blockUri, aiName, data) {
+        switch (data.type) {
+            case 'FILE_DONE':
                 const ref = blockUri.toNormalizedString();
                 this.emitFile(blockUri, aiName, data.payload.filename, data.payload.content, data.reason);
                 return {
-                    type: 'FILE',
+                    type: 'FILE_DONE',
                     created: Date.now(),
                     payload: {
                         filename: data.payload.filename,
+                        path: (0, path_1.join)(this.getBasePath(blockUri.fullName), data.payload.filename),
                         content: data.payload.content,
                         blockRef: ref,
                         instanceId: event_parser_1.StormEventParser.toInstanceIdFromRef(ref),
@@ -117,6 +253,9 @@ class StormCodegen {
      * Generates the code for a block and sends it to the AI
      */
     async processBlockCode(block) {
+        if (this.isAborted()) {
+            return;
+        }
         // Generate the code for the block using the standard codegen templates
         const generatedResult = await this.generateBlock(block.content);
         if (!generatedResult) {
@@ -124,7 +263,10 @@ class StormCodegen {
         }
         const allFiles = this.toStormFiles(generatedResult);
         // Send all the non-ai files to the stream
-        this.emitFiles((0, nodejs_utils_1.parseKapetaUri)(block.uri), block.aiName, allFiles);
+        await this.emitStaticFiles((0, nodejs_utils_1.parseKapetaUri)(block.uri), block.aiName, allFiles);
+        if (this.isAborted()) {
+            return;
+        }
         const relevantFiles = allFiles.filter((file) => file.type !== codegen_1.AIFileTypes.IGNORE && file.type !== codegen_1.AIFileTypes.WEB_SCREEN);
         const uiTemplates = allFiles.filter((file) => file.type === codegen_1.AIFileTypes.WEB_SCREEN);
         if (uiTemplates.length > 0) {
@@ -138,8 +280,14 @@ class StormCodegen {
             uiStream.on('data', (evt) => {
                 this.handleUiOutput((0, nodejs_utils_1.parseKapetaUri)(block.uri), block.aiName, evt);
             });
+            this.out.on('aborted', () => {
+                uiStream.abort();
+            });
             await uiStream.waitForDone();
         }
+        if (this.isAborted()) {
+            return;
+        }
         // Gather the context files for implementation. These will be all be passed to the AI
         const contextFiles = relevantFiles.filter((file) => ![codegen_1.AIFileTypes.SERVICE, codegen_1.AIFileTypes.WEB_SCREEN].includes(file.type));
         // Send the service and UI templates to the AI. These will be send one-by-one in addition to the context files
@@ -148,6 +296,9 @@ class StormCodegen {
             await this.processTemplates((0, nodejs_utils_1.parseKapetaUri)(block.uri), block.aiName, stormClient_1.stormClient.createServiceImplementation.bind(stormClient_1.stormClient), serviceFiles, contextFiles);
         }
         const basePath = this.getBasePath(block.content.metadata.name);
+        if (this.isAborted()) {
+            return;
+        }
         for (const serviceFile of serviceFiles) {
             const filePath = (0, path_1.join)(basePath, serviceFile.filename);
             await (0, promises_1.writeFile)(filePath, serviceFile.content);
@@ -192,6 +343,9 @@ class StormCodegen {
                     console.debug('Validation error:', result);
                     const errorStream = await stormClient_1.stormClient.createErrorClassification(result.error, []);
                     const fixes = new Map();
+                    this.out.on('aborted', () => {
+                        errorStream.abort();
+                    });
                     errorStream.on('data', (evt) => {
                         if (evt.type === 'ERROR_CLASSIFIER') {
                             // find the file that caused the error
@@ -206,8 +360,8 @@ class StormCodegen {
                             const fix = `${evt.payload.potentialFix}\n---\n${knownFiles
                                 .map((e) => e.filename)
                                 .join('\n')}\n---\n${content}`;
-                            console.log(`trying to fix the code in ${eventFileName}`);
-                            console.debug(`with the fix:\n${fix}`);
+                            //console.log(`trying to fix the code in ${eventFileName}`);
+                            //console.debug(`with the fix:\n${fix}`);
                             const code = this.codeFix(fix);
                             fixes.set((0, path_1.join)(basePath, eventFileName), code);
                         }
@@ -252,6 +406,9 @@ class StormCodegen {
                     resolve(evt.payload.content);
                 }
             });
+            this.out.on('aborted', () => {
+                fixStream.abort();
+            });
             fixStream.on('error', (err) => {
                 reject(err);
             });
@@ -261,8 +418,8 @@ class StormCodegen {
     /**
      * Emits the text-based files to the stream
      */
-    emitFiles(uri, aiName, files) {
-        files.forEach((file) => {
+    async emitStaticFiles(uri, aiName, files) {
+        const promises = files.map((file) => {
             if (!file.content || typeof file.content !== 'string') {
                 return;
             }
@@ -276,14 +433,30 @@ class StormCodegen {
                 // They will need to be implemented by the AI
                 return;
             }
-            this.emitFile(uri, aiName, file.filename, file.content);
+            const basePath = this.getBasePath(uri.fullName);
+            const ref = uri.toNormalizedString();
+            const fileEvent = {
+                type: 'FILE_DONE',
+                reason: 'File generated',
+                created: Date.now(),
+                payload: {
+                    filename: file.filename,
+                    path: (0, path_1.join)(basePath, file.filename),
+                    content: file.content,
+                    blockName: aiName,
+                    blockRef: ref,
+                    instanceId: event_parser_1.StormEventParser.toInstanceIdFromRef(ref),
+                },
+            };
+            return new SimulatedFileDelay(fileEvent, this.out).start();
         });
+        return Promise.all(promises);
     }
     emitFile(uri, blockName, filename, content, reason = 'File generated') {
         const basePath = this.getBasePath(uri.fullName);
         const ref = uri.toNormalizedString();
         this.out.emit('data', {
-            type: 'FILE',
+            type: 'FILE_DONE',
             reason,
             created: Date.now(),
             payload: {
@@ -306,18 +479,15 @@ class StormCodegen {
                 template: templateFile,
                 prompt: this.userPrompt,
             });
-            const files = [];
+            this.out.on('aborted', () => {
+                stream.abort();
+            });
             stream.on('data', (evt) => {
-                const file = this.handleTemplateFileOutput(blockUri, aiName, templateFile, evt);
-                if (file) {
-                    files.push(file);
-                }
+                this.handleTemplateFileOutput(blockUri, aiName, templateFile, evt);
             });
             await stream.waitForDone();
-            return files;
         });
-        const fileChunks = await Promise.all(promises);
-        return fileChunks.flat();
+        await Promise.all(promises);
     }
     /**
      * Converts the generated files to a format that can be sent to the AI
@@ -357,6 +527,9 @@ class StormCodegen {
      * Generates the code using codegen for a given block.
      */
     async generateBlock(yamlContent) {
+        if (this.isAborted()) {
+            return;
+        }
         if (!yamlContent.spec.target?.kind) {
             //Not all block types have targets
             return;
@@ -371,5 +544,8 @@ class StormCodegen {
         new codegen_1.CodeWriter(basePath).write(generatedResult);
         return generatedResult;
     }
+    abort() {
+        this.out.abort();
+    }
 }
 exports.StormCodegen = StormCodegen;

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

@@ -2,7 +2,7 @@
  * Copyright 2023 Kapeta Inc.
  * SPDX-License-Identifier: BUSL-1.1
  */
-import { StormEvent } from './events';
+import { StormEvent, StormEventPhases, StormEventPhaseType } from './events';
 import { BlockDefinition, Plan } from '@kapeta/schemas';
 import { KapetaURI } from '@kapeta/nodejs-utils';
 export interface BlockDefinitionInfo {
@@ -39,6 +39,9 @@ export interface StormOptions {
     desktopLanguage: string;
     gatewayKind: string;
 }
+export declare function createPhaseStartEvent(type: StormEventPhaseType): StormEventPhases;
+export declare function createPhaseEndEvent(type: StormEventPhaseType): StormEventPhases;
+export declare function createPhaseEvent(start: boolean, type: StormEventPhaseType): StormEventPhases;
 export declare function resolveOptions(): Promise<StormOptions>;
 export declare class StormEventParser {
     static toInstanceId(handle: string, blockName: string): string;

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

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: BUSL-1.1
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StormEventParser = exports.resolveOptions = void 0;
+exports.StormEventParser = exports.resolveOptions = exports.createPhaseEvent = exports.createPhaseEndEvent = exports.createPhaseStartEvent = void 0;
 const nodejs_utils_1 = require("@kapeta/nodejs-utils");
 const kaplang_core_1 = require("@kapeta/kaplang-core");
 const uuid_1 = require("uuid");
@@ -29,6 +29,24 @@ function prettifyKaplang(source) {
         return source;
     }
 }
+function createPhaseStartEvent(type) {
+    return createPhaseEvent(true, type);
+}
+exports.createPhaseStartEvent = createPhaseStartEvent;
+function createPhaseEndEvent(type) {
+    return createPhaseEvent(false, type);
+}
+exports.createPhaseEndEvent = createPhaseEndEvent;
+function createPhaseEvent(start, type) {
+    return {
+        type: start ? 'PHASE_START' : 'PHASE_END',
+        created: Date.now(),
+        payload: {
+            phaseType: type,
+        },
+    };
+}
+exports.createPhaseEvent = createPhaseEvent;
 async function resolveOptions() {
     // Predefined types for now - TODO: Allow user to select / change
     const blockTypeService = await definitionsManager_1.definitionsManager.getLatestDefinition('kapeta/block-type-service');
@@ -193,10 +211,6 @@ class StormEventParser {
                 evt.payload.toBlockId = StormEventParser.toInstanceId(handle, evt.payload.toComponent);
                 this.connections.push(evt.payload);
                 break;
-            default:
-            case 'SCREEN_CANDIDATE':
-            case 'FILE':
-                break;
         }
         return this.toResult(handle);
     }
@@ -213,7 +227,7 @@ class StormEventParser {
         return this.error;
     }
     toResult(handle) {
-        const planRef = StormEventParser.toRef(handle, this.planName ?? 'undefined');
+        const planRef = StormEventParser.toRef(handle, this.planName || 'undefined');
         const blockDefinitions = this.toBlockDefinitions(handle);
         const refIdMap = {};
         const blocks = Object.entries(blockDefinitions).map(([ref, block]) => {
@@ -225,7 +239,7 @@ class StormEventParser {
                 block: {
                     ref,
                 },
-                name: block.content.metadata.title ?? block.content.metadata.name,
+                name: block.content.metadata.title || block.content.metadata.name,
                 dimensions: {
                     left: 0,
                     top: 0,

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

@@ -150,19 +150,35 @@ export interface StormEventScreenCandidate {
         url: string;
     };
 }
-export interface StormEventFile {
-    type: 'FILE';
+export interface StormEventFileBasePayload {
+    filename: string;
+    path: string;
+    blockName: string;
+    blockRef: string;
+    instanceId: string;
+}
+export interface StormEventFileBase {
+    type: string;
     reason: string;
     created: number;
-    payload: {
-        filename: string;
-        path: string;
+    payload: StormEventFileBasePayload;
+}
+export interface StormEventFileLogical extends StormEventFileBase {
+    type: 'FILE_START' | 'FILE_CHUNK_RESET';
+}
+export interface StormEventFileState extends StormEventFileBase {
+    type: 'FILE_STATE';
+    payload: StormEventFileBasePayload & {
+        state: string;
+    };
+}
+export interface StormEventFileContent extends StormEventFileBase {
+    type: 'FILE_DONE' | 'FILE_CHUNK';
+    payload: StormEventFileBasePayload & {
         content: string;
-        blockName: string;
-        blockRef: string;
-        instanceId: string;
     };
 }
+export type StormEventFile = StormEventFileLogical | StormEventFileState | StormEventFileContent;
 export interface StormEventBlockReady {
     type: 'BLOCK_READY';
     reason: string;
@@ -184,4 +200,16 @@ export interface StormEventDefinitionChange {
     created: number;
     payload: StormDefinitions;
 }
-export type StormEvent = StormEventCreateBlock | StormEventCreateConnection | StormEventCreatePlanProperties | StormEventInvalidResponse | StormEventPlanRetry | StormEventCreateDSL | StormEventCreateDSLResource | StormEventError | StormEventScreen | StormEventScreenCandidate | StormEventFile | StormEventDone | StormEventDefinitionChange | StormEventErrorClassifier | StormEventCodeFix | StormEventBlockReady;
+export declare enum StormEventPhaseType {
+    META = "META",
+    DEFINITIONS = "DEFINITIONS",
+    IMPLEMENTATION = "IMPLEMENTATION"
+}
+export interface StormEventPhases {
+    type: 'PHASE_START' | 'PHASE_END';
+    created: number;
+    payload: {
+        phaseType: StormEventPhaseType;
+    };
+}
+export type StormEvent = StormEventCreateBlock | StormEventCreateConnection | StormEventCreatePlanProperties | StormEventInvalidResponse | StormEventPlanRetry | StormEventCreateDSL | StormEventCreateDSLResource | StormEventError | StormEventScreen | StormEventScreenCandidate | StormEventFileLogical | StormEventFileState | StormEventFileContent | StormEventDone | StormEventDefinitionChange | StormEventErrorClassifier | StormEventCodeFix | StormEventBlockReady | StormEventPhases;

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

@@ -1,2 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.StormEventPhaseType = void 0;
+var StormEventPhaseType;
+(function (StormEventPhaseType) {
+    StormEventPhaseType["META"] = "META";
+    StormEventPhaseType["DEFINITIONS"] = "DEFINITIONS";
+    StormEventPhaseType["IMPLEMENTATION"] = "IMPLEMENTATION";
+})(StormEventPhaseType || (exports.StormEventPhaseType = StormEventPhaseType = {}));