chore: ratelimit -> rate_limit

Author: paulo

node/config.test.ts

@@ -13,7 +13,7 @@ import { bundle } from './bundler.js'
 import { FunctionConfig, getFunctionConfig } from './config.js'
 import type { Declaration } from './declaration.js'
 import { ImportMap } from './import_map.js'
-import { RatelimitAction, RatelimitAggregator } from './ratelimit.js'
+import { RateLimitAction, RateLimitAggregator } from './rate_limit.js'
 
 const importMapFile = {
   baseURL: new URL('file:///some/path/import-map.json'),
@@ -129,7 +129,7 @@ const functions: TestFunctions[] = [
       rateLimit: {
         windowSize: 10,
         windowLimit: 100,
-        aggregateBy: [RatelimitAggregator.IP, RatelimitAggregator.Domain],
+        aggregateBy: [RateLimitAggregator.IP, RateLimitAggregator.Domain],
       },
     },
     name: 'func9',
@@ -153,11 +153,11 @@ const functions: TestFunctions[] = [
       path: '/rewrite',
       name: 'a limit rewrite',
       rateLimit: {
-        action: RatelimitAction.Rewrite,
+        action: RateLimitAction.Rewrite,
         to: '/rewritten',
         windowSize: 20,
         windowLimit: 200,
-        aggregateBy: [RatelimitAggregator.IP, RatelimitAggregator.Domain],
+        aggregateBy: [RateLimitAggregator.IP, RateLimitAggregator.Domain],
       },
     },
     name: 'func9',

node/config.ts

@@ -10,7 +10,7 @@ import { EdgeFunction } from './edge_function.js'
 import { ImportMap } from './import_map.js'
 import { Logger } from './logger.js'
 import { getPackagePath } from './package_json.js'
-import { Ratelimit } from './ratelimit.js'
+import { RateLimit } from './rate_limit.js'
 
 enum ConfigExitCode {
   Success = 0,
@@ -47,7 +47,7 @@ export interface FunctionConfig {
   name?: string
   generator?: string
   method?: HTTPMethod | HTTPMethod[]
-  rateLimit?: Ratelimit
+  rateLimit?: RateLimit
 }
 
 const getConfigExtractor = () => {

node/manifest.test.ts

@@ -9,7 +9,7 @@ import { BundleError } from './bundle_error.js'
 import { Cache, FunctionConfig } from './config.js'
 import { Declaration } from './declaration.js'
 import { generateManifest } from './manifest.js'
-import { RatelimitAction, RatelimitAggregator } from './ratelimit.js'
+import { RateLimitAction, RateLimitAggregator } from './rate_limit.js'
 
 test('Generates a manifest with different bundles', () => {
   const bundle1 = {
@@ -533,11 +533,11 @@ test('Generates a manifest with rewrite config', () => {
   const userFunctionConfig: Record<string, FunctionConfig> = {
     'func-1': {
       rateLimit: {
-        action: RatelimitAction.Rewrite,
+        action: RateLimitAction.Rewrite,
         to: '/new_path',
         windowLimit: 100,
         windowSize: 60,
-        aggregateBy: [RatelimitAggregator.Domain, RatelimitAggregator.IP],
+        aggregateBy: [RateLimitAggregator.Domain, RateLimitAggregator.IP],
       },
     },
   }

node/manifest.ts

@@ -9,13 +9,7 @@ import { EdgeFunction } from './edge_function.js'
 import { FeatureFlags } from './feature_flags.js'
 import { Layer } from './layer.js'
 import { getPackageVersion } from './package_json.js'
-import {
-  Ratelimit,
-  RewriteActionConfig,
-  RatelimitAction,
-  RatelimitAlgorithm,
-  RatelimitAggregator,
-} from './ratelimit.js'
+import { RateLimit, RateLimitAction, RateLimitAlgorithm, RateLimitAggregator } from './rate_limit.js'
 import { nonNullable } from './utils/non_nullable.js'
 import { ExtendedURLPattern } from './utils/urlpattern.js'
 
@@ -239,26 +233,26 @@ const generateManifest = ({
   return { declarationsWithoutFunction: [...declarationsWithoutFunction], manifest, unroutedFunctions }
 }
 
-const getTrafficRulesConfig = (rl: Ratelimit | undefined) => {
+const getTrafficRulesConfig = (rl: RateLimit | undefined) => {
   if (rl === undefined) {
     return
   }
 
-  const ratelimitAgg = Array.isArray(rl.aggregateBy) ? rl.aggregateBy : [RatelimitAggregator.Domain]
-  const rewriteConfig = (rl as RewriteActionConfig).to ? { to: (rl as RewriteActionConfig).to } : undefined
+  const rateLimitAgg = Array.isArray(rl.aggregateBy) ? rl.aggregateBy : [RateLimitAggregator.Domain]
+  const rewriteConfig = 'to' in rl && typeof rl.to === 'string' ? { to: rl.to } : undefined
 
   return {
     action: {
-      type: rl.action || RatelimitAction.Limit,
+      type: rl.action || RateLimitAction.Limit,
       config: {
         ...rewriteConfig,
         rate_limit_config: {
           window_limit: rl.windowLimit,
           window_size: rl.windowSize,
-          algorithm: RatelimitAlgorithm.SlidingWindow,
+          algorithm: RateLimitAlgorithm.SlidingWindow,
         },
         aggregate: {
-          keys: ratelimitAgg.map((agg) => ({ type: agg })),
+          keys: rateLimitAgg.map((agg) => ({ type: agg })),
         },
       },
     },

node/rate_limit.ts

@@ -0,0 +1,30 @@
+export enum RateLimitAlgorithm {
+  SlidingWindow = 'sliding_window',
+}
+
+export enum RateLimitAggregator {
+  Domain = 'domain',
+  IP = 'ip',
+}
+
+export enum RateLimitAction {
+  Limit = 'rate_limit',
+  Rewrite = 'rewrite',
+}
+
+interface SlidingWindow {
+  windowLimit: number
+  windowSize: number
+}
+
+export type RewriteActionConfig = SlidingWindow & {
+  to: string
+}
+
+interface RateLimitConfig {
+  action?: RateLimitAction
+  aggregateBy?: RateLimitAggregator | RateLimitAggregator[]
+  algorithm?: RateLimitAlgorithm
+}
+
+export type RateLimit = RateLimitConfig & (SlidingWindow | RewriteActionConfig)