Merge remote-tracking branch 'socket.io-postgres-emitter/main' into monorepo

Author: darrachequesne

.github/workflows/ci.yml

@@ -35,6 +35,18 @@ jobs:
         ports:
           - 6379:6379
 
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: changeit
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

packages/socket.io-postgres-emitter/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.1.0 (2021-06-14)
+
+Initial commit
+

packages/socket.io-postgres-emitter/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2021 Damien Arrachequesne (@darrachequesne)
+
+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.

packages/socket.io-postgres-emitter/README.md

@@ -0,0 +1,149 @@
+# Socket.IO Postgres emitter
+
+The `@socket.io/postgres-emitter` package allows you to easily communicate with a group of Socket.IO servers from another Node.js process (server-side).
+
+![Emitter diagram](./assets/emitter.png)
+
+It must be used in conjunction with [`@socket.io/posgres-adapter`](https://github.com/socketio/socket.io-posgres-adapter/).
+
+Supported features:
+
+- [broadcasting](https://socket.io/docs/v4/broadcasting-events/)
+- [utility methods](https://socket.io/docs/v4/server-instance/#Utility-methods)
+  - [`socketsJoin`](https://socket.io/docs/v4/server-instance/#socketsJoin)
+  - [`socketsLeave`](https://socket.io/docs/v4/server-instance/#socketsLeave)
+  - [`disconnectSockets`](https://socket.io/docs/v4/server-instance/#disconnectSockets)
+  - [`serverSideEmit`](https://socket.io/docs/v4/server-instance/#serverSideEmit)
+
+Related packages:
+
+- Postgres adapter: https://github.com/socketio/socket.io-postgres-adapter/
+- Redis adapter: https://github.com/socketio/socket.io-redis-adapter/
+- Redis emitter: https://github.com/socketio/socket.io-redis-emitter/
+- MongoDB adapter: https://github.com/socketio/socket.io-mongo-adapter/
+- MongoDB emitter: https://github.com/socketio/socket.io-mongo-emitter/
+
+**Table of contents**
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [API](#api)
+- [Known errors](#known-errors)
+- [License](#license)
+
+## Installation
+
+```
+npm install @socket.io/postgres-emitter pg
+```
+
+For TypeScript users, you might also need `@types/pg`.
+
+## Usage
+
+```js
+const { Emitter } = require("@socket.io/postgres-emitter");
+const { Pool } = require("pg");
+
+const pool = new Pool({
+  user: "postgres",
+  host: "localhost",
+  database: "postgres",
+  password: "changeit",
+  port: 5432,
+});
+
+const io = new Emitter(pool);
+
+setInterval(() => {
+  io.emit("ping", new Date());
+}, 1000);
+```
+
+## API
+
+### `Emitter(pool[, nsp][, opts])`
+
+```js
+const io = new Emitter(pool);
+```
+
+The `pool` argument is a [Pool object](https://node-postgres.com/api/pool) from the `pg` package.
+
+### `Emitter#to(room:string):BroadcastOperator`
+### `Emitter#in(room:string):BroadcastOperator`
+
+Specifies a specific `room` that you want to emit to.
+
+```js
+io.to("room1").emit("hello");
+```
+
+### `Emitter#except(room:string):BroadcastOperator`
+
+Specifies a specific `room` that you want to exclude from broadcasting.
+
+```js
+io.except("room2").emit("hello");
+```
+
+### `Emitter#of(namespace:string):Emitter`
+
+Specifies a specific namespace that you want to emit to.
+
+```js
+const customNamespace = io.of("/custom");
+
+customNamespace.emit("hello");
+```
+
+### `Emitter#socketsJoin(rooms:string|string[])`
+
+Makes the matching socket instances join the specified rooms:
+
+```js
+// make all Socket instances join the "room1" room
+io.socketsJoin("room1");
+
+// make all Socket instances of the "admin" namespace in the "room1" room join the "room2" room
+io.of("/admin").in("room1").socketsJoin("room2");
+```
+
+### `Emitter#socketsLeave(rooms:string|string[])`
+
+Makes the matching socket instances leave the specified rooms:
+
+```js
+// make all Socket instances leave the "room1" room
+io.socketsLeave("room1");
+
+// make all Socket instances of the "admin" namespace in the "room1" room leave the "room2" room
+io.of("/admin").in("room1").socketsLeave("room2");
+```
+
+### `Emitter#disconnectSockets(close:boolean)`
+
+Makes the matching socket instances disconnect:
+
+```js
+// make all Socket instances disconnect
+io.disconnectSockets();
+
+// make all Socket instances of the "admin" namespace in the "room1" room disconnect
+io.of("/admin").in("room1").disconnectSockets();
+
+// this also works with a single socket ID
+io.of("/admin").in(theSocketId).disconnectSockets();
+```
+
+### `Emitter#serverSideEmit(ev:string[,...args:any[]])`
+
+Emits an event that will be received by each Socket.IO server of the cluster.
+
+```js
+io.serverSideEmit("ping");
+```
+
+## License
+
+[MIT](LICENSE)