add some tests for notification sagas

Author: dlech

src/sagas/notification.test.ts

@@ -0,0 +1,88 @@
+// SPDX-License-Identifier: MIT
+// Copyright (c) 2021 The Pybricks Authors
+
+import { IToaster } from '@blueprintjs/core';
+import { AsyncSaga } from '../../test';
+import { Action } from '../actions';
+import {
+    BleDeviceFailToConnectReasonType,
+    didFailToConnect as bleDidFailToConnect,
+} from '../actions/ble';
+import { storageChanged } from '../actions/editor';
+import {
+    BootloaderConnectionFailureReason,
+    didFailToConnect as bootloaderDidFailToConnect,
+} from '../actions/lwp3-bootloader';
+import { didFailToCompile } from '../actions/mpy';
+import { add } from '../actions/notification';
+import { didSucceed, didUpdate } from '../actions/service-worker';
+import notification from './notification';
+
+test.each([
+    bleDidFailToConnect({ reason: BleDeviceFailToConnectReasonType.NoWebBluetooth }),
+    bleDidFailToConnect({ reason: BleDeviceFailToConnectReasonType.NoGatt }),
+    bleDidFailToConnect({ reason: BleDeviceFailToConnectReasonType.NoService }),
+    bleDidFailToConnect({
+        reason: BleDeviceFailToConnectReasonType.Unknown,
+        err: { name: 'test', message: 'unknown' },
+    }),
+    bootloaderDidFailToConnect(BootloaderConnectionFailureReason.Unknown),
+    bootloaderDidFailToConnect(BootloaderConnectionFailureReason.NoWebBluetooth),
+    bootloaderDidFailToConnect(BootloaderConnectionFailureReason.GattServiceNotFound),
+    storageChanged('test'),
+    didFailToCompile('reason'),
+    add('warning', 'message'),
+    add('error', 'message', 'url'),
+    didUpdate({} as ServiceWorkerRegistration),
+    didSucceed({} as ServiceWorkerRegistration),
+])('actions that should show notification: %o', async (action: Action) => {
+    const getToasts = jest.fn().mockReturnValue([]);
+    const show = jest.fn();
+    const dismiss = jest.fn();
+    const clear = jest.fn();
+
+    const toaster: IToaster = {
+        getToasts,
+        show,
+        dismiss,
+        clear,
+    };
+
+    const saga = new AsyncSaga(notification, { notification: { toaster } });
+
+    saga.put(action);
+
+    expect(show).toBeCalled();
+    expect(dismiss).not.toBeCalled();
+    expect(clear).not.toBeCalled();
+
+    await saga.end();
+});
+
+test.each([
+    bleDidFailToConnect({ reason: BleDeviceFailToConnectReasonType.Canceled }),
+    bootloaderDidFailToConnect(BootloaderConnectionFailureReason.Canceled),
+])('actions that should not show a notification: %o', async (action: Action) => {
+    const getToasts = jest.fn().mockReturnValue([]);
+    const show = jest.fn();
+    const dismiss = jest.fn();
+    const clear = jest.fn();
+
+    const toaster: IToaster = {
+        getToasts,
+        show,
+        dismiss,
+        clear,
+    };
+
+    const saga = new AsyncSaga(notification, { notification: { toaster } });
+
+    saga.put(action);
+
+    expect(getToasts).not.toBeCalled();
+    expect(show).not.toBeCalled();
+    expect(dismiss).not.toBeCalled();
+    expect(clear).not.toBeCalled();
+
+    await saga.end();
+});

test/index.ts

@@ -12,7 +12,7 @@ export class AsyncSaga {
     private state: Partial<RootState>;
     private task: Task;
 
-    public constructor(saga: Saga) {
+    public constructor(saga: Saga, context?: Record<string, unknown>) {
         this.channel = stdChannel();
         this.dispatches = [];
         this.takers = [];
@@ -25,6 +25,7 @@ export class AsyncSaga {
                 onError: (e, _i): void => {
                     throw e;
                 },
+                context,
             },
             saga,
         );