Skip to content

feat(schema): set hide true for websockets #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 25, 2025
Merged

feat(schema): set hide true for websockets #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e3b4e9
feat(schema): set hide true for websockets
rozzilla May 23, 2025
4f3ed09
update
rozzilla May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,11 @@ function fastifyWebsocket (fastify, opts, next) {
isWebsocketRoute = true

if (routeOptions.websocket) {
if (!routeOptions.schema) {
routeOptions.schema = {}
}
routeOptions.schema.hide = true

wsHandler = routeOptions.handler
handler = function (_, reply) {
reply.code(404).send()
Expand Down
7 changes: 5 additions & 2 deletions test/hooks.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,18 @@ const WebSocket = require('ws')
const split = require('split2')

test('Should run onRequest, preValidation, preHandler hooks', (t, end) => {
t.plan(7)
t.plan(8)
const fastify = Fastify()

t.after(() => fastify.close())

fastify.register(fastifyWebsocket)

fastify.register(async function (fastify) {
fastify.addHook('onRequest', async () => t.assert.ok('called', 'onRequest'))
fastify.addHook('onRequest', async ({ routeOptions: { schema: { hide } } }) => {
t.assert.ok('called', 'onRequest')
t.assert.strictEqual(hide, true, 'schema hide property should be set to true when route option is websocket')
})
fastify.addHook('preParsing', async () => t.assert.ok('called', 'preParsing'))
fastify.addHook('preValidation', async () => t.assert.ok('called', 'preValidation'))
fastify.addHook('preHandler', async () => t.assert.ok('called', 'preHandler'))
Expand Down