fix: address review comments

mmilko01 · mmilko01 · commit 2ef86d905cf0 · 2025-04-23T15:08:35.000+03:00
diff --git a/packages/preview-middleware-client/src/adp/controllers/AddFragment.controller.ts b/packages/preview-middleware-client/src/adp/controllers/AddFragment.controller.ts
@@ -29,7 +29,10 @@ import { getFragments } from '../api-handler';
 import BaseDialog from './BaseDialog.controller';
 import { notifyUser } from '../utils';
 import { QuickActionTelemetryData } from '../../cpe/quick-actions/quick-action-definition';
+import { getFragmentTemplateName } from '../../cpe/additional-change-info/add-xml-additional-info';
 import type { AddFragmentData, DeferredXmlFragmentData } from '../add-fragment';
+import { setApplicationRequiresReload } from '@sap-ux-private/control-property-editor-common';
+import { CommunicationService } from '../../cpe/communication-service';
 
 const radix = 10;
 
@@ -148,12 +151,17 @@ export default class AddFragment extends BaseDialog<AddFragmentModel> {
             targetAggregation: targetAggregation ?? 'content'
         };
 
-        if(this.data){
+        if (this.data) {
             this.data.deferred.resolve(modifiedValue);
         } else {
             await this.createFragmentChange(modifiedValue);
         }
 
+        const templateName = getFragmentTemplateName(this.runtimeControl.getId(), targetAggregation);
+        if (templateName) {
+            CommunicationService.sendAction(setApplicationRequiresReload(true));
+        }
+
         const bundle = await getTextBundle();
         notifyUser(bundle.getText('ADP_ADD_FRAGMENT_NOTIFICATION', [fragmentName]), 8000);
 
diff --git a/packages/preview-middleware-client/src/cpe/additional-change-info/add-xml-additional-info.ts b/packages/preview-middleware-client/src/cpe/additional-change-info/add-xml-additional-info.ts
@@ -26,7 +26,7 @@ export function getAddXMLAdditionalInfo(change: FlexChange<AddXMLChangeContent>)
     return undefined;
 }
 
