reply.compress is not working as expected

Prerequisites

• I have written a descriptive issue title
• I have searched existing issues to ensure the bug has not already been reported

Fastify version

4.9.2

Plugin version

6.1.1

Node.js version

18.10.0

Operating system

Linux

Operating system version (i.e. 20.04, 11.3, 10)

Alpine Linux 3.16 with node 18

Description

as documented, I registered the plugin with code:

fastify.register(require('@fastify/compress'),{global: false })

then tried to use reply.compress() I have this error (and crash):

/home/node/code/models/stream-result.js:46
      reply.type('application/json').compress(piped);
                                     ^

TypeError: reply.type(...).compress is not a function

piped is a stream, and replacing with compress with send works

Steps to Reproduce

not sure if it is needed to pass reply object to an external function to reproduce the error

Expected Behavior

It should accept a stream and stream it.

[climba03003]

and that means the better way to make compress works with commonjs is to wrap all in a async start function

I always recommend people to put all the routes inside a plugin. So, they will not face similar issue. I do not recommend to place fastify.get or similar in the same level of fastify.register.

For example,

fastify.register(plugin, {})

fastify.get('/', function() {})

should refactor into

fastify.register(plugin, {})

fastify.register(function(fastify, __, done) {
  fastify.get('/', function() {})

  done()
})

In this case, wrapper of async start is not needed.

[climba03003]

I don’t get the point, why it is not working using commonjs? isn’t cjs supported anymore?

It is supported in commonjs. And I have no idea why it didn’t works for you without a minimal repo.

My guess is about there are something wrong about your setup. For example, the routes and @fastify/compress are inside separate encapsulation context.

Another though is all the plugin is registered inside the same file. And you did not await that file in the most upper layer.