only dedupe pagination queries if the variables match

HoudiniGraphql · Oct 24, 2024 · 4892fdf · 4892fdf
1 parent 03ede8e
commit 4892fdf
Show file tree

Hide file tree

Showing 10 changed files with 178 additions and 45 deletions.
diff --git a/packages/houdini/src/codegen/generators/artifacts/index.ts b/packages/houdini/src/codegen/generators/artifacts/index.ts
@@ -4,6 +4,7 @@ import * as recast from 'recast'
 import type {
 	CachePolicies,
 	Config,
+	DedupeMatchModes,
 	Document,
 	DocumentArtifact,
 	MutationArtifact,
@@ -12,6 +13,7 @@ import type {
 } from '../../../lib'
 import {
 	ArtifactKind,
+	DedupeMatchMode,
 	HoudiniError,
 	cleanupFiles,
 	fs,
@@ -233,12 +235,22 @@ export default function artifactGenerator(stats: {
 								(arg) => arg.name.value === 'cancelFirst'
 							)
 
-							dedupe =
-								cancelFirstArg &&
-								cancelFirstArg.value.kind === 'BooleanValue' &&
-								cancelFirstArg.value
-									? 'first'
-									: 'last'
+							const matchArg = dedupeDirective.arguments?.find(
+								(arg) => arg.name.value === 'match'
+							)
+
+							dedupe = {
+								cancel:
+									cancelFirstArg &&
+									cancelFirstArg.value.kind === 'BooleanValue' &&
+									cancelFirstArg.value
+										? 'first'
+										: 'last',
+								match:
+									matchArg && matchArg.value.kind === 'StringValue'
+										? (matchArg.value.value as DedupeMatchModes)
+										: DedupeMatchMode.Operation,
+							}
 						}
 
 						// use this selection set

diff --git a/packages/houdini/src/codegen/generators/artifacts/tests/artifacts.test.ts b/packages/houdini/src/codegen/generators/artifacts/tests/artifacts.test.ts
@@ -846,7 +846,11 @@ test('paginate over unions', async function () {
 		    },
 
 		    "pluginData": {},
-		    "dedupe": "last",
+
+		    "dedupe": {
+		        "cancel": "last",
+		        "match": "Operation"
+		    },
 
 		    "input": {
 		        "fields": {
@@ -4932,7 +4936,11 @@ describe('mutation artifacts', function () {
 			    },
 
 			    "pluginData": {},
-			    "dedupe": "last",
+
+			    "dedupe": {
+			        "cancel": "last",
+			        "match": "Operation"
+			    },
 
 			    "input": {
 			        "fields": {
@@ -5185,7 +5193,11 @@ describe('mutation artifacts', function () {
 			    },
 
 			    "pluginData": {},
-			    "dedupe": "last",
+
+			    "dedupe": {
+			        "cancel": "last",
+			        "match": "Operation"
+			    },
 
 			    "input": {
 			        "fields": {
@@ -7774,7 +7786,12 @@ test('persists dedupe which', async function () {
 		    },
 
 		    "pluginData": {},
-		    "dedupe": "last",
+
+		    "dedupe": {
+		        "cancel": "last",
+		        "match": "Operation"
+		    },
+
 		    "policy": "CacheOrNetwork",
 		    "partial": false
 		};
@@ -7846,7 +7863,12 @@ test('persists dedupe first', async function () {
 		    },
 
 		    "pluginData": {},
-		    "dedupe": "first",
+
+		    "dedupe": {
+		        "cancel": "first",
+		        "match": "Operation"
+		    },
+
 		    "policy": "CacheOrNetwork",
 		    "partial": false
 		};

diff --git a/packages/houdini/src/codegen/generators/artifacts/tests/pagination.test.ts b/packages/houdini/src/codegen/generators/artifacts/tests/pagination.test.ts
@@ -781,7 +781,11 @@ test('cursor as scalar gets the right pagination query argument types', async fu
 		    },
 
 		    "pluginData": {},
-		    "dedupe": "last",
+
+		    "dedupe": {
+		        "cancel": "last",
+		        "match": "Operation"
+		    },
 
 		    "input": {
 		        "fields": {

diff --git a/packages/houdini/src/codegen/generators/definitions/enums.test.ts b/packages/houdini/src/codegen/generators/definitions/enums.test.ts
@@ -24,6 +24,14 @@ test('generates runtime definitions for each enum', async function () {
 	expect(parsedQuery).toMatchInlineSnapshot(`
 		type ValuesOf<T> = T[keyof T]
 			
+		export declare const DedupeMatchMode: {
+		    readonly Variables: "Variables";
+		    readonly Operation: "Operation";
+		    readonly None: "None";
+		}
+
+		export type DedupeMatchMode$options = ValuesOf<typeof DedupeMatchMode>
+		 
 		/** Documentation of testenum1 */
 		export declare const TestEnum1: {
 		    /** Documentation of Value1 */
@@ -72,5 +80,11 @@ test('generates runtime definitions for each enum', async function () {
 		    "Value3": "Value3",
 		    "Value2": "Value2"
 		};
+
+		export const DedupeMatchMode = {
+		    "Variables": "Variables",
+		    "Operation": "Operation",
+		    "None": "None"
+		};
 	`)
 })
diff --git a/packages/houdini/src/codegen/generators/definitions/schema.test.ts b/packages/houdini/src/codegen/generators/definitions/schema.test.ts
@@ -40,7 +40,7 @@ test('adds internal documents to schema', async function () {
 			@dedupe is used to prevent an operation from running more than once at the same time.
 			If the cancelFirst arg is set to true, the response already in flight will be canceled instead of the second one.
 			"""
-			directive @dedupe(cancelFirst: Boolean) on QUERY | MUTATION
+			directive @dedupe(cancelFirst: Boolean, match: DedupeMatchMode) on QUERY | MUTATION
 
 			"""@optimisticKey is used to identify a field as an optimistic key"""
 			directive @optimisticKey on FIELD
@@ -101,6 +101,12 @@ test('adds internal documents to schema', async function () {
 			  SinglePage
 			}
 
+			enum DedupeMatchMode {
+			  Variables
+			  Operation
+			  None
+			}
+
 			scalar ViewerIDFromSession
 		`)
 })
@@ -138,7 +144,7 @@ test('list operations are included', async function () {
 			@dedupe is used to prevent an operation from running more than once at the same time.
 			If the cancelFirst arg is set to true, the response already in flight will be canceled instead of the second one.
 			"""
-			directive @dedupe(cancelFirst: Boolean) on QUERY | MUTATION
+			directive @dedupe(cancelFirst: Boolean, match: DedupeMatchMode) on QUERY | MUTATION
 
 			"""@optimisticKey is used to identify a field as an optimistic key"""
 			directive @optimisticKey on FIELD
@@ -199,6 +205,12 @@ test('list operations are included', async function () {
 			  SinglePage
 			}
 
+			enum DedupeMatchMode {
+			  Variables
+			  Operation
+			  None
+			}
+
 			scalar ViewerIDFromSession
 
 			directive @User_delete repeatable on FIELD
@@ -255,7 +267,7 @@ test('list operations are included but delete directive should not be in when we
 			@dedupe is used to prevent an operation from running more than once at the same time.
 			If the cancelFirst arg is set to true, the response already in flight will be canceled instead of the second one.
 			"""
-			directive @dedupe(cancelFirst: Boolean) on QUERY | MUTATION
+			directive @dedupe(cancelFirst: Boolean, match: DedupeMatchMode) on QUERY | MUTATION
 
 			"""@optimisticKey is used to identify a field as an optimistic key"""
 			directive @optimisticKey on FIELD
@@ -316,6 +328,12 @@ test('list operations are included but delete directive should not be in when we
 			  SinglePage
 			}
 
+			enum DedupeMatchMode {
+			  Variables
+			  Operation
+			  None
+			}
+
 			scalar ViewerIDFromSession
 
 			directive @User_delete repeatable on FIELD
@@ -385,7 +403,7 @@ test("writing twice doesn't duplicate definitions", async function () {
 			@dedupe is used to prevent an operation from running more than once at the same time.
 			If the cancelFirst arg is set to true, the response already in flight will be canceled instead of the second one.
 			"""
-			directive @dedupe(cancelFirst: Boolean) on QUERY | MUTATION
+			directive @dedupe(cancelFirst: Boolean, match: DedupeMatchMode) on QUERY | MUTATION
 
 			"""@optimisticKey is used to identify a field as an optimistic key"""
 			directive @optimisticKey on FIELD
@@ -446,6 +464,12 @@ test("writing twice doesn't duplicate definitions", async function () {
 			  SinglePage
 			}
 
+			enum DedupeMatchMode {
+			  Variables
+			  Operation
+			  None
+			}
+
 			scalar ViewerIDFromSession
 		`)
 })
diff --git a/packages/houdini/src/codegen/transforms/paginate.test.ts b/packages/houdini/src/codegen/transforms/paginate.test.ts
@@ -1061,7 +1061,7 @@ test('query with forwards cursor paginate', async function () {
 
 	// load the contents of the file
 	expect(docs[0]?.document).toMatchInlineSnapshot(`
-		query Users($first: Int = 10, $after: String) @dedupe {
+		query Users($first: Int = 10, $after: String) @dedupe(match: Variables) {
 		  usersByForwardsCursor(first: $first, after: $after) @paginate {
 		    edges {
 		      node {
@@ -1108,7 +1108,7 @@ test('query with custom first args', async function () {
 
 	// load the contents of the file
 	expect(docs[0]?.document).toMatchInlineSnapshot(`
-		query Users($limit: Int!, $after: String) @dedupe {
+		query Users($limit: Int!, $after: String) @dedupe(match: Variables) {
 		  usersByForwardsCursor(first: $limit, after: $after) @paginate {
 		    edges {
 		      node {
@@ -1155,7 +1155,7 @@ test('query with backwards cursor paginate', async function () {
 
 	// load the contents of the file
 	expect(docs[0]?.document).toMatchInlineSnapshot(`
-		query Users @dedupe {
+		query Users @dedupe(match: Variables) {
 		  usersByBackwardsCursor(last: 10) @paginate {
 		    edges {
 		      node {
@@ -1198,7 +1198,7 @@ test('query with offset paginate', async function () {
 
 	// load the contents of the file
 	expect(docs[0]?.document).toMatchInlineSnapshot(`
-		query Users($limit: Int = 10, $offset: Int) @dedupe {
+		query Users($limit: Int = 10, $offset: Int) @dedupe(match: Variables) {
 		  usersByOffset(limit: $limit, offset: $offset) @paginate {
 		    id
 		  }
@@ -1229,7 +1229,7 @@ test('query with backwards cursor on full paginate', async function () {
 
 	// load the contents of the file
 	expect(docs[0]?.document).toMatchInlineSnapshot(`
-		query Users($first: Int, $after: String, $last: Int = 10, $before: String) @dedupe {
+		query Users($first: Int, $after: String, $last: Int = 10, $before: String) @dedupe(match: Variables) {
 		  usersByCursor(last: $last, first: $first, after: $after, before: $before) @paginate {
 		    edges {
 		      node {
@@ -1276,7 +1276,7 @@ test('query with forwards cursor on full paginate', async function () {
 
 	// load the contents of the file
 	expect(docs[0]?.document).toMatchInlineSnapshot(`
-		query Users($first: Int = 10, $after: String, $last: Int, $before: String) @dedupe {
+		query Users($first: Int = 10, $after: String, $last: Int, $before: String) @dedupe(match: Variables) {
 		  usersByCursor(first: $first, after: $after, last: $last, before: $before) @paginate {
 		    edges {
 		      node {
@@ -1323,7 +1323,7 @@ test("don't generate unsupported directions", async function () {
 
 	// load the contents of the file
 	expect(docs[0]?.document).toMatchInlineSnapshot(`
-		query Users($first: Int = 10, $after: String) @dedupe {
+		query Users($first: Int = 10, $after: String) @dedupe(match: Variables) {
 		  usersByForwardsCursor(first: $first, after: $after) @paginate {
 		    edges {
 		      node {
@@ -1370,7 +1370,7 @@ test("forwards cursor paginated query doesn't overlap variables", async function
 
 	// load the contents of the file
 	expect(docs[0]?.document).toMatchInlineSnapshot(`
-		query Users($first: Int!, $after: String, $last: Int, $before: String) @dedupe {
+		query Users($first: Int!, $after: String, $last: Int, $before: String) @dedupe(match: Variables) {
 		  usersByCursor(first: $first, after: $after, last: $last, before: $before) @paginate {
 		    edges {
 		      node {
@@ -1417,7 +1417,7 @@ test("backwards cursor paginated query doesn't overlap variables", async functio
 
 	// load the contents of the file
 	expect(docs[0]?.document).toMatchInlineSnapshot(`
-		query Users($last: Int!, $first: Int, $after: String, $before: String) @dedupe {
+		query Users($last: Int!, $first: Int, $after: String, $before: String) @dedupe(match: Variables) {
 		  usersByCursor(last: $last, first: $first, after: $after, before: $before) @paginate {
 		    edges {
 		      node {
@@ -1460,7 +1460,7 @@ test("offset paginated query doesn't overlap variables", async function () {
 
 	// load the contents of the file
 	expect(docs[0]?.document).toMatchInlineSnapshot(`
-		query Users($limit: Int! = 10, $offset: Int) @dedupe {
+		query Users($limit: Int! = 10, $offset: Int) @dedupe(match: Variables) {
 		  usersByOffset(limit: $limit, offset: $offset) @paginate {
 		    id
 		  }

diff --git a/packages/houdini/src/codegen/transforms/paginate.ts b/packages/houdini/src/codegen/transforms/paginate.ts
@@ -2,7 +2,7 @@ import * as graphql from 'graphql'
 
 import type { Config, Document } from '../../lib'
 import { HoudiniError, parentTypeFromAncestors, unwrapType, wrapType } from '../../lib'
-import { ArtifactKind, type PaginateModes } from '../../runtime/lib/types'
+import { ArtifactKind, DedupeMatchMode, type PaginateModes } from '../../runtime/lib/types'
 import {
 	fragmentArguments as collectFragmentArguments,
 	type FragmentArgument,
@@ -233,6 +233,19 @@ export default async function paginate(config: Config, documents: Document[]): P
 									kind: graphql.Kind.NAME,
 									value: config.dedupeDirective,
 								},
+								arguments: [
+									{
+										kind: 'Argument',
+										name: {
+											kind: 'Name',
+											value: 'match',
+										},
+										value: {
+											kind: 'EnumValue',
+											value: DedupeMatchMode.Variables,
+										},
+									},
+								],
 							},
 						],
 					} as graphql.OperationDefinitionNode

diff --git a/packages/houdini/src/codegen/transforms/schema.ts b/packages/houdini/src/codegen/transforms/schema.ts
@@ -3,7 +3,7 @@ import * as graphql from 'graphql'
 
 import type { Config, Document } from '../../lib'
 import { siteURL } from '../../lib'
-import { CachePolicy, PaginateMode } from '../../runtime/lib/types'
+import { CachePolicy, DedupeMatchMode, PaginateMode } from '../../runtime/lib/types'
 import { fragmentArguments } from './fragmentVariables'
 
 // graphqlExtensions adds a few different things to the graphql schema
@@ -52,13 +52,21 @@ directive @${config.paginateDirective}(${config.listOrPaginateNameArg}: String,
 """
 directive @${config.listPrependDirective} on FRAGMENT_SPREAD
 
+enum DedupeMatchMode {
+	${DedupeMatchMode.Variables}
+	${DedupeMatchMode.Operation}
+	${DedupeMatchMode.None}
+}
+
 """
 	@${
 		config.dedupeDirective
 	} is used to prevent an operation from running more than once at the same time.
 	If the cancelFirst arg is set to true, the response already in flight will be canceled instead of the second one.
 """
-directive @${config.dedupeDirective}(cancelFirst: Boolean) on QUERY | MUTATION
+directive @${
+		config.dedupeDirective
+	}(cancelFirst: Boolean, match: DedupeMatchMode) on QUERY | MUTATION
 
 """
 	@${config.optimisticKeyDirective} is used to identify a field as an optimistic key