@atproto/bsync 0.0.18 → 0.0.20

package/tests/operations.test.ts

@@ -0,0 +1,295 @@
+import assert from 'node:assert'
+import { Code, ConnectError } from '@connectrpc/connect'
+import getPort from 'get-port'
+import { wait } from '@atproto/common'
+import {
+  BsyncClient,
+  BsyncService,
+  Database,
+  authWithApiKey,
+  createClient,
+  envToCfg,
+} from '../src'
+import { Method, Operation } from '../src/proto/bsync_pb'
+
+describe('operations', () => {
+  let bsync: BsyncService
+  let client: BsyncClient
+
+  beforeAll(async () => {
+    bsync = await BsyncService.create(
+      envToCfg({
+        port: await getPort(),
+        dbUrl: process.env.DB_POSTGRES_URL,
+        dbSchema: 'bsync_operations',
+        apiKeys: ['key-1'],
+        longPollTimeoutMs: 500,
+      }),
+    )
+    await bsync.ctx.db.migrateToLatestOrThrow()
+    await bsync.start()
+    client = createClient({
+      httpVersion: '1.1',
+      baseUrl: `http://localhost:${bsync.ctx.cfg.service.port}`,
+      interceptors: [authWithApiKey('key-1')],
+    })
+  })
+
+  afterAll(async () => {
+    await bsync.destroy()
+  })
+
+  beforeEach(async () => {
+    await clearOps(bsync.ctx.db)
+  })
+
+  describe('putOperation', () => {
+    it('requires auth.', async () => {
+      // unauthed
+      const unauthedClient = createClient({
+        httpVersion: '1.1',
+        baseUrl: `http://localhost:${bsync.ctx.cfg.service.port}`,
+      })
+      const tryPutOperation1 = unauthedClient.putOperation({
+        collection: 'app.bsky.some.col',
+        actorDid: 'did:example:a',
+        rkey: 'rkey1',
+        method: Method.CREATE,
+        payload: Buffer.from([1, 2, 3]),
+      })
+      await expect(tryPutOperation1).rejects.toEqual(
+        new ConnectError('missing auth', Code.Unauthenticated),
+      )
+      // bad auth
+      const badauthedClient = createClient({
+        httpVersion: '1.1',
+        baseUrl: `http://localhost:${bsync.ctx.cfg.service.port}`,
+        interceptors: [authWithApiKey('key-bad')],
+      })
+      const tryPutOperation2 = badauthedClient.putOperation({
+        collection: 'app.bsky.some.col',
+        actorDid: 'did:example:a',
+        rkey: 'rkey1',
+        method: Method.CREATE,
+        payload: Buffer.from([1, 2, 3]),
+      })
+      await expect(tryPutOperation2).rejects.toEqual(
+        new ConnectError('invalid api key', Code.Unauthenticated),
+      )
+    })
+
+    it('fails on bad inputs.', async () => {
+      await expect(
+        client.putOperation({
+          collection: 'bad-collection',
+          actorDid: 'did:example:a',
+          rkey: 'rkey1',
+          method: Method.CREATE,
+          payload: Buffer.from([]),
+        }),
+      ).rejects.toEqual(
+        new ConnectError(
+          'operation collection is invalid NSID',
+          Code.InvalidArgument,
+        ),
+      )
+      await expect(
+        client.putOperation({
+          collection: 'app.bsky.some.col',
+          actorDid: 'bad-did',
+          rkey: 'rkey1',
+          method: Method.CREATE,
+          payload: Buffer.from([]),
+        }),
+      ).rejects.toEqual(
+        new ConnectError(
+          'operation actor_did is invalid DID',
+          Code.InvalidArgument,
+        ),
+      )
+      await expect(
+        client.putOperation({
+          collection: 'app.bsky.some.col',
+          actorDid: 'did:example:a',
+          rkey: '',
+          method: Method.CREATE,
+          payload: Buffer.from([]),
+        }),
+      ).rejects.toEqual(
+        new ConnectError('operation rkey is required', Code.InvalidArgument),
+      )
+      await expect(
+        client.putOperation({
+          collection: 'app.bsky.some.col',
+          actorDid: 'did:example:a',
+          rkey: 'rkey1',
+          method: Method.UNSPECIFIED,
+          payload: Buffer.from([]),
+        }),
+      ).rejects.toEqual(
+        new ConnectError('operation method is invalid', Code.InvalidArgument),
+      )
+      await expect(
+        client.putOperation({
+          collection: 'app.bsky.some.col',
+          actorDid: 'did:example:a',
+          rkey: 'rkey1',
+          method: Method.DELETE,
+          payload: Buffer.from([1, 2, 3]),
+        }),
+      ).rejects.toEqual(
+        new ConnectError(
+          'cannot specify a payload when method is DELETE',
+          Code.InvalidArgument,
+        ),
+      )
+    })
+
+    it('puts operations.', async () => {
+      const res1 = await client.putOperation({
+        collection: 'app.bsky.some.col',
+        actorDid: 'did:example:a',
+        rkey: 'rkey1',
+        method: Method.CREATE,
+        payload: Buffer.from([1, 2, 3]),
+      })
+      const res2 = await client.putOperation({
+        collection: 'app.bsky.some.col',
+        actorDid: 'did:example:a',
+        rkey: 'rkey1',
+        method: Method.UPDATE,
+        payload: Buffer.from([4, 5, 6]),
+      })
+
+      expect(res1.operation?.id).toBe('1')
+      expect(res2.operation?.id).toBe('2')
+      expect(await dumpOps(bsync.ctx.db)).toStrictEqual([
+        {
+          id: 1,
+          collection: 'app.bsky.some.col',
+          actorDid: 'did:example:a',
+          rkey: 'rkey1',
+          method: Method.CREATE,
+          payload: Buffer.from([1, 2, 3]),
+          createdAt: expect.any(Date),
+        },
+        {
+          id: 2,
+          collection: 'app.bsky.some.col',
+          actorDid: 'did:example:a',
+          rkey: 'rkey1',
+          method: Method.UPDATE,
+          payload: Buffer.from([4, 5, 6]),
+          createdAt: expect.any(Date),
+        },
+      ])
+    })
+
+    it('returns the operations on creation.', async () => {
+      const res = await client.putOperation({
+        collection: 'app.bsky.some.col',
+        actorDid: 'did:example:a',
+        rkey: 'rkey1',
+        method: Method.CREATE,
+        payload: Buffer.from([1, 2, 3]),
+      })
+
+      const op = res.operation
+      assert(op)
+      // Compare each field individually to avoid custom serialization by proto response objects.
+      expect(op.id).toBe('3')
+      expect(op.collection).toBe('app.bsky.some.col')
+      expect(op.actorDid).toBe('did:example:a')
+      expect(op.rkey).toBe('rkey1')
+      expect(op.method).toBe(Method.CREATE)
+      expect(op.payload).toEqual(Uint8Array.from([1, 2, 3]))
+    })
+  })
+
+  describe('scanOperations', () => {
+    it('requires auth.', async () => {
+      // unauthed
+      const unauthedClient = createClient({
+        httpVersion: '1.1',
+        baseUrl: `http://localhost:${bsync.ctx.cfg.service.port}`,
+      })
+      const tryScanOperations1 = unauthedClient.scanOperations({})
+      await expect(tryScanOperations1).rejects.toEqual(
+        new ConnectError('missing auth', Code.Unauthenticated),
+      )
+      // bad auth
+      const badauthedClient = createClient({
+        httpVersion: '1.1',
+        baseUrl: `http://localhost:${bsync.ctx.cfg.service.port}`,
+        interceptors: [authWithApiKey('key-bad')],
+      })
+      const tryScanOperations2 = badauthedClient.scanOperations({})
+      await expect(tryScanOperations2).rejects.toEqual(
+        new ConnectError('invalid api key', Code.Unauthenticated),
+      )
+    })
+
+    it('pages over created ops.', async () => {
+      // add 100 ops
+      for (let i = 0; i < 100; ++i) {
+        await client.putOperation({
+          collection: 'app.bsky.some.col',
+          actorDid: `did:example:${i}`,
+          rkey: 'rkey1',
+          method: Method.CREATE,
+          payload: Buffer.from([1, 2, 3]),
+        })
+      }
+
+      let cursor: string | undefined
+      const operations: Operation[] = []
+      do {
+        const res = await client.scanOperations({
+          cursor,
+          limit: 30,
+        })
+        operations.push(...res.operations)
+        cursor = res.operations.length ? res.cursor : undefined
+      } while (cursor)
+
+      expect(operations.length).toEqual(100)
+      const operationIds = operations.map((op) => parseInt(op.id, 10))
+      const ascending = (a: number, b: number) => a - b
+      expect(operationIds).toEqual([...operationIds].sort(ascending))
+    })
+
+    it('supports long-poll, finding an operation.', async () => {
+      const scanPromise = client.scanOperations({})
+      await wait(100) // would be complete by now if it wasn't long-polling for an item
+      const { operation } = await client.putOperation({
+        collection: 'app.bsky.some.col',
+        actorDid: 'did:example:a',
+        rkey: 'rkey1',
+        method: Method.CREATE,
+        payload: Buffer.from([1, 2, 3]),
+      })
+      const res = await scanPromise
+      expect(res.operations.length).toEqual(1)
+      expect(res.operations[0]).toEqual(operation)
+      expect(res.cursor).toEqual(operation?.id)
+    })
+
+    it('supports long-poll, not finding an operation.', async () => {
+      const res = await client.scanOperations({})
+      expect(res.cursor).toEqual('')
+      expect(res.operations).toEqual([])
+    })
+  })
+})
+
+const dumpOps = async (db: Database) => {
+  return db.db
+    .selectFrom('operation')
+    .selectAll()
+    .orderBy('id', 'asc')
+    .execute()
+}
+
+const clearOps = async (db: Database) => {
+  await db.db.deleteFrom('operation').execute()
+}

