Use EventTarget in worker / browser runtimes (#1668)

* passes tests * Remove _StripeEvent class * Convert flows test to TS * Add PlatformFunctions test * Node 14 woes * Fix Node version check * fix tests * Make base PlatformFunction class * more reviewer comments * More createEmitter tests * wip * Build and actually resolve * Throw error in web workers for streaming files * Remove checkForStream * Add tests * Update src/Webhooks.ts Co-authored-by: pakrym-stripe <[email protected]> * reviewer comments * better types * more cleanup --------- Co-authored-by: pakrym-stripe <[email protected]>
stripe · Feb 1, 2023 · b5fc448 · b5fc448
1 parent 4f5bd5f
commit b5fc448
Show file tree

Hide file tree

Showing 23 changed files with 499 additions and 144 deletions.
diff --git a/lib/StripeEmitter.js b/lib/StripeEmitter.js
diff --git a/lib/StripeResource.js b/lib/StripeResource.js
diff --git a/lib/multipart.js b/lib/multipart.js
diff --git a/lib/platform/NodePlatformFunctions.js b/lib/platform/NodePlatformFunctions.js
diff --git a/lib/platform/DefaultPlatformFunctions.js → lib/platform/PlatformFunctions.js b/lib/platform/DefaultPlatformFunctions.js → lib/platform/PlatformFunctions.js
diff --git a/lib/platform/WebPlatformFunctions.js b/lib/platform/WebPlatformFunctions.js
diff --git a/lib/stripe.common.js b/lib/stripe.common.js
diff --git a/lib/stripe.worker.js b/lib/stripe.worker.js
diff --git a/lib/utils.js b/lib/utils.js
diff --git a/src/Error.ts b/src/Error.ts
@@ -14,7 +14,7 @@ class StripeError extends Error {
   readonly code?: string;
   readonly doc_url?: string;
   readonly param?: string;
-  readonly detail?: string;
+  readonly detail?: string | Error;
   readonly statusCode?: number;
   readonly charge?: string;
   readonly decline_code?: string;

diff --git a/src/StripeEmitter.ts b/src/StripeEmitter.ts
@@ -0,0 +1,56 @@
+/**
+ * @private
+ * (For internal use in stripe-node.)
+ * Wrapper around the Event Web API.
+ */
+class _StripeEvent extends Event {
+  data?: RequestEvent | ResponseEvent;
+  constructor(eventName: string, data: any) {
+    super(eventName);
+    this.data = data;
+  }
+}
+
+type Listener = (...args: any[]) => any;
+type ListenerWrapper = (event: _StripeEvent) => void;
+
+/** Minimal EventEmitter wrapper around EventTarget. */
+class StripeEmitter {
+  eventTarget: EventTarget;
+  listenerMapping: Map<Listener, ListenerWrapper>;
+
+  constructor() {
+    this.eventTarget = new EventTarget();
+    this.listenerMapping = new Map();
+  }
+
+  on(eventName: string, listener: Listener): void {
+    const listenerWrapper: ListenerWrapper = (event: _StripeEvent): void => {
+      listener(event.data);
+    };
+    this.listenerMapping.set(listener, listenerWrapper);
+    return this.eventTarget.addEventListener(eventName, listenerWrapper);
+  }
+
+  removeListener(eventName: string, listener: Listener): void {
+    const listenerWrapper = this.listenerMapping.get(listener);
+    this.listenerMapping.delete(listener);
+    return this.eventTarget.removeEventListener(eventName, listenerWrapper!);
+  }
+
+  once(eventName: string, listener: Listener): void {
+    const listenerWrapper: ListenerWrapper = (event: _StripeEvent): void => {
+      listener(event.data);
+    };
+    this.listenerMapping.set(listener, listenerWrapper);
+    return this.eventTarget.addEventListener(eventName, listenerWrapper, {
+      once: true,
+    });
+  }
+
+  emit(eventName: string, data: RequestEvent | ResponseEvent): boolean {
+    return this.eventTarget.dispatchEvent(new _StripeEvent(eventName, data));
+  }
+}
+
+export = StripeEmitter;
diff --git a/src/StripeResource.ts b/src/StripeResource.ts
@@ -222,7 +222,7 @@ StripeResource.prototype = {
         opts.auth,
         {headers, settings, streaming: opts.streaming},
         requestCallback,
-        this.requestDataProcessor
+        this.requestDataProcessor?.bind(this)
       );
     });
   },

diff --git a/src/Types.d.ts b/src/Types.d.ts
@@ -31,7 +31,7 @@ type RequestCallback = (
   response?: any
 ) => RequestCallbackReturn;
 type RequestCallbackReturn = any;
-type RequestData = Record<string, unknown>;
+type RequestData = Record<string, any>;
 type RequestEvent = {
   api_version?: string;
   account?: string;
@@ -159,7 +159,7 @@ type StripeObject = {
   _requestSender: RequestSender;
   _getPropsFromConfig: (config: Record<string, unknown>) => UserProvidedConfig;
   _clientId?: string;
-  _platformFunctions: import('./platform/DefaultPlatformFunctions');
+  _platformFunctions: import('./platform/PlatformFunctions');
 };
 type RequestSender = {
   _request(
@@ -170,7 +170,7 @@ type RequestSender = {
     auth: string | null,
     options: RequestOptions,
     callback: RequestCallback,
-    requestDataProcessor: RequestDataProcessor | null
+    requestDataProcessor: RequestDataProcessor | undefined
   ): void;
 };
 type StripeRawError = {
@@ -183,7 +183,7 @@ type StripeRawError = {
   doc_url?: string;
   decline_code?: string;
   param?: string;
-  detail?: string;
+  detail?: string | Error;
   charge?: string;
   payment_method_type?: string;
   payment_intent?: any;