@atproto/bsync 0.0.3 → 0.0.5

package/dist/routes/scan-notif-operations.d.ts

@@ -0,0 +1,6 @@
+import { ServiceImpl } from '@connectrpc/connect';
+import { Service } from '../proto/bsync_connect';
+import AppContext from '../context';
+declare const _default: (ctx: AppContext) => Partial<ServiceImpl<typeof Service>>;
+export default _default;
+//# sourceMappingURL=scan-notif-operations.d.ts.map

package/dist/routes/scan-notif-operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scan-notif-operations.d.ts","sourceRoot":"","sources":["../../src/routes/scan-notif-operations.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAEhD,OAAO,UAAU,MAAM,YAAY,CAAA;8BAKd,UAAU,KAAG,QAAQ,YAAY,cAAc,CAAC,CAAC;AAAtE,wBAsDE"}

package/dist/routes/scan-notif-operations.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_events_1 = require("node:events");
+const bsync_pb_1 = require("../proto/bsync_pb");
+const auth_1 = require("./auth");
+const util_1 = require("./util");
+const notif_op_1 = require("../db/schema/notif_op");
+exports.default = (ctx) => ({
+    async scanNotifOperations(req, handlerCtx) {
+        (0, auth_1.authWithApiKey)(ctx, handlerCtx);
+        const { db, events } = ctx;
+        const limit = req.limit || 1000;
+        const cursor = (0, util_1.validCursor)(req.cursor);
+        const nextNotifOpPromise = (0, node_events_1.once)(events, notif_op_1.createNotifOpChannel, {
+            signal: (0, util_1.combineSignals)(ctx.shutdown, AbortSignal.timeout(ctx.cfg.service.longPollTimeoutMs)),
+        });
+        nextNotifOpPromise.catch(() => null); // ensure timeout is always handled
+        const nextNotifOpPageQb = db.db
+            .selectFrom('notif_op')
+            .selectAll()
+            .where('id', '>', cursor ?? -1)
+            .orderBy('id', 'asc')
+            .limit(limit);
+        let ops = await nextNotifOpPageQb.execute();
+        if (!ops.length) {
+            // if there were no ops on the page, wait for an event then try again.
+            try {
+                await nextNotifOpPromise;
+            }
+            catch (err) {
+                ctx.shutdown.throwIfAborted();
+                return new bsync_pb_1.ScanNotifOperationsResponse({
+                    operations: [],
+                    cursor: req.cursor,
+                });
+            }
+            ops = await nextNotifOpPageQb.execute();
+            if (!ops.length) {
+                return new bsync_pb_1.ScanNotifOperationsResponse({
+                    operations: [],
+                    cursor: req.cursor,
+                });
+            }
+        }
+        const lastOp = ops[ops.length - 1];
+        return new bsync_pb_1.ScanNotifOperationsResponse({
+            operations: ops.map((op) => ({
+                id: op.id.toString(),
+                actorDid: op.actorDid,
+                priority: op.priority ?? undefined,
+            })),
+            cursor: lastOp.id.toString(),
+        });
+    },
+});
+//# sourceMappingURL=scan-notif-operations.js.map

