@atproto/xrpc-server 0.11.5 → 0.11.6

package/tests/subscriptions.test.ts

@@ -1,398 +0,0 @@
-import * as http from 'node:http'
-import { AddressInfo } from 'node:net'
-import { WebSocket, createWebSocketStream } from 'ws'
-import { wait } from '@atproto/common'
-import { LexiconDoc, Lexicons } from '@atproto/lexicon'
-import {
-  ErrorFrame,
-  Frame,
-  MessageFrame,
-  Subscription,
-  byFrame,
-} from '../src/index.js'
-import * as xrpcServer from '../src/index.js'
-import {
-  basicAuthHeaders,
-  buildAddLexicons,
-  buildMethodLexicons,
-  closeServer,
-  createBasicAuth,
-  createServer,
-} from './_util.js'
-
-const LEXICONS = [
-  {
-    lexicon: 1,
-    id: 'io.example.streamOne',
-    defs: {
-      main: {
-        type: 'subscription',
-        parameters: {
-          type: 'params',
-          required: ['countdown'],
-          properties: {
-            countdown: { type: 'integer' },
-          },
-        },
-        message: {
-          schema: { type: 'union', refs: ['#countdownStatus'] },
-        },
-      },
-      countdownStatus: {
-        type: 'object',
-        required: ['count'],
-        properties: { count: { type: 'integer' } },
-      },
-    },
-  },
-  {
-    lexicon: 1,
-    id: 'io.example.streamTwo',
-    defs: {
-      main: {
-        type: 'subscription',
-        parameters: {
-          type: 'params',
-          required: ['countdown'],
-          properties: {
-            countdown: { type: 'integer' },
-          },
-        },
-        message: {
-          schema: {
-            type: 'union',
-            refs: ['#even', '#odd'],
-          },
-        },
-      },
-      even: {
-        type: 'object',
-        required: ['count'],
-        properties: { count: { type: 'integer' } },
-      },
-      odd: {
-        type: 'object',
-        required: ['count'],
-        properties: { count: { type: 'integer' } },
-      },
-    },
-  },
-  {
-    lexicon: 1,
-    id: 'io.example.streamAuth',
-    defs: {
-      main: {
-        type: 'subscription',
-        message: {
-          schema: { type: 'union', refs: ['#auth'] },
-        },
-      },
-      auth: {
-        type: 'object',
-        properties: {
-          credentials: { type: 'ref', ref: '#credentials' },
-          artifacts: { type: 'ref', ref: '#artifacts' },
-        },
-      },
-      credentials: {
-        type: 'object',
-        required: ['username'],
-        properties: {
-          username: { type: 'string' },
-        },
-      },
-      artifacts: {
-        type: 'object',
-        required: ['original'],
-        properties: {
-          original: { type: 'string' },
-        },
-      },
-    },
-  },
-] as const satisfies LexiconDoc[]
-
-const handlers = {
-  'io.example.streamOne': async function* ({
-    params,
-  }: xrpcServer.StreamContext) {
-    const countdown = Number(params.countdown ?? 0)
-    for (let i = countdown; i >= 0; i--) {
-      await wait(0)
-      yield { $type: 'io.example.streamOne#countdownStatus', count: i }
-    }
-  },
-  'io.example.streamTwo': async function* ({
-    params,
-  }: xrpcServer.StreamContext) {
-    const countdown = Number(params.countdown ?? 0)
-    for (let i = countdown; i >= 0; i--) {
-      await wait(200)
-      yield {
-        $type: `io.example.streamTwo${i % 2 === 0 ? '#even' : '#odd'}`,
-        count: i,
-      }
-    }
-    yield {
-      $type: 'io.example.otherNsid#done',
-    }
-  },
-  'io.example.streamAuth': {
-    auth: createBasicAuth({ username: 'admin', password: 'password' }),
-    handler: async function* ({ auth }) {
-      yield { ...auth, $type: 'io.example.streamAuth#auth' }
-    },
-  },
-}
-
-for (const buildServer of [buildMethodLexicons, buildAddLexicons]) {
-  describe(buildServer, () => {
-    // @NOTE we need to clone because "new Lexicons" will mutate the lexicon
-    // definitions
-    const lex = new Lexicons(structuredClone(LEXICONS))
-
-    let server: xrpcServer.Server
-    let s: http.Server
-    let port: number
-    beforeAll(async () => {
-      server = await buildServer(LEXICONS, handlers)
-      s = await createServer(server)
-      port = (s.address() as AddressInfo).port
-    })
-    afterAll(async () => {
-      if (s) await closeServer(s)
-    })
-
-    it('streams messages', async () => {
-      const ws = new WebSocket(
-        `ws://localhost:${port}/xrpc/io.example.streamOne?countdown=5`,
-      )
-
-      const frames: Frame[] = []
-      for await (const frame of byFrame(ws)) {
-        frames.push(frame)
-      }
-
-      expect(frames).toEqual([
-        new MessageFrame({ count: 5 }, { type: '#countdownStatus' }),
-        new MessageFrame({ count: 4 }, { type: '#countdownStatus' }),
-        new MessageFrame({ count: 3 }, { type: '#countdownStatus' }),
-        new MessageFrame({ count: 2 }, { type: '#countdownStatus' }),
-        new MessageFrame({ count: 1 }, { type: '#countdownStatus' }),
-        new MessageFrame({ count: 0 }, { type: '#countdownStatus' }),
-      ])
-    })
-
-    it('streams messages in a union', async () => {
-      const ws = new WebSocket(
-        `ws://localhost:${port}/xrpc/io.example.streamTwo?countdown=5`,
-      )
-
-      const frames: Frame[] = []
-      for await (const frame of byFrame(ws)) {
-        frames.push(frame)
-      }
-
-      expect(frames).toEqual([
-        new MessageFrame({ count: 5 }, { type: '#odd' }),
-        new MessageFrame({ count: 4 }, { type: '#even' }),
-        new MessageFrame({ count: 3 }, { type: '#odd' }),
-        new MessageFrame({ count: 2 }, { type: '#even' }),
-        new MessageFrame({ count: 1 }, { type: '#odd' }),
-        new MessageFrame({ count: 0 }, { type: '#even' }),
-        new MessageFrame({}, { type: 'io.example.otherNsid#done' }),
-      ])
-    })
-
-    it('resolves auth into handler', async () => {
-      const ws = new WebSocket(
-        `ws://localhost:${port}/xrpc/io.example.streamAuth`,
-        {
-          headers: basicAuthHeaders({
-            username: 'admin',
-            password: 'password',
-          }),
-        },
-      )
-
-      const frames: Frame[] = []
-      for await (const frame of byFrame(ws)) {
-        frames.push(frame)
-      }
-
-      expect(frames).toEqual([
-        new MessageFrame(
-          {
-            credentials: {
-              username: 'admin',
-            },
-            artifacts: {
-              original: 'YWRtaW46cGFzc3dvcmQ=',
-            },
-          },
-          {
-            type: '#auth',
-          },
-        ),
-      ])
-    })
-
-    it('errors immediately on bad parameter', async () => {
-      const ws = new WebSocket(
-        `ws://localhost:${port}/xrpc/io.example.streamOne`,
-      )
-
-      const frames: Frame[] = []
-      for await (const frame of byFrame(ws)) {
-        frames.push(frame)
-      }
-
-      expect(frames).toEqual([
-        expect.objectContaining({
-          body: expect.objectContaining({
-            error: 'InvalidRequest',
-            message: expect.stringContaining('countdown'),
-          }),
-        }),
-      ])
-    })
-
-    it('errors immediately on bad auth', async () => {
-      const ws = new WebSocket(
-        `ws://localhost:${port}/xrpc/io.example.streamAuth`,
-        {
-          headers: basicAuthHeaders({
-            username: 'bad',
-            password: 'wrong',
-          }),
-        },
-      )
-
-      const frames: Frame[] = []
-      for await (const frame of byFrame(ws)) {
-        frames.push(frame)
-      }
-
-      expect(frames).toEqual([
-        new ErrorFrame({
-          error: 'AuthenticationRequired',
-          message: 'Authentication Required',
-        }),
-      ])
-    })
-
-    it('does not websocket upgrade at bad endpoint', async () => {
-      const ws = new WebSocket(`ws://localhost:${port}/xrpc/does.not.exist`)
-      const drainStream = async () => {
-        for await (const _bytes of createWebSocketStream(ws)) {
-          // drain
-        }
-      }
-      await expect(drainStream).rejects.toHaveProperty('code', 'ECONNRESET')
-    })
-
-    describe('Subscription consumer', () => {
-      it('receives messages w/ skips', async () => {
-        const sub = new Subscription({
-          service: `ws://localhost:${port}`,
-          method: 'io.example.streamOne',
-          getParams: () => ({ countdown: 5 }),
-          validate: (obj) => {
-            const result = lex.assertValidXrpcMessage<{ count: number }>(
-              'io.example.streamOne',
-              obj,
-            )
-            if (!result.count || result.count % 2) {
-              return result
-            }
-          },
-        })
-
-        const messages: { count: number }[] = []
-        for await (const msg of sub) {
-          messages.push(msg)
-        }
-
-        expect(messages).toEqual([
-          { $type: 'io.example.streamOne#countdownStatus', count: 5 },
-          { $type: 'io.example.streamOne#countdownStatus', count: 3 },
-          { $type: 'io.example.streamOne#countdownStatus', count: 1 },
-          { $type: 'io.example.streamOne#countdownStatus', count: 0 },
-        ])
-      })
-
-      it('reconnects w/ param update', async () => {
-        let countdown = 10
-        let reconnects = 0
-        const sub = new Subscription({
-          service: `ws://localhost:${port}`,
-          method: 'io.example.streamOne',
-          onReconnectError: () => reconnects++,
-          getParams: () => ({ countdown }),
-          validate: (obj) => {
-            return lex.assertValidXrpcMessage<{ count: number }>(
-              'io.example.streamOne',
-              obj,
-            )
-          },
-        })
-
-        let disconnected = false
-        for await (const msg of sub) {
-          expect(msg.count).toBeGreaterThanOrEqual(countdown - 1) // No skips
-          countdown = Math.min(countdown, msg.count) // Only allow forward movement
-          if (msg.count <= 6 && !disconnected) {
-            disconnected = true
-            server.subscriptions.forEach(({ wss }) => {
-              wss.clients.forEach((c) => c.terminate())
-            })
-          }
-        }
-
-        expect(countdown).toEqual(0)
-        expect(reconnects).toBeGreaterThan(0)
-      })
-
-      it('aborts with signal', async () => {
-        const abortController = new AbortController()
-        const sub = new Subscription({
-          service: `ws://localhost:${port}`,
-          method: 'io.example.streamOne',
-          signal: abortController.signal,
-          getParams: () => ({ countdown: 10 }),
-          validate: (obj) => {
-            const result = lex.assertValidXrpcMessage<{ count: number }>(
-              'io.example.streamOne',
-              obj,
-            )
-            return result
-          },
-        })
-
-        let error
-        let disconnected = false
-        const messages: { count: number }[] = []
-        try {
-          for await (const msg of sub) {
-            messages.push(msg)
-            if (msg.count <= 6 && !disconnected) {
-              disconnected = true
-              abortController.abort(new Error('Oops!'))
-            }
-          }
-        } catch (err) {
-          error = err
-        }
-
-        expect(error).toEqual(new Error('Oops!'))
-        expect(messages).toEqual([
-          { $type: 'io.example.streamOne#countdownStatus', count: 10 },
-          { $type: 'io.example.streamOne#countdownStatus', count: 9 },
-          { $type: 'io.example.streamOne#countdownStatus', count: 8 },
-          { $type: 'io.example.streamOne#countdownStatus', count: 7 },
-          { $type: 'io.example.streamOne#countdownStatus', count: 6 },
-        ])
-      })
-    })
-  })
-}

package/tsconfig.build.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../../tsconfig/node.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "./dist",
-  },
-  "include": ["./src"],
-}

package/tsconfig.build.tsbuildinfo

@@ -1 +0,0 @@
-{"version":"7.0.0-dev.20260614.1","root":["./src/auth.ts","./src/errors.ts","./src/index.ts","./src/logger.ts","./src/rate-limiter-http.ts","./src/rate-limiter.ts","./src/server.ts","./src/types.ts","./src/util.ts","./src/stream/frames.ts","./src/stream/index.ts","./src/stream/logger.ts","./src/stream/server.ts","./src/stream/stream.ts","./src/stream/subscription.ts","./src/stream/types.ts"]}

package/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "include": [],
-  "references": [
-    { "path": "./tsconfig.build.json" },
-    { "path": "./tsconfig.tests.json" },
-  ],
-}

package/tsconfig.tests.json

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