Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-03-11 02:12:21 -05:00
Code Issues Activity

Removed Stripe API throttling in test environment

Browse source 
- I've discovered that 20% of our E2E test time is spent waiting around
  because we're throttling the requests to the Stripe API
- this makes sense in production because we have a requests/second limit
  but for testing it just makes things slower
- to avoid this, this commit increases the throttling thresholds if we
  detect we're in the testing environment
- the 10_000 limits are somewhat arbitrary, I tried Infinity but
  LeakyBucket doesn't like that number, and this achieves what I want
This commit is contained in:
Daniel Lockyer 2025-02-18 10:52:31 +01:00 • committed by Daniel Lockyer
parent 0a2d8f0264
commit 463d6e0631
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
ghost/stripe/lib/StripeAPI.js
View file

@ -7,10 +7,18 @@ const Stripe = require('stripe').Stripe;
/* Stripe has the following rate limits: /* Stripe has the following rate limits:
* - For most APIs, 100 read requests per second in live mode, 25 read requests per second in test mode * - For most APIs, 100 read requests per second in live mode, 25 read requests per second in test mode
* - For search, 20 requests per second in both live and test modes * - For search, 20 requests per second in both live and test modes
*
* For the testing environment, we increase these limits to 10,000 req/s to keep tests fast
*/ */
const EXPECTED_API_EFFICIENCY = 0.95; const EXPECTED_API_EFFICIENCY = 0.95;
const EXPECTED_SEARCH_API_EFFICIENCY = 0.15; const EXPECTED_SEARCH_API_EFFICIENCY = 0.15;
// If we're running in a testing environment, we don't want to rate limit the Stripe API like we do in production
const isTesting = process.env.NODE_ENV?.includes('testing');
const TEST_MODE_RATE_LIMIT = isTesting ? 10_000 : 25;
const LIVE_MODE_RATE_LIMIT = isTesting ? 10_000 : 100;
const SEARCH_MODE_RATE_LIMIT = isTesting ? 10_000 : 100;
const STRIPE_API_VERSION = '2020-08-27'; const STRIPE_API_VERSION = '2020-08-27';
/** /**
@ -86,11 +94,11 @@ module.exports = class StripeAPI {
this._config = config; this._config = config;
this._testMode = config.secretKey && config.secretKey.startsWith('sk_test_'); this._testMode = config.secretKey && config.secretKey.startsWith('sk_test_');
if (this._testMode) { if (this._testMode) {
this._rateLimitBucket = new LeakyBucket(EXPECTED_API_EFFICIENCY * 25, 1); this._rateLimitBucket = new LeakyBucket(EXPECTED_API_EFFICIENCY * TEST_MODE_RATE_LIMIT, 1);
} else { } else {
this._rateLimitBucket = new LeakyBucket(EXPECTED_API_EFFICIENCY * 100, 1); this._rateLimitBucket = new LeakyBucket(EXPECTED_API_EFFICIENCY * LIVE_MODE_RATE_LIMIT, 1);
} }
this._searchRateLimitBucket = new LeakyBucket(EXPECTED_SEARCH_API_EFFICIENCY * 100, 1); this._searchRateLimitBucket = new LeakyBucket(EXPECTED_SEARCH_API_EFFICIENCY * SEARCH_MODE_RATE_LIMIT, 1);
this._configured = true; this._configured = true;
} }