Merge pull request hashgraph#2184 from hashgraph/feature/block-deprec…

…ation Feature/block deprecation
IntellectEU · May 26, 2023 · 4478e0d · 4478e0d
2 parents 4ce9421 + 6f4c8a6
commit 4478e0d
Show file tree

Hide file tree

Showing 27 changed files with 465 additions and 39 deletions.
diff --git a/frontend/src/app/modules/analytics/compare-policy/compare-policy.component.ts b/frontend/src/app/modules/analytics/compare-policy/compare-policy.component.ts
@@ -48,6 +48,7 @@ export class ComparePolicyComponent implements OnInit {
         "aggregateDocumentBlock": "calendar_month",
         "reassigningBlock": "content_copy",
         "revokeBlock": "restart_alt",
+        "revocationBlock": "restart_alt",
         "setRelationshipsBlock": "settings",
         "splitBlock": "content_cut",
         "filtersAddon": "filter_alt",

diff --git a/...les/policy-engine/policy-configuration/common-properties/common-properties.component.html b/...les/policy-engine/policy-configuration/common-properties/common-properties.component.html
@@ -63,6 +63,13 @@
                             <span class="readonly-prop">{{about.children}}</span>
                         </td>
                     </tr>
+                    <tr class="propRow" [attr.collapse]="propHidden.about">
+                        <td class="propRowCol"></td>
+                        <td class="propRowCell cellName">Deprecated</td>
+                        <td class="propRowCell">
+                            <span class="readonly-prop">{{about.deprecated?'Yes':'No'}}</span>
+                        </td>
+                    </tr>
                 </ng-container>
 
                 <tr class="propHeader">
@@ -169,11 +176,11 @@
                         <td class="propHeaderCell"></td>
                     </tr>
                     <div *ngFor="let property of customProperties" common-property class="custom-properties"
-                        [block]="currentBlock" 
-                        [data]="block.properties" 
-                        [property]="property" 
+                        [block]="currentBlock"
+                        [data]="block.properties"
+                        [property]="property"
                         [readonly]="readonly"
-                        [collapse]="propHidden.customProperties" 
+                        [collapse]="propHidden.customProperties"
                         (update)="onSave()">
                     </div>
                 </ng-container>

diff --git a/...policy-engine/policy-configuration/policy-configuration/policy-configuration.component.ts b/...policy-engine/policy-configuration/policy-configuration/policy-configuration.component.ts
@@ -479,7 +479,10 @@ export class PolicyConfigurationComponent implements OnInit {
         this.componentsList.unGrouped = [];
         const search = this.search ? this.search.toLowerCase() : null;
         for (const block of all) {
-            if (search && block.search.indexOf(search) === -1) {
+            if (
+                (search && block.search.indexOf(search) === -1) ||
+                block?.deprecated
+            ) {
                 continue;
             }
             if (block.header === 'UI Components') {

diff --git a/.../src/app/modules/policy-engine/policy-configuration/policy-tree/policy-tree.component.css b/.../src/app/modules/policy-engine/policy-configuration/policy-tree/policy-tree.component.css
@@ -455,6 +455,23 @@
     grid-template-columns: auto 1px !important;
 }
 
+.block-container[deprecated="true"] .block-item {
+    background-color: lightgray !important;
+    border-color: lightgray !important;
+}
+
+.block-container[deprecated="true"] .block-item::after {
+    content: "";
+    width: 110%;
+    height: 3px;
+    background-color: black;
+    position: absolute;
+    left: -5%;
+}
+
+.block-container[selected="true"][deprecated="true"] .block-item {
+    border-color: #5161e1 !important;
+}
 
 .cdk-drag-animating {
     transition: transform 50ms cubic-bezier(0, 0, 0.2, 1);

diff --git a/...src/app/modules/policy-engine/policy-configuration/policy-tree/policy-tree.component.html b/...src/app/modules/policy-engine/policy-configuration/policy-tree/policy-tree.component.html
@@ -15,7 +15,7 @@
                 [attr.collapsed]="item.collapsed" [attr.selected]="isSelect(item)" [attr.error]="item.error"
                 [attr.root]="item.root" [attr.block-id]="item.id" [attr.block-instance]="item.node.tag"
                 [attr.block-type]="item.type" [style.paddingLeft]="item.offset" cdkDrag [cdkDragData]="item.level"
-                [cdkDragDisabled]="item.root">
+                [cdkDragDisabled]="item.root" [attr.deprecated]="item.deprecated">
                 <div class="block-expand" (click)="onCollapse($event, item)">
                     <mat-icon>arrow_drop_down</mat-icon>
                 </div>

diff --git a/...d/src/app/modules/policy-engine/policy-configuration/policy-tree/policy-tree.component.ts b/...d/src/app/modules/policy-engine/policy-configuration/policy-tree/policy-tree.component.ts
@@ -220,6 +220,7 @@ export class PolicyTreeComponent implements OnInit {
             node.level = level;
             node.root = block === this.root;
             node.expandable = block.expandable && !node.root;
+            node.deprecated = this.registeredService.getDeprecated(block.blockType);
             node.about = this.registeredService.getAbout(block, this.module);
             node.icon = this.registeredService.getIcon(block.blockType);
             node.type = this.registeredService.getHeader(block.blockType);

diff --git a/frontend/src/app/modules/policy-engine/services/blocks-information.ts b/frontend/src/app/modules/policy-engine/services/blocks-information.ts
@@ -82,6 +82,7 @@ const Container: IBlockSetting = {
         { type: BlockType.CustomLogicBlock },
         { type: BlockType.Report },
         { type: BlockType.RevokeBlock },
+        { type: BlockType.RevocationBlock },
         { type: BlockType.SetRelationshipsBlock },
         { type: BlockType.ButtonBlock },
         { type: BlockType.TokenActionBlock },
@@ -124,6 +125,7 @@ const Step: IBlockSetting = {
         { type: BlockType.CustomLogicBlock },
         { type: BlockType.Report },
         { type: BlockType.RevokeBlock },
+        { type: BlockType.RevocationBlock },
         { type: BlockType.SetRelationshipsBlock },
         { type: BlockType.ButtonBlock },
         { type: BlockType.TokenActionBlock },
@@ -378,6 +380,15 @@ const RevokeBlock: IBlockSetting = {
     property: RevokeConfigComponent,
 }
 
+const RevocationBlock: IBlockSetting = {
+    type: BlockType.RevocationBlock,
+    icon: 'restart_alt',
+    group: BlockGroup.Documents,
+    header: BlockHeaders.ServerBlocks,
+    factory: null,
+    property: null,
+}
+
 const SetRelationshipsBlock: IBlockSetting = {
     type: BlockType.SetRelationshipsBlock,
     icon: 'settings',
@@ -625,6 +636,7 @@ export default [
     AggregateDocument,
     ReassigningBlock,
     RevokeBlock,
+    RevocationBlock,
     SetRelationshipsBlock,
     SplitBlock,
     FiltersAddon,

diff --git a/frontend/src/app/modules/policy-engine/services/module-information.ts b/frontend/src/app/modules/policy-engine/services/module-information.ts
@@ -43,6 +43,7 @@ const Module: IBlockSetting = {
         { type: BlockType.CustomLogicBlock },
         { type: BlockType.Report },
         { type: BlockType.RevokeBlock },
+        { type: BlockType.RevocationBlock },
         { type: BlockType.SetRelationshipsBlock },
         { type: BlockType.ButtonBlock },
         { type: BlockType.TokenActionBlock },

diff --git a/frontend/src/app/modules/policy-engine/services/registered.service.ts b/frontend/src/app/modules/policy-engine/services/registered.service.ts
@@ -19,6 +19,7 @@ export class RegisteredService {
 
     private blockName: { [type: string]: string };
     private blockTitle: { [type: string]: string };
+    private blockDeprecation: { [type: string]: boolean };
     private blockAbout: { [type: string]: BlockAbout };
     private blockProperties: { [type: string]: BlockAbout };
 
@@ -38,14 +39,16 @@ export class RegisteredService {
         this.blockTitle = {};
         this.blockAbout = {};
         this.blockProperties = {};
+        this.blockDeprecation = {};
         this.defaultAbout = new BlockAbout({
             post: false,
             get: false,
             input: null,
             output: null,
             children: ChildrenType.None,
             control: ControlType.None,
-            defaultEvent: false
+            defaultEvent: false,
+            deprecated: false,
         })
 
         for (const config of blocks) {
@@ -103,6 +106,7 @@ export class RegisteredService {
             this.blockTitle[type] = setting.title;
             this.blockAbout[type] = new BlockAbout(setting, this.about[type]);
             this.blockProperties[type] = setting.properties;
+            this.blockDeprecation[type] = !!setting.deprecated;
         }
         this.update();
     }
@@ -119,7 +123,8 @@ export class RegisteredService {
                 group: this.group[type],
                 header: this.header[type],
                 title: this.blockTitle[type],
-                data: `new:${type}`
+                data: `new:${type}`,
+                deprecated: this.blockDeprecation[type],
             });
         }
         this.list = this.list.sort((a, b) => a.name > b.name ? 1 : -1);
@@ -181,4 +186,8 @@ export class RegisteredService {
     public getHeader(blockType: string): string {
         return this.header[blockType] || '';
     }
-}
+
+    public getDeprecated(blockType: string): boolean {
+        return this.blockDeprecation[blockType];
+    }
+ }
diff --git a/frontend/src/app/modules/policy-engine/structures/interfaces/block-about-config.interface.ts b/frontend/src/app/modules/policy-engine/structures/interfaces/block-about-config.interface.ts
@@ -9,4 +9,5 @@ export interface IBlockAboutConfig {
     children: ChildrenType;
     control: ControlType;
     defaultEvent: boolean;
+    deprecated?: boolean;
 }
diff --git a/frontend/src/app/modules/policy-engine/structures/interfaces/block-about.interface.ts b/frontend/src/app/modules/policy-engine/structures/interfaces/block-about.interface.ts
@@ -11,4 +11,5 @@ export interface IBlockAbout {
     defaultEvent: boolean;
     prev?: IBlockAbout;
     next?: boolean;
+    deprecated?: boolean;
 }
diff --git a/...c/app/modules/policy-engine/structures/interfaces/block-dynamic-about-config.interface.ts b/...c/app/modules/policy-engine/structures/interfaces/block-dynamic-about-config.interface.ts
@@ -14,4 +14,5 @@ export interface IBlockDynamicAboutConfig {
     children?: ConfigFunction<ChildrenType>;
     control?: ConfigFunction<ControlType>;
     defaultEvent?: ConfigFunction<boolean>;
+    deprecated?: ConfigFunction<boolean>;
 }
diff --git a/frontend/src/app/modules/policy-engine/structures/policy-models/block-about.ts b/frontend/src/app/modules/policy-engine/structures/policy-models/block-about.ts
@@ -34,6 +34,7 @@ export class BlockAbout {
         this._setProp(about, dynamic, 'children');
         this._setProp(about, dynamic, 'control');
         this._setProp(about, dynamic, 'defaultEvent');
+        this._setProp(about, dynamic, 'deprecated');
     }
 
     public getAbout(
@@ -48,6 +49,7 @@ export class BlockAbout {
             children: this._propFunc.children(this._propVal.children, block, module),
             control: this._propFunc.control(this._propVal.control, block, module),
             defaultEvent: this._propFunc.defaultEvent(this._propVal.defaultEvent, block, module),
+            deprecated: this._propFunc.deprecated(this._propVal.deprecated, block, module),
         };
     }
 
@@ -81,6 +83,9 @@ export class BlockAbout {
             get defaultEvent() {
                 return this._func.defaultEvent(this._val.defaultEvent, this._block, this._module);
             },
+            get deprecated() {
+                return this._func.defaultEvent(this._val.deprecated, this._block, this._module);
+            },
             set module(value: PolicyModel | PolicyModuleModel) {
                 this._module = value;
             },

diff --git a/frontend/src/app/modules/policy-engine/structures/tree-model/block-node.ts b/frontend/src/app/modules/policy-engine/structures/tree-model/block-node.ts
@@ -18,6 +18,7 @@ export class FlatBlockNode {
     public parentNode!: FlatBlockNode;
     public data!: any;
     public error!: boolean;
+    public deprecated!: boolean;
 
     constructor(node: PolicyBlockModel) {
         this.node = node;

diff --git a/frontend/src/app/modules/policy-engine/themes/default.ts b/frontend/src/app/modules/policy-engine/themes/default.ts
@@ -48,6 +48,7 @@ export const defaultTheme = {
                 'reassigningBlock',
                 'httpRequestBlock',
                 'revokeBlock',
+                'revocationBlock',
                 'sendToGuardianBlock',
                 'setRelationshipsBlock',
                 'splitBlock',

diff --git a/guardian-service/src/policy-engine/block-about.ts b/guardian-service/src/policy-engine/block-about.ts
@@ -494,6 +494,23 @@ export const BlockAbout = {
     'revokeBlock': {
         'label': 'Revoke Document',
         'title': 'Add \'Revoke\' Block',
+        'post': true,
+        'get': true,
+        'children': 'None',
+        'control': 'Server',
+        'input': [
+            'RunEvent'
+        ],
+        'output': [
+            'RunEvent',
+            'ErrorEvent'
+        ],
+        'defaultEvent': true,
+        'deprecated': true,
+    },
+    'revocationBlock': {
+        'label': 'Revocation',
+        'title': 'Add \'Revocation\' Block',
         'post': false,
         'get': false,
         'children': 'None',
@@ -505,7 +522,23 @@ export const BlockAbout = {
             'RunEvent',
             'ErrorEvent'
         ],
-        'defaultEvent': true
+        'defaultEvent': true,
+        'properties': [
+            {
+                'name': 'updatePrevDoc',
+                'label': 'Update previous document status',
+                'title': 'Update previous document status',
+                'type': 'Checkbox',
+                'default': false
+            },
+            {
+                'name': 'prevDocStatus',
+                'label': 'Status value',
+                'title': 'Status value',
+                'type': 'Input',
+                'default': ''
+            },
+        ],
     },
     'setRelationshipsBlock': {
         'label': 'Set Relationships',

diff --git a/guardian-service/src/policy-engine/block-validators/block-validator.ts b/guardian-service/src/policy-engine/block-validators/block-validator.ts
@@ -31,6 +31,7 @@ import { ReportItemBlock } from './blocks/report-item-block';
 import { RequestVcDocumentBlock } from './blocks/request-vc-document-block';
 import { RetirementBlock } from './blocks/retirement-block';
 import { RevokeBlock } from './blocks/revoke-block';
+import { RevocationBlock } from './blocks/revocation-block';
 import { SelectiveAttributes } from './blocks/selective-attributes-addon';
 import { SendToGuardianBlock } from './blocks/send-to-guardian-block';
 import { SetRelationshipsBlock } from './blocks/set-relationships-block';
@@ -75,6 +76,7 @@ export const validators = [
     RequestVcDocumentBlock,
     RetirementBlock,
     RevokeBlock,
+    RevocationBlock,
     SelectiveAttributes,
     SendToGuardianBlock,
     SetRelationshipsBlock,

diff --git a/guardian-service/src/policy-engine/block-validators/blocks/revocation-block.ts b/guardian-service/src/policy-engine/block-validators/blocks/revocation-block.ts
@@ -0,0 +1,31 @@
+import { BlockValidator, IBlockProp } from '@policy-engine/block-validators';
+
+/**
+ * Revoke document action with UI
+ */
+export class RevocationBlock {
+    /**
+     * Block type
+     */
+    public static readonly blockType: string = 'revocationBlock';
+
+    /**
+     * Validate block options
+     * @param validator
+     * @param config
+     */
+    public static async validate(
+        validator: BlockValidator,
+        ref: IBlockProp
+    ): Promise<void> {
+        try {
+            if (ref.options.updatePrevDoc && !ref.options.prevDocStatus) {
+                validator.addError('Option "Status Value" is not set');
+            }
+        } catch (error) {
+            validator.addError(
+                `Unhandled exception ${validator.getErrorMessage(error)}`
+            );
+        }
+    }
+}
diff --git a/guardian-service/src/policy-engine/policy-converter-utils.ts b/guardian-service/src/policy-engine/policy-converter-utils.ts
@@ -1,6 +1,6 @@
 import { Policy } from '@guardian/common';
-import { GenerateUUIDv4, UserType } from '@guardian/interfaces';
-import { EventActor, EventConfig, PolicyInputEventType, PolicyOutputEventType } from './interfaces';
+import { BlockType, GenerateUUIDv4, UserType } from '@guardian/interfaces';
+import { EventConfig, PolicyInputEventType, PolicyOutputEventType, EventActor } from './interfaces';
 
 /**
  * Policy converter utils
@@ -390,7 +390,7 @@ export class PolicyConverterUtils {
                 const currentBlock = stack.pop();
                 if (
                     currentBlock?.blockType ===
-                        'interfaceDocumentsSourceBlock' &&
+                        BlockType.DocumentsViewer &&
                     Array.isArray(currentBlock.uiMetaData?.fields)
                 ) {
                     currentBlock.uiMetaData.fields =
@@ -404,6 +404,10 @@ export class PolicyConverterUtils {
             }
         };
         clearOldRevokeColumns(root, block.tag);
+        block.blockType = BlockType.RevocationBlock;
+        block.updatePrevDoc = block.uiMetaData.updatePrevDoc;
+        block.prevDocStatus = block.uiMetaData.prevDocStatus;
+        delete block.uiMetaData;
         return block;
     }
 }
diff --git a/interfaces/src/type/block.type.ts b/interfaces/src/type/block.type.ts
@@ -27,6 +27,7 @@ export enum BlockType {
     CustomLogicBlock = 'customLogicBlock',
     Switch = 'switchBlock',
     RevokeBlock = 'revokeBlock',
+    RevocationBlock = 'revocationBlock',
     SetRelationshipsBlock = 'setRelationshipsBlock',
     ButtonBlock = 'buttonBlock',
     TokenActionBlock = 'tokenActionBlock',