Allow connectionParams to be provided as part of wsOptions for replication-graphql

docs-src/docs/replication-graphql.md

@@ -333,7 +333,9 @@ const replicationState = replicateGraphQL(
 
             // Websocket options that can be passed as a parameter to initialize the subscription
             // Can be applied anything from the graphql-ws ClientOptions - https://the-guild.dev/graphql/ws/docs/interfaces/client.ClientOptions
-            // Excepting parameters: 'url', 'shouldRetry', 'webSocketImpl', 'connectionParams' - locked for the internal usage
+            // Except these parameters: 'url', 'shouldRetry', 'webSocketImpl' - locked for internal usage
+            // Note: if you provide connectionParams as a wsOption, make sure it returns any necessary headers (e.g. authorization)
+            // because providing your own connectionParams prevents headers from being included automatically
             wsOptions: { 
                 retryAttempts: 10,
             }

src/plugins/replication-graphql/graphql-websocket.ts

@@ -24,12 +24,13 @@ export function getGraphQLWebSocket(
         GRAPHQL_WEBSOCKET_BY_URL,
         url,
         () => {
+            const connectionParamsHeaders = headers ? { headers } : undefined;
             const wsClient = createClient({
                 ...options,
                 url,
                 shouldRetry: () => true,
                 webSocketImpl: IsomorphicWebSocket,
-                connectionParams: headers ? { headers } : undefined,
+                connectionParams: options.connectionParams || connectionParamsHeaders,
             });
             return {
                 url,

src/types/plugins/replication-graphql.d.ts

@@ -28,7 +28,7 @@ export type RxGraphQLReplicationPushQueryBuilder = (
     rows: RxReplicationWriteToMasterRow<any>[]
 ) => RxGraphQLReplicationQueryBuilderResponse;
 
-export type RxGraphQLPullWSOptions = Omit<ClientOptions, 'url' | 'shouldRetry' | 'webSocketImpl' | 'connectionParams'>;
+export type RxGraphQLPullWSOptions = Omit<ClientOptions, 'url' | 'shouldRetry' | 'webSocketImpl'>;
 
 export type RxGraphQLReplicationPullQueryBuilder<CheckpointType> = (
     latestPulledCheckpoint: CheckpointType | undefined,

test/unit/replication-graphql.test.ts

@@ -1693,8 +1693,14 @@ describe('replication-graphql.test.ts', () => {
                                 },
                                 'error': () => {
                                     capturedWSStates.push('error');
-                                }
-                            }
+                                },
+                            },
+                            connectionParams: () => {
+                                capturedWSStates.push('connectionParams');
+                                return {
+                                    token: 'Bearer token'
+                                };
+                            },
                         },
                     },
                     headers: {
@@ -1709,18 +1715,19 @@ describe('replication-graphql.test.ts', () => {
                 await replicationState.awaitInitialReplication();
 
                 await waitUntil(() => {
-                    return capturedWSStates.length === 2;
+                    return capturedWSStates.length === 3;
                 });
 
                 assert.equal(capturedWSStates.includes('connected'), true);
                 assert.equal(capturedWSStates.includes('connecting'), true);
+                assert.equal(capturedWSStates.includes('connectionParams'), true);
                 assert.equal(capturedWSStates.includes('closed'), false);
                 assert.equal(capturedWSStates.includes('error'), false);
 
                 replicationState.cancel();
 
                 await waitUntil(() => {
-                    return capturedWSStates.length === 3;
+                    return capturedWSStates.length === 4;
                 });
 
                 assert.equal(capturedWSStates.includes('closed'), true);