houdini 0.17.7 → 0.17.9

package/src/codegen/validators/typeCheck.ts

@@ -320,6 +320,8 @@ export default async function typeCheck(
 					listTypes,
 					fragments,
 				}),
+				// checkMutationOperation
+				checkMutationOperation(config),
 				// pagination directive can only show up on nodes or the query type
 				nodeDirectives(config, [config.paginateDirective]),
 				// this replaces KnownArgumentNamesRule
@@ -415,29 +417,43 @@ const validateLists = ({
 					return
 				}
 
+				// Do we have the parentId another way?
+				let parentIdFound = false
 				// look for one of the list directives
 				directive = node.directives?.find(({ name }) => [
 					[config.listPrependDirective, config.listAppendDirective].includes(name.value),
 				])
-				// if there is no directive
-				if (!directive) {
-					ctx.reportError(
-						new graphql.GraphQLError('parentID is required for this list fragment')
+				if (directive) {
+					// find the argument holding the parent ID
+					let parentArg = directive.arguments?.find(
+						(arg) => arg.name.value === config.listDirectiveParentIDArg
 					)
+					if (parentArg) {
+						parentIdFound = true
+					}
+				}
+
+				if (parentIdFound) {
+					// parentId was found, so we're good to go
 					return
 				}
 
-				// find the argument holding the parent ID
-				let parentArg = directive.arguments?.find(
-					(arg) => arg.name.value === config.listDirectiveParentIDArg
+				// look for allLists directive
+				const allLists = node.directives?.find(
+					({ name }) => config.listAllListsDirective === name.value
 				)
 
-				if (!parentArg) {
-					ctx.reportError(
-						new graphql.GraphQLError('parentID is required for this list fragment')
-					)
+				// if there is the directive or it's
+				if (allLists || config.defaultListTarget === 'all') {
 					return
 				}
+
+				ctx.reportError(
+					new graphql.GraphQLError(
+						`For this list fragment, you need to add or @${config.listParentDirective} or @${config.listAllListsDirective} directive to specify the behavior`
+					)
+				)
+				return
 			},
 			// if we run into a directive that points to a list, make sure that list exists
 			Directive(node) {
@@ -925,6 +941,45 @@ function nodeDirectives(config: Config, directives: string[]) {
 	}
 }
 
+function checkMutationOperation(config: Config) {
+	return function (ctx: graphql.ValidationContext): graphql.ASTVisitor {
+		return {
+			FragmentSpread(node, _, __, ___, ancestors) {
+				const append = node.directives?.find(
+					(c) => c.name.value === config.listAppendDirective
+				)
+
+				const prepend = node.directives?.find(
+					(c) => c.name.value === config.listPrependDirective
+				)
+				if (append && prepend) {
+					ctx.reportError(
+						new graphql.GraphQLError(
+							`You can't apply both @${config.listPrependDirective} and @${config.listAppendDirective} at the same time`
+						)
+					)
+					return
+				}
+
+				const parentId = node.directives?.find(
+					(c) => c.name.value === config.listParentDirective
+				)
+				const allLists = node.directives?.find(
+					(c) => c.name.value === config.listAllListsDirective
+				)
+				if (parentId && allLists) {
+					ctx.reportError(
+						new graphql.GraphQLError(
+							`You can't apply both @${config.listParentDirective} and @${config.listAllListsDirective} at the same time`
+						)
+					)
+					return
+				}
+			},
+		}
+	}
+}
+
 export function getAndVerifyNodeInterface(config: Config): graphql.GraphQLInterfaceType | null {
 	const { schema } = config
 

package/src/lib/config.ts

@@ -38,6 +38,8 @@ export class Config {
 	cacheBufferSize?: number
 	defaultCachePolicy: CachePolicy
 	defaultPartial: boolean
+	internalListPosition: 'first' | 'last'
+	defaultListTarget: 'all' | null = null
 	definitionsFolder?: string
 	newSchema: string = ''
 	newDocuments: string = ''
@@ -77,6 +79,8 @@ export class Config {
 			definitionsPath,
 			defaultCachePolicy = CachePolicy.CacheOrNetwork,
 			defaultPartial = false,
+			defaultListPosition = 'append',
+			defaultListTarget = null,
 			defaultKeys,
 			types = {},
 			logLevel,
@@ -116,6 +120,8 @@ export class Config {
 		this.cacheBufferSize = cacheBufferSize
 		this.defaultCachePolicy = defaultCachePolicy
 		this.defaultPartial = defaultPartial
+		this.internalListPosition = defaultListPosition === 'append' ? 'last' : 'first'
+		this.defaultListTarget == defaultListTarget
 		this.definitionsFolder = definitionsPath
 		this.logLevel = ((logLevel as LogLevel) || LogLevel.Summary).toLowerCase() as LogLevel
 		this.disableMasking = disableMasking
@@ -470,6 +476,10 @@ export class Config {
 		return 'parentID'
 	}
 
+	get listAllListsDirective() {
+		return 'allLists'
+	}
+
 	get listNameArg() {
 		return 'name'
 	}
@@ -578,6 +588,7 @@ export class Config {
 				this.listPrependDirective,
 				this.listAppendDirective,
 				this.listDirectiveParentIDArg,
+				this.listAllListsDirective,
 				this.whenDirective,
 				this.whenNotDirective,
 				this.argumentsDirective,

package/src/runtime/cache/cache.ts

@@ -110,8 +110,8 @@ export class Cache {
 	}
 
 	// return the list handler to mutate a named list in the cache
-	list(name: string, parentID?: string | {}): ListCollection {
-		const handler = this._internal_unstable.lists.get(name, parentID)
+	list(name: string, parentID?: string, allLists?: boolean): ListCollection {
+		const handler = this._internal_unstable.lists.get(name, parentID, allLists)
 		if (!handler) {
 			throw new Error(
 				`Cannot find list with name: ${name}${
@@ -570,7 +570,10 @@ class CacheInternal {
 				}
 
 				// if the necessary list doesn't exist, don't do anything
-				if (operation.list && !this.lists.get(operation.list, parentID)) {
+				if (
+					operation.list &&
+					!this.lists.get(operation.list, parentID, operation.target === 'all')
+				) {
 					continue
 				}
 
@@ -585,7 +588,7 @@ class CacheInternal {
 						operation.list
 					) {
 						this.cache
-							.list(operation.list, parentID)
+							.list(operation.list, parentID, operation.target === 'all')
 							.when(operation.when)
 							.addToList(fields, target, variables, operation.position || 'last')
 					}
@@ -598,7 +601,7 @@ class CacheInternal {
 						operation.list
 					) {
 						this.cache
-							.list(operation.list, parentID)
+							.list(operation.list, parentID, operation.target === 'all')
 							.when(operation.when)
 							.remove(target, variables)
 					}
@@ -624,7 +627,7 @@ class CacheInternal {
 						operation.list
 					) {
 						this.cache
-							.list(operation.list, parentID)
+							.list(operation.list, parentID, operation.target === 'all')
 							.when(operation.when)
 							.toggleElement(fields, target, variables, operation.position || 'last')
 					}

package/src/runtime/cache/lists.ts

@@ -16,7 +16,7 @@ export class ListManager {
 
 	private listsByField: Map<string, Map<string, List[]>> = new Map()
 
-	get(listName: string, id?: string | {}) {
+	get(listName: string, id?: string, allLists?: boolean) {
 		const matches = this.lists.get(listName)
 
 		// if we don't have a list by that name, we're done
@@ -24,11 +24,29 @@ export class ListManager {
 			return null
 		}
 
+		// if we want to update all list, return all matches
+		if (allLists) {
+			return new ListCollection(
+				Array.from(matches, ([key, value]) => [...value.lists]).flat()
+			)
+		}
+
 		const head = [...matches.values()][0]
 
+		// the provided id won't match the cache's ID so we have to compute the internal ID, using
+		// one of the matches to figure out the type of the list element
+		const { recordType } = head.lists[0]
+		const parentID = id ? this.cache._internal_unstable.id(recordType || '', id)! : this.rootID
+
 		// if there is only one list with that name, return it
 		if (matches?.size === 1) {
-			return head
+			// if there is no provided id, just use the first one
+			if (!id) {
+				return head
+			}
+
+			// otherwise we're only safe to use the head if it matches the parentID
+			return parentID === Array.from(matches.keys())[0] ? head : null
 		}
 
 		// there are multiple versions of the list so the user must
@@ -36,17 +54,13 @@ export class ListManager {
 		// it would have been caught in the size === 1 check above since
 		// root's ID is fixed
 		if (!id) {
-			throw new Error(
-				`Found multiple instances of "${listName}". Please provide a ` +
-					`parentID that corresponds to the object containing the field marked with @list or @paginate.`
+			console.error(
+				`Found multiple instances of "${listName}". Please provide one of @parentID or @allLists directives to ` +
+					`help identify which list you want modify. For more information, visit this guide: https://www.houdinigraphql.com/api/graphql#parentidvalue-string `
 			)
+			return null
 		}
 
-		// the provided id won't match the cache's ID so we have to compute the internal ID, using
-		// one of the matches to figure out the type of the list element
-		const { recordType } = head.lists[0]
-		const parentID = id ? this.cache._internal_unstable.id(recordType || '', id)! : this.rootID
-
 		// return the list pointing to the correct parent
 		return this.lists.get(listName)?.get(parentID)
 	}

package/src/runtime/cache/tests/list.test.ts

@@ -1624,10 +1624,6 @@ test('append operation', function () {
 					{
 						action: 'insert',
 						list: 'All_Users',
-						parentID: {
-							kind: 'String',
-							value: cache._internal_unstable.id('User', '1')!,
-						},
 					},
 				],
 				fields: {
@@ -1646,7 +1642,7 @@ test('append operation', function () {
 	})
 
 	// make sure we just added to the list
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toHaveLength(1)
+	expect([...cache.list('All_Users', '1')]).toHaveLength(1)
 })
 
 test('append from list', function () {
@@ -1716,10 +1712,6 @@ test('append from list', function () {
 					{
 						action: 'insert',
 						list: 'All_Users',
-						parentID: {
-							kind: 'String',
-							value: cache._internal_unstable.id('User', '1')!,
-						},
 					},
 				],
 				fields: {
@@ -1736,7 +1728,7 @@ test('append from list', function () {
 	})
 
 	// make sure we just added to the list
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toHaveLength(2)
+	expect([...cache.list('All_Users', '1')]).toHaveLength(2)
 })
 
 test('toggle list', function () {
@@ -1823,10 +1815,6 @@ test('toggle list', function () {
 				{
 					action: 'toggle',
 					list: 'All_Users',
-					parentID: {
-						kind: 'String',
-						value: cache._internal_unstable.id('User', '1')!,
-					},
 				},
 			],
 			fields: {
@@ -1841,23 +1829,15 @@ test('toggle list', function () {
 	// write some data to a different location with a new user
 	// that should be added to the list
 	cache.write({ selection: toggleSelection, data: { newUser: { id: '3' } } })
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toEqual([
-		'User:5',
-		'User:3',
-	])
+	expect([...cache.list('All_Users', '1')]).toEqual(['User:5', 'User:3'])
 
 	// toggle the user again to remove the user
 	cache.write({ selection: toggleSelection, data: { newUser: { id: '3' } } })
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toEqual([
-		'User:5',
-	])
+	expect([...cache.list('All_Users', '1')]).toEqual(['User:5'])
 
 	// toggle the user again to add the user back
 	cache.write({ selection: toggleSelection, data: { newUser: { id: '3' } } })
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toEqual([
-		'User:5',
-		'User:3',
-	])
+	expect([...cache.list('All_Users', '1')]).toEqual(['User:5', 'User:3'])
 })
 
 test('append when operation', function () {
@@ -1933,10 +1913,6 @@ test('append when operation', function () {
 					{
 						action: 'insert',
 						list: 'All_Users',
-						parentID: {
-							kind: 'String',
-							value: cache._internal_unstable.id('User', '1')!,
-						},
 						when: {
 							must: {
 								value: 'not-foo',
@@ -1960,7 +1936,7 @@ test('append when operation', function () {
 	})
 
 	// make sure we just added to the list
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toHaveLength(0)
+	expect([...cache.list('All_Users', '1')]).toHaveLength(0)
 })
 
 test('prepend when operation', function () {
@@ -2036,10 +2012,6 @@ test('prepend when operation', function () {
 					{
 						action: 'insert',
 						list: 'All_Users',
-						parentID: {
-							kind: 'String',
-							value: cache._internal_unstable.id('User', '1')!,
-						},
 						position: 'first',
 						when: {
 							must: {
@@ -2064,7 +2036,7 @@ test('prepend when operation', function () {
 	})
 
 	// make sure we just added to the list
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toHaveLength(0)
+	expect([...cache.list('All_Users', '1')]).toHaveLength(0)
 })
 
 test('prepend operation', function () {
@@ -2154,10 +2126,6 @@ test('prepend operation', function () {
 					{
 						action: 'insert',
 						list: 'All_Users',
-						parentID: {
-							kind: 'String',
-							value: cache._internal_unstable.id('User', '1')!,
-						},
 						position: 'first',
 					},
 				],
@@ -2177,10 +2145,7 @@ test('prepend operation', function () {
 	})
 
 	// make sure we just added to the list
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toEqual([
-		'User:3',
-		'User:2',
-	])
+	expect([...cache.list('All_Users', '1')]).toEqual(['User:3', 'User:2'])
 })
 
 test('remove operation', function () {
@@ -2265,10 +2230,6 @@ test('remove operation', function () {
 					{
 						action: 'remove',
 						list: 'All_Users',
-						parentID: {
-							kind: 'String',
-							value: cache._internal_unstable.id('User', '1')!,
-						},
 					},
 				],
 				fields: {
@@ -2287,7 +2248,7 @@ test('remove operation', function () {
 	})
 
 	// make sure we removed the element from the list
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toHaveLength(0)
+	expect([...cache.list('All_Users', '1')]).toHaveLength(0)
 })
 
 test('remove operation from list', function () {
@@ -2375,10 +2336,6 @@ test('remove operation from list', function () {
 					{
 						action: 'remove',
 						list: 'All_Users',
-						parentID: {
-							kind: 'String',
-							value: cache._internal_unstable.id('User', '1')!,
-						},
 					},
 				],
 				fields: {
@@ -2395,7 +2352,7 @@ test('remove operation from list', function () {
 	})
 
 	// make sure we removed the element from the list
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toHaveLength(0)
+	expect([...cache.list('All_Users', '1')]).toHaveLength(0)
 })
 
 test('delete operation', function () {
@@ -2498,7 +2455,7 @@ test('delete operation', function () {
 	})
 
 	// make sure we removed the element from the list
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toHaveLength(0)
+	expect([...cache.list('All_Users', '1')]).toHaveLength(0)
 
 	expect(cache._internal_unstable.storage.topLayer.operations['User:2'].deleted).toBeTruthy()
 })
@@ -2606,7 +2563,7 @@ test('delete operation from list', function () {
 	})
 
 	// make sure we removed the element from the list
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toHaveLength(0)
+	expect([...cache.list('All_Users', '1')]).toHaveLength(0)
 
 	expect(cache._internal_unstable.storage.topLayer.operations['User:2'].deleted).toBeTruthy()
 	expect(cache._internal_unstable.storage.topLayer.operations['User:3'].deleted).toBeTruthy()
@@ -2753,7 +2710,7 @@ test('delete operation from connection', function () {
 	})
 
 	// make sure we removed the element from the list
-	expect([...cache.list('All_Users', cache._internal_unstable.id('User', '1')!)]).toHaveLength(0)
+	expect([...cache.list('All_Users', '1')]).toHaveLength(0)
 	expect(cache._internal_unstable.storage.topLayer.operations['User:2'].deleted).toBeTruthy()
 })
 
@@ -3225,10 +3182,6 @@ test('list operations fail silently', function () {
 						{
 							action: 'insert',
 							list: 'All_Users',
-							parentID: {
-								kind: 'String',
-								value: cache._internal_unstable.id('User', '1')!,
-							},
 						},
 					],
 					fields: {
@@ -3399,7 +3352,7 @@ test('parentID must be passed if there are multiple instances of a list handler'
 	// instantiate a cache
 	const cache = new Cache(config)
 
-	const friendsSelection = {
+	const friendsSelection: SubscriptionSelection = {
 		friends: {
 			type: 'User',
 			keyRaw: 'friends',
@@ -3471,11 +3424,73 @@ test('parentID must be passed if there are multiple instances of a list handler'
 		{}
 	)
 
-	// looking up the list without a parent id should fail
-	expect(() => cache.list('All_Users')).toThrow()
-	expect(cache.list('All_Users', '1')!.lists[0].recordID).toEqual(
-		cache._internal_unstable.id('User', '1')
-	)
+	// append a value to the store
+	const writeSelectionNoParentID: SubscriptionSelection = {
+		user: {
+			type: 'User',
+			keyRaw: 'user',
+			operations: [
+				{
+					action: 'insert',
+					list: 'All_Users',
+				},
+			],
+			fields: {
+				id: {
+					type: 'ID',
+					keyRaw: 'id',
+				},
+				firstName: {
+					type: 'String',
+					keyRaw: 'firstName',
+				},
+			},
+		},
+	}
+	const writeSelectionWithParentID: SubscriptionSelection = {
+		user: {
+			type: 'User',
+			keyRaw: 'user',
+			operations: [
+				{
+					action: 'insert',
+					list: 'All_Users',
+					parentID: {
+						kind: 'String',
+						value: '1',
+					},
+				},
+			],
+			fields: {
+				id: {
+					type: 'ID',
+					keyRaw: 'id',
+				},
+				firstName: {
+					type: 'String',
+					keyRaw: 'firstName',
+				},
+			},
+		},
+	}
+
+	// write the value without a parent ID
+	cache.write({
+		selection: writeSelectionNoParentID,
+		data: { user: { id: '2', firstName: 'test' } },
+	})
+	// make sure we didn't modify the lists
+	expect([...cache.list('All_Users', '1')]).toHaveLength(1)
+	expect([...cache.list('All_Users', '2')]).toHaveLength(0)
+
+	// write the value with a parent ID
+	cache.write({
+		selection: writeSelectionWithParentID,
+		data: { user: { id: '2', firstName: 'test' } },
+	})
+	// make sure we modified the correct list
+	expect([...cache.list('All_Users', '1')]).toHaveLength(2)
+	expect([...cache.list('All_Users', '2')]).toHaveLength(0)
 })
 
 test('append in abstract list', function () {
@@ -3745,3 +3760,95 @@ test('list operations on interface fields without a well defined parent update t
 		},
 	})
 })
+
+test("parentID ignores single lists that don't match", function () {
+	// instantiate a cache
+	const cache = new Cache(config)
+
+	// create a list we will add to
+	cache.write({
+		selection: {
+			viewer: {
+				type: 'User',
+				keyRaw: 'viewer',
+				fields: {
+					id: {
+						type: 'ID',
+						keyRaw: 'id',
+					},
+				},
+			},
+		},
+		data: {
+			viewer: {
+				id: '1',
+			},
+		},
+	})
+
+	// subscribe to the data to register the list
+	cache.subscribe(
+		{
+			rootType: 'User',
+			selection: {
+				friends: {
+					type: 'User',
+					keyRaw: 'friends',
+					list: {
+						name: 'All_Users',
+						connection: false,
+						type: 'User',
+					},
+					fields: {
+						id: {
+							type: 'ID',
+							keyRaw: 'id',
+						},
+						firstName: {
+							type: 'String',
+							keyRaw: 'firstName',
+						},
+					},
+				},
+			},
+			parentID: cache._internal_unstable.id('User', '1')!,
+			set: vi.fn(),
+		},
+		{}
+	)
+
+	// write some data to a different location with a new user
+	// that should be added to the list
+	cache.write({
+		selection: {
+			newUser: {
+				type: 'User',
+				keyRaw: 'newUser',
+				operations: [
+					{
+						action: 'insert',
+						list: 'All_Users',
+						parentID: {
+							kind: 'String',
+							value: '2',
+						},
+					},
+				],
+				fields: {
+					id: {
+						type: 'ID',
+						keyRaw: 'id',
+					},
+				},
+			},
+		},
+		data: {
+			newUser: {
+				id: '3',
+			},
+		},
+	})
+
+	// make sure we just added to the list
+	expect([...cache.list('All_Users', '1')]).toHaveLength(0)
+})

package/src/runtime/lib/config.ts

@@ -100,13 +100,13 @@ export type ConfigFile = {
 	definitionsPath?: string
 
 	/**
-	 * One of "kit" or "svelte". Used to tell the preprocessor what kind of loading paradigm to generate for you. (default: kit)
+	 * One of "kit" or "svelte". Used to tell the preprocessor what kind of loading paradigm to generate for you. (default: `kit`)
 	 * @deprecated please follow the steps here: http://www.houdinigraphql.com/guides/release-notes#0170
 	 */
 	framework?: 'kit' | 'svelte'
 
 	/**
-	 * One of "esm" or "commonjs". Tells the artifact generator what kind of modules to create. (default: esm)
+	 * One of "esm" or "commonjs". Tells the artifact generator what kind of modules to create. (default: `esm`)
 	 */
 	module?: 'esm' | 'commonjs'
 
@@ -125,6 +125,16 @@ export type ConfigFile = {
 	 */
 	defaultPartial?: boolean
 
+	/**
+	 * Specifies whether mutations should append or prepend list. For more information: https://www.houdinigraphql.com/api/graphql (default: `append`)
+	 */
+	defaultListPosition?: 'append' | 'prepend'
+
+	/**
+	 * Specifies whether mutation should apply a specific target list. When you set `all`, it's like adding the directive `@allLists` to all _insert fragment (default: `null`)
+	 */
+	defaultListTarget?: 'all' | null
+
 	/**
 	 * A list of fields to use when computing a record’s id. The default value is ['id']. For more information: https://www.houdinigraphql.com/guides/caching-data#custom-ids
 	 */