feat: added preClose hook to disconnect sockets

README.md

@@ -6,6 +6,7 @@
 `fastify-socket.io` enables the use of [Socket.io](https://socket.io/) in a Fastify application.
 
 Supports Fastify versions `4.x`
+Supports socket.io version `4.x`
 
 ## Install
 
@@ -35,7 +36,19 @@ For more details see [examples](https://github.com/ducktors/fastify-socket.io/tr
 
 You can use it as is without passing any option, or you can configure it as explained by Socket.io [doc](https://socket.io/docs/server-api/).
 
-### Hook
+### Hooks
+
+By default the plugin will add a `preClose` hook that disconnects [all the local sockets](https://socket.io/docs/v4/server-api/#serverdisconnectsocketsclose) in order to close correctly the fastify server. In order to change this behaviour you can use `preClose` option:
+
+```javascript
+await fastify.register(require('fastify-socket.io'), {
+  preClose: (done) => {
+    // do other things
+    fastify.io.local.disconnectSockets(true);
+    done();
+  }
+})
+```
 
 The plugin also adds an `onClose` hook which closes the socket server when the `fastify` instance is closed.
 

examples/basic/server.js

@@ -1,24 +1,22 @@
-const fastify = require("fastify");
-const socketio = require("../..");
-const { join } = require("path");
-const { readFile } = require("fs").promises;
+const fastify = require('fastify')
+const socketio = require('../..')
+const { join } = require('path')
+const { readFile } = require('fs').promises
 
-const app = fastify({ logger: true });
+const app = fastify({ logger: true })
 
-app.register(socketio);
+app.register(socketio)
 
-app.get("/", async (req, reply) => {
-  const data = await readFile(join(__dirname, "..", "index.html"));
-  reply.header("content-type", "text/html; charset=utf-8");
-  reply.send(data);
-});
+app.get('/', async (req, reply) => {
+  const data = await readFile(join(__dirname, '..', 'index.html'))
+  reply.header('content-type', 'text/html; charset=utf-8')
+  reply.send(data)
+})
 
 app.ready((err) => {
-  if (err) throw err;
+  if (err) throw err
 
-  app.io.on("connect", (socket) =>
-    console.info("Socket connected!", socket.id)
-  );
-});
+  app.io.on('connect', (socket) => console.info('Socket connected!', socket.id))
+})
 
-app.listen({ port: 3000 });
+app.listen({ port: 3000 })

examples/typescript-example/server.ts

@@ -1,31 +1,31 @@
-import fastify from "fastify";
-import socketioServer from "../../src";
-import { join } from "node:path";
-import { readFile } from "node:fs/promises";
-import { Server } from "socket.io";
+import fastify from 'fastify'
+import socketioServer from '../../src'
+import { join } from 'node:path'
+import { readFile } from 'node:fs/promises'
+import { Server } from 'socket.io'
 
-const app = fastify({ logger: true });
+const app = fastify({ logger: true })
 
-app.register(socketioServer);
+app.register(socketioServer)
 
-app.get("/", async (_req, reply) => {
-  const data = await readFile(join(__dirname, "..", "index.html"));
-  reply.header("content-type", "text/html; charset=utf-8");
-  reply.send(data);
-});
+app.get('/', async (_req, reply) => {
+  const data = await readFile(join(__dirname, '..', 'index.html'))
+  reply.header('content-type', 'text/html; charset=utf-8')
+  reply.send(data)
+})
 
 app.ready((err) => {
-  if (err) throw err;
+  if (err) throw err
 
-  app.io.on("connection", (socket: any) =>
-    console.info("Socket connected!", socket.id)
-  );
-});
+  app.io.on('connection', (socket: any) =>
+    console.info('Socket connected!', socket.id),
+  )
+})
 
-app.listen({ port: 3000 });
+app.listen({ port: 3000 })
 
-declare module "fastify" {
+declare module 'fastify' {
   interface FastifyInstance {
-    io: Server<{ hello: string }>;
+    io: Server<{ hello: string }>
   }
 }

package.json

@@ -15,7 +15,7 @@
     "test:watch": "tsx --watch --test ./test/*.ts",
     "test:coverage": "c8 --all --src src --reporter lcov --reporter text tsx --test ./test/*.ts"
   },
-"repository": {
+  "repository": {
     "type": "git",
     "url": "git+https://github.com/ducktors/fastify-socket.io.git"
   },
@@ -33,7 +33,8 @@
     "husky": "^8.0.3",
     "lint-staged": "^13.2.3",
     "rome": "11.0.0",
-    "socket.io": "^4.7.1",
+    "socket.io": "^4.7.4",
+    "socket.io-client": "^4.7.4",
     "tsup": "^6.7.0",
     "tsx": "^3.13.0",
     "typescript": "^4.9.5"
@@ -42,6 +43,7 @@
     "dist"
   ],
   "peerDependencies": {
-    "fastify": "4.x.x"
+    "fastify": "4.x.x",
+    "socket.io": ">=4"
   }
-}
+}

src/index.ts

@@ -1,16 +1,30 @@
-import { FastifyInstance, FastifyPluginAsync } from "fastify";
-import fp from "fastify-plugin";
-import { Server, ServerOptions } from "socket.io";
+import { FastifyInstance, FastifyPluginAsync } from 'fastify'
+import fp from 'fastify-plugin'
+import { Server, ServerOptions } from 'socket.io'
 
-const fastifySocketIO: FastifyPluginAsync<Partial<ServerOptions>> = fp(
-  async function (fastify, opts) {
-    fastify.decorate("io", new Server(fastify.server, opts));
-    fastify.addHook("onClose", (fastify: FastifyInstance, done) => {
-      (fastify as any).io.close();
-      done();
-    });
+export type FastifySocketioOptions = Partial<ServerOptions> & {
+  preClose?: (done: Function) => void
+}
+
+const fastifySocketIO: FastifyPluginAsync<FastifySocketioOptions> = fp(
+  async function (fastify, opts: FastifySocketioOptions) {
+    function defaultPreClose(done: Function) {
+      (fastify as any).io.local.disconnectSockets(true)
+      done()
+    }
+    fastify.decorate('io', new Server(fastify.server, opts))
+    fastify.addHook('preClose', (done) => {
+      if (opts.preClose) {
+        return opts.preClose(done)
+      }
+      return defaultPreClose(done)
+    })
+    fastify.addHook('onClose', (fastify: FastifyInstance, done) => {
+      (fastify as any).io.close()
+      done()
+    })
   },
-  { fastify: ">=4.x.x", name: "fastify-socket.io" }
-);
+  { fastify: '>=4.x.x', name: 'fastify-socket.io' },
+)
 
-export default fastifySocketIO;
+export default fastifySocketIO