Merge pull request #2755 from stripe/xavdid/merge-node-beta

Merge to beta

Author: xavdid

.editorconfig

@@ -10,3 +10,6 @@ trim_trailing_whitespace = true
 
 [justfile]
 indent_size = 4
+
+[CHANGELOG.md]
+trim_trailing_whitespace = false

.github/pull_request_template.md

@@ -9,3 +9,15 @@ List out the key changes made in this PR, e.g.
 
 ### See Also
 <!-- Include any links or additional information that help explain this change. -->
+
+## Changelog
+<!-- Heads up! This section should include entries for any user-facing changes.
+Either fill it out or remove it if there are no entries to report.
+
+List changes that affect end users, e.g.
+- Fixes crash when calling `foo.bar()` with null argument
+- Adds support for new `baz` parameter on `PaymentIntent` creation
+
+List breaking changes first with a ⚠️ prefix, e.g.
+- ⚠️ Removes deprecated `legacy_method` function
+-->

CHANGELOG.md

@@ -42,24 +42,25 @@ value:
 ```js
 const stripe = require('stripe')('sk_test_...');
 
-stripe.customers.create({
+const customer = await stripeClient.customers.create({
   email: 'customer@example.com',
-})
-  .then(customer => console.log(customer.id))
-  .catch(error => console.error(error));
+});
+
+console.log(customer.id);
 ```
 
-Or using ES modules and `async`/`await`:
+Or using CJS:
 
 ```js
-import Stripe from 'stripe';
-const stripe = new Stripe('sk_test_...');
-
-const customer = await stripe.customers.create({
-  email: 'customer@example.com',
-});
+const Stripe = require('stripe');
+const stripeClient = Stripe('sk_test_...');
 
-console.log(customer.id);
+stripeClient.customers
+  .create({
+    email: 'customer@example.com',
+  })
+  .then((customer) => console.log(customer.id))
+  .catch((error) => console.error(error));
 ```
 
 > [!WARNING]
@@ -420,7 +421,11 @@ const header = stripe.webhooks.generateTestHeaderString({
   secret,
 });
 
-const event = stripe.webhooks.constructEvent(payloadString, header, secret);
+const event = stripeClient.webhooks.constructEvent(
+  payloadString,
+  header,
+  secret
+);
 
 // Do something with mocked signed event
 expect(event.id).to.equal(payload.id);
