@kapeta/local-cluster-service 0.48.0 → 0.48.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.48.1](https://github.com/kapetacom/local-cluster-service/compare/v0.48.0...v0.48.1) (2024-06-03)
+
+
+### Bug Fixes
+
+* Enrich events with block refs and instance ids ([#156](https://github.com/kapetacom/local-cluster-service/issues/156)) ([c45d5d7](https://github.com/kapetacom/local-cluster-service/commit/c45d5d776760a51fb786582d74cb4d049e27f0db))
+
 # [0.48.0](https://github.com/kapetacom/local-cluster-service/compare/v0.47.4...v0.48.0) (2024-06-03)
 
 

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

@@ -51,10 +51,15 @@ export declare class StormEventParser {
     private options;
     constructor(options: StormOptions);
     private reset;
-    addEvent(handle: string, evt: StormEvent): StormDefinitions;
+    /**
+     * Builds plan and block definitions - and enriches events with relevant refs and ids
+     */
+    processEvent(handle: string, evt: StormEvent): StormDefinitions;
     getEvents(): StormEvent[];
     isValid(): boolean;
     getError(): string;
+    private toInstanceId;
+    private toInstanceIdFromRef;
     toResult(handle: string): StormDefinitions;
     private toSafeName;
     private toRef;

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

@@ -122,9 +122,11 @@ class StormEventParser {
         this.blocks = {};
         this.connections = [];
     }
-    addEvent(handle, evt) {
+    /**
+     * Builds plan and block definitions - and enriches events with relevant refs and ids
+     */
+    processEvent(handle, evt) {
         this.events.push(evt);
-        console.log('evt', evt);
         switch (evt.type) {
             case 'CREATE_PLAN_PROPERTIES':
                 this.planName = evt.payload.name;
@@ -137,6 +139,8 @@ class StormEventParser {
                     models: [],
                     types: [],
                 };
+                evt.payload.blockRef = this.toRef(handle, evt.payload.name).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'PLAN_RETRY':
                 this.reset();
@@ -147,14 +151,22 @@ class StormEventParser {
                 break;
             case 'CREATE_API':
                 this.blocks[evt.payload.blockName].apis.push(prettifyKaplang(evt.payload.content));
+                evt.payload.blockRef = this.toRef(handle, evt.payload.blockName).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'CREATE_TYPE':
                 this.blocks[evt.payload.blockName].types.push(prettifyKaplang(evt.payload.content));
+                evt.payload.blockRef = this.toRef(handle, evt.payload.blockName).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'CREATE_MODEL':
                 this.blocks[evt.payload.blockName].models.push(prettifyKaplang(evt.payload.content));
+                evt.payload.blockRef = this.toRef(handle, evt.payload.blockName).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'CREATE_CONNECTION':
+                evt.payload.fromBlockId = this.toInstanceId(handle, evt.payload.fromComponent);
+                evt.payload.toBlockId = this.toInstanceId(handle, evt.payload.toComponent);
                 this.connections.push(evt.payload);
                 break;
             default:
@@ -176,13 +188,20 @@ class StormEventParser {
     getError() {
         return this.error;
     }
+    toInstanceId(handle, blockName) {
+        const ref = this.toRef(handle, blockName);
+        return this.toInstanceIdFromRef(ref.toNormalizedString());
+    }
+    toInstanceIdFromRef(ref) {
+        return (0, uuid_1.v5)((0, nodejs_utils_1.normalizeKapetaUri)(ref), uuid_1.v5.URL);
+    }
     toResult(handle) {
         const planRef = this.toRef(handle, this.planName ?? 'undefined');
         const blockDefinitions = this.toBlockDefinitions(handle);
         const refIdMap = {};
         const blocks = Object.entries(blockDefinitions).map(([ref, block]) => {
             // Create a deterministic uuid
-            const id = (0, uuid_1.v5)(ref, uuid_1.v5.URL);
+            const id = this.toInstanceIdFromRef(ref);
             refIdMap[ref] = id;
             return {
                 id,

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

@@ -14,6 +14,8 @@ export interface StormBlockInfo {
         name: string;
         description: string;
     }[];
+    blockRef?: string;
+    instanceId?: string;
 }
 export interface StormBlockInfoFilled extends StormBlockInfo {
     apis: string[];
@@ -28,9 +30,11 @@ export interface StormEventCreateBlock {
 }
 export interface StormConnection {
     fromComponent: string;
+    fromBlockId?: string;
     fromResource: string;
     fromResourceType: StormResourceType;
     toComponent: string;
+    toBlockId?: string;
     toResource: string;
     toResourceType: StormResourceType;
 }
@@ -72,6 +76,8 @@ export interface StormEventCreateDSL {
     payload: {
         blockName: string;
         content: string;
+        blockRef?: string;
+        instanceId?: string;
     };
 }
 export interface StormEventError {

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

@@ -27,12 +27,12 @@ router.post('/:handle/all', async (req, res) => {
         res.set('Content-Type', 'application/x-ndjson');
         res.set('Access-Control-Expose-Headers', stormClient_1.ConversationIdHeader);
         res.set(stormClient_1.ConversationIdHeader, metaStream.getConversationId());
-        console.log('metaStream.getConversationId()', metaStream.getConversationId());
         metaStream.on('data', (data) => {
-            const result = eventParser.addEvent(req.params.handle, data);
+            const result = eventParser.processEvent(req.params.handle, data);
+            sendEvent(res, data);
             sendDefinitions(res, result);
         });
-        await streamStormPartialResponse(metaStream, res);
+        await waitForStormStream(metaStream);
         if (!eventParser.isValid()) {
             // We can't continue if the meta stream is invalid
             sendEvent(res, {
@@ -88,6 +88,16 @@ function sendError(err, res) {
         res.status(400).send({ error: err.message });
     }
 }
+function waitForStormStream(result) {
+    return new Promise((resolve, reject) => {
+        result.on('error', (err) => {
+            reject(err);
+        });
+        result.on('end', () => {
+            resolve();
+        });
+    });
+}
 function streamStormPartialResponse(result, res) {
     return new Promise((resolve, reject) => {
         result.on('data', (data) => {

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

@@ -127,7 +127,7 @@ const events = [
 describe('event-parser', () => {
     it('it can parse events into a plan and blocks with proper layout', () => {
         const parser = new event_parser_1.StormEventParser(parserOptions);
-        events.forEach((event) => parser.addEvent('kapeta', event));
+        events.forEach((event) => parser.processEvent('kapeta', event));
         const result = parser.toResult('kapeta');
         expect(result.plan.metadata.name).toBe('kapeta/my-plan');
         expect(result.plan.metadata.description).toBe('my plan description');

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

@@ -51,10 +51,15 @@ export declare class StormEventParser {
     private options;
     constructor(options: StormOptions);
     private reset;
-    addEvent(handle: string, evt: StormEvent): StormDefinitions;
+    /**
+     * Builds plan and block definitions - and enriches events with relevant refs and ids
+     */
+    processEvent(handle: string, evt: StormEvent): StormDefinitions;
     getEvents(): StormEvent[];
     isValid(): boolean;
     getError(): string;
+    private toInstanceId;
+    private toInstanceIdFromRef;
     toResult(handle: string): StormDefinitions;
     private toSafeName;
     private toRef;

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

@@ -122,9 +122,11 @@ class StormEventParser {
         this.blocks = {};
         this.connections = [];
     }
-    addEvent(handle, evt) {
+    /**
+     * Builds plan and block definitions - and enriches events with relevant refs and ids
+     */
+    processEvent(handle, evt) {
         this.events.push(evt);
-        console.log('evt', evt);
         switch (evt.type) {
             case 'CREATE_PLAN_PROPERTIES':
                 this.planName = evt.payload.name;
@@ -137,6 +139,8 @@ class StormEventParser {
                     models: [],
                     types: [],
                 };
+                evt.payload.blockRef = this.toRef(handle, evt.payload.name).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'PLAN_RETRY':
                 this.reset();
@@ -147,14 +151,22 @@ class StormEventParser {
                 break;
             case 'CREATE_API':
                 this.blocks[evt.payload.blockName].apis.push(prettifyKaplang(evt.payload.content));
+                evt.payload.blockRef = this.toRef(handle, evt.payload.blockName).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'CREATE_TYPE':
                 this.blocks[evt.payload.blockName].types.push(prettifyKaplang(evt.payload.content));
+                evt.payload.blockRef = this.toRef(handle, evt.payload.blockName).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'CREATE_MODEL':
                 this.blocks[evt.payload.blockName].models.push(prettifyKaplang(evt.payload.content));
+                evt.payload.blockRef = this.toRef(handle, evt.payload.blockName).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'CREATE_CONNECTION':
+                evt.payload.fromBlockId = this.toInstanceId(handle, evt.payload.fromComponent);
+                evt.payload.toBlockId = this.toInstanceId(handle, evt.payload.toComponent);
                 this.connections.push(evt.payload);
                 break;
             default:
@@ -176,13 +188,20 @@ class StormEventParser {
     getError() {
         return this.error;
     }
+    toInstanceId(handle, blockName) {
+        const ref = this.toRef(handle, blockName);
+        return this.toInstanceIdFromRef(ref.toNormalizedString());
+    }
+    toInstanceIdFromRef(ref) {
+        return (0, uuid_1.v5)((0, nodejs_utils_1.normalizeKapetaUri)(ref), uuid_1.v5.URL);
+    }
     toResult(handle) {
         const planRef = this.toRef(handle, this.planName ?? 'undefined');
         const blockDefinitions = this.toBlockDefinitions(handle);
         const refIdMap = {};
         const blocks = Object.entries(blockDefinitions).map(([ref, block]) => {
             // Create a deterministic uuid
-            const id = (0, uuid_1.v5)(ref, uuid_1.v5.URL);
+            const id = this.toInstanceIdFromRef(ref);
             refIdMap[ref] = id;
             return {
                 id,

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

@@ -14,6 +14,8 @@ export interface StormBlockInfo {
         name: string;
         description: string;
     }[];
+    blockRef?: string;
+    instanceId?: string;
 }
 export interface StormBlockInfoFilled extends StormBlockInfo {
     apis: string[];
@@ -28,9 +30,11 @@ export interface StormEventCreateBlock {
 }
 export interface StormConnection {
     fromComponent: string;
+    fromBlockId?: string;
     fromResource: string;
     fromResourceType: StormResourceType;
     toComponent: string;
+    toBlockId?: string;
     toResource: string;
     toResourceType: StormResourceType;
 }
@@ -72,6 +76,8 @@ export interface StormEventCreateDSL {
     payload: {
         blockName: string;
         content: string;
+        blockRef?: string;
+        instanceId?: string;
     };
 }
 export interface StormEventError {

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

@@ -27,12 +27,12 @@ router.post('/:handle/all', async (req, res) => {
         res.set('Content-Type', 'application/x-ndjson');
         res.set('Access-Control-Expose-Headers', stormClient_1.ConversationIdHeader);
         res.set(stormClient_1.ConversationIdHeader, metaStream.getConversationId());
-        console.log('metaStream.getConversationId()', metaStream.getConversationId());
         metaStream.on('data', (data) => {
-            const result = eventParser.addEvent(req.params.handle, data);
+            const result = eventParser.processEvent(req.params.handle, data);
+            sendEvent(res, data);
             sendDefinitions(res, result);
         });
-        await streamStormPartialResponse(metaStream, res);
+        await waitForStormStream(metaStream);
         if (!eventParser.isValid()) {
             // We can't continue if the meta stream is invalid
             sendEvent(res, {
@@ -88,6 +88,16 @@ function sendError(err, res) {
         res.status(400).send({ error: err.message });
     }
 }
+function waitForStormStream(result) {
+    return new Promise((resolve, reject) => {
+        result.on('error', (err) => {
+            reject(err);
+        });
+        result.on('end', () => {
+            resolve();
+        });
+    });
+}
 function streamStormPartialResponse(result, res) {
     return new Promise((resolve, reject) => {
         result.on('data', (data) => {

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

@@ -127,7 +127,7 @@ const events = [
 describe('event-parser', () => {
     it('it can parse events into a plan and blocks with proper layout', () => {
         const parser = new event_parser_1.StormEventParser(parserOptions);
-        events.forEach((event) => parser.addEvent('kapeta', event));
+        events.forEach((event) => parser.processEvent('kapeta', event));
         const result = parser.toResult('kapeta');
         expect(result.plan.metadata.name).toBe('kapeta/my-plan');
         expect(result.plan.metadata.description).toBe('my plan description');

package/package.json

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

package/src/storm/codegen.ts

@@ -136,7 +136,7 @@ export class StormCodegen {
         }
 
         const basePath = path.join(os.tmpdir(), block.content.metadata.name);
-        
+
         for (const serviceFile of serviceFiles) {
             const filePath = join(basePath, serviceFile.filename);
             await writeFile(filePath, serviceFile.content);
@@ -147,7 +147,7 @@ export class StormCodegen {
             await writeFile(filePath, serviceFile.content);
         }
 
-        for(const uiFile of uiTemplates){
+        for (const uiFile of uiTemplates) {
             const filePath = join(basePath, uiFile.filename);
             await writeFile(filePath, uiFile.content);
         }

package/src/storm/event-parser.ts

@@ -221,9 +221,11 @@ export class StormEventParser {
         this.connections = [];
     }
 
-    public addEvent(handle: string, evt: StormEvent): StormDefinitions {
+    /**
+     * Builds plan and block definitions - and enriches events with relevant refs and ids
+     */
+    public processEvent(handle: string, evt: StormEvent): StormDefinitions {
         this.events.push(evt);
-        console.log('evt', evt);
         switch (evt.type) {
             case 'CREATE_PLAN_PROPERTIES':
                 this.planName = evt.payload.name;
@@ -236,6 +238,8 @@ export class StormEventParser {
                     models: [],
                     types: [],
                 };
+                evt.payload.blockRef = this.toRef(handle, evt.payload.name).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'PLAN_RETRY':
                 this.reset();
@@ -246,14 +250,22 @@ export class StormEventParser {
                 break;
             case 'CREATE_API':
                 this.blocks[evt.payload.blockName].apis.push(prettifyKaplang(evt.payload.content));
+                evt.payload.blockRef = this.toRef(handle, evt.payload.blockName).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'CREATE_TYPE':
                 this.blocks[evt.payload.blockName].types.push(prettifyKaplang(evt.payload.content));
+                evt.payload.blockRef = this.toRef(handle, evt.payload.blockName).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'CREATE_MODEL':
                 this.blocks[evt.payload.blockName].models.push(prettifyKaplang(evt.payload.content));
+                evt.payload.blockRef = this.toRef(handle, evt.payload.blockName).toNormalizedString();
+                evt.payload.instanceId = this.toInstanceIdFromRef(evt.payload.blockRef);
                 break;
             case 'CREATE_CONNECTION':
+                evt.payload.fromBlockId = this.toInstanceId(handle, evt.payload.fromComponent);
+                evt.payload.toBlockId = this.toInstanceId(handle, evt.payload.toComponent);
                 this.connections.push(evt.payload);
                 break;
 
@@ -281,13 +293,22 @@ export class StormEventParser {
         return this.error;
     }
 
+    private toInstanceId(handle: string, blockName: string) {
+        const ref = this.toRef(handle, blockName);
+        return this.toInstanceIdFromRef(ref.toNormalizedString());
+    }
+
+    private toInstanceIdFromRef(ref: string) {
+        return uuid(normalizeKapetaUri(ref), uuid.URL);
+    }
+
     public toResult(handle: string): StormDefinitions {
         const planRef = this.toRef(handle, this.planName ?? 'undefined');
         const blockDefinitions = this.toBlockDefinitions(handle);
         const refIdMap: { [key: string]: string } = {};
         const blocks = Object.entries(blockDefinitions).map(([ref, block]) => {
             // Create a deterministic uuid
-            const id = uuid(ref, uuid.URL);
+            const id = this.toInstanceIdFromRef(ref);
             refIdMap[ref] = id;
             return {
                 id,

package/src/storm/events.ts

@@ -30,6 +30,8 @@ export interface StormBlockInfo {
         name: string;
         description: string;
     }[];
+    blockRef?: string;
+    instanceId?: string;
 }
 
 export interface StormBlockInfoFilled extends StormBlockInfo {
@@ -47,9 +49,11 @@ export interface StormEventCreateBlock {
 
 export interface StormConnection {
     fromComponent: string;
+    fromBlockId?: string;
     fromResource: string;
     fromResourceType: StormResourceType;
     toComponent: string;
+    toBlockId?: string;
     toResource: string;
     toResourceType: StormResourceType;
 }
@@ -96,6 +100,8 @@ export interface StormEventCreateDSL {
     payload: {
         blockName: string;
         content: string;
+        blockRef?: string;
+        instanceId?: string;
     };
 }
 

package/src/storm/routes.ts

@@ -35,15 +35,15 @@ router.post('/:handle/all', async (req: KapetaBodyRequest, res: Response) => {
         res.set('Content-Type', 'application/x-ndjson');
         res.set('Access-Control-Expose-Headers', ConversationIdHeader);
         res.set(ConversationIdHeader, metaStream.getConversationId());
-        console.log('metaStream.getConversationId()', metaStream.getConversationId());
 
         metaStream.on('data', (data: StormEvent) => {
-            const result = eventParser.addEvent(req.params.handle, data);
+            const result = eventParser.processEvent(req.params.handle, data);
 
+            sendEvent(res, data);
             sendDefinitions(res, result);
         });
 
-        await streamStormPartialResponse(metaStream, res);
+        await waitForStormStream(metaStream);
 
         if (!eventParser.isValid()) {
             // We can't continue if the meta stream is invalid
@@ -109,6 +109,17 @@ function sendError(err: Error, res: Response) {
         res.status(400).send({ error: err.message });
     }
 }
+function waitForStormStream(result: StormStream) {
+    return new Promise<void>((resolve, reject) => {
+        result.on('error', (err) => {
+            reject(err);
+        });
+
+        result.on('end', () => {
+            resolve();
+        });
+    });
+}
 
 function streamStormPartialResponse(result: StormStream, res: Response) {
     return new Promise<void>((resolve, reject) => {

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

@@ -139,7 +139,7 @@ const events: StormEvent[] = [
 describe('event-parser', () => {
     it('it can parse events into a plan and blocks with proper layout', () => {
         const parser = new StormEventParser(parserOptions);
-        events.forEach((event) => parser.addEvent('kapeta', event));
+        events.forEach((event) => parser.processEvent('kapeta', event));
 
         const result = parser.toResult('kapeta');