From 4e7e0833cc352e852f257cbf14dfcf1630464155 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Mon, 25 May 2020 22:01:20 +0200
Subject: [PATCH] packages/core: add observable consumer to ErrorApi

---
 .../core/src/api/apis/definitions/ErrorApi.ts |  6 ++++
 .../apis/implementations/ErrorApiForwarder.ts | 30 ++++++++-----------
 .../CopyTextButton/CopyTextButton.test.tsx    |  1 +
 .../src/components/CreateAudit/index.test.tsx |  2 +-
 4 files changed, 20 insertions(+), 19 deletions(-)

diff --git a/packages/core/src/api/apis/definitions/ErrorApi.ts b/packages/core/src/api/apis/definitions/ErrorApi.ts
index c481547459..7f9676ea5a 100644
--- a/packages/core/src/api/apis/definitions/ErrorApi.ts
+++ b/packages/core/src/api/apis/definitions/ErrorApi.ts
@@ -15,6 +15,7 @@
  */
 
 import { createApiRef } from '../ApiRef';
+import { Observable } from '../../types';
 
 /**
  * Mirrors the javascript Error class, for the purpose of
@@ -54,6 +55,11 @@ export type ErrorApi = {
    * Post an error for handling by the application.
    */
   post(error: Error, context?: ErrorContext): void;
+
+  /**
+   * Observe errors posted by other parts of the application.
+   */
+  error$(): Observable<{ error: Error; context?: ErrorContext }>;
 };
 
 export const errorApiRef = createApiRef<ErrorApi>({
diff --git a/packages/core/src/api/apis/implementations/ErrorApiForwarder.ts b/packages/core/src/api/apis/implementations/ErrorApiForwarder.ts
index 8d777ac18f..79397c0a67 100644
--- a/packages/core/src/api/apis/implementations/ErrorApiForwarder.ts
+++ b/packages/core/src/api/apis/implementations/ErrorApiForwarder.ts
@@ -14,32 +14,26 @@
  * limitations under the License.
  */
 import { ErrorApi, ErrorContext, AlertApi } from '../../../';
-
-type SubscriberFunc = (error: Error) => void;
-type Unsubscribe = () => void;
+import { PublishSubject } from './lib';
+import { Observable } from '../../types';
 
 export class ErrorApiForwarder implements ErrorApi {
-  private readonly subscribers = new Set<SubscriberFunc>();
-  private alertApi: AlertApi;
+  private readonly subject = new PublishSubject<{
+    error: Error;
+    context?: ErrorContext;
+  }>();
 
-  constructor(alertApi: AlertApi) {
-    this.alertApi = alertApi;
-  }
+  constructor(private readonly alertApi: AlertApi) {}
 
   post(error: Error, context?: ErrorContext) {
-    if (context?.hidden) {
-      return;
+    if (!context?.hidden) {
+      this.alertApi.post({ message: error.message, severity: 'error' });
     }
 
-    this.alertApi.post({ message: error.message, severity: 'error' });
-    this.subscribers.forEach(subscriber => subscriber(error));
+    this.subject.next({ error, context });
   }
 
-  subscribe(func: SubscriberFunc): Unsubscribe {
-    this.subscribers.add(func);
-
-    return () => {
-      this.subscribers.delete(func);
-    };
+  error$(): Observable<{ error: Error; context?: ErrorContext }> {
+    return this.subject;
   }
 }
diff --git a/packages/core/src/components/CopyTextButton/CopyTextButton.test.tsx b/packages/core/src/components/CopyTextButton/CopyTextButton.test.tsx
index 695a700738..7bc59d1f48 100644
--- a/packages/core/src/components/CopyTextButton/CopyTextButton.test.tsx
+++ b/packages/core/src/components/CopyTextButton/CopyTextButton.test.tsx
@@ -44,6 +44,7 @@ const apiRegistry = ApiRegistry.from([
       post(error) {
         throw error;
       },
+      error$: jest.fn(),
     } as ErrorApi,
   ],
 ]);
diff --git a/plugins/lighthouse/src/components/CreateAudit/index.test.tsx b/plugins/lighthouse/src/components/CreateAudit/index.test.tsx
index f47dc3d475..b337698485 100644
--- a/plugins/lighthouse/src/components/CreateAudit/index.test.tsx
+++ b/plugins/lighthouse/src/components/CreateAudit/index.test.tsx
@@ -53,7 +53,7 @@ describe('CreateAudit', () => {
   let errorApi: ErrorApi;
 
   beforeEach(() => {
-    errorApi = { post: jest.fn() };
+    errorApi = { post: jest.fn(), error$: jest.fn() };
     apis = ApiRegistry.from([
       [lighthouseApiRef, new LighthouseRestApi('http://lighthouse')],
       [errorApiRef, errorApi],