Merge pull request #12338 from Budibase/fix/qa-core-test-failures

Attempt to fix QA-core flaky tests
Budibase · Nov 8, 2023 · 8c230f6 · 8c230f6
2 parents cfecff4 + e4bc6a5
commit 8c230f6
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 33 deletions.
diff --git a/packages/server/src/api/routes/public/index.ts b/packages/server/src/api/routes/public/index.ts
@@ -27,51 +27,59 @@ interface KoaRateLimitOptions {
 }
 
 const PREFIX = "/api/public/v1"
-// allow a lot more requests when in test
-const DEFAULT_API_REQ_LIMIT_PER_SEC = env.isTest() ? 100 : 10
 
-function getApiLimitPerSecond(): number {
- if (!env.API_REQ_LIMIT_PER_SEC) {
- return DEFAULT_API_REQ_LIMIT_PER_SEC
- }
- return parseInt(env.API_REQ_LIMIT_PER_SEC)
-}
+// type can't be known - untyped libraries
+let limiter: any, rateLimitStore: any
+if (!env.DISABLE_RATE_LIMITING) {
+ // allow a lot more requests when in test
+ const DEFAULT_API_REQ_LIMIT_PER_SEC = env.isTest() ? 100 : 10
 
-let rateLimitStore: any = null
-if (!env.isTest()) {
- const { password, host, port } = redis.utils.getRedisConnectionDetails()
- let options: KoaRateLimitOptions = {
- socket: {
- host: host,
- port: port,
- },
+ function getApiLimitPerSecond(): number {
+ if (!env.API_REQ_LIMIT_PER_SEC) {
+ return DEFAULT_API_REQ_LIMIT_PER_SEC
+ }
+ return parseInt(env.API_REQ_LIMIT_PER_SEC)
  }
 
- if (password) {
- options.password = password
- }
+ if (!env.isTest()) {
+ const { password, host, port } = redis.utils.getRedisConnectionDetails()
+ let options: KoaRateLimitOptions = {
+ socket: {
+ host: host,
+ port: port,
+ },
+ }
 
- if (!env.REDIS_CLUSTERED) {
- // Can't set direct redis db in clustered env
- options.database = SelectableDatabase.RATE_LIMITING
+ if (password) {
+ options.password = password
+ }
+
+ if (!env.REDIS_CLUSTERED) {
+ // Can't set direct redis db in clustered env
+ options.database = SelectableDatabase.RATE_LIMITING
+ }
+ rateLimitStore = new Stores.Redis(options)
+ RateLimit.defaultOptions({
+ store: rateLimitStore,
+ })
  }
- rateLimitStore = new Stores.Redis(options)
- RateLimit.defaultOptions({
- store: rateLimitStore,
+ // rate limiting, allows for 2 requests per second
+ limiter = RateLimit.middleware({
+ interval: { sec: 1 },
+ // per ip, per interval
+ max: getApiLimitPerSecond(),
  })
+} else {
+ console.log("**** PUBLIC API RATE LIMITING DISABLED ****")
 }
-// rate limiting, allows for 2 requests per second
-const limiter = RateLimit.middleware({
- interval: { sec: 1 },
- // per ip, per interval
- max: getApiLimitPerSecond(),
-})
 
 const publicRouter = new Router({
  prefix: PREFIX,
 })
 
-publicRouter.use(limiter)
+if (limiter) {
+ publicRouter.use(limiter)
+}
 
 function addMiddleware(
  endpoints: any,

diff --git a/packages/server/src/environment.ts b/packages/server/src/environment.ts
@@ -61,6 +61,7 @@ const environment = {
  ALLOW_DEV_AUTOMATIONS: process.env.ALLOW_DEV_AUTOMATIONS,
  DISABLE_THREADING: process.env.DISABLE_THREADING,
  DISABLE_AUTOMATION_LOGS: process.env.DISABLE_AUTOMATION_LOGS,
+ DISABLE_RATE_LIMITING: process.env.DISABLE_RATE_LIMITING,
  MULTI_TENANCY: process.env.MULTI_TENANCY,
  ENABLE_ANALYTICS: process.env.ENABLE_ANALYTICS,
  SELF_HOSTED: process.env.SELF_HOSTED,

diff --git a/qa-core/package.json b/qa-core/package.json
@@ -20,7 +20,7 @@
  "test:self:ci": "yarn run test --testPathIgnorePatterns=\\.integration\\. \\.cloud\\. \\.licensing\\.",
  "serve:test:self:ci": "start-server-and-test dev:built http://localhost:4001/health test:self:ci",
  "serve": "start-server-and-test dev:built http://localhost:4001/health",
- "dev:built": "cd ../ && yarn dev:built"
+ "dev:built": "cd ../ && DISABLE_RATE_LIMITING=1 yarn dev:built"
  },
  "devDependencies": {
  "@budibase/types": "^2.3.17",