Skip to content

feat: pass subscription Headers as connection_init payload #2719

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
Sep 7, 2022
Merged

feat: pass subscription Headers as connection_init payload #2719

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
c52ebbf
feat: pass subscription Headers as connection_init payload
andreialecu Aug 28, 2022
a76456c
chore: update changeset
andreialecu Aug 28, 2022
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 .changeset/late-queens-visit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@graphiql/toolkit': minor
---

Allow passing Headers for subscriptions into connection_init payload
3 changes: 2 additions & 1 deletion packages/graphiql-toolkit/src/create-fetcher/createFetcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ export function createGraphiQLFetcher(options: CreateFetcherOptions): Fetcher {
// simpler fetcher for schema requests
const simpleFetcher = createSimpleFetcher(options, httpFetch);

const wsFetcher = getWsFetcher(options);
const httpFetcher = options.enableIncrementalDelivery
? createMultipartFetcher(options, httpFetch)
: simpleFetcher;
Expand All @@ -52,6 +51,8 @@ export function createGraphiQLFetcher(options: CreateFetcherOptions): Fetcher {
graphQLParams.operationName || undefined,
);
if (isSubscription) {
const wsFetcher = getWsFetcher(options, fetcherOpts);

if (!wsFetcher) {
throw Error(
`Your GraphiQL createFetcher is not properly configured for websocket subscriptions yet. ${
Expand Down
13 changes: 8 additions & 5 deletions packages/graphiql-toolkit/src/create-fetcher/lib.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,15 +193,18 @@ export const createMultipartFetcher = (
* @param options {CreateFetcherOptions}
* @returns
*/
export const getWsFetcher = (options: CreateFetcherOptions) => {
export const getWsFetcher = (
options: CreateFetcherOptions,
fetcherOpts: FetcherOpts | undefined,
) => {
if (options.wsClient) {
return createWebsocketsFetcherFromClient(options.wsClient);
}
if (options.subscriptionUrl) {
return createWebsocketsFetcherFromUrl(
options.subscriptionUrl,
options.wsConnectionParams,
);
return createWebsocketsFetcherFromUrl(options.subscriptionUrl, {
...options.wsConnectionParams,
...fetcherOpts?.headers,
});
}
const legacyWebsocketsClient = options.legacyClient || options.legacyWsClient;
if (legacyWebsocketsClient) {
Expand Down