cojson-transport-ws 0.7.14

package/.eslintrc.cjs

@@ -0,0 +1,24 @@
+module.exports = {
+    extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:require-extensions/recommended",
+        "prettier"
+    ],
+    parser: "@typescript-eslint/parser",
+    plugins: ["@typescript-eslint", "require-extensions"],
+    parserOptions: {
+        project: "./tsconfig.json",
+        tsconfigRootDir: __dirname,
+    },
+    ignorePatterns: [".eslint.cjs"],
+    root: true,
+    rules: {
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": [
+            "error",
+            { argsIgnorePattern: "^_", varsIgnorePattern: "^_" },
+        ],
+        "@typescript-eslint/no-floating-promises": "error",
+    },
+}

package/.prettierrc.js

@@ -0,0 +1,9 @@
+/** @type {import("prettier").Config} */
+const config = {
+    trailingComma: "all",
+    tabWidth: 4,
+    semi: true,
+    singleQuote: false,
+};
+
+export default config;

package/.turbo/turbo-build.log

@@ -0,0 +1,8 @@
+
+> cojson-transport-ws@0.7.14 build /Users/anselm/jazz/jazz/packages/cojson-transport-ws
+> npm run lint && rm -rf ./dist && tsc --sourceMap --outDir dist
+
+
+> cojson-transport-ws@0.7.14 lint
+> eslint . --ext ts,tsx
+

package/CHANGELOG.md

@@ -0,0 +1,189 @@
+# cojson-transport-nodejs-ws
+
+## 0.7.14
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.14
+
+## 0.7.11
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.11
+
+## 0.7.10
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.10
+
+## 0.7.9
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.9
+
+## 0.7.0
+
+### Patch Changes
+
+-   c4151fc: Support stricter TS lint rules
+-   21771c4: Reintroduce changes from main
+-   f0f6f1b: Clean up API more & re-add jazz-nodejs
+-   627d895: Get rid of Co namespace
+-   a423eee: ignore error on ws close, fixing "Invalid state: Controller is already closed"
+-   Updated dependencies [1a35307]
+-   Updated dependencies [96c494f]
+-   Updated dependencies [19f52b7]
+-   Updated dependencies [d8fe2b1]
+-   Updated dependencies [1200aae]
+-   Updated dependencies [52675c9]
+-   Updated dependencies [1a35307]
+-   Updated dependencies [e299c3e]
+-   Updated dependencies [bf0f8ec]
+-   Updated dependencies [c4151fc]
+-   Updated dependencies [8636319]
+-   Updated dependencies [952982e]
+-   Updated dependencies [21771c4]
+-   Updated dependencies [69ac514]
+-   Updated dependencies [f0f6f1b]
+-   Updated dependencies [1a44f87]
+-   Updated dependencies [63374cc]
+    -   cojson@0.7.0
+
+## 0.7.0-alpha.42
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.42
+
+## 0.7.0-alpha.41
+
+### Patch Changes
+
+-   ignore error on ws close, fixing "Invalid state: Controller is already closed"
+
+## 0.7.0-alpha.39
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.39
+
+## 0.7.0-alpha.38
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.38
+
+## 0.7.0-alpha.37
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.37
+
+## 0.7.0-alpha.36
+
+### Patch Changes
+
+-   Updated dependencies [1a35307]
+-   Updated dependencies [1a35307]
+    -   cojson@0.7.0-alpha.36
+
+## 0.7.0-alpha.35
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.35
+
+## 0.7.0-alpha.29
+
+### Patch Changes
+
+-   Reintroduce changes from main
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.29
+
+## 0.7.0-alpha.28
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.28
+
+## 0.7.0-alpha.27
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.27
+
+## 0.7.0-alpha.24
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.24
+
+## 0.7.0-alpha.11
+
+### Patch Changes
+
+-   Support stricter TS lint rules
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.11
+
+## 0.7.0-alpha.10
+
+### Patch Changes
+
+-   Clean up API more & re-add jazz-nodejs
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.10
+
+## 0.5.2-alpha.2
+
+### Patch Changes
+
+-   Get rid of Co namespace
+
+## 0.5.2-alpha.1
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.1
+
+## 0.5.2-alpha.0
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.7.0-alpha.0
+
+## 0.5.1
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.6.0
+
+## 0.5.0
+
+### Minor Changes
+
+-   Adding a lot of performance improvements to cojson, add a stresstest for the twit example and make that run smoother in a lot of ways.
+
+### Patch Changes
+
+-   Updated dependencies
+    -   cojson@0.5.0