@@ -436,20 +441,11 @@ See [undocumented params and properties](https://docs.stripe.com/sdks/server-sid
 
 If you're writing a plugin that uses the library, we'd appreciate it if you instantiated your stripe client with `appInfo`, eg;
 
-```js
-const stripe = require('stripe')('sk_test_...', {
-  appInfo: {
-    name: 'MyAwesomePlugin',
-    version: '1.2.34', // Optional
-    url: 'https://myawesomeplugin.info', // Optional
-  },
-});
-```
-
-Or using ES modules or TypeScript:
+With ES modules or TypeScript:
 
 ```js
-const stripe = new Stripe(apiKey, {
+import Stripe from 'stripe';
+const stripeClient = new Stripe(apiKey, {
   appInfo: {
     name: 'MyAwesomePlugin',
     version: '1.2.34', // Optional
@@ -574,7 +570,7 @@ const stripe = new Stripe('sk_test_...', {
 
 ### Private Preview SDKs
 
-Stripe has features in the [private preview phase](https://docs.stripe.com/release-phases) that can be accessed via versions of this package that have the `-alpha.X` suffix like `18.6.0-alpha.1`. These are invite-only features. Once invited, you can install the private preview SDKs by following the same instructions as for the [public preview SDKs](https://github.com/stripe/stripe-node?tab=readme-ov-file#public-preview-sdks) above and replacing the term `public-preview` with `private-preview`:
+Stripe has features in the [private preview phase](https://docs.stripe.com/release-phases) that can be accessed via versions of this package that have the `-alpha.X` suffix like `18.6.0-alpha.1`. You can install the private preview SDKs by following the same instructions as for the [public preview SDKs](#public-preview-sdks) above and replacing the term `public-preview` with `private-preview`. Note that access to specific private preview API features may require separate approval:
 
 ```
 npm install stripe@private-preview --save-exact
@@ -629,6 +625,9 @@ New features and bug fixes are released on the latest major version of the `stri
 
 ## Development
 
+> [!WARNING]
+> External contributions to this repo from first-time contributors are currently on hiatus. If you'd like to see a change made to the package, please open an issue.
+
 [Contribution guidelines for this project](CONTRIBUTING.md)
 
 The tests depend on [stripe-mock][stripe-mock], so make sure to fetch and

README.md

@@ -9,6 +9,7 @@ import {
 import {StripeContext} from './StripeContext.js';
 import {
   RequestHeaders,
+  ResponseHeaders,
   RequestEvent,
   ResponseEvent,
   RequestCallback,
@@ -96,6 +97,15 @@ export class RequestSender {
     return headers['request-id'] as string;
   }
 
+  private _emitStripeNotice(headers: ResponseHeaders): void {
+    const notice = headers['stripe-notice'];
+    if (notice) {
+      this._stripe._platformFunctions.emitWarning(
+        typeof notice === 'string' ? notice : notice[0]
+      );
+    }
+  }
+
   /**
    * Used by methods with spec.streaming === true. For these methods, we do not
    * buffer successful responses into memory or do parse them into stripe
@@ -113,6 +123,7 @@ export class RequestSender {
   ): (res: HttpClientResponseInterface) => RequestCallbackReturn {
     return (res: HttpClientResponseInterface): RequestCallbackReturn => {
       const headers = res.getHeaders();
+      this._emitStripeNotice(headers);
 
       const streamCompleteCallback = (): void => {
         const responseEvent = this._makeResponseEvent(
@@ -152,6 +163,7 @@ export class RequestSender {
   ) {
     return (res: HttpClientResponseInterface): void => {
       const headers = res.getHeaders();
+      this._emitStripeNotice(headers);
       const requestId = this._getRequestId(headers);
       const statusCode = res.getStatusCode();
 
@@ -294,10 +306,7 @@ export class RequestSender {
     return false;
   }
 
-  _getSleepTimeInMS(
-    numRetries: number,
-    retryAfter: number | null = null
-  ): number {
+  _getSleepTimeInMS(numRetries: number, retryAfter?: number): number {
     const initialNetworkRetryDelay = this._stripe.getInitialNetworkRetryDelay();
     const maxNetworkRetryDelay = this._stripe.getMaxNetworkRetryDelay();
 
@@ -578,7 +587,7 @@ export class RequestSender {
       apiVersion: string,
       headers: RequestHeaders,
       requestRetries: number,
-      retryAfter: number | null
+      retryAfter?: number
     ): ReturnType<typeof setTimeout> => {
       return setTimeout(
         requestFn,
@@ -693,8 +702,7 @@ export class RequestSender {
                   makeRequest,
                   apiVersion,
                   headers,
-                  requestRetries,
-                  null
+                  requestRetries
                 );
               } else {
                 const isTimeoutError =

src/RequestSender.ts

@@ -173,6 +173,7 @@ class V2ListIterator<T> implements AsyncIterator<T> {
   private firstPagePromise: Promise<PageResult<T>> | null;
   private currentPageIterator: Iterator<T> | null;
   private nextPageUrl: string | null;
+  private promiseCache: PromiseCache;
   private options: RequestOptions | undefined;
   private spec: MakeRequestSpec | undefined;
   private stripeResource: StripeResourceObject;
@@ -185,6 +186,7 @@ class V2ListIterator<T> implements AsyncIterator<T> {
     this.firstPagePromise = firstPagePromise;
     this.currentPageIterator = null;
     this.nextPageUrl = null;
+    this.promiseCache = {currentPromise: null};
     this.options = options;
     this.spec = spec;
     this.stripeResource = stripeResource;
@@ -210,19 +212,45 @@ class V2ListIterator<T> implements AsyncIterator<T> {
     this.currentPageIterator = page.data[Symbol.iterator]();
     return this.currentPageIterator;
   }
-  async next(): Promise<IteratorResult<T>> {
+  private async _next(): Promise<IteratorResult<T>> {
     await this.initFirstPage();
     if (this.currentPageIterator) {
       const result = this.currentPageIterator.next();
       if (!result.done) return {done: false, value: result.value};
     }
+    return this.nextFromNewPage();
+  }
+  private async nextFromNewPage(): Promise<IteratorResult<T>> {
     const nextPageIterator = await this.turnPage();
     if (!nextPageIterator) {
       return {done: true, value: undefined};
     }
     const result = nextPageIterator.next();
     if (!result.done) return {done: false, value: result.value};
-    return {done: true, value: undefined};
+    // Empty intermediate page — recurse to try the next page.
+    return this.nextFromNewPage();
+  }
+  next(): Promise<IteratorResult<T>> {
+    /**
+     * If a user calls `.next()` multiple times in parallel,
+     * return the same result until something has resolved
+     * to prevent page-turning race conditions.
+     */
+    if (this.promiseCache.currentPromise) {
+      return this.promiseCache.currentPromise;
+    }
+
+    const nextPromise = (async (): Promise<IteratorResult<T>> => {
+      try {
+        return await this._next();
+      } finally {
+        this.promiseCache.currentPromise = null;
+      }
+    })();
+
+    this.promiseCache.currentPromise = nextPromise;
+
+    return nextPromise;
   }
 }
 

src/autoPagination.ts

@@ -1,5 +1,6 @@
 import * as crypto from 'crypto';
 import * as http from 'http';
+import * as os from 'os';
 import {CryptoProvider} from '../crypto/CryptoProvider.js';
 import {EventEmitter} from 'events';
 import {HttpClient, NodeHttpClientInterface} from '../net/HttpClient.js';
@@ -8,7 +9,6 @@ import {NodeHttpClient} from '../net/NodeHttpClient.js';
 import {PlatformFunctions} from './PlatformFunctions.js';
 import {StripeError} from '../Error.js';
 import {concat} from '../utils.js';
-import {arch, release} from 'os';
 import {MultipartRequestData, RequestData, BufferedFile} from '../Types.js';
 
 class StreamProcessingError extends StripeError {}
@@ -28,7 +28,7 @@ export class NodePlatformFunctions extends PlatformFunctions {
 
   /** @override */
   getPlatformInfo(): string {
-    return `${process.platform} ${release()} ${arch()}`;
+    return `${process.platform} ${os.release()} ${os.arch()}`;
   }
 
   /** @override */
@@ -50,6 +50,38 @@ export class NodePlatformFunctions extends PlatformFunctions {
     return process.version;
   }
 
+  private getUname(): string | null {
+    try {
+      const parts = [os.type(), os.release(), os.arch()];
+      // os.version() returns detailed kernel version, available since Node 10.7.0
+      // It may not exist in older typings, so access carefully
+      const version = (os as any).version?.();
+      if (version) parts.push(version);
+      try {
+        parts.push(os.hostname());
+        // eslint-disable-next-line no-empty
+      } catch (_e) {}
+      return parts.join(' ');
+    } catch {
+      return null;
+    }
+  }
+
+  /** @override */
+  getSourceHash(): string | null {
+    try {
+      const uname = this.getUname();
+      return uname
+        ? crypto
+            .createHash('md5')
+            .update(uname)
+            .digest('hex')
+        : null;
+    } catch {
+      return null;
+    }
+  }
+
   /**
    * @override
    * Secure compare, from https://github.com/freewil/scmp

src/platform/NodePlatformFunctions.ts

@@ -35,6 +35,10 @@ export class PlatformFunctions {
     return null;
   }
 
+  getSourceHash(): string | null {
+    return null;
+  }
+
   /**
    * Emits a warning. Node.js uses process.emitWarning; other runtimes
    * fall back to console.warn.

src/platform/PlatformFunctions.ts

@@ -26,7 +26,7 @@ export class AccountNoticeResource extends StripeResource {
   ): Promise<Response<AccountNotice>> {
     return this._makeRequest(
       'GET',
-      `/v1/account_notices/${id}`,
+      `/v1/account_notices/${encodeURIComponent(id)}`,
       params,
       options
     ) as any;
@@ -41,7 +41,7 @@ export class AccountNoticeResource extends StripeResource {
   ): Promise<Response<AccountNotice>> {
     return this._makeRequest(
       'POST',
-      `/v1/account_notices/${id}`,
+      `/v1/account_notices/${encodeURIComponent(id)}`,
       params,
       options
     ) as any;