@sridhardvvce/gcp-pubsub-adapter 0.1.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 The Socket.IO team
+
+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,62 @@
+# Socket.IO Google Cloud pub/sub adapter
+
+The `@socket.io/gcp-pubsub-adapter` package allows broadcasting packets between multiple Socket.IO servers.
+
+**Table of contents**
+
+- [Supported features](#supported-features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Options](#options)
+- [License](#license)
+
+## Supported features
+
+| Feature                         | `socket.io` version | Support                                        |
+|---------------------------------|---------------------|------------------------------------------------|
+| Socket management               | `4.0.0`             | :white_check_mark: YES (since version `0.1.0`) |
+| Inter-server communication      | `4.1.0`             | :white_check_mark: YES (since version `0.1.0`) |
+| Broadcast with acknowledgements | `4.5.0`             | :white_check_mark: YES (since version `0.1.0`) |
+| Connection state recovery       | `4.6.0`             | :x: NO                                         |
+
+## Installation
+
+```
+npm install @socket.io/gcp-pubsub-adapter
+```
+
+## Usage
+
+```js
+import { PubSub } from "@google-cloud/pubsub";
+import { Server } from "socket.io";
+import { createAdapter } from "@socket.io/gcp-pubsub-adapter";
+
+const pubsub = new PubSub({
+  projectId: "your-project-id"
+});
+
+const topic = pubsub.topic(topicNameOrId);
+
+const io = new Server({
+  adapter: createAdapter(topic)
+});
+
+// wait for the creation of the pub/sub subscription
+await io.of("/").adapter.init();
+
+io.listen(3000);
+```
+
+## Options
+
+| Name                  | Description                                                                                                       | Default value  |
+|-----------------------|-------------------------------------------------------------------------------------------------------------------|----------------|
+| `subscriptionPrefix`  | The prefix for the new subscription to create.                                                                    | `socket.io`    |
+| `subscriptionOptions` | The options used to create the subscription.                                                                      | `-`            |
+| `heartbeatInterval`   | The number of ms between two heartbeats.                                                                          | `5_000`        |
+| `heartbeatTimeout`    | The number of ms without heartbeat before we consider a node down.                                                | `10_000`       |
+
+## License
+
+[MIT](LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import { ClusterAdapterWithHeartbeat } from "socket.io-adapter";
+import type { ClusterAdapterOptions, ClusterMessage, ClusterResponse, Offset, ServerId } from "socket.io-adapter";
+import type { Topic, Message, CreateSubscriptionOptions } from "@google-cloud/pubsub";
+export interface AdapterOptions extends ClusterAdapterOptions {
+    /**
+     * The prefix for the new subscription to create
+     * @default "socket.io"
+     */
+    subscriptionPrefix?: string;
+    /**
+     * The options used to create the subscription.
+     */
+    subscriptionOptions?: CreateSubscriptionOptions;
+}
+/**
+ * Returns a function that will create a {@link PubSubAdapter} instance.
+ *
+ * @param topic - a Google pub/sub topic
+ * @param opts - additional options
+ *
+ * @public
+ */
+export declare function createAdapter(topic: Topic, opts?: AdapterOptions): (nsp: any) => PubSubAdapter;
+export declare class PubSubAdapter extends ClusterAdapterWithHeartbeat {
+    private readonly topic;
+    /**
+     * Adapter constructor.
+     *
+     * @param nsp - the namespace
+     * @param topic - a Google pub/sub topic
+     * @param opts - additional options
+     *
+     * @public
+     */
+    constructor(nsp: any, topic: Topic, opts: ClusterAdapterOptions);
+    protected doPublish(message: ClusterMessage): Promise<Offset>;
+    protected doPublishResponse(requesterUid: ServerId, response: ClusterResponse): Promise<void>;
+    onRawMessage(rawMessage: Message): void;
+}

package/dist/index.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PubSubAdapter = exports.createAdapter = void 0;
+const socket_io_adapter_1 = require("socket.io-adapter");
+const msgpack_1 = require("@msgpack/msgpack");
+const node_crypto_1 = require("node:crypto");
+const debug = require("debug")("socket.io-gcloud-pubsub-adapter");
+function randomId() {
+    return (0, node_crypto_1.randomBytes)(8).toString("hex");
+}
+/**
+ * Returns a function that will create a {@link PubSubAdapter} instance.
+ *
+ * @param topic - a Google pub/sub topic
+ * @param opts - additional options
+ *
+ * @public
+ */
+function createAdapter(topic, opts = {}) {
+    const subscriptionPrefix = opts.subscriptionPrefix || "socket.io";
+    const subscriptionName = `${subscriptionPrefix}-${randomId()}`;
+    const namespaceToAdapters = new Map();
+    debug("creating subscription [%s]", subscriptionName);
+    // a new subscription is created every time, in order to always start at the last offset (and not replay old messages)
+    const subscriptionCreation = topic
+        .createSubscription(subscriptionName, opts.subscriptionOptions)
+        .then((res) => {
+        debug("subscription [%s] was successfully created", subscriptionName);
+        const subscription = res[0];
+        subscription.on("message", (message) => {
+            var _a;
+            const namespace = message.attributes["nsp"];
+            (_a = namespaceToAdapters.get(namespace)) === null || _a === void 0 ? void 0 : _a.onRawMessage(message);
+            message.ack();
+        });
+        subscription.on("error", (err) => {
+            debug("an error has occurred: %s", err.message);
+        });
+    })
+        .catch((err) => {
+        debug("an error has occurred while creating the subscription: %s", err.message);
+        throw err; // ✅ FAIL FAST //Sridhar
+    });
+    return function (nsp) {
+        const adapter = new PubSubAdapter(nsp, topic, opts);
+        namespaceToAdapters.set(nsp.name, adapter);
+        const defaultInit = adapter.init;
+        adapter.init = () => {
+            return subscriptionCreation.then(() => {
+                defaultInit.call(adapter);
+            });
+        };
+        const defaultClose = adapter.close;
+        adapter.close = () => {
+            namespaceToAdapters.delete(nsp.name);
+            if (namespaceToAdapters.size === 0) {
+                debug("deleting subscription [%s]", subscriptionName);
+                topic
+                    .subscription(subscriptionName)
+                    .delete()
+                    .then(() => {
+                    debug("subscription [%s] was successfully deleted", subscriptionName);
+                })
+                    .catch((err) => {
+                    debug("an error has occurred while deleting the subscription: %s", err.message);
+                });
+            }
+            defaultClose.call(adapter);
+        };
+        return adapter;
+    };
+}
+exports.createAdapter = createAdapter;
+class PubSubAdapter extends socket_io_adapter_1.ClusterAdapterWithHeartbeat {
+    /**
+     * Adapter constructor.
+     *
+     * @param nsp - the namespace
+     * @param topic - a Google pub/sub topic
+     * @param opts - additional options
+     *
+     * @public
+     */
+    constructor(nsp, topic, opts) {
+        super(nsp, opts);
+        this.topic = topic;
+    }
+    doPublish(message) {
+        return this.topic
+            .publishMessage({
+            data: Buffer.from((0, msgpack_1.encode)(message)),
+            attributes: {
+                nsp: this.nsp.name,
+                uid: this.uid,
+            },
+        })
+            .then();
+    }
+    doPublishResponse(requesterUid, response) {
+        return this.topic
+            .publishMessage({
+            data: Buffer.from((0, msgpack_1.encode)(response)),
+            attributes: {
+                nsp: this.nsp.name,
+                uid: this.uid,
+                requesterUid,
+            },
+        })
+            .then();
+    }
+    onRawMessage(rawMessage) {
+        if (rawMessage.attributes["uid"] === this.uid) {
+            debug("ignore message from self");
+            return;
+        }
+        const requesterUid = rawMessage.attributes["requesterUid"];
+        if (requesterUid && requesterUid !== this.uid) {
+            debug("ignore response for another node");
+            return;
+        }
+        const decoded = (0, msgpack_1.decode)(rawMessage.data);
+        debug("received %j", decoded);
+        if (requesterUid) {
+            this.onResponse(decoded);
+        }
+        else {
+            this.onMessage(decoded);
+        }
+    }
+}
+exports.PubSubAdapter = PubSubAdapter;

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@sridhardvvce/gcp-pubsub-adapter",
+  "version": "0.1.0",
+  "description": "The Socket.IO adapter for Google Cloud pub/sub, allowing to broadcast events between several Socket.IO servers",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:socketio/socket.io-gcp-pubsub-adapter.git"
+  },
+  "files": [
+    "dist/"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "compile": "rimraf ./dist && tsc",
+    "test": "npm run format:check && tsc && nyc mocha --require ts-node/register --timeout 10000 test/index.ts",
+    "format:check": "prettier --parser typescript --check 'lib/**/*.ts' 'test/**/*.ts'",
+    "format:fix": "prettier --parser typescript --write 'lib/**/*.ts' 'test/**/*.ts'",
+    "prepack": "npm run compile"
+  },
+  "dependencies": {
+    "@google-cloud/pubsub": "^4.3.3",
+    "@msgpack/msgpack": "^2.8.0",
+    "debug": "~4.3.4"
+  },
+  "peerDependencies": {
+    "socket.io-adapter": "^2.5.4"
+  },
+  "devDependencies": {
+    "@types/expect.js": "^0.3.29",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^14.14.7",
+    "expect.js": "0.3.1",
+    "mocha": "^10.2.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.1.2",
+    "rimraf": "^5.0.5",
+    "socket.io": "^4.6.1",
+    "socket.io-client": "^4.6.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "socket.io",
+    "google cloud platform",
+    "gcp",
+    "pubsub"
+  ]
+}