package/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright 2024, Garden Computing, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# CoJSON Transport NodeJS/Websockets
+
+This implements sync protocol transport for CoJSON / Jazz (see [jazz.tools](https://jazz.tools)) using WebSockets.

package/dist/index.js

@@ -0,0 +1,59 @@
+import { DisconnectedError, PingTimeoutError } from "cojson";
+import { Either, Stream, Queue, Effect, Exit } from "effect";
+export function createWebSocketPeer(options) {
+    return Effect.gen(function* () {
+        const ws = options.websocket;
+        const incoming = yield* Queue.unbounded();
+        const outgoing = yield* Queue.unbounded();
+        ws.addEventListener("close", (event) => {
+            void Effect.runPromiseExit(Queue.offer(incoming, Either.left(new DisconnectedError(`${event.code}: ${event.reason}`)))).then((e) => {
+                if (Exit.isFailure(e) && !Exit.isInterrupted(e)) {
+                    console.warn("Failed closing ws", e);
+                }
+            });
+        });
+        let pingTimeout;
+        ws.addEventListener("message", (event) => {
+            const msg = JSON.parse(event.data);
+            if (pingTimeout) {
+                clearTimeout(pingTimeout);
+            }
+            pingTimeout = setTimeout(() => {
+                console.debug("Ping timeout");
+                void Effect.runPromise(Queue.offer(incoming, Either.left(new PingTimeoutError())));
+                try {
+                    ws.close();
+                }
+                catch (e) {
+                    console.error("Error while trying to close ws on ping timeout", e);
+                }
+            }, 2500);
+            if (msg.type === "ping") {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                globalThis.jazzPings =
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    globalThis.jazzPings || [];
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                globalThis.jazzPings.push({
+                    received: Date.now(),
+                    sent: msg.time,
+                    dc: msg.dc,
+                });
+                return;
+            }
+            else {
+                void Effect.runPromise(Queue.offer(incoming, Either.right(msg)));
+            }
+        });
+        ws.addEventListener("open", () => {
+            void Stream.fromQueue(outgoing).pipe(Stream.runForEach((msg) => Effect.sync(() => ws.send(JSON.stringify(msg)))), Effect.runPromise);
+        });
+        return {
+            id: options.id,
+            incoming: Stream.fromQueue(incoming, { shutdown: true }).pipe(Stream.mapEffect((either) => either)),
+            outgoing,
+            role: options.role,
+        };
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAQ,gBAAgB,EAAe,MAAM,QAAQ,CAAC;AAChF,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAgB7D,MAAM,UAAU,mBAAmB,CAAC,OAInC;IACG,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QACvB,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC;QAE7B,MAAM,QAAQ,GACV,KAAK,CAAC,CAAC,KAAK,CAAC,SAAS,EAEnB,CAAC;QACR,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,SAAS,EAAe,CAAC;QAEvD,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACnC,KAAK,MAAM,CAAC,cAAc,CACtB,KAAK,CAAC,KAAK,CACP,QAAQ,EACR,MAAM,CAAC,IAAI,CACP,IAAI,iBAAiB,CAAC,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC,CAC1D,CACJ,CACJ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBACT,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC9C,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC;gBACzC,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,IAAI,WAAsD,CAAC;QAE3D,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAc,CAAC,CAAC;YAE7C,IAAI,WAAW,EAAE,CAAC;gBACd,YAAY,CAAC,WAAW,CAAC,CAAC;YAC9B,CAAC;YAED,WAAW,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC1B,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;gBAC9B,KAAK,MAAM,CAAC,UAAU,CAClB,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,gBAAgB,EAAE,CAAC,CAAC,CAC7D,CAAC;gBACF,IAAI,CAAC;oBACD,EAAE,CAAC,KAAK,EAAE,CAAC;gBACf,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACT,OAAO,CAAC,KAAK,CACT,gDAAgD,EAChD,CAAC,CACJ,CAAC;gBACN,CAAC;YACL,CAAC,EAAE,IAAI,CAAC,CAAC;YAET,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBACtB,8DAA8D;gBAC7D,UAAkB,CAAC,SAAS;oBACzB,8DAA8D;oBAC7D,UAAkB,CAAC,SAAS,IAAI,EAAE,CAAC;gBACxC,8DAA8D;gBAC7D,UAAkB,CAAC,SAAS,CAAC,IAAI,CAAC;oBAC/B,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE;oBACpB,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,EAAE,EAAE,GAAG,CAAC,EAAE;iBACb,CAAC,CAAC;gBACH,OAAO;YACX,CAAC;iBAAM,CAAC;gBACJ,KAAK,MAAM,CAAC,UAAU,CAClB,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAC3C,CAAC;YACN,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE;YAC7B,KAAK,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,CAChC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,EAAE,EAAE,CACtB,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAClD,EACD,MAAM,CAAC,UAAU,CACpB,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,OAAO;YACH,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CACzD,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,CACvC;YACD,QAAQ;YACR,IAAI,EAAE,OAAO,CAAC,IAAI;SACrB,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC"}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "cojson-transport-ws",
+  "type": "module",
+  "version": "0.7.14",
+  "main": "dist/index.js",
+  "types": "src/index.ts",
+  "license": "MIT",
+  "dependencies": {
+    "effect": "^3.1.5",
+    "typescript": "^5.1.6",
+    "cojson": "0.7.14"
+  },
+  "devDependencies": {
+    "@types/ws": "^8.5.5"
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": "eslint --fix",
+    "*.{js,jsx,mdx,json}": "prettier --write"
+  },
+  "scripts": {
+    "dev": "tsc --watch --sourceMap --outDir dist",
+    "lint": "eslint . --ext ts,tsx",
+    "format": "prettier --write './src/**/*.{ts,tsx}'",
+    "build": "npm run lint && rm -rf ./dist && tsc --sourceMap --outDir dist"
+  }
+}

package/src/index.ts

@@ -0,0 +1,108 @@
+import { DisconnectedError, Peer, PingTimeoutError, SyncMessage } from "cojson";
+import { Either, Stream, Queue, Effect, Exit } from "effect";
+
+interface AnyWebSocket {
+    addEventListener(
+        type: "close",
+        listener: (event: { code: number; reason: string }) => void,
+    ): void;
+    addEventListener(
+        type: "message",
+        listener: (event: { data: string | unknown }) => void,
+    ): void;
+    addEventListener(type: "open", listener: () => void): void;
+    close(): void;
+    send(data: string): void;
+}
+
+export function createWebSocketPeer(options: {
+    id: string;
+    websocket: AnyWebSocket;
+    role: Peer["role"];
+}): Effect.Effect<Peer> {
+    return Effect.gen(function* () {
+        const ws = options.websocket;
+
+        const incoming =
+            yield* Queue.unbounded<
+                Either.Either<SyncMessage, DisconnectedError | PingTimeoutError>
+            >();
+        const outgoing = yield* Queue.unbounded<SyncMessage>();
+
+        ws.addEventListener("close", (event) => {
+            void Effect.runPromiseExit(
+                Queue.offer(
+                    incoming,
+                    Either.left(
+                        new DisconnectedError(`${event.code}: ${event.reason}`),
+                    ),
+                ),
+            ).then((e) => {
+                if (Exit.isFailure(e) && !Exit.isInterrupted(e)) {
+                    console.warn("Failed closing ws", e);
+                }
+            });
+        });
+
+        let pingTimeout: ReturnType<typeof setTimeout> | undefined;
+
+        ws.addEventListener("message", (event) => {
+            const msg = JSON.parse(event.data as string);
+
+            if (pingTimeout) {
+                clearTimeout(pingTimeout);
+            }
+
+            pingTimeout = setTimeout(() => {
+                console.debug("Ping timeout");
+                void Effect.runPromise(
+                    Queue.offer(incoming, Either.left(new PingTimeoutError())),
+                );
+                try {
+                    ws.close();
+                } catch (e) {
+                    console.error(
+                        "Error while trying to close ws on ping timeout",
+                        e,
+                    );
+                }
+            }, 2500);
+
+            if (msg.type === "ping") {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                (globalThis as any).jazzPings =
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    (globalThis as any).jazzPings || [];
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                (globalThis as any).jazzPings.push({
+                    received: Date.now(),
+                    sent: msg.time,
+                    dc: msg.dc,
+                });
+                return;
+            } else {
+                void Effect.runPromise(
+                    Queue.offer(incoming, Either.right(msg)),
+                );
+            }
+        });
+
+        ws.addEventListener("open", () => {
+            void Stream.fromQueue(outgoing).pipe(
+                Stream.runForEach((msg) =>
+                    Effect.sync(() => ws.send(JSON.stringify(msg))),
+                ),
+                Effect.runPromise,
+            );
+        });
+
+        return {
+            id: options.id,
+            incoming: Stream.fromQueue(incoming, { shutdown: true }).pipe(
+                Stream.mapEffect((either) => either),
+            ),
+            outgoing,
+            role: options.role,
+        };
+    });
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "module": "esnext",
+    "target": "ES2020",
+    "moduleResolution": "bundler",
+    "moduleDetection": "force",
+    "strict": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "noUncheckedIndexedAccess": true,
+    "esModuleInterop": true,
+  },
+  "include": ["./src/**/*"],
+}