Merged in feat/use-hash-for-graphql-cache (pull request #2251)

Feature: Use hash of query+variables for graphql cache instead of gitsha

* feature: use a hash of query+variables as part of the cache key instead of gitsha

* .

* Merge branch 'master' of bitbucket.org:scandic-swap/web into feat/use-hash-for-graphql-cache

* use correct json stringify

* merge

* remove edgeRequest in favor of request

* add more indicative logging


Approved-by: Linus Flood

apps/scandic-web/services/dataCache/DistributedCache/cacheOrGet.ts

@@ -15,7 +15,9 @@ export const cacheOrGet: DataCache["cacheOrGet"] = async <T>(
   ttl: CacheTime,
   opts?: CacheOrGetOptions
 ) => {
-  const cacheKey = generateCacheKey(key)
+  const cacheKey = generateCacheKey(key, {
+    includeGitHashInKey: opts?.includeGitHashInKey ?? true,
+  })
 
   let cachedValue: Awaited<T> | undefined = undefined
   if (shouldGetFromCache(opts)) {
@@ -32,8 +34,12 @@ export const cacheOrGet: DataCache["cacheOrGet"] = async <T>(
     const perf = performance.now()
     const data = await callback(overrideTTL)
 
+    const size = JSON.stringify(data).length / (1024 * 1024)
+    if (size >= 5) {
+      cacheLogger.warn(`'${key}' is larger than 5MB!`)
+    }
     cacheLogger.debug(
-      `Getting data '${cacheKey}' took ${(performance.now() - perf).toFixed(2)}ms`
+      `Fetching data took ${(performance.now() - perf).toFixed(2)}ms ${size.toFixed(4)}MB for '${key}'`
     )
 
     await set<T>(cacheKey, data, realTTL)

apps/scandic-web/services/dataCache/DistributedCache/generateCacheKey/getPrefix.ts

@@ -2,28 +2,41 @@ import { env } from "@/env/server"
 
 import { getBranchPrefix } from "./getBranchPrefix"
 
-export function getPrefix(): string {
+export function getPrefix(options: {
+  includeGitHashInKey: boolean
+  includeBranchPrefix: boolean
+}): string {
+  const prefixTokens = []
+
+  const includeGitHashInKey = options.includeGitHashInKey
+  const includeBranchPrefix = options.includeBranchPrefix
+
   if (process.env.NODE_ENV === "development") {
     const devPrefix = process.env.USER || process.env.USERNAME || "dev"
     return `${devPrefix}`
   }
 
-  const branch = env.BRANCH.trim()
-  const gitSha = env.GIT_SHA?.trim().substring(0, 7)
+  if (includeGitHashInKey) {
+    const gitSha = env.GIT_SHA?.trim().substring(0, 7)
 
-  if (!branch && !gitSha) {
-    throw new Error("Unable to getPrefix, BRANCH and GIT_SHA must be set")
+    if (!gitSha) {
+      throw new Error("Unable to getPrefix, GIT_SHA must be set")
+    }
+
+    prefixTokens.push(gitSha)
   }
 
-  if (!branch) {
-    throw new Error("Unable to getPrefix, BRANCH must be set")
-  }
+  if (includeBranchPrefix) {
+    const branch = env.BRANCH?.trim()
 
-  if (!gitSha) {
-    throw new Error("Unable to getPrefix, GIT_SHA must be set")
+    if (!branch) {
+      throw new Error("Unable to getPrefix, BRANCH must be set")
+    }
+    const branchPrefix = getBranchPrefix(branch)
+    if (branchPrefix) {
+      prefixTokens.push(branchPrefix)
+    }
   }
 
-  const prefixTokens = [getBranchPrefix(branch), gitSha].filter(Boolean)
-
   return prefixTokens.join(":")
 }

apps/scandic-web/services/dataCache/DistributedCache/generateCacheKey/index.ts

@@ -1,13 +1,20 @@
 import { getPrefix } from "./getPrefix"
 
-export function generateCacheKey(key: string | string[]): string {
+export function generateCacheKey(
+  key: string | string[],
+  options?: { includeGitHashInKey?: boolean }
+): string {
+  const includeGitHashInKey = options?.includeGitHashInKey ?? true
   const keyArray = (Array.isArray(key) ? key : [key]).filter(Boolean)
 
   if (keyArray.length === 0) {
     throw new Error("No keys provided")
   }
 
-  const prefix = getPrefix()
+  const prefix = getPrefix({
+    includeGitHashInKey,
+    includeBranchPrefix: true,
+  })
 
   const keyTokens = [prefix, keyArray.join("_")].filter(Boolean).join(":")