Added Component test with local script file. Fixed some bugs in parameter handling

Author: mvdnet

.gitignore

@@ -13,3 +13,4 @@ Thumbs.db
 dist/**/*
 yarn.lock
 coverage/
+tests/*.glb

src/ParamManager.ts

@@ -28,7 +28,8 @@
  * 
  */
 
-import { ScriptParam, ScriptParamData, ParamOperation, ParamManagerOperator } from './internal'
+import type { ScriptParamData } from './internal'
+import { ScriptParam, ParamOperation, ParamManagerOperator } from './internal'
 
 import deepEqual from 'deep-is'
 
@@ -45,13 +46,18 @@ export class ParamManager
     paramOperators:Array<ParamManagerOperator> = [];
 
     /** Set up ParamManager with current params */
-    constructor(params?:Array<ScriptParam>)
+    constructor(params?:Array<ScriptParam|ScriptParamData>)
     {
         if(Array.isArray(params) && params.length > 0)
         {
             //this.paramOperators = params.map(p => new ParamManagerOperator(this, this._validateParam(ScriptParamToParam(p)))); // always make sure we use Param internally
             // Disable validation because its old
-            this.paramOperators = params.map(p => new ParamManagerOperator(this, p)); // always make sure we use Param internally
+            this.paramOperators = params
+                                    .map(
+                                        p => {
+                                            const paramDef = (p instanceof ScriptParam) ? p : new ScriptParam().fromData(p);
+                                            return new ParamManagerOperator(this, paramDef); // always make sure we use Param internally
+                                        });
             this.paramOperators.forEach( p => this[p.name] = p) // set param access
         }
     }

src/Runner.ts

@@ -16,7 +16,7 @@
 import type { ArchiyouApp, ExportGLTFOptions, Statement, 
                 StatementResult, RunnerScriptScopeState, ScriptOutputPath, ScriptOutputFormatModel, 
                 ScriptOutputFormat, ScriptOutputData, DocData,
-                ConsoleMessageType,
+                ConsoleMessageType, ScriptData
  } from "./internal"
 
 
@@ -25,7 +25,7 @@ import { OcLoader, Console, Brep, Doc, Calc, Exporter, Services, Make, Db,
             RunnerScriptExecutionResult, Script, CodeParser, LibraryConnector, 
             ScriptOutputManager, Pipeline } from "./internal"
 
-import { Point, Vector, Bbox, Edge, Vertex, Wire, Face, Shell, Solid, ShapeCollection, Obj, ParamManager } from "./internal"
+import { Point, Vector, Bbox, Edge, Vertex, Wire, Face, Shell, Solid, ShapeCollection, Obj, ScriptParam, ParamManager } from "./internal"
 
 import { RunnerComponentImporter } from "./internal"
 
@@ -1131,9 +1131,15 @@ ${e.message === '***** CODE ****\nUnexpected end of input' ? code : ''}
     _executionStartRunInScope(scope:any, request: RunnerScriptExecutionRequest):void
     {
         // Setup ParamManager - it still uses Array of Param defintions with _value
-        const paramDefsWithValues = [...Object.values(request.script.params || {})]
-        paramDefsWithValues.forEach(p => p._value = request.params[p.name]);
+        const paramDefsWithValues = [...Object.values(request.script.params || {})] as Array<ScriptParam|ScriptParamData>; // param names are uppercase
+        paramDefsWithValues.forEach(pd => 
+        {
+            const n = Object.keys(request.params || {}).find( p => p.toLowerCase() === pd.name.toLowerCase())
+            pd._value = request.params[n];
+        });
+
         console.info(`Runner::_executionStartRunInScope()[in execution context]: Setting up ParamManager in scope with params "${JSON.stringify(paramDefsWithValues)}"`);
+
         scope.ay.paramManager = new ParamManager(paramDefsWithValues)
             .setParent(scope); // sets globals in method setParent()
         scope.$PARAMS = scope.ay.paramManager;
@@ -1375,14 +1381,30 @@ ${e.message === '***** CODE ****\nUnexpected end of input' ? code : ''}
             // Load dynamically to avoid issues in browser
             const FS_PROMISES_LIB = 'fs/promises'; // avoid problems with older build systems preparsing import statement
             const fs = await import(FS_PROMISES_LIB); // use promises version of fs
-            const data = await fs.readFile(path, 'utf-8');
+            const pathLib = await import('path');
+
+            // NOTE: absolute paths are recommended - otherwise we take the working directory as root
+            // There is no way to get the main script from here
+            if(path[0] === '.')
+            {
+                path = pathLib.resolve(process.cwd(), path);
+                console.warn(`$component("${path}")::_prepareComponentScript(): Resolved relative path using current working to: "${path}"`);
+            }
 
-            if(!data)
+            try {
+                // Scripts are modules (not JSON)
+                const data:ScriptData = (await import(path))?.default;
+
+                if(!data){ throw new Error(`$component("${path}")::_prepareComponentScript(): Cannot read component script from file "${path}". File is empty!`);}
+
+                const componentScript = new Script().fromData(data);
+                return componentScript;
+            }
+            catch(e)
             { 
-                throw new Error(`$component("${path}")::_prepareComponentScript(): Cannot read component script from file "${path}". File not found or empty!`);
+                throw new Error(`$component("${path}")::_prepareComponentScript(): Cannot read component script from file "${path}". File not found`);
             }
-            const componentScript = new Script().fromData(data);
-            return componentScript;
+            
         }
         // path in format like 'archiyou/testcomponent:0.5' or 'archiyou/testcomponent' (default library)
         // or externally: 'pubv2.archiyou.com/archiyou/myscript:1.0'

