feat(service-worker): add messageerror event handling and logging (#62834)

SkyZeroZx · thePunderWoman · commit 8255e0cf1535 · 2025-07-31T09:17:43.000Z
Add messageerror event handling and logging to Driver class PR Close #62834
diff --git a/packages/service-worker/worker/src/driver.ts b/packages/service-worker/worker/src/driver.ts
@@ -189,8 +189,8 @@ export class Driver implements Debuggable, UpdateSource {
       }
     });
 
-    // Handle the fetch, message, and push, notificationclick,
-    // notificationclose and pushsubscriptionchange events.
+    // Handle the fetch, message, push, notificationclick,
+    // notificationclose, pushsubscriptionchange, and messageerror events.
     this.scope.addEventListener('fetch', (event) => this.onFetch(event!));
     this.scope.addEventListener('message', (event) => this.onMessage(event!));
     this.scope.addEventListener('push', (event) => this.onPush(event!));
@@ -201,6 +201,7 @@ export class Driver implements Debuggable, UpdateSource {
       // based on the incorrect assumption that browsers don't support it.
       this.onPushSubscriptionChange(event as PushSubscriptionChangeEvent),
     );
+    this.scope.addEventListener('messageerror', (event) => this.onMessageError(event));
 
     // The debugger generates debug pages in response to debugging requests.
     this.debugger = new DebugHandler(this, this.adapter);
@@ -338,6 +339,15 @@ export class Driver implements Debuggable, UpdateSource {
     event.waitUntil(this.handlePushSubscriptionChange(event));
   }
 
+  private onMessageError(event: MessageEvent): void {
+    // Handle message deserialization errors that occur when receiving messages
+    // that cannot be deserialized, typically due to corrupted data or unsupported formats.
+    this.debugger.log(
+      `Message error occurred - data could not be deserialized`,
+      `Driver.onMessageError(origin: ${event.origin})`,
+    );
+  }
+
   private async ensureInitialized(event: ExtendableEvent): Promise<void> {
     // Since the SW may have just been started, it may or may not have been initialized already.
     // `this.initialized` will be `null` if initialization has not yet been attempted, or will be a
diff --git a/packages/service-worker/worker/test/happy_spec.ts b/packages/service-worker/worker/test/happy_spec.ts
@@ -1193,6 +1193,21 @@ import {envIsSupported} from '../testing/utils';
       });
     });
 
+    describe('messageerror events', () => {
+      it('logs message deserialization errors', async () => {
+        await driver.initialized;
+
+        const debuggerLogSpy = spyOn(driver.debugger, 'log');
+
+        scope.handleMessageError('someClient');
+
+        expect(debuggerLogSpy).toHaveBeenCalledWith(
+          'Message error occurred - data could not be deserialized',
+          'Driver.onMessageError(origin: )',
+        );
+      });
+    });
+
     describe('notification close events', () => {
       it('broadcasts notification close events', async () => {
         expect(await makeRequest(scope, '/foo.txt')).toEqual('this is foo');
diff --git a/packages/service-worker/worker/testing/scope.ts b/packages/service-worker/worker/testing/scope.ts
@@ -236,6 +236,24 @@ export class SwTestHarnessImpl
     return event.ready;
   }
 
+  handleMessageError(clientId: string | null) {
+    if (!this.eventHandlers.has('messageerror')) {
+      throw new Error('No messageerror handler registered');
+    }
+
+    if (clientId && !this.clients.getMock(clientId)) {
+      this.clients.add(clientId, this.scopeUrl);
+    }
+
+    const event = new MockExtendableMessageEvent(
+      null,
+      (clientId && this.clients.getMock(clientId)) || null,
+    );
+    this.eventHandlers.get('messageerror')!.call(this, event);
+
+    return event.ready;
+  }
+
   handlePush(data: Object): Promise<void> {
     if (!this.eventHandlers.has('push')) {
       throw new Error('No push handler registered');