package/tsconfig.build.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/client.ts","./src/config.ts","./src/context.ts","./src/index.ts","./src/logger.ts","./src/db/index.ts","./src/db/types.ts","./src/db/migrations/20240108T220751294Z-init.ts","./src/db/migrations/20240717T224303472Z-notif-ops.ts","./src/db/migrations/index.ts","./src/db/migrations/provider.ts","./src/db/schema/index.ts","./src/db/schema/mute_item.ts","./src/db/schema/mute_op.ts","./src/db/schema/notif_item.ts","./src/db/schema/notif_op.ts","./src/proto/bsync_connect.ts","./src/proto/bsync_pb.ts","./src/routes/add-mute-operation.ts","./src/routes/add-notif-operation.ts","./src/routes/auth.ts","./src/routes/index.ts","./src/routes/scan-mute-operations.ts","./src/routes/scan-notif-operations.ts","./src/routes/util.ts"],"version":"5.6.3"}
+{"root":["./src/client.ts","./src/config.ts","./src/context.ts","./src/index.ts","./src/logger.ts","./src/db/index.ts","./src/db/types.ts","./src/db/migrations/20240108T220751294Z-init.ts","./src/db/migrations/20240717T224303472Z-notif-ops.ts","./src/db/migrations/20250527T022203400Z-add-operation.ts","./src/db/migrations/index.ts","./src/db/migrations/provider.ts","./src/db/schema/index.ts","./src/db/schema/mute_item.ts","./src/db/schema/mute_op.ts","./src/db/schema/notif_item.ts","./src/db/schema/notif_op.ts","./src/db/schema/operation.ts","./src/proto/bsync_connect.ts","./src/proto/bsync_pb.ts","./src/routes/add-mute-operation.ts","./src/routes/add-notif-operation.ts","./src/routes/auth.ts","./src/routes/index.ts","./src/routes/put-operation.ts","./src/routes/scan-mute-operations.ts","./src/routes/scan-notif-operations.ts","./src/routes/scan-operations.ts","./src/routes/util.ts"],"version":"5.8.2"}

package/tsconfig.tests.tsbuildinfo

@@ -1 +1 @@
-{"root":["./tests/mutes.test.ts","./tests/notifications.test.ts"],"version":"5.6.3"}
+{"root":["./tests/mutes.test.ts","./tests/notifications.test.ts","./tests/operations.test.ts"],"version":"5.8.2"}