src/RunnerComponentImporter.ts

@@ -217,7 +217,7 @@ export class RunnerComponentImporter
         const request:RunnerScriptExecutionRequest = {
             script: script,
             component: this.label, // scope identifier
-            params: this.params,
+            params: this._params, 
             outputs: (this._requestedOutputs.length === 0) ? this.DEFAULT_OUTPUTS : this._requestedOutputs,
         };
 
@@ -261,7 +261,9 @@ export class RunnerComponentImporter
                 {
                     console.info(`$component("${this.label}")::_executeComponentScript(): Recreating component Obj tree in main scope for pipeline "${pl}"...`);
                     const recreatedObj = this._recreateComponentObjTree(outPathObj._output as Object);
-                    pipelineResult['model'] = recreatedObj.shapes(true); // result is ShapeCollection of all shapes in the Obj tree
+                    // result is ShapeCollection of all shapes in the Obj tree
+                    pipelineResult['model'] = recreatedObj.shapes(true); // NOTE: only visible shapes, filted out in _recreateComponentObjTree
+
                     console.info(`$component("${this.label}")::_executeComponentScript(): Recreated component Obj tree in main scope for pipeline "${pl}".`);
                 }
             });
@@ -293,16 +295,19 @@ export class RunnerComponentImporter
     }
 
     /** We need to recreate the component object tree into the current scope */
