feat: remove defaultTimeout for server options

The `defaultTimeout` causes a default signal to be set on fetch, this is
good in practice, but nextjs unfortunately disables the request
deduplication process.

Author: mvantellingen

.changeset/tricky-news-jam.md

@@ -0,0 +1,5 @@
+---
+"@labdigital/graphql-fetcher": minor
+---
+
+Remove the default timeout signal since the presence of the signal disables nextjs request deduplication

src/server.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, it, vi } from "vitest";
+import { describe, expect, it } from "vitest";
 import { createSha256, pruneObject } from "./helpers";
 import { initServerFetcher } from "./server";
 import { TypedDocumentString } from "./testing";
@@ -52,7 +52,6 @@ describe("gqlServerFetch", () => {
 				}),
 				cache: "force-cache",
 				next: { revalidate: 900 },
-				signal: expect.any(AbortSignal),
 			},
 		);
 	});
@@ -93,7 +92,6 @@ describe("gqlServerFetch", () => {
 					"Content-Type": "application/json",
 				}),
 				next: { revalidate: 900 },
-				signal: expect.any(AbortSignal),
 			},
 		);
 	});
@@ -131,7 +129,6 @@ describe("gqlServerFetch", () => {
 					"Content-Type": "application/json",
 				}),
 				next: { revalidate: 900 },
-				signal: expect.any(AbortSignal),
 			},
 		);
 	});
@@ -164,7 +161,6 @@ describe("gqlServerFetch", () => {
 				}),
 				cache: "no-store",
 				next: { revalidate: undefined },
-				signal: expect.any(AbortSignal),
 			},
 		);
 	});
@@ -203,7 +199,6 @@ describe("gqlServerFetch", () => {
 				}),
 				cache: "force-cache",
 				next: { revalidate: 900 },
-				signal: expect.any(AbortSignal),
 			},
 		);
 	});
@@ -234,7 +229,6 @@ describe("gqlServerFetch", () => {
 					"Content-Type": "application/json",
 				}),
 				cache: "no-store",
-				signal: expect.any(AbortSignal),
 			},
 		);
 	});
@@ -264,41 +258,8 @@ describe("gqlServerFetch", () => {
 		expect(fetchMock).toHaveBeenCalledTimes(1);
 	});
 
-	it("should use time out after 30 seconds by default", async () => {
-		const timeoutSpy = vi.spyOn(AbortSignal, "timeout");
-		const gqlServerFetch = initServerFetcher("https://localhost/graphql");
-		fetchMock.mockResponse(successResponse);
-
-		await gqlServerFetch(query, { myVar: "baz" }, {});
-
-		expect(timeoutSpy).toHaveBeenCalledWith(30000);
-
-		// It should not try to POST the query if the persisted query cannot be parsed
-		expect(fetchMock).toHaveBeenCalledTimes(1);
-	});
-
-	it("should use the provided timeout duration", async () => {
-		vi.useFakeTimers();
-		const timeoutSpy = vi.spyOn(AbortSignal, "timeout");
-		const gqlServerFetch = initServerFetcher("https://localhost/graphql", {
-			defaultTimeout: 1,
-		});
-		fetchMock.mockResponse(successResponse);
-
-		await gqlServerFetch(query, { myVar: "baz" }, {});
-
-		vi.runAllTimers();
-
-		expect(timeoutSpy).toHaveBeenCalledWith(1);
-
-		// It should not try to POST the query if the persisted query cannot be parsed
-		expect(fetchMock).toHaveBeenCalledTimes(1);
-	});
-
 	it("should use the provided signal", async () => {
-		const gqlServerFetch = initServerFetcher("https://localhost/graphql", {
-			defaultTimeout: 1,
-		});
+		const gqlServerFetch = initServerFetcher("https://localhost/graphql");
 		fetchMock.mockResponse(successResponse);
 
 		const controller = new AbortController();

src/server.ts

@@ -21,6 +21,11 @@ import {
 } from "./request";
 
 type RequestOptions = {
+	/**
+	 * Pass an AbortSignal to the fetch request. Note that when passing a signal
+	 * to the fetcher, NextJS will disable cache deduplication, so be careful when
+	 * using this option.
+	 */
 	signal?: AbortSignal;
 	headers?: Headers | Record<string, string>;
 };
@@ -33,13 +38,6 @@ type Options = {
 	 */
 	dangerouslyDisableCache?: boolean;
 
-	/**
-	 * Sets the default timeout duration in ms after which a request will throw a timeout error
-	 *
-	 * @default 30000
-	 */
-	defaultTimeout?: number;
-
 	/**
 	 * Default headers to be sent with each request
 	 */
@@ -75,7 +73,6 @@ export const initServerFetcher =
 		url: string,
 		{
 			dangerouslyDisableCache = false,
-			defaultTimeout = 30000,
 			defaultHeaders = {},
 			includeQuery = false,
 			createDocumentId = getDocumentId,
@@ -85,9 +82,7 @@ export const initServerFetcher =
 		astNode: DocumentTypeDecoration<TResponse, TVariables>,
 		variables: TVariables,
 		{ cache, next = {} }: CacheOptions,
-		options: RequestOptions = {
-			signal: AbortSignal.timeout(defaultTimeout),
-		} satisfies RequestOptions,
+		options: RequestOptions = {}
 	): Promise<GqlResponse<TResponse>> => {
 		const query = isNode(astNode) ? print(astNode) : astNode.toString();
 
@@ -99,7 +94,7 @@ export const initServerFetcher =
 			includeQuery,
 		);
 		const requestOptions: RequestOptions = {
-			signal: options.signal ?? AbortSignal.timeout(defaultTimeout),
+			...options,
 			headers: mergeHeaders({ ...defaultHeaders, ...options.headers }),
 		};