@atcute/xrpc-server-deno 0.1.0 → 1.0.0

package/README.md

@@ -1,17 +1,24 @@
 # @atcute/xrpc-server-deno
 
-Deno WebSocket adapter for `@atcute/xrpc-server`.
+Deno WebSocket adapter for [`@atcute/xrpc-server`](../xrpc-server/).
+
+```sh
+deno add npm:@atcute/xrpc-server-deno
+```
+
+see the [subscriptions section](../xrpc-server/#subscriptions) in the main package for usage
+details.
 
 ```ts
 import { XRPCRouter } from '@atcute/xrpc-server';
 import { createDenoWebSocket } from '@atcute/xrpc-server-deno';
 
-import { ComAtprotoSyncSubscribeRepos } from './lexicons/index.ts';
+import { ComExampleSubscribe } from './lexicons/index.ts';
 
 const adapter = createDenoWebSocket();
 const router = new XRPCRouter({ websocket: adapter });
 
-router.addSubscription(ComAtprotoSyncSubscribeRepos.mainSchema, {
+router.addSubscription(ComExampleSubscribe.mainSchema, {
 	async *handler({ params, signal }) {
 		while (!signal.aborted) {
 			yield {

package/dist/index.d.ts

@@ -1,3 +1,9 @@
 import type { WebSocketAdapter } from '@atcute/xrpc-server';
-export declare const createDenoWebSocket: () => WebSocketAdapter;
+export interface CreateDenoWebSocketOptions {
+    /** backpressure high water mark in bytes; defaults to 250 KB. */
+    highWaterMark?: number;
+    /** backpressure low water mark in bytes; defaults to 50 KB. */
+    lowWaterMark?: number;
+}
+export declare const createDenoWebSocket: ({ highWaterMark, lowWaterMark, }?: CreateDenoWebSocketOptions) => WebSocketAdapter;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAuB,MAAM,qBAAqB,CAAC;AAEjF,eAAO,MAAM,mBAAmB,QAAO,gBA2BtC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAuB,MAAM,qBAAqB,CAAC;AAEjF,MAAM,WAAW,0BAA0B;IAC1C,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+DAA+D;IAC/D,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,eAAO,MAAM,mBAAmB,sCAG7B,0BAA0B,KAAQ,gBAyCpC,CAAC"}

package/dist/index.js

@@ -1,13 +1,24 @@
-export const createDenoWebSocket = () => {
+export const createDenoWebSocket = ({ highWaterMark = 250_000, lowWaterMark = 50_000, } = {}) => {
     return {
         async upgrade(request, handler) {
             const { response, socket } = Deno.upgradeWebSocket(request);
             const controller = new AbortController();
+            const signal = controller.signal;
             const connection = {
-                signal: controller.signal,
+                signal: signal,
                 send(data) {
                     socket.send(data);
                 },
+                async drain() {
+                    if (socket.bufferedAmount <= highWaterMark) {
+                        return;
+                    }
+                    while (!signal.aborted &&
+                        socket.readyState === WebSocket.OPEN &&
+                        socket.bufferedAmount > lowWaterMark) {
+                        await sleep(10, signal);
+                    }
+                },
                 close(code, reason) {
                     socket.close(code, reason);
                 },
@@ -22,4 +33,17 @@ export const createDenoWebSocket = () => {
         },
     };
 };
+const sleep = (ms, signal) => {
+    return new Promise((resolve) => {
+        const timer = setTimeout(() => {
+            signal.removeEventListener('abort', onAbort);
+            resolve();
+        }, ms);
+        const onAbort = () => {
+            clearTimeout(timer);
+            resolve();
+        };
+        signal.addEventListener('abort', onAbort, { once: true });
+    });
+};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAqB,EAAE;IACzD,OAAO;QACN,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO;YAC7B,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAE5D,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;YACzC,MAAM,UAAU,GAAwB;gBACvC,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,IAAI,CAAC,IAAgB;oBACpB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACnB,CAAC;gBACD,KAAK,CAAC,IAAa,EAAE,MAAe;oBACnC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAC5B,CAAC;aACD,CAAC;YAEF,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;gBACpB,OAAO,CAAC,UAAU,CAAC,CAAC;YACrB,CAAC,CAAC;YAEF,MAAM,CAAC,OAAO,GAAG,CAAC,EAAE,EAAE,EAAE;gBACvB,UAAU,CAAC,KAAK,CAAC,yCAAyC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;YACtE,CAAC,CAAC;YAEF,OAAO,QAAQ,CAAC;QACjB,CAAC;KACD,CAAC;AACH,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,EACnC,aAAa,GAAG,OAAO,EACvB,YAAY,GAAG,MAAM,GACrB,GAA+B,EAAE,EAAoB,EAAE;IACvD,OAAO;QACN,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO;YAC7B,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAE5D,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;YACzC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACjC,MAAM,UAAU,GAAwB;gBACvC,MAAM,EAAE,MAAM;gBACd,IAAI,CAAC,IAAgB;oBACpB,MAAM,CAAC,IAAI,CAAC,IAA+B,CAAC,CAAC;gBAC9C,CAAC;gBACD,KAAK,CAAC,KAAK;oBACV,IAAI,MAAM,CAAC,cAAc,IAAI,aAAa,EAAE,CAAC;wBAC5C,OAAO;oBACR,CAAC;oBAED,OACC,CAAC,MAAM,CAAC,OAAO;wBACf,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI;wBACpC,MAAM,CAAC,cAAc,GAAG,YAAY,EACnC,CAAC;wBACF,MAAM,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;oBACzB,CAAC;gBACF,CAAC;gBACD,KAAK,CAAC,IAAa,EAAE,MAAe;oBACnC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAC5B,CAAC;aACD,CAAC;YAEF,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;gBACpB,OAAO,CAAC,UAAU,CAAC,CAAC;YACrB,CAAC,CAAC;YAEF,MAAM,CAAC,OAAO,GAAG,CAAC,EAAE,EAAE,EAAE;gBACvB,UAAU,CAAC,KAAK,CAAC,yCAAyC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;YACtE,CAAC,CAAC;YAEF,OAAO,QAAQ,CAAC;QACjB,CAAC;KACD,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,MAAmB,EAAiB,EAAE;IAChE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC9B,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC7B,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7C,OAAO,EAAE,CAAC;QACX,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,OAAO,GAAG,GAAG,EAAE;YACpB,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,EAAE,CAAC;QACX,CAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/lib/index.ts

@@ -1,15 +1,39 @@
 import type { WebSocketAdapter, WebSocketConnection } from '@atcute/xrpc-server';
 
-export const createDenoWebSocket = (): WebSocketAdapter => {
+export interface CreateDenoWebSocketOptions {
+	/** backpressure high water mark in bytes; defaults to 250 KB. */
+	highWaterMark?: number;
+	/** backpressure low water mark in bytes; defaults to 50 KB. */
+	lowWaterMark?: number;
+}
+
+export const createDenoWebSocket = ({
+	highWaterMark = 250_000,
+	lowWaterMark = 50_000,
+}: CreateDenoWebSocketOptions = {}): WebSocketAdapter => {
 	return {
 		async upgrade(request, handler) {
 			const { response, socket } = Deno.upgradeWebSocket(request);
 
 			const controller = new AbortController();
+			const signal = controller.signal;
 			const connection: WebSocketConnection = {
-				signal: controller.signal,
+				signal: signal,
 				send(data: Uint8Array) {
-					socket.send(data);
+					socket.send(data as Uint8Array<ArrayBuffer>);
+				},
+				async drain() {
+					if (socket.bufferedAmount <= highWaterMark) {
+						return;
+					}
+
+					while (
+						!signal.aborted &&
+						socket.readyState === WebSocket.OPEN &&
+						socket.bufferedAmount > lowWaterMark
+					) {
+						await sleep(10, signal);
+					}
 				},
 				close(code?: number, reason?: string) {
 					socket.close(code, reason);
@@ -28,3 +52,19 @@ export const createDenoWebSocket = (): WebSocketAdapter => {
 		},
 	};
 };
+
+const sleep = (ms: number, signal: AbortSignal): Promise<void> => {
+	return new Promise((resolve) => {
+		const timer = setTimeout(() => {
+			signal.removeEventListener('abort', onAbort);
+			resolve();
+		}, ms);
+
+		const onAbort = () => {
+			clearTimeout(timer);
+			resolve();
+		};
+
+		signal.addEventListener('abort', onAbort, { once: true });
+	});
+};

package/package.json

@@ -1,7 +1,6 @@
 {
-  "type": "module",
   "name": "@atcute/xrpc-server-deno",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Deno WebSocket adapter for @atcute/xrpc-server",
   "license": "0BSD",
   "repository": {
@@ -12,19 +11,24 @@
     "dist/",
     "lib/",
     "!lib/**/*.bench.ts",
-    "!lib/**/*.test.ts"
+    "!lib/**/*.test.ts",
+    "!dist/**/*.{test,bench}.*"
   ],
+  "type": "module",
   "exports": {
     ".": "./dist/index.js"
   },
-  "peerDependencies": {
-    "@atcute/xrpc-server": "^0.1.3"
+  "publishConfig": {
+    "access": "public"
   },
   "devDependencies": {
     "@types/deno": "^2.5.0"
   },
+  "peerDependencies": {
+    "@atcute/xrpc-server": "^1.0.0"
+  },
   "scripts": {
-    "build": "tsc --project tsconfig.build.json",
+    "build": "tsgo",
     "prepublish": "rm -rf dist; pnpm run build"
   }
 }