feat: support onListen hook

Eomm · Sep 14, 2023 · 99b918c · 99b918c
1 parent 1d09bc1
commit 99b918c
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -122,6 +122,7 @@ The JSON structure returned by the `overview` method is like the following:
     "onSend": [],
     "onResponse": [],
     "onTimeout": [],
+    "onListen": [],
     "onReady": [],
     "onClose": [],
     "onRoute": [],

diff --git a/index.d.ts b/index.d.ts
@@ -60,6 +60,7 @@ interface OverviewStructureHooks {
   onSend?: OverviewStructureHook[],
   onResponse?: OverviewStructureHook[],
   onTimeout?: OverviewStructureHook[],
+  onListen?: OverviewStructureHook[],
   onReady?: OverviewStructureHook[],
   preClose?: OverviewStructureHook[],
   onClose?: OverviewStructureHook[],

diff --git a/index.js b/index.js
@@ -211,7 +211,7 @@ function getJsonOverview (request, reply) {
 
 const plugin = fp(fastifyOverview, {
   name: 'fastify-overview',
-  fastify: '^4.x'
+  fastify: '^4.23.x'
 })
 
 module.exports = plugin

diff --git a/lib/utils.js b/lib/utils.js
@@ -89,6 +89,7 @@ function getEmptyHookRoute () {
 
 function getEmptyHookApplication () {
   return {
+    onListen: [],
     onReady: [],
     preClose: [],
     onClose: [],

diff --git a/package.json b/package.json
@@ -36,7 +36,7 @@
     "@types/node": "^20.1.0",
     "@typescript-eslint/eslint-plugin": "^6.2.1",
     "@typescript-eslint/parser": "^6.0.0",
-    "fastify": "^4.0.2",
+    "fastify": "^4.23.0",
     "standard": "^17.0.0",
     "tap": "^16.0.1",
     "tsd": "^0.29.0"

diff --git a/test/fixture/app-no-source.json b/test/fixture/app-no-source.json
@@ -81,6 +81,7 @@
             "onResponse": [],
             "onTimeout": [],
             "onRequestAbort": [],
+            "onListen": [],
             "onReady": [],
             "preClose": [],
             "onClose": [],
@@ -158,6 +159,7 @@
         "onResponse": [],
         "onTimeout": [],
         "onRequestAbort": [],
+        "onListen": [],
         "onReady": [],
         "preClose": [],
         "onClose": [],
@@ -204,6 +206,7 @@
         "onResponse": [],
         "onTimeout": [],
         "onRequestAbort": [],
+        "onListen": [],
         "onReady": [],
         "preClose": [],
         "onClose": [],
@@ -315,6 +318,7 @@
     "onResponse": [],
     "onTimeout": [],
     "onRequestAbort": [],
+    "onListen": [],
     "onReady": [],
     "preClose": [],
     "onClose": [],

diff --git a/test/fixture/app-source.json b/test/fixture/app-source.json
@@ -141,6 +141,7 @@
             "onResponse": [],
             "onTimeout": [],
             "onRequestAbort": [],
+            "onListen": [],
             "onReady": [],
             "preClose": [],
             "onClose": [],
@@ -258,6 +259,7 @@
         "onResponse": [],
         "onTimeout": [],
         "onRequestAbort": [],
+        "onListen": [],
         "onReady": [],
         "preClose": [],
         "onClose": [],
@@ -324,6 +326,7 @@
         "onResponse": [],
         "onTimeout": [],
         "onRequestAbort": [],
+        "onListen": [],
         "onReady": [],
         "preClose": [],
         "onClose": [],
@@ -525,6 +528,7 @@
     "onResponse": [],
     "onTimeout": [],
     "onRequestAbort": [],
+    "onListen": [],
     "onReady": [],
     "preClose": [],
     "onClose": [],

diff --git a/test/fixture/autoload.json b/test/fixture/autoload.json
@@ -142,6 +142,7 @@
             "onResponse": [],
             "onTimeout": [],
             "onRequestAbort": [],
+            "onListen": [],
             "onReady": [],
             "preClose": [],
             "onClose": [],
@@ -292,6 +293,7 @@
         "onResponse": [],
         "onTimeout": [],
         "onRequestAbort": [],
+        "onListen": [],
         "onReady": [],
         "preClose": [],
         "onClose": [],
@@ -358,6 +360,7 @@
         "onResponse": [],
         "onTimeout": [],
         "onRequestAbort": [],
+        "onListen": [],
         "onReady": [],
         "preClose": [],
         "onClose": [],
@@ -424,6 +427,7 @@
         "onResponse": [],
         "onTimeout": [],
         "onRequestAbort": [],
+        "onListen": [],
         "onReady": [],
         "preClose": [],
         "onClose": [],
@@ -490,6 +494,7 @@
         "onResponse": [],
         "onTimeout": [],
         "onRequestAbort": [],
+        "onListen": [],
         "onReady": [],
         "preClose": [],
         "onClose": [],
@@ -646,6 +651,7 @@
             "onResponse": [],
             "onTimeout": [],
             "onRequestAbort": [],
+            "onListen": [],
             "onReady": [],
             "preClose": [],
             "onClose": [],
@@ -763,6 +769,7 @@
         "onResponse": [],
         "onTimeout": [],
         "onRequestAbort": [],
+        "onListen": [],
         "onReady": [],
         "preClose": [],
         "onClose": [],
@@ -829,6 +836,7 @@
         "onResponse": [],
         "onTimeout": [],
         "onRequestAbort": [],
+        "onListen": [],
         "onReady": [],
         "preClose": [],
         "onClose": [],
@@ -1030,6 +1038,7 @@
     "onResponse": [],
     "onTimeout": [],
     "onRequestAbort": [],
+    "onListen": [],
     "onReady": [],
     "preClose": [],
     "onClose": [],

diff --git a/test/fixture/index.00.json b/test/fixture/index.00.json
@@ -59,6 +59,12 @@
       "hash": "97eb877315c76c90eccaf8fe6fb2015477bbf401"
     }
   ],
+  "onListen": [
+    {
+      "name": "onListen",
+      "hash": "9294d9abb602193c9b3cd02624da004b4b9e0da1"
+    }
+  ],
   "onReady": [],
   "preClose": [],
   "onClose": [],

diff --git a/test/index.test.js b/test/index.test.js
@@ -24,6 +24,7 @@ test('basic test', async t => {
   app.addHook('onResponse', async function hook8 () {})
   app.addHook('onTimeout', () => {})
   app.addHook('onRequestAbort', async function hookAbort (request) { })
+  app.addHook('onListen', async function onListen () { })
 
   app.register(function (instance, opts, next) { next() })
   app.register(async function (instance, opts) { })