@graphcommerce/magento-store 5.2.0-canary.16 → 5.2.0-canary.18

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 5.2.0-canary.18
+
+### Patch Changes
+
+- [#1790](https://github.com/graphcommerce-org/graphcommerce/pull/1790) [`875a595da`](https://github.com/graphcommerce-org/graphcommerce/commit/875a595da5f52b77bc2535cf4a660267b0046a1e) - ApolloClient cache would balloon with all redirects and make sure redirects work ([@LaurensFranken](https://github.com/LaurensFranken))
+
+## 5.2.0-canary.17
+
 ## 5.2.0-canary.16
 
 ## 5.2.0-canary.15

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/magento-store",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "5.2.0-canary.16",
+  "version": "5.2.0-canary.18",
   "sideEffects": false,
   "prettier": "@graphcommerce/prettier-config-pwa",
   "eslintConfig": {
@@ -12,15 +12,15 @@
     }
   },
   "devDependencies": {
-    "@graphcommerce/eslint-config-pwa": "5.2.0-canary.16",
-    "@graphcommerce/prettier-config-pwa": "5.2.0-canary.16",
-    "@graphcommerce/typescript-config-pwa": "5.2.0-canary.16"
+    "@graphcommerce/eslint-config-pwa": "5.2.0-canary.18",
+    "@graphcommerce/prettier-config-pwa": "5.2.0-canary.18",
+    "@graphcommerce/typescript-config-pwa": "5.2.0-canary.18"
   },
   "dependencies": {
-    "@graphcommerce/graphql": "5.2.0-canary.16",
-    "@graphcommerce/graphql-mesh": "5.2.0-canary.16",
-    "@graphcommerce/image": "5.2.0-canary.16",
-    "@graphcommerce/next-ui": "5.2.0-canary.16"
+    "@graphcommerce/graphql": "5.2.0-canary.18",
+    "@graphcommerce/graphql-mesh": "5.2.0-canary.18",
+    "@graphcommerce/image": "5.2.0-canary.18",
+    "@graphcommerce/next-ui": "5.2.0-canary.18"
   },
   "peerDependencies": {
     "@lingui/react": "^3.13.2",

package/utils/redirectOrNotFound.ts

@@ -11,20 +11,25 @@ export type RedirectOr404Return = Promise<
   | { notFound: true; revalidate?: number | boolean }
 >
 
-const notFound = () => {
+const notFound = (from: string, reason: string) => {
   flushMeasurePerf()
+  console.log(`[redirectOrNotFound: /${from}] ${reason}`)
   return { notFound: true, revalidate: 60 * 20 } as const
 }
 
-const redirect = (to: string, permanent: boolean, locale?: string) => {
+const redirect = (from: string, to: string, permanent: boolean, locale?: string) => {
   const prefix = locale === defaultLocale() ? '' : `/${locale}`
   const destination = `${prefix}${to}`
 
   flushMeasurePerf()
 
+  // eslint-disable-next-line no-console
+  console.log(
+    `[redirectOrNotFound: /${prefix}/${from}] ${
+      permanent ? 'Permanent' : 'Temporary'
+    } redirect to ${destination}`,
+  )
   if (process.env.NODE_ENV === 'development') {
-    // eslint-disable-next-line no-console
-    console.log(`${permanent ? 'Permanent' : 'Temporary'} redirect to ${to}`)
     // eslint-disable-next-line no-param-reassign
     permanent = false
   }
@@ -37,75 +42,81 @@ export async function redirectOrNotFound(
   params?: ParsedUrlQuery,
   locale?: string,
 ): RedirectOr404Return {
-  try {
-    // Create a URL from the params provided.
-    const urlKey = Object.values(params ?? {})
-      .map((v) => (Array.isArray(v) ? v.join('/') : v))
-      .join('/')
+  // Create a URL from the params provided.
+  const from = Object.values(params ?? {})
+    .map((v) => (Array.isArray(v) ? v.join('/') : v))
+    .join('/')
 
+  try {
     // Get the configured suffixes from the store config
     const { product_url_suffix: prodSuffix, category_url_suffix: catSuffix } =
       (await client.query({ query: StoreConfigDocument })).data.storeConfig ?? {}
 
-    const candidates = new Set([urlKey])
+    const candidates = new Set([from])
 
-    // If the incoming URL contains a suffix, we check if the URL without the suffix exists
-    // if the incoming URL does not contain a suffix, we check if the URL with the suffix exists
+    // If the incomming URL contains a suffix, we check if the URL without the suffix exists
+    // if the incomming URL does not contain a suffix, we check if the URL with the suffix exists
     const suffixes = [prodSuffix, catSuffix].filter(nonNullable)
     suffixes.forEach((suffix) => {
-      candidates.add(
-        urlKey.endsWith(suffix) ? urlKey.slice(0, -suffix.length) : `${urlKey}${suffix}`,
-      )
+      candidates.add(from.endsWith(suffix) ? from.slice(0, -suffix.length) : `${from}${suffix}`)
     })
 
-    const routePromises = [...candidates].map(async (url) => {
-      const result = await client.query({ query: HandleRedirectDocument, variables: { url } })
-      if (!result.data.route) throw Error('No data')
-      return result.data
-    })
-
-    const routeData = await Promise.any(routePromises)
+    const routePromises = [...candidates].map(
+      async (url) =>
+        (
+          await client.query({
+            query: HandleRedirectDocument,
+            variables: { url },
+            fetchPolicy: 'no-cache',
+          })
+        ).data,
+    )
+
+    const routeData = (await Promise.all(routePromises)).find(nonNullable)
+
+    if (!routeData?.route)
+      return notFound(
+        from,
+        `no redirect candidates found for these paths: ${[...candidates.values()].join(',')}`,
+      )
 
-    const relativeUrl =
-      routeData.route?.relative_url && routeData.route?.relative_url !== urlKey
+    const redirectUrl =
+      routeData?.route?.relative_url && routeData?.route?.relative_url !== from
         ? routeData.route.relative_url
         : undefined
 
     // There is a URL, so we need to check if it can be found in the database.
     const permanent = routeData.route?.redirect_code === 301
 
-    if (!routeData.route) return notFound()
-
-    if (
-      isTypename(routeData.route, [
-        'ConfigurableProduct',
-        'BundleProduct',
-        'SimpleProduct',
-        'VirtualProduct',
-        'DownloadableProduct',
-      ])
-    ) {
-      if (process.env.NEXT_PUBLIC_SINGLE_PRODUCT_PAGE !== '1') {
-        console.warn('Redirects are only supported for NEXT_PUBLIC_SINGLE_PRODUCT_PAGE')
-      }
-
-      if (relativeUrl) {
-        return redirect(`/p/${relativeUrl}`, permanent, locale)
-      }
-
-      if (routeData.products?.items?.find((i) => i?.url_key === routeData.route?.url_key)) {
-        return redirect(`/p/${routeData.route?.url_key}`, permanent, locale)
-      }
-
-      return notFound()
-    }
+    const isProduct = isTypename(routeData.route, [
+      'ConfigurableProduct',
+      'BundleProduct',
+      'SimpleProduct',
+      'VirtualProduct',
+      'DownloadableProduct',
+      'GroupedProduct',
+    ])
 
-    if (relativeUrl) {
-      return redirect(`/${relativeUrl}`, permanent, locale)
+    if (isProduct) {
+      if (process.env.NEXT_PUBLIC_SINGLE_PRODUCT_PAGE !== '1')
+        return notFound(from, 'Redirects are only supported for single product pages.')
+
+      if (redirectUrl) return redirect(from, `/p/${redirectUrl}`, permanent, locale)
+
+      if (!routeData.products?.items?.find((i) => i?.url_key === routeData.route?.url_key))
+        return notFound(from, `Route found, but product isn't returned from products query`)
+
+      return redirect(from, `/p/${routeData.route?.url_key}`, true, locale)
     }
+
+    if (redirectUrl) return redirect(from, `/${redirectUrl}`, permanent, locale)
+
+    return notFound(from, `Route found, but no redirect URL`)
   } catch (e) {
-    // We're done
+    if (e instanceof Error) {
+      return notFound(from, `Error while redirecting: ${e.message}`)
+    }
+    console.log(e)
+    return notFound(from, `Error while redirecting`)
   }
-
-  return notFound()
 }