server: implement websocket compression setting (fixes #3292)

[gahag]

Description

As discussed, the websocket package has a compression setting built-in.
This commit implements the wiring to allow such configuration through
the connection-compression command line flag, or the
HASURA_GRAPHQL_CONNECTION_COMPRESSION environment variable.

Changelog

• CHANGELOG.md is updated with user-facing content relevant to this PR. If no changelog is required, then add the no-changelog-required label.

Affected components

• Server

Related Issues

#3292

Solution and Design

As discussed, the websocket package has a compression setting built-in.
This commit implements the wiring to allow such configuration through
the connection-compression command line flag, or the
HASURA_GRAPHQL_CONNECTION_COMPRESSION environment variable.

Steps to test and verify

Run graphql with the compression flag, and send a big but low entropy string through a graphql client.

Limitations, known bugs & workarounds

Server checklist

Catalog upgrade

Does this PR change Hasura Catalog version?

• No
• Yes
  • Updated docs with SQL for downgrading the catalog

Metadata

Does this PR add a new Metadata feature?

• No
• Yes
  • Does run_sql auto manages the new metadata through schema diffing?
    • Yes
    • Not required
  • Does run_sql auto manages the definitions of metadata on renaming?
    • Yes
    • Not required
  • Does export_metadata/replace_metadata supports the new metadata added?
    • Yes
    • Not required

GraphQL

• No new GraphQL schema is generated
• New GraphQL schema is being generated:
  • New types and typenames are correlated

Breaking changes

• No Breaking changes

• There are breaking changes:

  1. Metadata API

     Existing query types:

     • Modify args payload which is not backward compatible
     • Behavioural change of the API
     • Change in response JSON schema
     • Change in error code

  2. GraphQL API

     Schema Generation:

     • Change in any NamedType
     • Change in table field names

     Schema Resolve:-

     • Change in treatment of null value for any input fields

  3. Logging

     • Log JSON schema has changed
     • Log type names have changed

[hasura-bot]

Beep boop! 🤖

Hey @gahag, thanks for your PR!

One of my human friends will review this PR and get back to you as soon as possible.

Stay awesome! 😎

[netlify]

Deploy preview for hasura-docs ready!

Built with commit f559c00

https://deploy-preview-5928--hasura-docs.netlify.app

[abooij]

This looks good to me, thanks for this PR, @gahag!

@0x777, do we want to have some kind of unit test for this? I suppose it might be difficult to integrate a test for this into our testing suite...

[gahag]

@lexi-lambda I've made a new commit with the suggested changes. Thanks for the review! Should I squash the two commits?

[abooij]

@lexi-lambda I've made a new commit with the suggested changes. Thanks for the review! Should I squash the two commits?

You can leave the commits as-is, we usually squash the commits in a PR at merge time. Let's give Alexis some more time to have another look.

[tirumaraiselvan]

changelog

[hasura-bot]

Beep boop! 🤖

Awesome work @gahag! All of us at Hasura ❤️ what you did.

Thanks again 🤗

[mehtavishwa30]

Hello @gahag!

Thanks so much for your contribution to Hasura OSS during the Hacktoberfest 2020! We'd love to send you some Hasura swag as a token of appreciation and you will be getting an email with the swag form shortly. ✨

[kokroo]

Compression on websockets doesn't seem to actually work anymore. The headers indicate that permessage-deflate is on, but the packets are still not compressed. After checking with wireshark, even with that header present, the frame size is the same as the length of the payload. Manually using the deflate tool shows that the text is 1000% compressible.