@atproto/xrpc-server 0.4.2 → 0.4.4-next.0

package/jest.config.js

@@ -1,6 +1,7 @@
-const base = require('../../jest.config.base.js')
-
+/** @type {import('jest').Config} */
 module.exports = {
-  ...base,
   displayName: 'XRPC Server',
+  transform: { '^.+\\.(t|j)s$': '@swc/jest' },
+  transformIgnorePatterns: [`<rootDir>/node_modules/(?!get-port)`],
+  setupFiles: ['<rootDir>/../../jest.setup.ts'],
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/xrpc-server",
-  "version": "0.4.2",
+  "version": "0.4.4-next.0",
   "license": "MIT",
   "description": "atproto HTTP API (XRPC) server library",
   "keywords": [
@@ -14,6 +14,7 @@
     "directory": "packages/xrpc-server"
   },
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "dependencies": {
     "cbor-x": "^1.5.1",
     "express": "^4.17.2",
@@ -23,9 +24,9 @@
     "uint8arrays": "3.0.0",
     "ws": "^8.12.0",
     "zod": "^3.21.4",
-    "@atproto/common": "^0.3.3",
-    "@atproto/crypto": "^0.3.0",
-    "@atproto/lexicon": "^0.3.1"
+    "@atproto/common": "^0.3.4-next.0",
+    "@atproto/lexicon": "^0.3.3-next.0",
+    "@atproto/crypto": "^0.3.1-next.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.13",
@@ -34,16 +35,14 @@
     "@types/ws": "^8.5.4",
     "get-port": "^6.1.2",
     "jose": "^4.15.4",
+    "jest": "^28.1.2",
     "key-encoder": "^2.0.3",
     "multiformats": "^9.9.0",
-    "@atproto/crypto": "^0.3.0",
-    "@atproto/xrpc": "^0.4.1"
+    "@atproto/crypto": "^0.3.1-next.0",
+    "@atproto/xrpc": "^0.4.3-next.0"
   },
   "scripts": {
     "test": "jest",
-    "build": "node ./build.js",
-    "postbuild": "tsc --build tsconfig.build.json",
-    "update-main-to-dist": "node ../../update-main-to-dist.js packages/xrpc-server"
-  },
-  "types": "dist/index.d.ts"
+    "build": "tsc --build tsconfig.build.json"
+  }
 }

package/src/rate-limiter.ts

@@ -75,6 +75,9 @@ export class RateLimiter implements RateLimiterI {
       return null
     }
     const key = opts?.calcKey ? opts.calcKey(ctx) : this.calcKey(ctx)
+    if (key === null) {
+      return null
+    }
     const points = opts?.calcPoints
       ? opts.calcPoints(ctx)
       : this.calcPoints(ctx)

package/src/server.ts