-function getFragmentTemplateName(selectorId: string, targetAggregation: string): string {
+export function getFragmentTemplateName(selectorId: string, targetAggregation: string): string {
     const control = getControlById(selectorId);
 
     if (!control) {
diff --git a/packages/preview-middleware-client/src/flp/enableFakeConnector.ts b/packages/preview-middleware-client/src/flp/enableFakeConnector.ts
@@ -1,5 +1,6 @@
 import LrepConnector from 'sap/ui/fl/LrepConnector';
 import FakeLrepConnector from 'sap/ui/fl/FakeLrepConnector';
+import { getAdditionalChangeInfo } from '../utils/additional-change-info';
 
 import { CHANGES_API_PATH, FlexChange, getFlexSettings } from './common';
 
@@ -37,6 +38,8 @@ export async function create(changes: FlexChange | FlexChange[]): Promise<void>
                 change.support.generator = settings.generator;
             }
 
+            const additionalChangeInfo = getAdditionalChangeInfo(change);
+
             if (typeof FakeLrepConnector.fileChangeRequestNotifier === 'function' && change.fileName) {
                 try {
                     FakeLrepConnector.fileChangeRequestNotifier(change.fileName, 'create', change);
@@ -45,9 +48,15 @@ export async function create(changes: FlexChange | FlexChange[]): Promise<void>
                 }
             }
 
+            const body = {
+                change,
+                additionalChangeInfo
+            };
+
+
             return fetch(CHANGES_API_PATH, {
                 method: 'POST',
-                body: JSON.stringify(change, null, 2),
+                body: JSON.stringify(body, null, 2),
                 headers: {
                     'content-type': 'application/json'
                 }
diff --git a/packages/preview-middleware-client/test/__mock__/sap/ui/rta/plugin/AddXMLPlugin.ts b/packages/preview-middleware-client/test/__mock__/sap/ui/rta/plugin/AddXMLPlugin.ts
@@ -1,5 +1,8 @@
-export default class AddXMLPlugin {
-    constructor() {}
-    public execute = jest.fn();
-    public add = jest.fn();
-}
+const AddXMLPlugin = jest.fn().mockImplementation(() => {
+    return {
+        execute: jest.fn(),
+        add: jest.fn()
+    };
+});
+
+export default AddXMLPlugin;
diff --git a/packages/preview-middleware-client/test/unit/adp/add-fragment.test.ts b/packages/preview-middleware-client/test/unit/adp/add-fragment.test.ts
@@ -1,13 +1,11 @@
 import { initAddXMLPlugin } from '../../../src/adp/add-fragment';
 import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
 import type UI5Element from 'sap/ui/core/Element';
-import CommandFactory from 'sap/ui/rta/command/CommandFactory';
-import AddXMLPlugin from 'sap/ui/rta/plugin/AddXMLPlugin';
+import CommandFactory from 'mock/sap/ui/rta/command/CommandFactory';
+import AddXMLPlugin from 'mock/sap/ui/rta/plugin/AddXMLPlugin';
 import { DialogFactory, DialogNames } from '../../../src/adp/dialog-factory';
 import { createDeferred } from '../../../src/adp/utils';
 
-jest.mock('sap/ui/rta/command/CommandFactory');
-jest.mock('sap/ui/rta/plugin/AddXMLPlugin');
 jest.mock('../../../src/adp/dialog-factory');
 jest.mock('../../../src/adp/utils', () => ({
     createDeferred: jest.fn()
@@ -31,13 +29,10 @@ describe('AddFragmentService', () => {
 
     describe('init', () => {
         it('should initialize the AddXMLPlugin and set it in RTA plugins', async () => {
-            const mockCommandFactory = jest.fn();
-            (CommandFactory as unknown as jest.Mock).mockImplementation(() => mockCommandFactory);
-
             initAddXMLPlugin(mockRta);
 
             expect(AddXMLPlugin).toHaveBeenCalledWith({
-                commandFactory: mockCommandFactory,
+                commandFactory: expect.any(CommandFactory),
                 fragmentHandler: expect.any(Function)
             });
 
diff --git a/packages/preview-middleware-client/test/unit/adp/controllers/AddFragment.controller.test.ts b/packages/preview-middleware-client/test/unit/adp/controllers/AddFragment.controller.test.ts
@@ -17,6 +17,15 @@ import type ManagedObject from 'sap/ui/base/ManagedObject';
 import Core from 'sap/ui/core/Core';
 import { type AddFragmentChangeContentType } from 'sap/ui/fl/Change';
 import { AddFragmentData } from '../../../../src/adp/add-fragment';
+import * as addXMLAdditionalInfo from '../../../../src/cpe/additional-change-info/add-xml-additional-info';
+import { CommunicationService } from '../../../../src/cpe/communication-service';
+
+jest.mock('@sap-ux-private/control-property-editor-common');
+jest.mock('../../../../src/cpe/communication-service', () => ({
+    CommunicationService: {
+        sendAction: jest.fn()
+    }
+}));
 
 describe('AddFragment', () => {
     beforeAll(() => {
@@ -624,6 +633,7 @@ describe('AddFragment', () => {
         const rtaMock = new RuntimeAuthoringMock({} as RTAOptions);
 
         test('creates new fragment and a change', async () => {
+            const mockSendAction = CommunicationService.sendAction as jest.Mock;
             sapMock.ui.version = '1.71.62';
             const executeSpy = jest.fn();
             rtaMock.getCommandStack.mockReturnValue({
@@ -641,8 +651,10 @@ describe('AddFragment', () => {
                     getAllAggregations: jest.fn().mockReturnValue({}),
                     getName: jest.fn().mockReturnValue('sap.uxap.ObjectPageLayout'),
                     getDefaultAggregationName: jest.fn().mockReturnValue('content')
-                })
+                }),
+                getId: jest.fn().mockReturnValue('some-id')
             } as unknown as ManagedObject);
+            jest.spyOn(addXMLAdditionalInfo, 'getFragmentTemplateName').mockReturnValue('templateName');
 
             const addFragment = new AddFragment(
                 'adp.extension.controllers.AddFragment',
@@ -700,6 +712,7 @@ describe('AddFragment', () => {
                 }
             });
             expect(CommandFactory.getCommandFor.mock.calls[0][4].selector).toBeUndefined();
+            expect(mockSendAction).toHaveBeenCalled();
         });
 
         test('add header field fragment and a change if targetAggregation is items and not a dynamic header', async () => {
@@ -783,8 +796,10 @@ describe('AddFragment', () => {
                     getMetadata: jest.fn().mockReturnValue({
                         getName: jest.fn().mockReturnValue('No.Dynamic.ObjectPageDynamicHeaderContent')
                     })
-                })
+                }),
+                getId: jest.fn().mockReturnValue('some-id')
             } as unknown as ManagedObject);
+            jest.spyOn(addXMLAdditionalInfo, 'getFragmentTemplateName').mockReturnValue('');
 
             addFragment.handleDialogClose = jest.fn();
 
@@ -890,8 +905,10 @@ describe('AddFragment', () => {
                     getMetadata: jest.fn().mockReturnValue({
                         getName: jest.fn().mockReturnValue('sap.uxap.ObjectPageLayout')
                     })
-                })
+                }),
+                getId: jest.fn().mockReturnValue('some-id')
             } as unknown as ManagedObject);
+            jest.spyOn(addXMLAdditionalInfo, 'getFragmentTemplateName').mockReturnValue('');
 
             addFragment.handleDialogClose = jest.fn();
 
@@ -931,8 +948,10 @@ describe('AddFragment', () => {
                     getAllAggregations: jest.fn().mockReturnValue({}),
                     getName: jest.fn().mockReturnValue('sap.uxap.ObjectPageLayout'),
                     getDefaultAggregationName: jest.fn().mockReturnValue('content')
-                })
+                }),
+                getId: jest.fn().mockReturnValue('some-id')
             } as unknown as ManagedObject);
+            jest.spyOn(addXMLAdditionalInfo, 'getFragmentTemplateName').mockReturnValue('templateName');
             const event = {
                 getSource: jest.fn().mockReturnValue({
                     setEnabled: jest.fn()
@@ -972,7 +991,7 @@ describe('AddFragment', () => {
                 fragment: `<core:FragmentDefinition xmlns:core='sap.ui.core'></core:FragmentDefinition>`,
                 fragmentPath: `fragments/test.fragment.xml`,
                 index: 0,
-                targetAggregation: 'content',
+                targetAggregation: 'content'
             });
         });
     });
diff --git a/packages/preview-middleware-client/test/unit/flp/WorkspaceConnector.test.ts b/packages/preview-middleware-client/test/unit/flp/WorkspaceConnector.test.ts
@@ -1,10 +1,12 @@
 import ObjectStorageConnector from 'mock/sap/ui/fl/write/api/connectors/ObjectStorageConnector';
 import connector from '../../../src/flp/WorkspaceConnector';
 import VersionInfo from 'mock/sap/ui/VersionInfo';
+import * as additionalChangeInfo from '../../../src/utils/additional-change-info';
 
 import { documentMock, fetchMock } from 'mock/window';
 
 describe('flp/WorkspaceConnector', () => {
+    jest.spyOn(additionalChangeInfo, 'getAdditionalChangeInfo').mockReturnValue(undefined);
     test('layers', () => {
         expect(connector.layers).toEqual(['VENDOR', 'CUSTOMER_BASE']);
     });
@@ -15,15 +17,25 @@ describe('flp/WorkspaceConnector', () => {
         });
 
         test('setItem', async () => {
+            jest.spyOn(additionalChangeInfo, 'getAdditionalChangeInfo').mockReturnValueOnce({
+                templateName: 'templateName'
+            });
             connector.storage.fileChangeRequestNotifier = jest.fn();
             const change = { data: '~Data' };
             await connector.storage.setItem('~notUsed', change);
 
+            const body = {
+                change: {
+                    ...change
+                },
+                additionalChangeInfo: { templateName: 'templateName' }
+            };
+
             expect(fetch).toHaveBeenCalledWith(
                 expect.anything(),
                 expect.objectContaining({
                     method: 'POST',
-                    body: JSON.stringify({change: {...change}}, null, 2)
+                    body: JSON.stringify(body, null, 2)
                 })
             );
             expect(connector.storage.fileChangeRequestNotifier).toHaveBeenCalledTimes(0);
@@ -38,10 +50,15 @@ describe('flp/WorkspaceConnector', () => {
                 expect.anything(),
                 expect.objectContaining({
                     method: 'POST',
-                    body: JSON.stringify({change: {...change}}, null, 2)
+                    body: JSON.stringify({ change: { ...change } }, null, 2)
                 })
             );
-            expect(connector.storage.fileChangeRequestNotifier).toHaveBeenCalledWith('dummyFile', 'create', change, undefined);
+            expect(connector.storage.fileChangeRequestNotifier).toHaveBeenCalledWith(
+                'dummyFile',
+                'create',
+                change,
+                undefined
+            );
         });
 
         test('setItem, generator - tool-variant', async () => {
diff --git a/packages/preview-middleware-client/test/unit/flp/enableFakeConnector.test.ts b/packages/preview-middleware-client/test/unit/flp/enableFakeConnector.test.ts
@@ -3,8 +3,10 @@ import FakeLrepConnector from 'mock/sap/ui/fl/FakeLrepConnector';
 
 import enableFakeConnector, { loadChanges, create } from '../../../src/flp/enableFakeConnector';
 import LrepConnector from 'mock/sap/ui/fl/LrepConnector';
+import * as additionalChangeInfo from '../../../src/utils/additional-change-info';
 
 describe('flp/FakeLrepConnector', () => {
+    jest.spyOn(additionalChangeInfo, 'getAdditionalChangeInfo').mockReturnValue(undefined);
     afterEach(() => {
         jest.restoreAllMocks();
     });
diff --git a/packages/preview-middleware-client/tsconfig.json b/packages/preview-middleware-client/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "extends": "../../tsconfig.json",
   "include": [
-    "src/**/*.ts",
+    "src",
     "test",
     "test/**/*.json",
     "types"

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ export function getAddXMLAdditionalInfo(change: FlexChange<AddXMLChangeContent>)`
`26`	`26`	`return undefined;`
`27`	`27`	`}`
`28`	`28`
`29`		`-function getFragmentTemplateName(selectorId: string, targetAggregation: string): string {`
	`29`	`+export function getFragmentTemplateName(selectorId: string, targetAggregation: string): string {`
`30`	`30`	`const control = getControlById(selectorId);`
`31`	`31`
`32`	`32`	`if (!control) {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "../../tsconfig.json",`
`3`	`3`	`"include": [`
`4`		`- "src/*/.ts",`
	`4`	`+ "src",`
`5`	`5`	`"test",`
`6`	`6`	`"test/*/.json",`
`7`	`7`	`"types"`