core/src/utils/test/hardware-back-button.spec.ts - main - githubmirror/ionic

core/src/utils/test/hardware-back-button.spec.ts
112 строк3 KB
Liam DeBeasi
feat: add experimental hardware back button support in browsers (#28705)
05 янв 2024, 17:10
05 янв 2024, 17:10658d1ca
import type { BackButtonEvent } from '../../../src/interface';
import { startHardwareBackButton } from '../hardware-back-button';
import { config } from '../../global/config';
import { win } from '@utils/browser';

describe('Hardware Back Button', () => {
  beforeEach(() => startHardwareBackButton());
  it('should call handler', () => {
    const cbSpy = jest.fn();
    document.addEventListener('ionBackButton', (ev) => {
      (ev as BackButtonEvent).detail.register(0, cbSpy);
    });

    dispatchBackButtonEvent();
    expect(cbSpy).toHaveBeenCalled();
  });

  it('should call handlers in order of priority', () => {
    const cbSpy = jest.fn();
    const cbSpyTwo = jest.fn();
    document.addEventListener('ionBackButton', (ev) => {
      (ev as BackButtonEvent).detail.register(100, cbSpy);
      (ev as BackButtonEvent).detail.register(99, cbSpyTwo);
    });

    dispatchBackButtonEvent();
    expect(cbSpy).toHaveBeenCalled();
    expect(cbSpyTwo).not.toHaveBeenCalled();
  });

  it('should only call last handler to be added for handlers with same priority', () => {
    const cbSpy = jest.fn();
    const cbSpyTwo = jest.fn();
    document.addEventListener('ionBackButton', (ev) => {
      (ev as BackButtonEvent).detail.register(100, cbSpy);
      (ev as BackButtonEvent).detail.register(100, cbSpyTwo);
    });

    dispatchBackButtonEvent();
    expect(cbSpy).not.toHaveBeenCalled();
    expect(cbSpyTwo).toHaveBeenCalled();
  });

  it('should call multiple callbacks', () => {
    const cbSpy = (processNextHandler: () => void) => {
      processNextHandler();
    };
    const cbSpyTwo = jest.fn();
    document.addEventListener('ionBackButton', (ev) => {
      (ev as BackButtonEvent).detail.register(100, cbSpy);
      (ev as BackButtonEvent).detail.register(99, cbSpyTwo);
    });

    dispatchBackButtonEvent();
    expect(cbSpyTwo).toHaveBeenCalled();
  });
});

describe('Experimental Close Watcher', () => {
  test('should not use the Close Watcher API when available', () => {
    const mockAPI = mockCloseWatcher();

    config.reset({ experimentalCloseWatcher: false });

    startHardwareBackButton();

    expect(mockAPI.mock.calls).toHaveLength(0);
  });
  test('should use the Close Watcher API when available', () => {
    const mockAPI = mockCloseWatcher();

    config.reset({ experimentalCloseWatcher: true });

    startHardwareBackButton();

    expect(mockAPI.mock.calls).toHaveLength(1);
  });
  test('Close Watcher should dispatch ionBackButton events', () => {
    const mockAPI = mockCloseWatcher();

    config.reset({ experimentalCloseWatcher: true });

    startHardwareBackButton();

    const cbSpy = jest.fn();
    document.addEventListener('ionBackButton', cbSpy);

    // Call onclose on Ionic's instance of CloseWatcher
    mockAPI.getMockImplementation()!().onclose();

    expect(cbSpy).toHaveBeenCalled();
  });
});

const mockCloseWatcher = () => {
  const mockCloseWatcher = jest.fn();
  mockCloseWatcher.mockReturnValue({
    requestClose: () => null,
    close: () => null,
    destroy: () => null,
    oncancel: () => null,
    onclose: () => null,
  });
  (win as any).CloseWatcher = mockCloseWatcher;

  return mockCloseWatcher;
};

const dispatchBackButtonEvent = () => {
  const ev = new Event('backbutton');
  document.dispatchEvent(ev);
};