feat: 4535 Extend Policy definition language to include a Formula calculations block

common/src/entity/formula.ts

@@ -1,8 +1,8 @@
-import {AfterDelete, BeforeCreate, Entity, Property} from '@mikro-orm/core';
+import { AfterDelete, BeforeCreate, Entity, Property } from '@mikro-orm/core';
 import { BaseEntity } from '../models/index.js';
 import { EntityStatus, GenerateUUIDv4, IFormula, IFormulaConfig } from '@guardian/interfaces';
-import {ObjectId} from '@mikro-orm/mongodb';
-import {DataBaseHelper} from '../helpers/index.js';
+import { ObjectId } from '@mikro-orm/mongodb';
+import { DataBaseHelper } from '../helpers/index.js';
 
 /**
  * Formula collection
@@ -93,6 +93,12 @@ export class Formula extends BaseEntity implements IFormula {
     @Property({ nullable: true })
     contentFileId?: ObjectId;
 
+    /**
+     * Auto Generated
+     */
+    @Property({ nullable: true })
+    autoGenerated?: boolean;
+
     /**
      * Set defaults
      */

common/src/hedera-modules/message/formula-message.ts

@@ -34,6 +34,10 @@ export class FormulaMessage extends Message {
      * Policy Instance topic id
      */
     public policyInstanceTopicId: string;
+    /**
+     * Auto Generated
+     */
+    public autoGenerated: boolean;
 
     /**
      * Document
@@ -55,6 +59,7 @@ export class FormulaMessage extends Message {
         this.uuid = item.uuid;
         this.policyTopicId = item.policyTopicId;
         this.policyInstanceTopicId = item.policyInstanceTopicId;
+        this.autoGenerated = !!item.autoGenerated;
         this.config = toBuffer(zip);
     }
 
@@ -82,6 +87,7 @@ export class FormulaMessage extends Message {
             uuid: this.uuid,
             policyTopicId: this.policyTopicId,
             policyInstanceTopicId: this.policyInstanceTopicId,
+            autoGenerated: this.autoGenerated,
             cid: this.getDocumentUrl(UrlType.cid),
             uri: this.getDocumentUrl(UrlType.url),
         };
@@ -140,6 +146,7 @@ export class FormulaMessage extends Message {
         message.uuid = json.uuid;
         message.policyTopicId = json.policyTopicId;
         message.policyInstanceTopicId = json.policyInstanceTopicId;
+        message.autoGenerated = json.autoGenerated;
         const urls = [
             {
                 cid: json.cid,
@@ -191,6 +198,7 @@ export class FormulaMessage extends Message {
         result.uuid = this.uuid;
         result.policyTopicId = this.policyTopicId;
         result.policyInstanceTopicId = this.policyInstanceTopicId;
+        result.autoGenerated = this.autoGenerated;
         result.config = this.config;
     }
 
@@ -206,6 +214,7 @@ export class FormulaMessage extends Message {
         result.uuid = json.uuid;
         result.policyTopicId = json.policyTopicId;
         result.policyInstanceTopicId = json.policyInstanceTopicId;
+        result.autoGenerated = json.autoGenerated;
         result.config = json.config;
         return result;
     }

common/src/hedera-modules/message/message-body.interface.ts

@@ -35,6 +35,10 @@ export interface MessageBody {
      * Revoke message
      */
     revokeMessage?: string;
+    /**
+     * Revoke owner
+     */
+    revokeOwner?: string;
     /**
      * Message reason
      */
@@ -762,6 +766,10 @@ export interface FormulaMessageBody extends MessageBody {
      * Policy instance topic ID
      */
     policyInstanceTopicId: string;
+    /**
+     * Auto Generated
+     */
+    autoGenerated: boolean;
     /**
      * CID
      */

common/src/hedera-modules/message/message.ts

@@ -96,6 +96,11 @@ export abstract class Message {
      * @protected
      */
     protected _statusReason: string;
+    /**
+     * Revoke owner
+     * @protected
+     */
+    protected _statusOwner: string;
     /**
      * Message action
      */
@@ -257,12 +262,17 @@ export abstract class Message {
      * @param message
      * @param parentIds
      */
-    public revoke(message: string, parentIds?: string[]): void {
+    public revoke(
+        message: string,
+        owner: string,
+        parentIds?: string[]
+    ): void {
         this._status = MessageStatus.REVOKE;
         this._statusMessage = message;
         this._statusReason = parentIds
             ? RevokeReason.ParentRevoked
             : RevokeReason.DocumentRevoked;
+        this._statusOwner = owner
         this._parentIds = parentIds;
         this._action = MessageAction.RevokeDocument;
     }
@@ -312,6 +322,7 @@ export abstract class Message {
                 lang: this.lang,
                 account: this.account,
                 revokeMessage: this._statusMessage,
+                revokeOwner: this._statusOwner,
                 reason: this._statusReason,
                 parentIds: this._parentIds
             }

common/src/hedera-modules/topic-helper.ts

@@ -204,6 +204,9 @@ export class TopicHelper {
         rationale: string,
         userId?: string
     ) {
+        if (!topic) {
+            throw new Error('Invalid topic');
+        }
         const messageServer = new MessageServer({
             operatorId: this.hederaAccountId,
             operatorKey: this.hederaAccountKey,

common/src/hedera-modules/vcjs/context-helper.ts

@@ -32,6 +32,9 @@ export class ContextHelper {
     }
 
     private static _clearContext(item: any, contexts: Set<string>) {
+        if (item === undefined || item === null) {
+            return;
+        }
         if (typeof item === 'object') {
             if (Array.isArray(item)) {
                 for (const i of item) {
@@ -105,6 +108,9 @@ export class ContextHelper {
     }
 
     private static _getItems(root: any, key: string, items: any[]) {
+        if (root === null || root === undefined) {
+            return items;
+        }
         if (Array.isArray(root)) {
             for (const item of root) {
                 ContextHelper._getItems(item, key, items);
@@ -121,4 +127,26 @@ export class ContextHelper {
             return items;
         }
     }
+
+    public static clearEmptyProperties(vc: any): any {
+        if (vc === null || vc === undefined) {
+            return vc;
+        }
+        if (Array.isArray(vc)) {
+            for (const prop of vc) {
+                ContextHelper.clearEmptyProperties(prop);
+            }
+        } else if (typeof vc === 'object') {
+            for (const key of Object.keys(vc)) {
+                if (vc[key] === null || vc[key] === undefined) {
+                    delete vc[key];
+                } else {
+                    ContextHelper.clearEmptyProperties(vc[key]);
+                }
+            }
+            return vc;
+        } else {
+            return vc;
+        }
+    }
 }

common/src/helpers/utils.ts

@@ -393,3 +393,22 @@ export function stripPrefix(text: string, prefixes: string | string[]): string {
     }
     return text
 }
+
+export function findBlocks(tree: any, filter: (block: any) => boolean): any[] {
+    const result: any[] = [];
+    _findBlocks(tree, filter, result);
+    return result;
+}
+
+function _findBlocks(node: any, filter: (block: any) => boolean, result: any[]): void {
+    if (node) {
+        if (filter(node)) {
+            result.push(node);
+        }
+        if (Array.isArray(node.children)) {
+            for (const child of node.children) {
+                _findBlocks(child, filter, result);
+            }
+        }
+    }
+}

common/src/import-export/formula.ts

@@ -1,8 +1,9 @@
 import JSZip from 'jszip';
 import { Formula, Policy } from '../entity/index.js';
-import { IFormulaConfig } from '@guardian/interfaces';
+import { EntityStatus, GenerateUUIDv4, IFormulaConfig } from '@guardian/interfaces';
 import { DatabaseServer } from '../database-modules/index.js';
 import { ImportExportUtils } from './utils.js';
+import { findBlocks } from '../helpers/utils.js';
 
 interface ISchemaComponents {
     iri: string;
@@ -199,4 +200,113 @@ export class FormulaImportExport {
         }
         return components;
     }
+
+    public static generateByPolicy(policy: Policy): Formula | null {
+        const blocks = findBlocks(policy.config, (b) => b.blockType === 'mathBlock');
+        const formulas: any[] = [];
+        for (const block of blocks) {
+            FormulaImportExport.generateFormulaByBlock(block, formulas);
+        }
+        if (formulas.length) {
+            return {
+                uuid: GenerateUUIDv4(),
+                name: policy.name,
+                description: policy.description,
+                owner: policy.owner,
+                policyId: policy.id,
+                policyInstanceTopicId: policy.instanceTopicId,
+                policyTopicId: policy.topicId,
+                status: EntityStatus.DRAFT,
+                autoGenerated: true,
+                config: {
+                    files: [],
+                    formulas
+                }
+            } as any
+        } else {
+            return null;
+        }
+    }
+
+    private static generateFormulaByBlock(block: any, result: any[]) {
+        try {
+            const inputSchema = block.inputSchema;
+            const outputSchema = block.outputSchema || inputSchema;
+            const expression = block.expression;
+            const items: any[] = [];
+            // Variables
+            if (Array.isArray(expression?.variables)) {
+                for (const item of expression.variables) {
+                    items.push({
+                        uuid: GenerateUUIDv4(),
+                        name: item.name,
+                        description: item.description,
+                        type: 'variable',
+                        value: '',
+                        link: {
+                            entityId: inputSchema,
+                            item: item.field,
+                            type: 'schema'
+                        }
+                    })
+                }
+            }
+            // Formulas
+            if (Array.isArray(expression?.formulas)) {
+                for (const item of expression.formulas) {
+                    items.push({
+                        uuid: GenerateUUIDv4(),
+                        name: item.name,
+                        description: item.description,
+                        type: 'formula',
+                        value: item.body,
+                        relationships: item.relationships
+                    })
+                }
+            }
+            // Relationships
+            for (const item of items) {
+                const relationships: string[] = [];
+                if (Array.isArray(item.relationships)) {
+                    for (const name of item.relationships) {
+                        const link = items.find((e) => e.name === name);
+                        if (link) {
+                            relationships.push(link.uuid);
+                        }
+                    }
+                }
+                item.relationships = relationships;
+            }
+            // Outputs
+            if (Array.isArray(expression?.outputs)) {
+                for (const item of expression.outputs) {
+                    let link = items.find((e) => e.name === item.name);
+                    if (link.type === 'variable') {
+                        const newTarget = {
+                            uuid: GenerateUUIDv4(),
+                            name: item.name,
+                            description: block.tag,
+                            type: 'formula',
+                            value: item.name,
+                            relationships: [link.uuid]
+                        }
+                        items.push(newTarget);
+                        link = newTarget;
+                    }
+                    link.link = {
+                        entityId: outputSchema,
+                        item: item.field,
+                        type: 'schema'
+                    }
+                }
+            }
+
+            for (const item of items) {
+                result.push(item);
+            }
+            return result;
+        } catch (error) {
+            return;
+        }
+    }
 }

common/src/import-export/policy.ts

@@ -144,7 +144,7 @@ export class PolicyImportExport {
         const allCategories = await DatabaseServer.getPolicyCategories();
         policy.categoriesExport = policy.categories?.length ? PolicyImportExport.getPolicyCategoriesExport(policy, allCategories) : [];
 
-        const formulas = await dataBaseServer.find(Formula, { policyId: policy.id });
+        const formulas = await dataBaseServer.find(Formula, { policyId: policy.id, autoGenerated: { $ne: true }  });
 
         return {
             policy,
@@ -672,6 +672,8 @@ export class PolicyImportExport {
             item.id = (item.id || item._id)?.toString();
             delete item._id;
             delete item.status;
+            delete item.policyTopicId;
+            delete item.policyInstanceTopicId;
             return item;
         });