fix: add missing onPaywallClosed event. add internalHandlers for paywall to unsubscribe after onPaywallClosed

Author: StanislavMayorov

src/__tests__/integration/ui/paywall/paywall-view-controller-events.test.ts

@@ -1364,7 +1364,10 @@ describe('ViewController - dismiss cleanup', () => {
     // Call dismiss
     await view.dismiss();
 
-    // Emit events AFTER dismiss - handlers should NOT be called
+    // Emit onPaywallClosed event - this triggers cleanup via internal handler
+    emitPaywallViewDisappearedEvent(viewId, sample.view);
+
+    // Emit events AFTER cleanup - handlers should NOT be called
     emitPaywallProductSelectedEvent(viewId, sample.product_id, sample.view);
     emitPaywallPurchaseStartedEvent(
       viewId,
@@ -1374,7 +1377,7 @@ describe('ViewController - dismiss cleanup', () => {
     emitPaywallUserActionEvent(viewId, 'close', undefined, sample.view);
     emitPaywallRestoreStartedEvent(viewId, sample.view);
 
-    // Verify that NONE of the handlers were called after dismiss
+    // Verify that NONE of the handlers were called after cleanup
     expect(onProductSelectedHandler).not.toHaveBeenCalled();
     expect(onPurchaseStartedHandler).not.toHaveBeenCalled();
     expect(onCloseHandler).not.toHaveBeenCalled();
@@ -1657,7 +1660,12 @@ describe('ViewController - onPaywallClosed after user action close', () => {
     });
 
     // 1. User presses close button - this should trigger dismiss
-    emitPaywallUserActionEvent(viewId, 'close', undefined, closeButtonSample.view);
+    emitPaywallUserActionEvent(
+      viewId,
+      'close',
+      undefined,
+      closeButtonSample.view,
+    );
 
     expect(onCloseButtonPressHandler).toHaveBeenCalledTimes(1);
     expect(dismissSpy).toHaveBeenCalledTimes(1);
@@ -1668,8 +1676,8 @@ describe('ViewController - onPaywallClosed after user action close', () => {
     // 3. Native code sends onPaywallClosed event after paywall actually closes
     emitPaywallViewDisappearedEvent(viewId, closedSample.view);
 
-    // BUG EXPECTATION: onPaywallClosed handler should be called,
-    // but it might not be if dismiss() unsubscribed all handlers before native sent the event
+    // VERIFICATION: onPaywallClosed handler should be called
+    // Cleanup happens via internal handler AFTER this client handler executes
     expect(onPaywallClosedHandler).toHaveBeenCalledTimes(1);
 
     dismissSpy.mockRestore();

src/ui/view-controller.test.ts

@@ -21,6 +21,7 @@ jest.mock('./view-emitter', () => {
   return {
     ViewEmitter: jest.fn().mockImplementation(() => ({
       addListener: jest.fn(),
+      addInternalListener: jest.fn(),
       removeAllListeners: jest.fn(),
     })),
   };
@@ -127,7 +128,7 @@ describe('ViewController', () => {
   });
 
   describe('dismiss', () => {
-    it('calls bridge and unsubscribes listeners', async () => {
+    it('calls bridge and registers internal cleanup handler', async () => {
       const { AdaptyPaywallCoder } = jest.requireMock(
         '@/coders/adapty-paywall',
       );
@@ -140,15 +141,23 @@ describe('ViewController', () => {
         .mockResolvedValueOnce(undefined); // dismiss
 
       const { ViewEmitter } = jest.requireMock('./view-emitter');
+      const addInternalListenerMock = jest.fn();
       const removeAllListenersMock = jest.fn();
       (ViewEmitter as unknown as jest.Mock).mockImplementation(() => ({
         addListener: jest.fn(),
+        addInternalListener: addInternalListenerMock,
         removeAllListeners: removeAllListenersMock,
       }));
 
       const view = await ViewController.create(paywall, {} as any);
       view.setEventHandlers({ onCloseButtonPress: () => true });
 
+      // Verify internal handler was registered for cleanup
+      expect(addInternalListenerMock).toHaveBeenCalledWith(
+        'onPaywallClosed',
+        expect.any(Function),
+      );
+
       await view.dismiss();
 
       expect($bridge.request).toHaveBeenLastCalledWith(
@@ -157,7 +166,10 @@ describe('ViewController', () => {
         'Void',
         expect.any(Object),
       );
-      expect(removeAllListenersMock).toHaveBeenCalled();
+
+      // Cleanup now happens via internal handler, not directly in dismiss()
+      // So removeAllListeners should NOT be called immediately after dismiss
+      expect(removeAllListenersMock).not.toHaveBeenCalled();
     });
 
     it('throws if id is null', async () => {
@@ -181,6 +193,7 @@ describe('ViewController', () => {
       const addListener = jest.fn();
       (ViewEmitter as unknown as jest.Mock).mockImplementation(() => ({
         addListener,
+        addInternalListener: jest.fn(),
         removeAllListeners: jest.fn(),
       }));
 
@@ -229,6 +242,7 @@ describe('ViewController', () => {
       // Mock ViewEmitter instance BEFORE create
       (ViewEmitter as unknown as jest.Mock).mockImplementation(() => ({
         addListener,
+        addInternalListener: jest.fn(),
         removeAllListeners,
       }));
 
@@ -292,6 +306,7 @@ describe('ViewController', () => {
       });
       (ViewEmitter as unknown as jest.Mock).mockImplementation(() => ({
         addListener,
+        addInternalListener: jest.fn(),
         removeAllListeners: jest.fn(),
       }));
 
@@ -347,6 +362,7 @@ describe('ViewController', () => {
       });
       (ViewEmitter as unknown as jest.Mock).mockImplementation(() => ({
         addListener,
+        addInternalListener: jest.fn(),
         removeAllListeners: jest.fn(),
       }));
 
@@ -401,6 +417,7 @@ describe('ViewController', () => {
       const addListener = jest.fn();
       (ViewEmitter as unknown as jest.Mock).mockImplementation(() => ({
         addListener,
+        addInternalListener: jest.fn(),
         removeAllListeners: jest.fn(),
       }));
 

src/ui/view-controller.ts

@@ -72,9 +72,18 @@ export class ViewController {
     );
 
     view.id = result.id;
+    view.viewEmitter = new ViewEmitter(result.id);
 
     view.setEventHandlers(DEFAULT_EVENT_HANDLERS);
 
+    // Register internal handler for cleanup
+    view.viewEmitter.addInternalListener('onPaywallClosed', () => {
+      // Called AFTER client's onPaywallClosed handler
+      if (view.viewEmitter) {
+        view.viewEmitter.removeAllListeners();
+      }
+    });
+
     return view;
   }
 
@@ -184,10 +193,6 @@ export class ViewController {
     } satisfies Req['AdaptyUIDismissPaywallView.Request']);
 
     await this.handle<void>(methodKey, body, 'Void', ctx, log);
-
-    if (this.viewEmitter) {
-      this.viewEmitter.removeAllListeners();
-    }
   }
 
   /**

src/ui/view-emitter.ts

@@ -36,6 +36,13 @@ export class ViewEmitter {
       onRequestClose: () => Promise<void>;
     }
   > = new Map();
+  private internalHandlers: Map<
+    EventName,
+    {
+      handler: (event: ParsedPaywallEvent) => void;
+      config: (typeof HANDLER_TO_EVENT_CONFIG)[EventName];
+    }
+  > = new Map();
 
   constructor(viewId: string) {
     this.viewId = viewId;
@@ -59,6 +66,7 @@ export class ViewEmitter {
       onRequestClose,
     });
 
+    // If no subscription to native event exists - create one
     if (!this.eventListeners.has(config.nativeEvent)) {
       const subscription = $bridge.addEventListener(
         config.nativeEvent,
@@ -70,6 +78,54 @@ export class ViewEmitter {
     return this.eventListeners.get(config.nativeEvent)!;
   }
 
+  /**
+   * Adds an internal event handler.
+   * Internal handlers:
+   * - Are called AFTER client handlers
+   * - Do NOT return boolean (don't affect auto-dismiss)
+   * - Are used for internal SDK logic (e.g., cleanup)
+   * @internal
+   */
+  public addInternalListener(
+    event: EventName,
+    callback: (event: ParsedPaywallEvent) => void,
+  ): void {
+    const config = HANDLER_TO_EVENT_CONFIG[event];
+
+    if (!config) {
+      throw new Error(`No event config found for handler: ${event}`);
+    }
+
+    // Replace existing internal handler for this event
+    this.internalHandlers.set(event, {
+      handler: callback,
+      config,
+    });
+
+    // If no subscription to native event exists - create one
+    if (!this.eventListeners.has(config.nativeEvent)) {
+      const subscription = $bridge.addEventListener(
+        config.nativeEvent,
+        this.createEventHandler(config),
+      );
+      this.eventListeners.set(config.nativeEvent, subscription);
+    }
+  }
+
+  /**
+   * Checks if handler should be skipped based on action type filtering
+   */
+  private shouldSkipHandler(
+    handlerConfig: { propertyMap?: { [key: string]: string } },
+    parsedEvent: ParsedPaywallEvent,
+  ): boolean {
+    return !!(
+      handlerConfig.propertyMap &&
+      parsedEvent.id === PaywallEventId.DidPerformAction &&
+      parsedEvent.action.type !== handlerConfig.propertyMap['action']
+    );
+  }
+
   private createEventHandler(
     config: (typeof HANDLER_TO_EVENT_CONFIG)[EventName],
   ) {
@@ -91,6 +147,7 @@ export class ViewEmitter {
       const possibleHandlers =
         NATIVE_EVENT_TO_HANDLERS[config.nativeEvent] || [];
 
+      // 1. Client handlers
       let hasError = false;
       for (const handlerName of possibleHandlers) {
         const handlerData = this.handlers.get(handlerName);
@@ -101,11 +158,7 @@ export class ViewEmitter {
         const { handler, config: handlerConfig, onRequestClose } = handlerData;
 
         // Filter by action type for DidPerformAction events
-        if (
-          handlerConfig.propertyMap &&
-          parsedEvent.id === PaywallEventId.DidPerformAction &&
-          parsedEvent.action.type !== handlerConfig.propertyMap['action']
-        ) {
+        if (this.shouldSkipHandler(handlerConfig, parsedEvent)) {
           continue;
         }
 
@@ -141,6 +194,34 @@ export class ViewEmitter {
         }
       }
 
+      // 2. Internal handlers
+      for (const handlerName of possibleHandlers) {
+        const internalHandlerData = this.internalHandlers.get(handlerName);
+        if (!internalHandlerData) {
+          continue;
+        }
+
+        const { handler, config: handlerConfig } = internalHandlerData;
+
+        // Use the same filtering logic
+        if (this.shouldSkipHandler(handlerConfig, parsedEvent)) {
+          continue;
+        }
+
+        try {
+          handler(parsedEvent);
+        } catch (error) {
+          // Log error but continue execution
+          log.failed({
+            error,
+            handlerName: `internal:${handlerName}`,
+            viewId: eventViewId,
+            eventId: parsedEvent.id,
+            reason: 'internal_handler_failed',
+          });
+        }
+      }
+
       if (!hasError) {
         log.success({ viewId: eventViewId, eventId: parsedEvent.id });
       }
@@ -151,6 +232,7 @@ export class ViewEmitter {
     this.eventListeners.forEach(subscription => subscription.remove());
     this.eventListeners.clear();
     this.handlers.clear();
+    this.internalHandlers.clear();
   }
 }