feat: collect user feedback (#965)

honeybadger-io · Jan 14, 2023 · 0842f0a · 0842f0a
1 parent 7d20076
commit 0842f0a
Show file tree

Hide file tree

Showing 34 changed files with 4,651 additions and 197 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -22,6 +22,7 @@
       "error",
       "always"
     ],
+    "@typescript-eslint/no-this-alias": 0,
     "@typescript-eslint/no-empty-function": 0,
     "@typescript-eslint/no-var-requires": 0,
     "@typescript-eslint/ban-ts-comment": 0,

diff --git a/.github/workflows/cdn-publish.yml b/.github/workflows/cdn-publish.yml
@@ -8,9 +8,6 @@ jobs:
     steps:
       - name: Git Checkout
         uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-          ref: master
 
       - name: Setup Node
         uses: actions/setup-node@v3

diff --git a/packages/core/src/client.ts b/packages/core/src/client.ts
@@ -22,7 +22,7 @@ import {
   Notice,
   Noticeable,
   HoneybadgerStore,
-  BacktraceFrame, Transport, NoticeTransportPayload
+  BacktraceFrame, Transport, NoticeTransportPayload, UserFeedbackFormOptions
 } from './types'
 import { GlobalStore } from './store';
 
@@ -87,6 +87,8 @@ export abstract class Client {
 
   protected abstract checkIn(id: string): Promise<void>
 
+  protected abstract showUserFeedbackForm(options: UserFeedbackFormOptions): Promise<void>
+
   getVersion(): string {
     return notifier.version
   }

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -78,6 +78,7 @@ export interface Notice {
 }
 
 export interface BrowserConfig extends Config {
+  userFeedbackEndpoint: string,
   async: boolean
   maxErrors: number
 }
@@ -187,3 +188,21 @@ export type StoreContents = {
   context: Record<string, unknown>,
   breadcrumbs: BreadcrumbRecord[]
 }
+
+export type UserFeedbackFormOptions = {
+  onLoad?: () => void;
+  messages?: {
+    heading?: string;
+    explanation?: string;
+    thanks?: string;
+  }
+  buttons?: {
+    submit?: string;
+    cancel?: string;
+  };
+  labels?: {
+    name?: string;
+    email?: string;
+    comment?: string;
+  };
+}
diff --git a/packages/core/test/helpers.ts b/packages/core/test/helpers.ts
@@ -1,6 +1,6 @@
 import { Client as BaseClient } from '../src/client'
-import { Config, Logger, Notice, Noticeable, Transport, TransportOptions, NoticeTransportPayload } from '../src/types'
-import { runAfterNotifyHandlers } from '../src/util';
+import { Config, Logger, Notice, Noticeable, Transport, TransportOptions, NoticeTransportPayload, UserFeedbackFormOptions } from '../src/types'
+import { runAfterNotifyHandlers } from '../src/util'
 
 export function nullLogger(): Logger {
   return {
@@ -27,6 +27,10 @@ export class TestClient extends BaseClient {
     throw new Error('Method not implemented.');
   }
 
+  protected showUserFeedbackForm(_options: UserFeedbackFormOptions): Promise<void> {
+    throw new Error('Method not implemented.');
+  }
+
   constructor(opts: Partial<Config>, transport: Transport) {
     super(opts, transport);
   }