-    _recreateComponentObjTree(tree:Object, parentObj?:Obj):Obj
+    _recreateComponentObjTree(tree:Object, parentObj?:Obj, onlyVisible:boolean=true):Obj
     {
         console.info(`$component("${this.label}")::_recreateComponentObjTree(): Recreating component object tree...`);
         const mainScope = this._scope;
 
         const curNode = tree as Object as any; // TODO: TS typing
         const newObj = new mainScope.Obj(); // create Geom Obj container 
         newObj.name((curNode as any).name);
+
+        const curNodeVisibleShapes = onlyVisible ? curNode.shapes.filter(s => s.visible()) : curNode.shapes;
+
         // IMPORTANT: Shapes are still tied to Geom of component scope - change that
-        newObj._updateShapes(curNode.shapes.map(s => { s._brep = mainScope.brep; return s; })); 
+        newObj._updateShapes(curNodeVisibleShapes.map(s => { s._brep = mainScope.brep; return s; })); 
 
         console.info(`$component("${this.label}")::_recreateComponentObjTree(): Recreated object "${newObj.name()}" with ${newObj.shapes(false).length} shapes`);
 

src/Script.ts

@@ -97,6 +97,7 @@ export class Script
 
     _validateBasics():boolean
     {
+        // TODO: use a validation library at the start
         const VALIDATIONS = {
             id: this.id && typeof this.id === "string", // should always be a string
             name : !this.name || (typeof this.name === "string" && this.name.length > 0), // can be undefined, but accept only strings
@@ -115,6 +116,7 @@ export class Script
         {
             const firstErrorIndex = Object.values(VALIDATIONS).findIndex(v => v !== true);
             console.error(`Script._validateBasics(): Basic validation failed: ${Object.keys(VALIDATIONS)[firstErrorIndex]}`);
+            console.error(`Incoming data: ${JSON.stringify(this[Object.keys(VALIDATIONS)[firstErrorIndex]])}`);
         }
 
         return this._valid = isValidBasic && this._validatePublished();
@@ -301,7 +303,7 @@ export class Script
             return Infinity;
         }
 
-        return Object.values(this.params).reduce((acc, paraissm) => {
+        return Object.values(this.params).reduce((acc, param) => {
             acc *= param.numValues();
             return acc;
         }, 1);
@@ -367,6 +369,7 @@ export class Script
 
     /** Load from raw data
      *  Some backwards compatibility
+     *  TODO: Make this a static method
      */
     fromData(data:Script|ScriptData|Record<string, any>):Script|this
     {

tests/unit/Runner.components.test.ts

@@ -1,4 +1,4 @@
-import { Runner } from '../../src/internal'
+import { Runner, RunnerOps } from '../../src/internal'
 import type { ScriptData } from '../../src/internal'
 
 import { describe, it,  beforeAll, expect } from 'vitest'
@@ -15,7 +15,7 @@ describe('Runner with components', () =>
     });
 
     /*
-    it('it should execute a script with a component script define by inline code', 
+    it('should execute a script with a component script define by inline code', 
         async () => 
         {
             const mainScript = {
@@ -45,7 +45,43 @@ describe('Runner with components', () =>
     );
     */
 
-    it('it should handle recursive component scripts', async () => {
+    it('should load a local script file as component', async () => {
+
+        // from working dir
+        const LOCAL_SCRIPT_PATH = './tests/unit/RunnerComponent.js'
+
+        const mainScript = {
+                code : `
+                    // Make a wall
+                    wall = boxbetween([0,0,0], [4000, 200, 3000]) // leftbottom at center
+                            .move(0,-100); // align with X axis
+
+                    // Place Frame as component
+                    frame = $component('${LOCAL_SCRIPT_PATH}')
+                                .params({ width: 1000, height: 500, depth: 300 })
+                                .model();
+                    frame.moveTo(0, 0, 0) // center at origin
+                        .move(2000, 0, 1500);
+                    
+                    // subtract frame from wall
+                    wall.subtract(frame.bbox().shape());
+
+                    print(frame.length); // ==> 1
+                `
+            } as ScriptData;
+
+        const r = await runner.execute({ script: mainScript });
+        expect(r).toBeDefined();
+        expect(r.status).toBe('success');
+        expect(r?.messages?.filter(m => m.type === 'user')[0].message).toBe('1');
+        expect((r?.outputs?.[0].output as ArrayBuffer)?.byteLength).toBeGreaterThan(30000); // 30508  (but some small differences)
+
+        // for visible check: save glb to ./tests/unit/RunnerComponent.glb
+        new RunnerOps().saveBlobToFile(r?.outputs?.[0]?.output as any, './tests/unit/RunnerComponent.glb');
+    })
+
+    /*
+    it('should handle recursive component scripts', async () => {
         // NOTE: make sure you nest backticks correctly or avoid!
         const mainScript = {
             code: `
@@ -73,6 +109,6 @@ describe('Runner with components', () =>
         expect(r?.messages?.filter(m => m.type === 'user')[0].message).toBe('4');
         expect((r?.outputs?.[0].output as ArrayBuffer)?.byteLength).toBeGreaterThan(69000); // can vary
     });
-
+    */
 
 })

tests/unit/RunnerComponent.glb

@@ -0,0 +1,44 @@
+// used with Runner.components.test.ts
+export default {
+    id : "Frame",
+    name: "Frame",
+    author: "test",
+    params: {
+        width: {
+            type: "number",
+            default: 1000,
+            min: 300,
+            max: 2000
+        },
+        height: {
+            type: "number",
+            default: 1000,
+            min: 300,
+            max: 2000
+        },
+        depth: {
+            type: "number",
+            default: 200,
+            min: 100,
+            max: 500
+        }
+    },
+    code: `
+        // Create the simple frame
+        frameOuter = line([0,0,0],[$WIDTH,0,0])
+                .hide()
+                .extruded($HEIGHT, [0,0,1])
+                .hide();
+         
+        frameInner = frameOuter.offsetted(-50).name('h');
+        frame =  frameOuter
+                    .subtract(frameInner.hide())
+                    .extruded($DEPTH)
+                    .color('blue')
+        
+    `,
+    published: {
+        version: "0.1",
+    }
+
+}