package/dist/routes/scan-notif-operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scan-notif-operations.js","sourceRoot":"","sources":["../../src/routes/scan-notif-operations.ts"],"names":[],"mappings":";;AAAA,6CAAkC;AAGlC,gDAA+D;AAE/D,iCAAuC;AACvC,iCAAoD;AACpD,oDAA4D;AAE5D,kBAAe,CAAC,GAAe,EAAwC,EAAE,CAAC,CAAC;IACzE,KAAK,CAAC,mBAAmB,CAAC,GAAG,EAAE,UAAU;QACvC,IAAA,qBAAc,EAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QAC/B,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,GAAG,CAAA;QAC1B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,IAAI,IAAI,CAAA;QAC/B,MAAM,MAAM,GAAG,IAAA,kBAAW,EAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QACtC,MAAM,kBAAkB,GAAG,IAAA,kBAAI,EAAC,MAAM,EAAE,+BAAoB,EAAE;YAC5D,MAAM,EAAE,IAAA,qBAAc,EACpB,GAAG,CAAC,QAAQ,EACZ,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CACvD;SACF,CAAC,CAAA;QACF,kBAAkB,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA,CAAC,mCAAmC;QAExE,MAAM,iBAAiB,GAAG,EAAE,CAAC,EAAE;aAC5B,UAAU,CAAC,UAAU,CAAC;aACtB,SAAS,EAAE;aACX,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC;aAC9B,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;aACpB,KAAK,CAAC,KAAK,CAAC,CAAA;QAEf,IAAI,GAAG,GAAG,MAAM,iBAAiB,CAAC,OAAO,EAAE,CAAA;QAE3C,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YAChB,sEAAsE;YACtE,IAAI,CAAC;gBACH,MAAM,kBAAkB,CAAA;YAC1B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,GAAG,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAA;gBAC7B,OAAO,IAAI,sCAA2B,CAAC;oBACrC,UAAU,EAAE,EAAE;oBACd,MAAM,EAAE,GAAG,CAAC,MAAM;iBACnB,CAAC,CAAA;YACJ,CAAC;YACD,GAAG,GAAG,MAAM,iBAAiB,CAAC,OAAO,EAAE,CAAA;YACvC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;gBAChB,OAAO,IAAI,sCAA2B,CAAC;oBACrC,UAAU,EAAE,EAAE;oBACd,MAAM,EAAE,GAAG,CAAC,MAAM;iBACnB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAElC,OAAO,IAAI,sCAA2B,CAAC;YACrC,UAAU,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC3B,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACpB,QAAQ,EAAE,EAAE,CAAC,QAAQ;gBACrB,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,SAAS;aACnC,CAAC,CAAC;YACH,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE;SAC7B,CAAC,CAAA;IACJ,CAAC;CACF,CAAC,CAAA"}

package/dist/routes/util.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+export declare const validCursor: (cursor: string) => number | null;
+export declare const combineSignals: (a: AbortSignal, b: AbortSignal) => AbortSignal;
+export declare const isValidDid: (did: string) => boolean;
+export declare const isValidAtUri: (uri: string) => boolean;
+//# sourceMappingURL=util.d.ts.map

package/dist/routes/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/routes/util.ts"],"names":[],"mappings":";AAOA,eAAO,MAAM,WAAW,WAAY,MAAM,KAAG,MAAM,GAAG,IAOrD,CAAA;AAED,eAAO,MAAM,cAAc,MAAO,WAAW,KAAK,WAAW,gBAa5D,CAAA;AAED,eAAO,MAAM,UAAU,QAAS,MAAM,YAUrC,CAAA;AAED,eAAO,MAAM,YAAY,QAAS,MAAM,YAOvC,CAAA"}

package/dist/routes/util.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidAtUri = exports.isValidDid = exports.combineSignals = exports.validCursor = void 0;
+const connect_1 = require("@connectrpc/connect");
+const syntax_1 = require("@atproto/syntax");
+const validCursor = (cursor) => {
+    if (cursor === '')
+        return null;
+    const int = parseInt(cursor, 10);
+    if (isNaN(int) || int < 0) {
+        throw new connect_1.ConnectError('invalid cursor', connect_1.Code.InvalidArgument);
+    }
+    return int;
+};
+exports.validCursor = validCursor;
+const combineSignals = (a, b) => {
+    const controller = new AbortController();
+    for (const signal of [a, b]) {
+        if (signal.aborted) {
+            controller.abort();
+            return signal;
+        }
+        signal.addEventListener('abort', () => controller.abort(signal.reason), {
+            // @ts-ignore https://github.com/DefinitelyTyped/DefinitelyTyped/pull/68625
+            signal: controller.signal,
+        });
+    }
+    return controller.signal;
+};
+exports.combineSignals = combineSignals;
+const isValidDid = (did) => {
+    try {
+        (0, syntax_1.ensureValidDid)(did);
+        return true;
+    }
+    catch (err) {
+        if (err instanceof syntax_1.InvalidDidError) {
+            return false;
+        }
+        throw err;
+    }
+};
+exports.isValidDid = isValidDid;
+const isValidAtUri = (uri) => {
+    try {
+        (0, syntax_1.ensureValidAtUri)(uri);
+        return true;
+    }
+    catch {
+        return false;
+    }
+};
+exports.isValidAtUri = isValidAtUri;
+//# sourceMappingURL=util.js.map

