@syncbridge/common 0.5.11 → 0.6.0

package/classes/base-element.d.ts

@@ -28,6 +28,7 @@ export declare namespace BaseElement {
             status: ServiceStatus,
             statusMessage: string
         ];
+        'values-updated': [string[]];
     }
     interface InitArgs extends Runnable.InitArgs {
         logger?: ILogger;

package/classes/base-element.js

@@ -12,8 +12,10 @@ export class BaseElement extends Runnable {
         this.logger = init.logger;
         this.name = init.name;
         this.values = init.values;
-        if (this.logger)
-            this.on('error', err => this.logger?.error(err));
+        this.on('error', err => this.logger?.error(err));
+        this.on('values-updated', (properties) => {
+            this.logger?.info(`Configuration changed. Updated properties: ${properties.join(',')}`);
+        });
     }
     get status() {
         return this._context.calculatedStatus || this._context.status;
@@ -48,7 +50,9 @@ export class BaseElement extends Runnable {
         await Promise.all(Object.values(this.components).map(component => component.init()));
     }
     async _start(abortSignal) {
-        await Promise.all(Object.values(this.components).map(component => component.start(abortSignal)));
+        if (this.status === ServiceStatus.starting ||
+            this.status === ServiceStatus.started)
+            await Promise.all(Object.values(this.components).map(component => component.start(abortSignal)));
     }
     async _stop() {
         await Promise.all(Object.values(this.components)

package/constants.js

@@ -1,4 +1,4 @@
-export const version = '0.5.11';
+export const version = '0.6.0';
 export const OWN_ELEMENT_METADATA = Symbol.for('OWN_ELEMENT_METADATA');
 export const COMPONENT_OPTIONS = Symbol.for('COMPONENT_OPTIONS');
 export const PROCESSOR_OPTIONS = Symbol.for('PROCESSOR_OPTIONS');

package/index.d.ts

@@ -16,5 +16,5 @@ export * from './models-document.js';
 export * from './processor-factory.js';
 export * from './registry/extension-package.js';
 export * from './registry/extension-registry.js';
-export * from './utils/metadata-utils.js';
+export * from './utils/materialize-metadata.js';
 export * from './utils/profile-utils.js';

package/index.js

@@ -16,5 +16,5 @@ export * from './models-document.js';
 export * from './processor-factory.js';
 export * from './registry/extension-package.js';
 export * from './registry/extension-registry.js';
-export * from './utils/metadata-utils.js';
+export * from './utils/materialize-metadata.js';
 export * from './utils/profile-utils.js';

package/models/enums/log-level.d.ts

@@ -5,6 +5,7 @@ export declare enum LogLevel {
     error = "error",
     warn = "warn",
     info = "info",
+    verbose = "verbose",
     trace = "trace",
     debug = "debug"
 }

package/models/enums/log-level.js

@@ -7,6 +7,7 @@ export var LogLevel;
     LogLevel["error"] = "error";
     LogLevel["warn"] = "warn";
     LogLevel["info"] = "info";
+    LogLevel["verbose"] = "verbose";
     LogLevel["trace"] = "trace";
     LogLevel["debug"] = "debug";
 })(LogLevel || (LogLevel = {}));

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@syncbridge/common",
-  "version": "0.5.11",
+  "version": "0.6.0",
   "description": "SyncBridge Common utilities",
   "author": "Panates Inc",
   "license": "MIT",
   "dependencies": {
     "@jsopen/objects": "^2.1.1",
+    "fast-deep-equal": "^3.1.3",
     "node-events-async": "^1.5.0",
     "reflect-metadata": "^0.2.2",
     "semver": "^7.7.4",
     "ts-gems": "^3.11.3",
-    "valgen": "^5.19.4"
+    "valgen": "^5.19.5"
   },
   "peerDependencies": {
     "@opra/common": ">=1.17.1 <2"

package/processor-factory.d.ts

@@ -6,12 +6,14 @@ export declare namespace ProcessorFactory {
     const METADATA_KEY: unique symbol;
     const PROFILE_KEY: unique symbol;
     interface ProcessorOptions {
-        logger: ILogger;
+        logger?: ILogger;
         dataDirectory?: string;
     }
     function createProcessor<T extends ProcessorBase>(profile: Profile, options?: ProcessorOptions): Promise<{
         processor: T;
         issues: StackExecutor.Issue[];
     }>;
-    function updateProcessor(processor: ProcessorBase, profile: Profile, options?: ProcessorOptions): Promise<StackExecutor.Issue[]>;
+    function updateProcessor(processor: ProcessorBase, profile: Profile, options?: ProcessorOptions): Promise<{
+        issues: StackExecutor.Issue[];
+    }>;
 }

package/processor-factory.js

@@ -1,7 +1,8 @@
+import equal from 'fast-deep-equal';
 import { StackExecutor } from './classes/stack-executor.js';
 import { initializeModelsDocument } from './models-document.js';
 import { ExtensionRegistry } from './registry/extension-registry.js';
-import { materializeMetadata } from './utils/metadata-utils.js';
+import { materializeMetadata } from './utils/materialize-metadata.js';
 export var ProcessorFactory;
 (function (ProcessorFactory) {
     ProcessorFactory.METADATA_KEY = Symbol('METADATA');
@@ -16,10 +17,17 @@ export var ProcessorFactory;
             values: profile.values || {},
             dataDirectory: options?.dataDirectory,
         });
-        const issues = await _configureProcessor(processor, profile);
+        const ctx = {
+            stackExecutor: new StackExecutor(),
+            processor,
+            profile,
+            options,
+            valueUpdates: new Map(),
+        };
+        await _configureProcessor(ctx);
         return {
             processor: processor,
-            issues,
+            issues: ctx.stackExecutor.issues,
         };
     }
     ProcessorFactory.createProcessor = createProcessor;
@@ -28,69 +36,164 @@ export var ProcessorFactory;
             processor.logger = options.logger;
         if (options?.dataDirectory)
             processor.dataDirectory = options.dataDirectory;
-        return _configureProcessor(processor, profile);
+        const ctx = {
+            stackExecutor: new StackExecutor(),
+            processor,
+            profile,
+            options,
+            valueUpdates: new Map(),
+        };
+        await _configureProcessor(ctx);
+        const signalUpdates = async (obj) => {
+            if (obj.components) {
+                for (const component of Object.values(obj.components)) {
+                    await signalUpdates(component);
+                }
+            }
+            const properties = ctx.valueUpdates.get(obj);
+            if (properties?.length) {
+                await obj.emitAsyncSafe('values-updated', properties);
+            }
+        };
+        await signalUpdates(processor);
+        return {
+            issues: ctx.stackExecutor.issues,
+        };
     }
     ProcessorFactory.updateProcessor = updateProcessor;
-    async function _configureProcessor(processor, profile) {
-        const processorMetadata = materializeMetadata(profile);
-        const stackExecutor = new StackExecutor();
-        async function configureComponents(owner, curPath, newMetadata, newProfile, oldMetadata, oldProfile) {
-            if (!newMetadata.components)
-                return;
-            // Stack: components
-            await stackExecutor.executeAsync('components', async () => {
-                for (const [key, childMetadata] of Object.entries(newMetadata.components)) {
-                    // Stack: components/componentName
-                    await stackExecutor.executeAsync(key, async () => {
-                        const oldChildMetadata = oldMetadata?.components?.[key];
-                        const oldChildProfile = oldProfile?.components?.[key];
-                        const childProfile = newProfile.components[key];
-                        const componentPath = curPath ? curPath + '/' + key : key;
-                        let componentInstance = owner.components?.[key];
-                        /** Create component only if processor is stopped */
-                        if (processor.stopped) {
-                            const compReg = ExtensionRegistry.getComponent(childMetadata.className);
-                            /** Create the component instance */
-                            const compClass = await compReg.getClass();
-                            componentInstance = new compClass({
-                                processor: processor,
-                                parent: owner,
-                                name: key,
-                                path: componentPath,
-                                values: childProfile.values || {},
-                            });
-                            owner.components = owner.components || {};
-                            owner.components[key] = componentInstance;
-                            if (childMetadata.propertyKey)
-                                owner[childMetadata.propertyKey] = componentInstance;
-                        }
-                        else if (oldMetadata?.className &&
-                            oldMetadata?.className !== newMetadata.className) {
-                            throw new Error('Can not change component class while processor running. You should stop it first.');
-                        }
-                        else {
-                            // todo update only hot-plug values
-                            componentInstance.values = childProfile.values || {};
-                        }
-                        /** Create the child logger */
-                        componentInstance.logger = owner.logger?.child({
-                            component: componentPath,
+    async function _configureProcessor(ctx) {
+        const { processor, profile } = ctx;
+        const cmpCtx = {
+            ...ctx,
+            owner: processor,
+            curPath: '',
+            newMetadata: materializeMetadata(profile),
+            newProfile: profile,
+            oldMetadata: processor[ProcessorFactory.METADATA_KEY],
+            oldProfile: processor[ProcessorFactory.PROFILE_KEY],
+        };
+        _validateComponents(cmpCtx);
+        await _configureComponents(cmpCtx);
+        processor[ProcessorFactory.METADATA_KEY] = cmpCtx.newMetadata;
+        processor[ProcessorFactory.PROFILE_KEY] = profile;
+    }
+    function _validateComponents(ctx) {
+        const { newMetadata, newProfile, oldMetadata, oldProfile, curPath, owner, stackExecutor, processor, } = ctx;
+        if (!newMetadata.components)
+            return;
+        // Stack: components
+        stackExecutor.execute('components', () => {
+            for (const [key, childMetadata] of Object.entries(newMetadata.components)) {
+                // Stack: components/componentName
+                stackExecutor.execute(key, () => {
+                    const oldChildMetadata = oldMetadata?.components?.[key];
+                    const oldChildProfile = oldProfile?.components?.[key];
+                    const childProfile = newProfile.components[key];
+                    const componentPath = curPath ? curPath + '/' + key : key;
+                    const componentInstance = owner.components?.[key];
+                    if (processor.stopped &&
+                        oldMetadata?.className &&
+                        oldMetadata?.className !== newMetadata.className)
+                        throw new Error('Can not change component class while processor running. You should stop it first.');
+                    /** Validate sub components */
+                    if (childMetadata.components) {
+                        _validateComponents({
+                            ...ctx,
+                            owner: componentInstance,
+                            curPath: componentPath,
+                            newMetadata: childMetadata,
+                            newProfile: childProfile,
+                            oldMetadata: oldChildMetadata,
+                            oldProfile: oldChildProfile,
                         });
-                        if (childProfile.settings?.logs?.level) {
-                            componentInstance.logger.level =
-                                childProfile.settings?.logs?.level;
+                    }
+                });
+            }
+        });
+    }
+    async function _configureComponents(ctx) {
+        const { newMetadata, stackExecutor } = ctx;
+        if (!newMetadata.components)
+            return;
+        // Stack: components
+        await stackExecutor.executeAsync('components', async () => {
+            for (const [key, childMetadata] of Object.entries(newMetadata.components)) {
+                // Stack: components/componentName
+                await stackExecutor.executeAsync(key, async () => {
+                    await _configureComponent(ctx, key, childMetadata);
+                });
+            }
+        });
+    }
+    async function _configureComponent(ctx, key, childMetadata) {
+        const { newProfile, oldMetadata, oldProfile, curPath, owner, processor } = ctx;
+        const oldChildMetadata = oldMetadata?.components?.[key];
+        const oldChildProfile = oldProfile?.components?.[key];
+        const childProfile = newProfile.components[key];
+        const componentPath = curPath ? curPath + '/' + key : key;
+        let componentInstance = owner.components?.[key];
+        /** Create the component only if the owner stopped */ // todo implement hotplug components
+        if (owner.stopped) {
+            const compReg = ExtensionRegistry.getComponent(childMetadata.className);
+            /** Create the component instance */
+            const compClass = await compReg.getClass();
+            componentInstance = new compClass({
+                processor: processor,
+                parent: owner,
+                name: key,
+                path: componentPath,
+                values: childProfile.values || {},
+            });
+            owner.components = owner.components || {};
+            owner.components[key] = componentInstance;
+            if (childMetadata.propertyKey)
+                owner[childMetadata.propertyKey] = componentInstance;
+        }
+        else {
+            componentInstance.values = {};
+            const patchValues = (target, valPath, newValues, newVariables, oldValues, oldVariables) => {
+                if (oldValues)
+                    Object.assign(target, oldValues);
+                const updatedValues = ctx.valueUpdates.get(componentInstance) || [];
+                ctx.valueUpdates.set(componentInstance, updatedValues);
+                if (newVariables) {
+                    for (const [varKey, varMeta] of Object.entries(newVariables)) {
+                        const keyPath = valPath ? valPath + '.' + varKey : varKey;
+                        /** Update only hotplug variables */
+                        if (varMeta?.hotPlug !== true)
+                            continue;
+                        if (varMeta.type === 'nested') {
+                            target[varKey] = {};
+                            patchValues(target[varKey], keyPath, newValues[varKey], newVariables[varKey]?.variables || {}, oldValues?.[varKey], oldVariables?.[varKey]?.variables);
+                            continue;
                         }
-                        /** Initialize sub components */
-                        if (childMetadata.components) {
-                            configureComponents(componentInstance, componentPath, childMetadata, childProfile, oldChildMetadata, oldChildProfile);
+                        if (!equal(target[varKey], newValues[varKey])) {
+                            updatedValues.push(keyPath);
+                            target[varKey] = newValues[varKey];
                         }
-                    });
+                    }
                 }
+            };
+            patchValues(componentInstance.values, '', childProfile.values || {}, childMetadata.variables || {}, oldChildProfile?.values, oldChildMetadata?.variables);
+        }
+        /** Create the child logger */
+        componentInstance.logger = owner.logger?.child({
+            component: componentPath,
+        });
+        if (childProfile.settings?.logs?.level) {
+            componentInstance.logger.level = childProfile.settings?.logs?.level;
+        }
+        /** Initialize sub components */
+        if (childMetadata.components) {
+            await _configureComponents({
+                ...ctx,
+                owner: componentInstance,
+                curPath: componentPath,
+                newMetadata: childMetadata,
+                newProfile: childProfile,
+                oldMetadata: oldChildMetadata,
+                oldProfile: oldChildProfile,
             });
         }
-        await configureComponents(processor, '', processorMetadata, profile, processor[ProcessorFactory.METADATA_KEY], processor[ProcessorFactory.PROFILE_KEY]);
-        processor[ProcessorFactory.METADATA_KEY] = processorMetadata;
-        processor[ProcessorFactory.PROFILE_KEY] = profile;
-        return stackExecutor.issues;
     }
 })(ProcessorFactory || (ProcessorFactory = {}));