[Bug?]: deleteCacheKey() does not format key like cache() & cacheFindMany()

[ched-dev]

What's not working?

When I call deleteCacheKey([key, id]) it cannot find the key even though it is the same value passed to cache([key, id]) or cacheFindMany(key).

Code References:

redwood/packages/api/src/cache/index.ts

Lines 80 to 85 in 2efee67

	const cache = async <TResult>(
	key: CacheKey,
	input: () => TResult | Promise<TResult>,
	options?: CacheOptions
	): Promise<any> => {
	const cacheKey = formatCacheKey(key, prefix)

redwood/packages/api/src/cache/index.ts

Lines 137 to 143 in 2efee67

	const cacheFindMany = async <TDelegate extends GenericDelegate>(
	key: CacheKey,
	model: TDelegate,
	options: CacheFindManyOptions<Parameters<TDelegate['findMany']>[0]> = {}
	) => {
	const { conditions, ...rest } = options
	const cacheKey = formatCacheKey(key, prefix)

redwood/packages/api/src/cache/index.ts

Lines 188 to 205 in 2efee67

	const deleteCacheKey = async (key: CacheKey) => {
	let result
	try {
	await Promise.race([
	(result = client.del(key as string)),
	wait(timeout).then(() => {
	throw new CacheTimeoutError()
	}),
	])
	logger?.debug(`[Cache] DEL '${key}'`)
	return result
	} catch (e: any) {
	logger?.error(`[Cache] Error DEL '${key}': ${e.message}`)
	return false
	}
	}

How do we reproduce the bug?

Using deleteCacheKey([key, id]) with a global prefix

• Add a global prefix to your /api/src/lib/cache.ts file

export const { cache, cacheFindMany, cacheClient, deleteCacheKey } = createCache(client, {
  logger,
+  prefix: `prod`,
  timeout: 500,
})

• Cache a query with an array of strings

export const productCategory: QueryResolvers['productCategory'] = ({ id }) => {
  return cache(['productCategories', id], () => {
    return db.productCategory.findUnique({
      where: { id },
    })
  })
}

• When loaded next it will properly create the cache item with a key similar to prod-productCategories-GUID
• Add a matching deleteCacheKey() for your update query

export const updateProductCategory: MutationResolvers['updateProductCategory'] =
  async ({ id, input }) => {
    await deleteCacheKey(['productCategories', id])

    return db.productCategory.update({
      data: input,
      where: { id },
    })
  }

• Update the same item you previously viewed (productCategories.GUID)
• Console will throw error because it cannot find the key

[Cache] Error DEL 'productCategories,GUID': Invalid argument type

What's your environment? (If it applies)

System:
    OS: macOS 12.0.1
    Shell: 5.8 - /bin/zsh
  Binaries:
    Node: 16.13.2 - /private/var/folders/.../node
    Yarn: 3.2.0 - /private/var/folders/.../yarn
  Databases:
    SQLite: 3.36.0 - /usr/bin/sqlite3
  Browsers:
    Chrome: 109.0.5414.87
    Firefox: 107.0
    Safari: 15.1
  npmPackages:
    @redwoodjs/core: ^3.8.0 => 3.8.0

Are you interested in working on this?

• I'm interested in working on this

[arimendelow]

just ran into the same issue :) thanks @cannikin for your great work on this!

[cannikin]

Oh geez, I dunno why that wasn’t merged by now! I’ll take a look tomorrow.

[cannikin]

Merged! Should be in 4.2.3 or 4.3.0, whichever comes next!