package/dist/routes/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/routes/util.ts"],"names":[],"mappings":";;;AAAA,iDAAwD;AACxD,4CAIwB;AAEjB,MAAM,WAAW,GAAG,CAAC,MAAc,EAAiB,EAAE;IAC3D,IAAI,MAAM,KAAK,EAAE;QAAE,OAAO,IAAI,CAAA;IAC9B,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IAChC,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,sBAAY,CAAC,gBAAgB,EAAE,cAAI,CAAC,eAAe,CAAC,CAAA;IAChE,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAPY,QAAA,WAAW,eAOvB;AAEM,MAAM,cAAc,GAAG,CAAC,CAAc,EAAE,CAAc,EAAE,EAAE;IAC/D,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;IACxC,KAAK,MAAM,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QAC5B,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,UAAU,CAAC,KAAK,EAAE,CAAA;YAClB,OAAO,MAAM,CAAA;QACf,CAAC;QACD,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YACtE,2EAA2E;YAC3E,MAAM,EAAE,UAAU,CAAC,MAAM;SAC1B,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,UAAU,CAAC,MAAM,CAAA;AAC1B,CAAC,CAAA;AAbY,QAAA,cAAc,kBAa1B;AAEM,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,EAAE;IACxC,IAAI,CAAC;QACH,IAAA,uBAAc,EAAC,GAAG,CAAC,CAAA;QACnB,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,wBAAe,EAAE,CAAC;YACnC,OAAO,KAAK,CAAA;QACd,CAAC;QACD,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC,CAAA;AAVY,QAAA,UAAU,cAUtB;AAEM,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,EAAE;IAC1C,IAAI,CAAC;QACH,IAAA,yBAAgB,EAAC,GAAG,CAAC,CAAA;QACrB,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA;AAPY,QAAA,YAAY,gBAOxB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/bsync",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "license": "MIT",
   "description": "Sychronizing service for app.bsky App View (Bluesky API)",
   "keywords": [
@@ -24,7 +24,7 @@
     "pg": "^8.10.0",
     "pino-http": "^8.2.1",
     "typed-emitter": "^2.1.0",
-    "@atproto/common": "^0.4.0",
+    "@atproto/common": "^0.4.1",
     "@atproto/syntax": "^0.3.0"
   },
   "devDependencies": {
@@ -32,6 +32,7 @@
     "@bufbuild/protoc-gen-es": "^1.5.0",
     "@connectrpc/protoc-gen-connect-es": "^1.1.4",
     "@types/pg": "^8.6.6",
+    "get-port": "^5.1.1",
     "jest": "^28.1.2",
     "ts-node": "^10.8.2"
   },

package/proto/bsync.proto

@@ -41,6 +41,33 @@ message ScanMuteOperationsResponse {
   string cursor = 2;
 }
 
+message NotifOperation {
+  string id = 1;
+  string actor_did = 2;
+  optional bool priority = 3;
+}
+
+message AddNotifOperationRequest {
+  string actor_did = 1;
+  optional bool priority = 2;
+}
+
+message AddNotifOperationResponse {
+  NotifOperation operation = 1;
+}
+
+message ScanNotifOperationsRequest {
+  string cursor = 1;
+  int32 limit = 2;
+}
+
+message ScanNotifOperationsResponse {
+  repeated NotifOperation operations = 1;
+  string cursor = 2;
+}
+
+
+
 // Ping
 message PingRequest {}
 message PingResponse {}
