[sitecore-jss] Fix undefined fields from event overriding layout data

(cherry picked from commit 58aeff9)
Sitecore · Dec 16, 2024 · 2c0f6df · 2c0f6df
1 parent 7b47056
commit 2c0f6df
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 4 deletions.
diff --git a/packages/sitecore-jss/src/editing/utils.test.ts b/packages/sitecore-jss/src/editing/utils.test.ts
@@ -212,6 +212,24 @@ describe('component library utils', () => {
       expect(changedComponent.params).to.deep.equal(expectedParams);
     });
 
+    it('should not update fields or params when update fields and params are undefined', () => {
+      const changedComponent = JSON.parse(JSON.stringify(testComponent));
+      changedComponent.fields = undefined;
+      changedComponent.params = undefined;
+      const message = new MessageEvent('message', {
+        origin: 'http://localhost',
+        data: {
+          name: 'component:update',
+          details: {
+            uid: 'test-content',
+          },
+        },
+      });
+      updateComponentHandler(message, changedComponent);
+      expect(changedComponent.fields).to.be.undefined;
+      expect(changedComponent.params).to.be.undefined;
+    });
+
     it('should debug log when component not found', () => {
       const message = new MessageEvent('message', {
         origin: 'http://localhost',

diff --git a/packages/sitecore-jss/src/editing/utils.ts b/packages/sitecore-jss/src/editing/utils.ts
@@ -257,13 +257,17 @@ export const updateComponentHandler = (
 
   if (updateComponent) {
     console.debug(
-      'Found rendering with uid %s to update. Updating with fields %o and params %o',
+      'Found component with uid %s to update. Update fields: %o. Update params: %o.',
       eventArgs.details.uid,
       eventArgs.details.fields,
       eventArgs.details.params
     );
-    updateComponent.fields = { ...updateComponent.fields, ...eventArgs.details.fields };
-    updateComponent.params = { ...updateComponent.params, ...eventArgs.details.params };
+    if (eventArgs.details.fields) {
+      updateComponent.fields = { ...updateComponent.fields, ...eventArgs.details.fields };
+    }
+    if (eventArgs.details.params) {
+      updateComponent.params = { ...updateComponent.params, ...eventArgs.details.params };
+    }
     if (successCallback) successCallback(rootComponent);
   } else {
     console.debug('Rendering with uid %s not found', eventArgs.details.uid);

diff --git a/packages/sitecore-jss/src/test-data/component-editing-data.ts b/packages/sitecore-jss/src/test-data/component-editing-data.ts
@@ -1,4 +1,3 @@
-// default setup for placeholder-less component
 const contentBlock = {
   uid: 'test-content',
   componentName: 'ContentBlock',