Response compression plugin - customize content-types for compression

[KingSora]

Describe the feature

The response compression plugin will compress all response above a certain threshold, but it doesn't offer an opt-out for responses that are already compressed formats (e.g. files like mp4, jpg etc.)

The feature would be to expose an option to disable compression for certain procedures which don't need or want it.

Ideally this can be configured completely independently for any procedure and is not dependent on content-types or other headers. Somethng like the allow function from the OpenAPIReferenceHandlerPlugin. (a function which receives context anf returns a boolean whether to compress or not)

Additional information

• Would you be willing to help implement this feature?

[pullfrog]

  ^{｜ Build this ➔ ｜ Make a plan ➔}

[dinwwwh]

It shouldn't compress for compresssed content-type, please check src for detail

[KingSora]

If I would return a ReadableStream which is a streamed mp4 file, then the plugin would compress the ReadableStream, even though I know that a mp4 file will not benefit from that compression and it will only waste CPU cycles. In the src the opt-out only works if the response headers already contain a content-enconding header, which in the ReadableStream example would NOT be the case.

[dinwwwh]

In the src the opt-out only works if the response headers already contain a content-enconding header,

It should check content-type, and for mp4 content-type it shouldn't compress.

[KingSora]

I see, we handle a bit more exotic and propritary content types.. the mp4 was just an example. An option like honos contentTypeFilter would help us out here

[dinwwwh]

The filter should be smart enough, any example where you need custom filter?

[KingSora]

We use application/octet-stream which is very general and is not in the regex so it won't be compressed, but we would want compression there in certain cases. We could specify a better content type, but its a propritary format so the content type would also not be in the regex. Didn't notice that behavior before.

[dinwwwh]

But the plugin doesn't compress application/octet-stream by default

[KingSora]

Yes, in certain cases we would like to have compression for application/octet-stream. The cases where we would want to opt-out of compression are resolved.