@@ -50,6 +77,8 @@ service Service {
   // Sync
   rpc AddMuteOperation(AddMuteOperationRequest) returns (AddMuteOperationResponse);
   rpc ScanMuteOperations(ScanMuteOperationsRequest) returns (ScanMuteOperationsResponse);
+  rpc AddNotifOperation(AddNotifOperationRequest) returns (AddNotifOperationResponse);
+  rpc ScanNotifOperations(ScanNotifOperationsRequest) returns (ScanNotifOperationsResponse);
   // Ping
   rpc Ping(PingRequest) returns (PingResponse);
 }

package/src/context.ts

@@ -2,6 +2,7 @@ import TypedEventEmitter from 'typed-emitter'
 import { ServerConfig } from './config'
 import Database from './db'
 import { createMuteOpChannel } from './db/schema/mute_op'
+import { createNotifOpChannel } from './db/schema/notif_op'
 import { EventEmitter } from 'stream'
 
 export type AppContextOptions = {
@@ -43,4 +44,5 @@ export default AppContext
 
 export type AppEvents = {
   [createMuteOpChannel]: () => void
+  [createNotifOpChannel]: () => void
 }

package/src/db/migrations/20240717T224303472Z-notif-ops.ts

@@ -0,0 +1,24 @@
+import { Kysely, sql } from 'kysely'
+
+export async function up(db: Kysely<unknown>): Promise<void> {
+  await db.schema
+    .createTable('notif_op')
+    .addColumn('id', 'bigserial', (col) => col.primaryKey())
+    .addColumn('actorDid', 'varchar', (col) => col.notNull())
+    .addColumn('priority', 'boolean')
+    .addColumn('createdAt', 'timestamptz', (col) =>
+      col.notNull().defaultTo(sql`CURRENT_TIMESTAMP`),
+    )
+    .execute()
+  await db.schema
+    .createTable('notif_item')
+    .addColumn('actorDid', 'varchar', (col) => col.primaryKey())
+    .addColumn('priority', 'boolean', (col) => col.notNull())
+    .addColumn('fromId', 'bigint', (col) => col.notNull())
+    .execute()
+}
+
+export async function down(db: Kysely<unknown>): Promise<void> {
+  await db.schema.dropTable('notif_item').execute()
+  await db.schema.dropTable('notif_op').execute()
+}

package/src/db/migrations/index.ts

@@ -3,3 +3,4 @@
 // this with kysely's FileMigrationProvider, but it doesn't play nicely with the build process.
 
 export * as _20240108T220751294Z from './20240108T220751294Z-init'
+export * as _20240717T224303472Z from './20240717T224303472Z-notif-ops'

package/src/db/schema/index.ts

@@ -1,8 +1,13 @@
 import { Kysely } from 'kysely'
 import * as muteOp from './mute_op'
 import * as muteItem from './mute_item'
+import * as notifOp from './notif_op'
+import * as notifItem from './notif_item'
 
-export type DatabaseSchemaType = muteItem.PartialDB & muteOp.PartialDB
+export type DatabaseSchemaType = muteItem.PartialDB &
+  muteOp.PartialDB &
+  notifItem.PartialDB &
+  notifOp.PartialDB
 
 export type DatabaseSchema = Kysely<DatabaseSchemaType>
 

package/src/db/schema/notif_item.ts

@@ -0,0 +1,13 @@
+import { Selectable } from 'kysely'
+
+export interface NotifItem {
+  actorDid: string
+  priority: boolean
+  fromId: number
+}
+
+export type NotifItemEntry = Selectable<NotifItem>
+
+export const tableName = 'notif_item'
+
+export type PartialDB = { [tableName]: NotifItem }

package/src/db/schema/notif_op.ts

@@ -0,0 +1,16 @@
+import { GeneratedAlways, Selectable } from 'kysely'
+
+export interface NotifOp {
+  id: GeneratedAlways<number>
+  actorDid: string
+  priority: boolean | null
+  createdAt: GeneratedAlways<Date>
+}
+
+export type NotifOpEntry = Selectable<NotifOp>
+
+export const tableName = 'notif_op'
+
+export type PartialDB = { [tableName]: NotifOp }
+
+export const createNotifOpChannel = 'notif_op_create' // used with listen/notify

package/src/index.ts

@@ -7,6 +7,7 @@ import AppContext, { AppContextOptions } from './context'
 import { ServerConfig } from './config'
 import routes from './routes'
 import { createMuteOpChannel } from './db/schema/mute_op'
+import { createNotifOpChannel } from './db/schema/notif_op'
 
 export * from './config'
 export * from './client'
@@ -88,10 +89,15 @@ export class BsyncService {
     this.ac.signal.addEventListener('abort', () => conn.release(), {
       once: true,
     })
-    conn.query(`listen ${createMuteOpChannel}`) // if this errors, unhandled rejection should cause process to exit
+    // if these error, unhandled rejection should cause process to exit
+    conn.query(`listen ${createMuteOpChannel}`)
+    conn.query(`listen ${createNotifOpChannel}`)
     conn.on('notification', (notif) => {
       if (notif.channel === createMuteOpChannel) {
-        this.ctx.events.emit('mute_op_create')
+        this.ctx.events.emit(createMuteOpChannel)
+      }
+      if (notif.channel === createNotifOpChannel) {
+        this.ctx.events.emit(createNotifOpChannel)
       }
     })
   }

package/src/logger.ts

@@ -1,5 +1,6 @@
-import pinoHttp from 'pino-http'
-import { subsystemLogger } from '@atproto/common'
+import { type IncomingMessage } from 'node:http'
+import pinoHttp, { stdSerializers } from 'pino-http'
+import { obfuscateHeaders, subsystemLogger } from '@atproto/common'
 
 export const dbLogger: ReturnType<typeof subsystemLogger> =
   subsystemLogger('bsync:db')
@@ -12,11 +13,14 @@ export const loggerMiddleware = pinoHttp({
     paths: ['req.headers.authorization'],
   },
   serializers: {
-    err: (err) => {
-      return {
-        code: err?.code,
-        message: err?.message,
-      }
+    err: (err: unknown) => ({
+      code: err?.['code'],
+      message: err?.['message'],
+    }),
+    req: (req: IncomingMessage) => {
+      const serialized = stdSerializers.req(req)
+      const headers = obfuscateHeaders(serialized.headers)
+      return { ...serialized, headers }
     },
   },
 })

package/src/proto/bsync_connect.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-connect-es v1.3.0 with parameter "target=ts,import_extension=.ts"
+// @generated by protoc-gen-connect-es v1.3.0 with parameter "target=ts,import_extension="
 // @generated from file bsync.proto (package bsync, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck
@@ -6,10 +6,14 @@
 import {
   AddMuteOperationRequest,
   AddMuteOperationResponse,
+  AddNotifOperationRequest,
+  AddNotifOperationResponse,
   PingRequest,
   PingResponse,
   ScanMuteOperationsRequest,
   ScanMuteOperationsResponse,
+  ScanNotifOperationsRequest,
+  ScanNotifOperationsResponse,
 } from './bsync_pb'
 import { MethodKind } from '@bufbuild/protobuf'
 
@@ -39,6 +43,24 @@ export const Service = {
       O: ScanMuteOperationsResponse,
       kind: MethodKind.Unary,
     },
+    /**
+     * @generated from rpc bsync.Service.AddNotifOperation
+     */
+    addNotifOperation: {
+      name: 'AddNotifOperation',
+      I: AddNotifOperationRequest,
+      O: AddNotifOperationResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc bsync.Service.ScanNotifOperations
+     */
+    scanNotifOperations: {
+      name: 'ScanNotifOperations',
+      I: ScanNotifOperationsRequest,
+      O: ScanNotifOperationsResponse,
+      kind: MethodKind.Unary,
+    },
     /**
      * Ping
      *