@@ -1,5 +1,10 @@
 import { Readable } from 'stream'
 import express, {
+  Application,
+  Express,
+  Router,
+  Request,
+  Response,
   ErrorRequestHandler,
   NextFunction,
   RequestHandler,
@@ -36,6 +41,7 @@ import {
   RateLimiterConsume,
   isShared,
   RateLimitExceededError,
+  HandlerPipeThrough,
 } from './types'
 import {
   decodeQueryParams,
@@ -51,8 +57,8 @@ export function createServer(lexicons?: LexiconDoc[], options?: Options) {
 }
 
 export class Server {
-  router = express()
-  routes = express.Router()
+  router: Express = express()
+  routes: Router = express.Router()
   subscriptions = new Map<string, XrpcStreamServer>()
   lex = new Lexicons()
   options: Options
@@ -68,7 +74,7 @@ export class Server {
     this.router.use(this.routes)
     this.router.use('/xrpc/:methodId', this.catchall.bind(this))
     this.router.use(errorMiddleware)
-    this.router.once('mount', (app: express.Application) => {
+    this.router.once('mount', (app: Application) => {
       this.enableStreamingOnListen(app)
     })
     this.options = opts ?? {}
@@ -173,15 +179,11 @@ export class Server {
     this.routes[verb](
       `/xrpc/${nsid}`,
       ...middleware,
-      this.createHandler(nsid, def, config.handler),
+      this.createHandler(nsid, def, config),
     )
   }
 
-  async catchall(
-    req: express.Request,
-    _res: express.Response,
-    next: NextFunction,
-  ) {
+  async catchall(req: Request, _res: Response, next: NextFunction) {
     const def = this.lex.getDef(req.params.methodId)
     if (!def) {
       return next(new MethodNotImplementedError())
@@ -206,10 +208,13 @@ export class Server {
   createHandler(
     nsid: string,
     def: LexXrpcQuery | LexXrpcProcedure,
-    handler: XRPCHandler,
+    routeCfg: XRPCHandlerConfig,
   ): RequestHandler {
-    const validateReqInput = (req: express.Request) =>
-      validateInput(nsid, def, req, this.options, this.lex)
+    const routeOpts = {
+      blobLimit: routeCfg.opts?.blobLimit ?? this.options.payload?.blobLimit,
+    }
+    const validateReqInput = (req: Request) =>
+      validateInput(nsid, def, req, routeOpts, this.lex)
     const validateResOutput =
       this.options.validateResponse === false
         ? (output?: HandlerSuccess) => output
@@ -254,12 +259,26 @@ export class Server {
         }
 
         // run the handler
-        const outputUnvalidated = await handler(reqCtx)
+        const outputUnvalidated = await routeCfg.handler(reqCtx)
 
         if (isHandlerError(outputUnvalidated)) {
           throw XRPCError.fromError(outputUnvalidated)
         }
 
+        if (outputUnvalidated && isHandlerPipeThrough(outputUnvalidated)) {
+          // set headers
+          if (outputUnvalidated?.headers) {
+            Object.entries(outputUnvalidated.headers).forEach(([name, val]) => {
+              res.header(name, val)
+            })
+          }
+          res
+            .header('Content-Type', outputUnvalidated.encoding)
+            .status(200)
+            .send(Buffer.from(outputUnvalidated.buffer))
+          return
+        }
+
         if (!outputUnvalidated || isHandlerSuccess(outputUnvalidated)) {
           // validate response
           const output = validateResOutput(outputUnvalidated)
@@ -371,7 +390,7 @@ export class Server {
     )
   }
 
-  private enableStreamingOnListen(app: express.Application) {
+  private enableStreamingOnListen(app: Application) {
     const _listen = app.listen
     app.listen = (...args) => {
       // @ts-ignore the args spread
@@ -445,6 +464,26 @@ function isHandlerSuccess(v: HandlerOutput): v is HandlerSuccess {
   return handlerSuccess.safeParse(v).success
 }
 
+function isHandlerPipeThrough(v: HandlerOutput): v is HandlerPipeThrough {
+  if (v === null || typeof v !== 'object') {
+    return false
+  }
+  if (!isString(v['encoding']) || !(v['buffer'] instanceof ArrayBuffer)) {
+    return false
+  }
+  if (v['headers'] !== undefined) {
+    if (v['headers'] === null || typeof v['headers'] !== 'object') {
+      return false
+    }
+    if (!Object.values(v['headers']).every(isString)) {
+      return false
+    }
+  }
+  return true
+}
+
+const isString = (val: unknown): val is string => typeof val === 'string'
+
 const kRequestLocals = Symbol('requestLocals')
 
 function createLocalsMiddleware(nsid: string): RequestHandler {

package/src/stream/frames.ts

@@ -11,7 +11,7 @@ import {
 } from './types'
 
 export abstract class Frame {
-  header: FrameHeader
+  abstract header: FrameHeader
   body: unknown
   get op(): FrameType {
     return this.header.op

package/src/stream/websocket-keepalive.ts

@@ -80,7 +80,7 @@ export class WebSocketKeepAlive {
 
   startHeartbeat(ws: WebSocket) {
     let isAlive = true
-    let heartbeatInterval: NodeJS.Timer | null = null
+    let heartbeatInterval: NodeJS.Timeout | null = null
 
     const checkAlive = () => {
       if (!isAlive) {
@@ -145,6 +145,7 @@ function forwardSignal(signal: AbortSignal, ac: AbortController) {
     return ac.abort(signal.reason)
   } else {
     signal.addEventListener('abort', () => ac.abort(signal.reason), {
+      // @ts-ignore https://github.com/DefinitelyTyped/DefinitelyTyped/pull/68625
       signal: ac.signal,
     })
   }

package/src/types.ts

@@ -46,6 +46,13 @@ export const handlerSuccess = zod.object({
 })
 export type HandlerSuccess = zod.infer<typeof handlerSuccess>
 
+export const handlerPipeThrough = zod.object({
+  encoding: zod.string(),
+  buffer: zod.instanceof(ArrayBuffer),
+  headers: zod.record(zod.string()).optional(),
+})
+export type HandlerPipeThrough = zod.infer<typeof handlerPipeThrough>
+
 export const handlerError = zod.object({
   status: zod.number(),
   error: zod.string().optional(),
@@ -53,7 +60,7 @@ export const handlerError = zod.object({
 })
 export type HandlerError = zod.infer<typeof handlerError>
 
-export type HandlerOutput = HandlerSuccess | HandlerError
+export type HandlerOutput = HandlerSuccess | HandlerPipeThrough | HandlerError
 
 export type XRPCReqContext = {
   auth: HandlerAuth | undefined
@@ -85,7 +92,7 @@ export type StreamAuthVerifier = (ctx: {
   req: IncomingMessage
 }) => Promise<AuthOutput> | AuthOutput
 
-export type CalcKeyFn = (ctx: XRPCReqContext) => string
+export type CalcKeyFn = (ctx: XRPCReqContext) => string | null
 export type CalcPointsFn = (ctx: XRPCReqContext) => number
 
 export interface RateLimiterI {
@@ -101,29 +108,29 @@ export type RateLimiterCreator = (opts: {
   keyPrefix: string
   durationMs: number
   points: number
-  calcKey?: (ctx: XRPCReqContext) => string
-  calcPoints?: (ctx: XRPCReqContext) => number
+  calcKey?: CalcKeyFn
+  calcPoints?: CalcPointsFn
 }) => RateLimiterI
 
 export type ServerRateLimitDescription = {
   name: string
   durationMs: number
   points: number
-  calcKey?: (ctx: XRPCReqContext) => string
-  calcPoints?: (ctx: XRPCReqContext) => number
+  calcKey?: CalcKeyFn
+  calcPoints?: CalcPointsFn
 }
 
 export type SharedRateLimitOpts = {
   name: string
-  calcKey?: (ctx: XRPCReqContext) => string
-  calcPoints?: (ctx: XRPCReqContext) => number
+  calcKey?: CalcKeyFn
+  calcPoints?: CalcPointsFn
 }
 
 export type RouteRateLimitOpts = {
   durationMs: number
   points: number
-  calcKey?: (ctx: XRPCReqContext) => string
-  calcPoints?: (ctx: XRPCReqContext) => number
+  calcKey?: CalcKeyFn
+  calcPoints?: CalcPointsFn
 }
 
 export type HandlerRateLimitOpts = SharedRateLimitOpts | RouteRateLimitOpts
@@ -143,7 +150,12 @@ export type RateLimiterStatus = {
   isFirstInDuration: boolean
 }
 
+export type RouteOpts = {
+  blobLimit?: number
+}
+
 export type XRPCHandlerConfig = {
+  opts?: RouteOpts
   rateLimit?: HandlerRateLimitOpts | HandlerRateLimitOpts[]
   auth?: AuthVerifier
   handler: XRPCHandler

package/src/util.ts

@@ -19,8 +19,8 @@ import {
   handlerSuccess,
   InvalidRequestError,
   InternalServerError,
-  Options,
   XRPCError,
+  RouteOpts,
 } from './types'
 
 export function decodeQueryParams(
@@ -82,7 +82,7 @@ export function validateInput(
   nsid: string,
   def: LexXrpcProcedure | LexXrpcQuery,
   req: express.Request,
-  opts: Options,
+  opts: RouteOpts,
   lexicons: Lexicons,
 ): HandlerInput | undefined {
   // request expectation
@@ -139,7 +139,7 @@ export function validateInput(
   if (req.readableEnded) {
     body = req.body
   } else {
-    body = decodeBodyStream(req, opts.payload?.blobLimit)
+    body = decodeBodyStream(req, opts.blobLimit)
   }
 
   return {

package/tests/bodies.test.ts

@@ -274,9 +274,9 @@ describe('Bodies', () => {
     const resBody = await res.json()
     const status = res.status
     expect(status).toBe(400)
-    expect(resBody.error).toBe('InvalidRequest')
-    expect(resBody.message).toBe(
-      'Request encoding (Content-Type) required but not provided',
-    )
+    expect(resBody).toMatchObject({
+      error: 'InvalidRequest',
+      message: 'Request encoding (Content-Type) required but not provided',
+    })
   })
 })

package/tests/errors.test.ts

@@ -75,7 +75,7 @@ const LEXICONS: LexiconDoc[] = [
   },
 ]
 
-const MISMATCHED_LEXICONS = [
+const MISMATCHED_LEXICONS: LexiconDoc[] = [
   {
     lexicon: 1,
     id: 'io.example.query',

package/tsconfig.build.json

@@ -1,4 +1,8 @@
 {
-  "extends": "./tsconfig.json",
-  "exclude": ["**/*.spec.ts", "**/*.test.ts"]
+  "extends": "../../tsconfig/node.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["./src"]
 }

package/tsconfig.json

@@ -1,15 +1,7 @@
 {
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "./dist", // Your outDir,
-    "emitDeclarationOnly": true
-  },
-  "include": ["./src", "__tests__/**/**.ts"],
+  "include": [],
   "references": [
-    { "path": "../common/tsconfig.build.json" },
-    { "path": "../crypto/tsconfig.build.json" },
-    { "path": "../lexicon/tsconfig.build.json" },
-    { "path": "../xrpc/tsconfig.build.json" }
+    { "path": "./tsconfig.build.json" },
+    { "path": "./tsconfig.tests.json" }
   ]
 }

package/tsconfig.tests.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig/tests.json",
+  "compilerOptions": {
+    "rootDir": "."
+  },
+  "include": ["./tests"]
+}

package/babel.config.js

@@ -1 +0,0 @@
-module.exports = require('../../babel.config.js')

package/build.js

@@ -1,14 +0,0 @@
-const { nodeExternalsPlugin } = require('esbuild-node-externals')
-
-const buildShallow =
-  process.argv.includes('--shallow') || process.env.ATP_BUILD_SHALLOW === 'true'
-
-require('esbuild').build({
-  logLevel: 'info',
-  entryPoints: ['src/index.ts'],
-  bundle: true,
-  sourcemap: true,
-  outdir: 'dist',
-  platform: 'node',
-  plugins: buildShallow ? [nodeExternalsPlugin()] : [],
-})