ADD 'includeWsHeaders' property for GraphQL replication

[johnnyvdberg]

This PR contains:

• A NEW FEATURE

Describe the problem you have without this PR

I ran into a similar issue as #4113. Some GraphQL backends only support authenticating web sockets by setting an HTTP header. To circumvent the current behaviour, I implemented my own replication strategy, but with this small change we can get back to the official replication strategy.

Proposed use:

{
      ...
      headers: {
        Authorization: <Bearer token>,
      },
      pull: {
        ...
        includeWsHeaders: true,
      }
}

Todos

• Tests
• Documentation
• Typings

Let me know what you think

[pubkey]

Code looks good. But we also need a test to ensure this will not break in the future.

[johnnyvdberg]

Added a test, I struggled to get the tests running on an M1 machine, so could contain an error.

[pubkey]

This test only ensures that the headers exist on the client state, not that they reach the backend.
The test should reproduce your initial problem.

[pubkey]

@johnnyvdberg

[johnnyvdberg]

Finally got around to writing a proper test. I added a very basic auth check in the graphql-ws server that validates the headers like auth usage with token expiration, validation and refresh. Wasn't really happy with the naming, so I renamed the property as well.

[johnnyvdberg]

I think the test might be a bit flaky, I wasn't able to reproduce the same error when testing locally.

[pubkey]

Thank you, merged!