Deserialization of Lionweb nodes to dynamic nodes

Author: alessiostalla

CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project from version 1.2.0 upwards are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [1.6.2] – 2024-02-29
+
+### Added
+- Deserialization of Lionweb nodes to dynamic nodes
+
 ## [1.6.1] – 2024-02-28
 
 ### Added

src/interop/lionweb.ts

@@ -10,7 +10,7 @@ import {
     InstantiationFacade, Language,
     Node as LionwebNode
 } from "@lionweb/core";
-import {Node} from "..";
+import {Node, NodeDefinition, PropertyDefinition} from "..";
 
 export class TylasuNodeWrapper implements LionwebNode {
     id: Id;
@@ -38,6 +38,37 @@ export class LanguageMapping {
     }
 }
 
+function featureToProperty(feature: Feature): PropertyDefinition {
+    const def: PropertyDefinition = { name: feature.name };
+    if (feature instanceof Containment) {
+        def.child = true;
+        def.multiple = feature.multiple;
+    }
+    return def
+}
+
+export class DynamicNode extends Node {
+
+    protected readonly _nodeDefinition: NodeDefinition;
+
+    constructor(public readonly classifier: Classifier) {
+        super();
+        const properties = {};
+        classifier.features.forEach(f => {
+            properties[f.name] = featureToProperty(f);
+        });
+        this._nodeDefinition = {
+            name: classifier.name,
+            properties: properties,
+            resolved: true
+        };
+    }
+
+    public get nodeDefinition(): NodeDefinition {
+        return this._nodeDefinition;
+    }
+}
+
 export class TylasuInstantiationFacade implements InstantiationFacade<TylasuNodeWrapper> {
 
     constructor(public languageMappings: LanguageMapping[] = [STARLASU_LANGUAGE_MAPPING]) {}
@@ -52,20 +83,18 @@ export class TylasuInstantiationFacade implements InstantiationFacade<TylasuNode
         for (const language of this.languageMappings) {
             const nodeType = language.classifiers.get(classifier);
             if (nodeType) {
-                node = this.makeNode(nodeType, parent?.node, propertySettings);
-                break;
+                node = new nodeType() as Node;
             }
         }
-        if (node) {
-            return {
-                id,
-                parent,
-                node,
-                annotations: []
-            };
-        } else {
-            throw new Error("Unknown classifier: " + classifier.id);
+        if (!node) {
+            node = new DynamicNode(classifier);
         }
+        return {
+            id,
+            parent,
+            node: this.setupNode(node, parent?.node, propertySettings),
+            annotations: []
+        };
     }
     setFeatureValue(node: TylasuNodeWrapper, feature: Feature, value: unknown): void {
         if (feature instanceof Containment) {
@@ -79,10 +108,9 @@ export class TylasuInstantiationFacade implements InstantiationFacade<TylasuNode
         }
     }
 
-    protected makeNode(nodeType: any, parent: Node | undefined, propertySettings: {
+    protected setupNode(node: Node, parent: Node | undefined, propertySettings: {
         [p: string]: unknown
     }): Node {
-        const node = new nodeType() as Node;
         Object.keys(propertySettings).forEach(k => {
             node[k] = propertySettings[k]; //TODO protect parent, origin etc.
         })

src/interop/strumenta-playground.ts

@@ -120,7 +120,7 @@ export abstract class TraceNode extends Node {
         return this.getPosition();
     }
 
-    protected get nodeDefinition(): NodeDefinition {
+    get nodeDefinition(): NodeDefinition {
         return {
             package: this.eo.eClass.eContainer.get("name") as string,
             name: this.eo.eClass.get("name") as string,

src/model/model.ts

@@ -146,7 +146,7 @@ export abstract class Node extends Origin implements Destination {
         return Object.getOwnPropertyNames(props).filter(p => props[p].child);
     }
 
-    protected get nodeDefinition(): NodeDefinition | undefined {
+    get nodeDefinition(): NodeDefinition | undefined {
         return getNodeDefinition(this);
     }
 

tests/interop/lionweb.test.ts

@@ -2,14 +2,16 @@ import FS_LANGUAGE_JSON from "./fs-language.json";
 import FS_MODEL from "./fs-model.json";
 import {expect} from "chai";
 import {deserializeChunk, deserializeLanguages, SerializationChunk} from "@lionweb/core";
-import {Children, Node} from "../../src";
+import {Children, Node, walk} from "../../src";
 import {
+    DynamicNode,
     findClassifier,
     LanguageMapping,
     STARLASU_LANGUAGE,
     STARLASU_LANGUAGE_MAPPING,
     TylasuInstantiationFacade
 } from "../../src/interop/lionweb";
+import {map, pipe, reduce} from "iter-ops";
 
 abstract class File extends Node {
     name: string;
@@ -24,6 +26,9 @@ class TextFile extends File {
     contents: string;
 }
 
+function printSequence(sequence: Generator<Node>): string {
+    return pipe(sequence, map(n => n.name), reduce((s1, s2) => s1 + (s1 ? ", " : "") + s2, "")).first;
+}
 
 describe('Lionweb integration', function() {
     const FS_LANGUAGE = deserializeLanguages(FS_LANGUAGE_JSON as SerializationChunk, STARLASU_LANGUAGE)[0];
@@ -32,7 +37,7 @@ describe('Lionweb integration', function() {
     FS_LANGUAGE_MAPPING.register(File, findClassifier(FS_LANGUAGE, "starlasu_language_com-strumenta-codeinsightstudio-model-filesystem_File"));
     FS_LANGUAGE_MAPPING.register(TextFile, findClassifier(FS_LANGUAGE, "starlasu_language_com-strumenta-codeinsightstudio-model-filesystem_TextFile"));
 
-    it("Can deserialize simple model",
+    it("can deserialize simple model",
         function () {
             const nodes = deserializeChunk(FS_MODEL, new TylasuInstantiationFacade([FS_LANGUAGE_MAPPING]), [FS_LANGUAGE], []);
             expect(nodes).not.to.be.empty;
@@ -50,5 +55,42 @@ describe('Lionweb integration', function() {
             const file = dir.files[0] as TextFile;
             expect(file.name).to.equal("delegate.egl");
             expect(file.contents.substring(0, 10)).to.equal("Delegate F");
+
+            expect(printSequence(walk(root.node))).to.equal(
+                "resources.zip, resources, delegate.egl, rosetta-code-count-examples-2.egl, " +
+                "rosetta-code-count-examples-1.egl, sub1, sub2, foreach.egl, SQLDropTable.egl, for.egl, SQLBatch.egl, " +
+                "SQLCreateTable.egl, SQLDropTable.egl, hello.egl, foreach.egl, Calc.egl, SQLBatch.egl, " +
+                "multipleWhenCondition.egl, handler.egl, SQLCreateTable.egl, newExample.egl, SQLDropTable.egl, " +
+                "nestedLoop.egl, for.egl");
+        });
+
+    it("can deserialize simple model to dynamic nodes",
+        function () {
+            const nodes = deserializeChunk(FS_MODEL, new TylasuInstantiationFacade(), [FS_LANGUAGE], []);
+            expect(nodes).not.to.be.empty;
+            expect(nodes.length).to.equal(1);
+            const root = nodes[0];
+            expect(root.node).to.be.instanceof(DynamicNode);
+            let dir = root.node as DynamicNode & any;
+            expect(dir.nodeDefinition.name).to.equal("Directory");
+            expect(dir.name).to.equal("resources.zip");
+            expect(dir.files.length).to.equal(1);
+            expect(dir.files[0]).to.be.instanceof(DynamicNode);
+            dir = dir.files[0] as DynamicNode & any;
+            expect(dir.nodeDefinition.name).to.equal("Directory");
+            expect(dir.name).to.equal("resources");
+            expect(dir.files.length).to.equal(15);
+            expect(dir.files[0]).to.be.instanceof(DynamicNode);
+            const file = dir.files[0] as DynamicNode & any;
+            expect(file.nodeDefinition.name).to.equal("TextFile");
+            expect(file.name).to.equal("delegate.egl");
+            expect(file.contents.substring(0, 10)).to.equal("Delegate F");
+
+            expect(printSequence(walk(root.node))).to.equal(
+                "resources.zip, resources, delegate.egl, rosetta-code-count-examples-2.egl, " +
+                "rosetta-code-count-examples-1.egl, sub1, sub2, foreach.egl, SQLDropTable.egl, for.egl, SQLBatch.egl, " +
+                "SQLCreateTable.egl, SQLDropTable.egl, hello.egl, foreach.egl, Calc.egl, SQLBatch.egl, " +
+                "multipleWhenCondition.egl, handler.egl, SQLCreateTable.egl, newExample.egl, SQLDropTable.egl, " +
+                "nestedLoop.egl, for.egl");
         });
 });