refactor(wizards/reportcontrol): use report update action

Author: JakobVogelsang

src/translations/de.ts

@@ -486,6 +486,13 @@ export const de: Translations = {
   report: {
     wizard: { location: 'Ablageort der Reports wählen' },
   },
+  controlblock: {
+    action: {
+      edit: '{{type}} "{{name}}" in IED {{iedName}} bearbeitet',
+      remove:
+        '{{type}} "{{name}}" and referenzierte Element von IED {{iedName}} entfernt',
+    },
+  },
   add: 'Hinzufügen',
   new: 'Neu',
   remove: 'Entfernen',

src/translations/en.ts

@@ -482,6 +482,13 @@ export const en = {
   report: {
     wizard: { location: 'Select Report Control Location' },
   },
+  controlblock: {
+    action: {
+      edit: 'Edited {{type}} "{{name}}" in IED {{iedName}}',
+      remove:
+        'Removed {{type}} "{{name}}" and its referenced elements from IED {{iedName}}',
+    },
+  },
   add: 'Add',
   new: 'New',
   remove: 'Remove',

src/wizards/gsecontrol.ts

@@ -13,6 +13,7 @@ import '../wizard-select.js';
 import '../wizard-textfield.js';
 import {
   cloneElement,
+  ComplexAction,
   Delete,
   EditorAction,
   getValue,
@@ -106,8 +107,10 @@ export function renderGseAttributes(
   ];
 }
 
-export function removeGseControl(element: Element): Delete[] {
-  const dataSet = element.parentElement!.querySelector(
+export function removeGseControl(element: Element): ComplexAction | null {
+  if (!element.parentElement) return null;
+
+  const dataSet = element.parentElement.querySelector(
     `DataSet[name="${element.getAttribute('datSet')}"]`
   );
   const gSE = getGSE(element);
@@ -126,7 +129,7 @@ export function removeGseControl(element: Element): Delete[] {
 
   actions.push({
     old: {
-      parent: element.parentElement!,
+      parent: element.parentElement,
       element,
       reference: element.nextSibling,
     },
@@ -135,9 +138,9 @@ export function removeGseControl(element: Element): Delete[] {
   if (dataSet && singleUse)
     actions.push({
       old: {
-        parent: element.parentElement!,
+        parent: element.parentElement,
         element: dataSet,
-        reference: element.nextSibling,
+        reference: dataSet.nextSibling,
       },
     });
 
@@ -150,7 +153,17 @@ export function removeGseControl(element: Element): Delete[] {
       },
     });
 
-  return actions;
+  const name = element.getAttribute('name')!;
+  const iedName = element.closest('IED')?.getAttribute('name') ?? '';
+
+  return {
+    title: get('controlblock.action.remove', {
+      type: element.tagName,
+      name,
+      iedName,
+    }),
+    actions,
+  };
 }
 
 export function updateGseControlAction(element: Element): WizardActor {
@@ -215,10 +228,10 @@ export function editGseControlWizard(element: Element): Wizard {
           label="${translate('remove')}"
           icon="delete"
           @click=${(e: MouseEvent) => {
-            const deleteActions = removeGseControl(element);
-            deleteActions.forEach(deleteAction =>
-              e.target?.dispatchEvent(newActionEvent(deleteAction))
-            );
+            const complexAction = removeGseControl(element);
+            if (complexAction)
+              e.target?.dispatchEvent(newActionEvent(complexAction));
+
             e.target?.dispatchEvent(newWizardEvent());
           }}
         ></mwc-button>`,

src/wizards/reportcontrol.ts

@@ -29,6 +29,7 @@ import {
   WizardInput,
   Delete,
   getUniqueElementName,
+  ComplexAction,
 } from '../foundation.js';
 import { FinderList } from '../finder-list.js';
 import { dataAttributePicker, iEDPicker } from './foundation/finder.js';
@@ -327,8 +328,10 @@ function prepareReportControlCreateWizard(anyParent: Element): WizardActor {
   };
 }
 
-export function removeReportControlAction(element: Element): Delete[] {
-  if (!element.parentElement) return [];
+export function removeReportControlAction(
+  element: Element
+): ComplexAction | null {
+  if (!element.parentElement) return null;
 
   const dataSet = element.parentElement.querySelector(
     `DataSet[name="${element.getAttribute('datSet')}"]`
@@ -358,11 +361,17 @@ export function removeReportControlAction(element: Element): Delete[] {
       old: {
         parent: element.parentElement!,
         element: dataSet,
-        reference: element.nextSibling,
+        reference: dataSet.nextSibling,
       },
     });
 
-  return actions;
+  const name = element.getAttribute('name')!;
+  const iedName = element.closest('IED')?.getAttribute('name') ?? '';
+
+  return {
+    title: get('controlblock.action.remove', { type: 'Report', name, iedName }),
+    actions,
+  };
 }
 
 function getRptEnabledAction(
@@ -420,7 +429,7 @@ function updateReportControlAction(element: Element): WizardActor {
 
     const max = getValue(inputs.find(i => i.label === 'max Clients')!);
 
-    let rptEnabledAction: EditorAction | null = null;
+    let rptEnabledAction: SimpleAction | null = null;
     if (
       max !== (element.querySelector('RptEnabled')?.getAttribute('max') ?? null)
     )
@@ -430,10 +439,22 @@ function updateReportControlAction(element: Element): WizardActor {
         element
       );
 
-    const actions: EditorAction[] = [];
+    const actions: SimpleAction[] = [];
     if (reportControlAction) actions.push(reportControlAction);
     if (rptEnabledAction) actions.push(rptEnabledAction);
-    return actions;
+
+    const name = attributes['name']!;
+    const iedName = element.closest('IED')!.getAttribute('name')!;
+    const complexAction = {
+      title: get('controlblock.action.edit', {
+        type: 'Report',
+        name,
+        iedName,
+      }),
+      actions,
+    };
+
+    return actions.length ? [complexAction] : [];
   };
 }
 
@@ -515,10 +536,10 @@ export function editReportControlWizard(element: Element): Wizard {
           label="${translate('remove')}"
           icon="delete"
           @click=${(e: MouseEvent) => {
-            const deleteActions = removeReportControlAction(element);
-            deleteActions.forEach(deleteAction =>
-              e.target?.dispatchEvent(newActionEvent(deleteAction))
-            );
+            const complexAction = removeReportControlAction(element);
+            if (complexAction)
+              e.target?.dispatchEvent(newActionEvent(complexAction));
+
             e.target?.dispatchEvent(newWizardEvent());
           }}
         ></mwc-button>`,

src/wizards/sampledvaluecontrol.ts

@@ -12,6 +12,7 @@ import '../wizard-select.js';
 import '../wizard-textfield.js';
 import {
   cloneElement,
+  ComplexAction,
   Delete,
   EditorAction,
   getValue,
@@ -47,8 +48,10 @@ function getSMV(element: Element): Element | null {
   );
 }
 
-export function removeSampledValueControlAction(element: Element): Delete[] {
-  if (!element.parentElement) return [];
+export function removeSampledValueControlAction(
+  element: Element
+): ComplexAction | null {
+  if (!element.parentElement) return null;
 
   const dataSet = element.parentElement!.querySelector(
     `DataSet[name="${element.getAttribute('datSet')}"]`
@@ -90,7 +93,17 @@ export function removeSampledValueControlAction(element: Element): Delete[] {
       },
     });
 
-  return actions;
+  const name = element.getAttribute('name')!;
+  const iedName = element.closest('IED')?.getAttribute('name') ?? '';
+
+  return {
+    title: get('controlblock.action.remove', {
+      type: element.tagName,
+      name,
+      iedName,
+    }),
+    actions,
+  };
 }
 
 interface ContentOptions {
@@ -273,10 +286,11 @@ export function editSampledValueControlWizard(element: Element): Wizard {
           label="${translate('remove')}"
           icon="delete"
           @click=${(e: MouseEvent) => {
-            const deleteActions = removeSampledValueControlAction(element);
-            deleteActions.forEach(deleteAction =>
-              e.target?.dispatchEvent(newActionEvent(deleteAction))
-            );
+            const complexAction = removeSampledValueControlAction(element);
+
+            if (complexAction)
+              e.target?.dispatchEvent(newActionEvent(complexAction));
+
             e.target?.dispatchEvent(newWizardEvent());
           }}
         ></mwc-button>`,

test/unit/wizards/gsecontrol.test.ts

@@ -6,6 +6,7 @@ import { MockWizard } from '../../mock-wizard.js';
 
 import { WizardTextField } from '../../../src/wizard-textfield.js';
 import {
+  Delete,
   isDelete,
   isReplace,
   Replace,
@@ -139,39 +140,55 @@ describe('gsecontrol wizards', () => {
       'application/xml'
     ).documentElement;
 
+    const missingparent = <Element>(
+      new DOMParser().parseFromString(
+        `<GSEControl name="myName" datSet="myDataSet"/>`,
+        'application/xml'
+      ).documentElement
+    );
+
     it('removes GSEControl and its refereced DataSet if no other GSEControl are aasinged', () => {
       const gseControl = ln01gse.querySelector('GSEControl')!;
-      const actions = removeGseControl(gseControl);
+      const actions = <Delete[]>removeGseControl(gseControl)!.actions;
       expect(actions.length).to.equal(2);
       expect(actions[0]).to.satisfy(isDelete);
       expect(actions[0].old.element).to.equal(gseControl);
       expect(actions[1]).to.satisfy(isDelete);
       expect(actions[1].old.element).to.equal(ln01gse.querySelector('DataSet'));
     });
+
     it('removes GSEControl only if other GSEControl is assinged to the same DataSet', () => {
       const gseControl = ln02gse.querySelector('GSEControl')!;
-      const actions = removeGseControl(gseControl);
+      const actions = <Delete[]>removeGseControl(gseControl)!.actions;
       expect(actions.length).to.equal(1);
       expect(actions[0]).to.satisfy(isDelete);
       expect(actions[0].old.element).to.equal(gseControl);
     });
+
     it('removes GSEControl only if other ReportControlBlock is assinged to the same DataSet', () => {
       const gseControl = ln02rp.querySelector('GSEControl')!;
-      const actions = removeGseControl(gseControl);
+      const actions = <Delete[]>removeGseControl(gseControl)!.actions;
       expect(actions.length).to.equal(1);
       expect(actions[0]).to.satisfy(isDelete);
       expect(actions[0].old.element).to.equal(gseControl);
     });
+
     it('removes GSEControl only if other SMV is assinged to the same DataSet', () => {
       const gseControl = ln02smv.querySelector('GSEControl')!;
-      const actions = removeGseControl(gseControl);
+      const actions = <Delete[]>removeGseControl(gseControl)!.actions;
       expect(actions.length).to.equal(1);
       expect(actions[0]).to.satisfy(isDelete);
       expect(actions[0].old.element).to.equal(gseControl);
     });
+
+    it('does not remove with missing parent element', () => {
+      const action = removeGseControl(missingparent);
+      expect(action).to.be.null;
+    });
+
     it('removes GSE element if present in the Communication section', () => {
       const gseControl = doc.querySelector('IED[name="IED1"] GSEControl')!;
-      const actions = removeGseControl(gseControl);
+      const actions = <Delete[]>removeGseControl(gseControl)!.actions;
       expect(actions.length).to.equal(3);
       expect(actions[0]).to.satisfy(isDelete);
       expect(actions[0].old.element).to.equal(gseControl);