ADD test for includeHttpHeadersWs

pubkey · Mar 16, 2023 · f0fbc6e · f0fbc6e
1 parent 77338fd
commit f0fbc6e
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 2 deletions.
diff --git a/src/plugins/replication-graphql/index.ts b/src/plugins/replication-graphql/index.ts
@@ -198,7 +198,7 @@ export function replicateGraphQL<RxDocType, CheckpointType>(
     const startBefore = graphqlReplicationState.start.bind(graphqlReplicationState);
     graphqlReplicationState.start = () => {
         if (mustUseSocket) {
-            const httpHeaders = pull.includeHttpHeadersWs ? mutateableClientState.headers : undefined;
+            const httpHeaders = pull.includeWsHeaders ? mutateableClientState.headers : undefined;
             const wsClient = getGraphQLWebSocket(ensureNotFalsy(url.ws), httpHeaders);
 
             wsClient.on('connected', () => {

diff --git a/src/types/plugins/replication-graphql.d.ts b/src/types/plugins/replication-graphql.d.ts
@@ -33,7 +33,7 @@ ReplicationPullOptions<RxDocType, CheckpointType>,
     streamQueryBuilder?: RxGraphQLReplicationPullStreamQueryBuilder;
     dataPath?: string;
     responseModifier?: RxGraphQLPullResponseModifier<RxDocType, CheckpointType>;
-    includeHttpHeadersWs?: boolean;
+    includeWsHeaders?: boolean;
 };
 
 export type RxGraphQLPullResponseModifier<RxDocType, CheckpointType> = (

diff --git a/test/helper/graphql-server.ts b/test/helper/graphql-server.ts
@@ -309,6 +309,14 @@ export async function spawn(
                 // Set up the WebSocket for handling GraphQL subscriptions
                 const subServer = useServer(
                     {
+                        onConnect: (ctx) => {
+                            if (reqHeaderName) { // Only check auth when required header was set
+                                const headers = ctx.connectionParams?.headers as Record<string, string>;
+                                if (headers[reqHeaderName] !== reqHeaderValue) {
+                                    return false;
+                                }
+                            }
+                        },
                         schema,
                         execute,
                         subscribe,

diff --git a/test/unit/replication-graphql.test.ts b/test/unit/replication-graphql.test.ts
@@ -1486,6 +1486,41 @@ describe('replication-graphql.test.ts', () => {
                 await server.close();
                 await c.database.destroy();
             });
+            it('should respect pull.includeWsHeaders', async () => {
+                const [c, server] = await Promise.all([
+                    humansCollection.createHumanWithTimestamp(0),
+                    SpawnServer.spawn()
+                ]);
+                server.requireHeader('token', 'Bearer token');
+                const replicationState = replicateGraphQL({
+                    collection: c,
+                    url: server.url,
+                    pull: {
+                        batchSize,
+                        queryBuilder: pullQueryBuilder,
+                        streamQueryBuilder: pullStreamQueryBuilder,
+                        includeWsHeaders: true,
+                    },
+                    headers: {
+                        token: 'Bearer token'
+                    },
+                    live: true,
+                    deletedField: 'deleted'
+                });
+                ensureReplicationHasNoErrors(replicationState);
+                await replicationState.awaitInSync();
+
+                const testDocData = getTestData(1)[0];
+
+                // Test mutation with subscription
+                await server.setDocument(testDocData);
+                await waitUntil(async () => {
+                    const docs = await c.find().exec();
+                    return docs.length === 1;
+                });
+                await server.close();
+                await c.database.destroy();
+            });
             it('should respect the pull.responseModifier', async () => {
                 const checkpointIterationModeAmount = 5;
                 const eventObservationModeAmount = 3;