Notifier usability improvements

dpwatrous · gingi · commit 633eb2b268c2 · 2023-11-09T12:53:06.000-05:00
- Add getNotifier() helper function
- Default to using FakeNotifier in tests
- FakeNotifier doesn't require expect() calls unless opted-in
diff --git a/packages/bonito-core/src/environment/abstract-environment.ts b/packages/bonito-core/src/environment/abstract-environment.ts
@@ -11,6 +11,7 @@ import {
     EnvironmentName,
 } from "./environment";
 import { Clock } from "../datetime/clock";
+import { Notifier } from "../notification";
 
 /**
  * Abstract base class for shared functionality across different environments
@@ -70,6 +71,22 @@ export abstract class AbstractEnvironment<
         return localizer;
     }
 
+    /**
+     * Get an instance of the global notifier
+     */
+    getNotifier(): Notifier {
+        const notifier = this.getInjectable<Notifier>(DependencyName.Notifier);
+        if (!notifier) {
+            throw new Error(
+                "No notifier configured for the current environment"
+            );
+        }
+        return notifier;
+    }
+
+    /**
+     * Get the currently configured HTTP client
+     */
     getHttpClient<T extends HttpClient>(): T {
         const httpClient = this.getInjectable<T>(DependencyName.HttpClient);
         if (!httpClient) {
diff --git a/packages/bonito-core/src/environment/environment.ts b/packages/bonito-core/src/environment/environment.ts
@@ -46,6 +46,11 @@ export interface Environment<C extends EnvironmentConfig> {
      */
     getLocalizer(): Localizer;
 
+    /**
+     * Gets the notifier for the current environment
+     */
+    getNotifier(): Notifier;
+
     /**
      * Gets the HTTP client for the current environment
      */
diff --git a/packages/bonito-core/src/environment/mock-environment.ts b/packages/bonito-core/src/environment/mock-environment.ts
@@ -8,13 +8,13 @@ import { createMockLogger } from "../logging";
 import { FakeResourceGroupService } from "../resource-group";
 import { FakeStorageAccountService } from "../storage";
 import { FakeSubscriptionService } from "../subscription";
-import { AlertNotifier } from "../notification/alert-notifier";
 import { AbstractEnvironment } from "./abstract-environment";
 import {
     EnvironmentName,
     EnvironmentConfig,
     EnvironmentMode,
 } from "./environment";
+import { FakeNotifier } from "../notification/fake-notifier";
 
 export const mockEnvironmentConfig: EnvironmentConfig = {
     mode: EnvironmentMode.Development,
@@ -30,7 +30,7 @@ export const mockDependencyFactories: DependencyFactories = {
     resourceGroupService: () => new FakeResourceGroupService(),
     storageAccountService: () => new FakeStorageAccountService(),
     subscriptionService: () => new FakeSubscriptionService(),
-    notifier: () => new AlertNotifier(),
+    notifier: () => new FakeNotifier(),
 };
 
 export class MockEnvironment<
diff --git a/packages/bonito-core/src/index.ts b/packages/bonito-core/src/index.ts
@@ -32,6 +32,7 @@ export {
 } from "./http";
 export * from "./location";
 export { getLogger } from "./logging/logging-util";
+export { getNotifier } from "./notification";
 export * from "./resource-group";
 export * from "./service";
 export * from "./storage";
diff --git a/packages/bonito-core/src/notification/__tests__/fake-notifier.spec.ts b/packages/bonito-core/src/notification/__tests__/fake-notifier.spec.ts
@@ -1,16 +1,14 @@
 import { initMockEnvironment } from "../../environment";
 import { FakeNotifier } from "../fake-notifier";
+import { getNotifier } from "../notification-util";
 
 describe("Fake notification tests", () => {
     let notifier: FakeNotifier;
 
     beforeEach(() => {
         initMockEnvironment();
-        notifier = new FakeNotifier();
-    });
-
-    afterEach(() => {
-        jest.restoreAllMocks();
+        notifier = getNotifier() as FakeNotifier;
+        notifier.enableChecking = true;
     });
 
     test("Each notifier function works as expected", () => {
diff --git a/packages/bonito-core/src/notification/fake-notifier.ts b/packages/bonito-core/src/notification/fake-notifier.ts
@@ -12,6 +12,11 @@ export interface ExpectedNotification {
 }
 
 export class FakeNotifier implements Notifier {
+    /**
+     * Enable only when specifically testing what notifications are sent
+     */
+    enableChecking: boolean = false;
+
     expectedNotifications: ExpectedNotification[] = [];
 
     expectInfo(notification: string, config: NotificationConfig): void {
@@ -39,6 +44,11 @@ export class FakeNotifier implements Notifier {
         expectedNotification: string,
         config: NotificationConfig
     ): void {
+        if (!this.enableChecking) {
+            throw new Error(
+                "Set `FakeNotifier.enableChecking = true` to enable notification assertions"
+            );
+        }
         this.expectedNotifications.push({
             level: level,
             notification: expectedNotification,
diff --git a/packages/bonito-core/src/notification/index.ts b/packages/bonito-core/src/notification/index.ts
@@ -1 +1,2 @@
 export * from "./notifier";
+export * from "./notification-util";
diff --git a/packages/bonito-core/src/notification/notification-util.ts b/packages/bonito-core/src/notification/notification-util.ts
@@ -0,0 +1,11 @@
+import { getEnvironment } from "../environment";
+import { Notifier } from "./notifier";
+
+/**
+ * Gets the notifier for the current environment
+ *
+ * @returns The globally-configured notifier instance
+ */
+export function getNotifier(): Notifier {
+    return getEnvironment().getNotifier();
+}
diff --git a/packages/react/src/account/create-account-action.ts b/packages/react/src/account/create-account-action.ts
@@ -1,4 +1,4 @@
-import { createForm } from "@azure/bonito-core";
+import { createForm, getNotifier } from "@azure/bonito-core";
 import { AbstractAction } from "@azure/bonito-core/lib/action";
 import {
     Form,
@@ -143,7 +143,8 @@ export class CreateAccountAction extends AbstractAction<CreateAccountFormValues>
     }
 
     async onExecute(formValues: CreateAccountFormValues): Promise<void> {
-        alert(
+        getNotifier().info(
+            "Account created",
             "Would write form values:\n" +
                 JSON.stringify(formValues, undefined, 4)
         );

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`export * from "./notifier";`
	`2`	`+export * from "./notification-util";`