@atproto/xrpc-server 0.3.1 → 0.3.2

package/dist/rate-limiter.d.ts

@@ -5,13 +5,15 @@ export declare type RateLimiterOpts = {
     durationMs: number;
     points: number;
     bypassSecret?: string;
+    bypassIps?: string[];
     calcKey?: CalcKeyFn;
     calcPoints?: CalcPointsFn;
     failClosed?: boolean;
 };
 export declare class RateLimiter implements RateLimiterI {
     limiter: RateLimiterAbstract;
-    private byPassSecret?;
+    private bypassSecret?;
+    private bypassIps?;
     private failClosed?;
     calcKey: CalcKeyFn;
     calcPoints: CalcPointsFn;

package/package.json

@@ -1,13 +1,19 @@
 {
   "name": "@atproto/xrpc-server",
-  "version": "0.3.1",
-  "main": "dist/index.js",
+  "version": "0.3.2",
   "license": "MIT",
+  "description": "atproto HTTP API (XRPC) server library",
+  "keywords": [
+    "atproto",
+    "xrpc"
+  ],
+  "homepage": "https://atproto.com",
   "repository": {
     "type": "git",
-    "url": "https://github.com/bluesky-social/atproto.git",
+    "url": "https://github.com/bluesky-social/atproto",
     "directory": "packages/xrpc-server"
   },
+  "main": "dist/index.js",
   "dependencies": {
     "cbor-x": "^1.5.1",
     "express": "^4.17.2",
@@ -17,9 +23,9 @@
     "uint8arrays": "3.0.0",
     "ws": "^8.12.0",
     "zod": "^3.21.4",
-    "@atproto/common": "^0.3.0",
+    "@atproto/common": "^0.3.1",
     "@atproto/crypto": "^0.2.2",
-    "@atproto/lexicon": "^0.2.1"
+    "@atproto/lexicon": "^0.2.2"
   },
   "devDependencies": {
     "@types/express": "^4.17.13",
@@ -29,7 +35,7 @@
     "get-port": "^6.1.2",
     "multiformats": "^9.9.0",
     "@atproto/crypto": "^0.2.2",
-    "@atproto/xrpc": "^0.3.1"
+    "@atproto/xrpc": "^0.3.2"
   },
   "scripts": {
     "test": "jest",

package/src/rate-limiter.ts

@@ -20,6 +20,7 @@ export type RateLimiterOpts = {
   durationMs: number
   points: number
   bypassSecret?: string
+  bypassIps?: string[]
   calcKey?: CalcKeyFn
   calcPoints?: CalcPointsFn
   failClosed?: boolean
@@ -27,14 +28,16 @@ export type RateLimiterOpts = {
 
 export class RateLimiter implements RateLimiterI {
   public limiter: RateLimiterAbstract
-  private byPassSecret?: string
+  private bypassSecret?: string
+  private bypassIps?: string[]
   private failClosed?: boolean
   public calcKey: CalcKeyFn
   public calcPoints: CalcPointsFn
 
   constructor(limiter: RateLimiterAbstract, opts: RateLimiterOpts) {
     this.limiter = limiter
-    this.byPassSecret = opts.bypassSecret
+    this.bypassSecret = opts.bypassSecret
+    this.bypassIps = opts.bypassIps
     this.calcKey = opts.calcKey ?? defaultKey
     this.calcPoints = opts.calcPoints ?? defaultPoints
   }
@@ -63,11 +66,14 @@ export class RateLimiter implements RateLimiterI {
     opts?: { calcKey?: CalcKeyFn; calcPoints?: CalcPointsFn },
   ): Promise<RateLimiterStatus | RateLimitExceededError | null> {
     if (
-      this.byPassSecret &&
-      ctx.req.header('x-ratelimit-bypass') === this.byPassSecret
+      this.bypassSecret &&
+      ctx.req.header('x-ratelimit-bypass') === this.bypassSecret
     ) {
       return null
     }
+    if (this.bypassIps && this.bypassIps.includes(ctx.req.ip)) {
+      return null
+    }
     const key = opts?.calcKey ? opts.calcKey(ctx) : this.calcKey(ctx)
     const points = opts?.calcPoints
       ? opts.calcPoints(ctx)

package/src/server.ts

@@ -405,7 +405,8 @@ export class Server {
         ? config.rateLimit
         : [config.rateLimit]
       this.routeRateLimiterFns[nsid] = []
-      for (const limit of limits) {
+      for (let i = 0; i < limits.length; i++) {
+        const limit = limits[i]
         const { calcKey, calcPoints } = limit
         if (isShared(limit)) {
           const rateLimiter = this.sharedRateLimiters[limit.name]
@@ -420,7 +421,7 @@ export class Server {
         } else {
           const { durationMs, points } = limit
           const rateLimiter = this.options.rateLimits?.creator({
-            keyPrefix: nsid,
+            keyPrefix: `nsid-${i}`,
             durationMs,
             points,
             calcKey,

package/src/types.ts

@@ -201,7 +201,13 @@ export class XRPCError extends Error {
 }
 
 export function isHandlerError(v: unknown): v is HandlerError {
-  return handlerError.safeParse(v).success
+  return (
+    !!v &&
+    typeof v === 'object' &&
+    typeof v['status'] === 'number' &&
+    (v['error'] === undefined || typeof v['error'] === 'string') &&
+    (v['message'] === undefined || typeof v['message'] === 'string')
+  )
 }
 
 export class InvalidRequestError extends XRPCError {