@graphcommerce/algolia-recommend 9.0.0-canary.85 → 9.0.0-canary.87

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @graphcommerce/algolia-recommend
 
+## 9.0.0-canary.87
+
+## 9.0.0-canary.86
+
+### Patch Changes
+
+- [#2379](https://github.com/graphcommerce-org/graphcommerce/pull/2379) [`ce30678`](https://github.com/graphcommerce-org/graphcommerce/commit/ce30678ad353ac4c7c38d79e96a2bb3de55f6fcb) - Automatically fall back to existing upsells/related products if they are defined and Algolia returns an error ([@paales](https://github.com/paales))
+
 ## 9.0.0-canary.85
 
 ## 9.0.0-canary.84

package/mesh/getRecommendations.ts

@@ -5,9 +5,13 @@ import type {
   AlgoliarecommendationsHit,
 } from '@graphcommerce/graphql-mesh'
 import { nonNullable } from '@graphcommerce/next-ui'
-import type { GraphQLResolveInfo } from 'graphql'
+import type { GraphQLError, GraphQLResolveInfo } from 'graphql'
 import type { Simplify } from 'type-fest'
 
+function isGraphQLError(err: unknown): err is GraphQLError {
+  return !!(err as GraphQLError)?.message
+}
+
 const inputToModel = {
   Trending_items_Input: 'trending_items' as const,
   Trending_facet_values_Input: 'trending_facets' as const,
@@ -15,29 +19,11 @@ const inputToModel = {
   Looking_similar_Input: 'looking_similar' as const,
   Related_products_Input: 'related_products' as const,
 }
+
 function isAlgoliaResponse<T extends object>(root: T): root is T & { uid: string } {
   return 'uid' in root
 }
-function argsFromKeysInput(keys, args, context) {
-  const body = keys
-    .map(
-      (key) =>
-        ({
-          [key.keyInput]: {
-            model: inputToModel[key.keyInput as string],
-            indexName: getIndexName(context),
-
-            ...args,
-            objectID: key.objectId,
-          },
-        }) as unknown as AlgoliarecommendationsRequest_Input,
-    )
-    .filter(nonNullable)
-
-  const returnObject = { input: { requests: body } }
 
-  return returnObject
-}
 export async function getRecommendations<
   K extends keyof AlgoliarecommendationsRequest_Input,
   Input extends AlgoliarecommendationsRequest_Input[K],
@@ -53,29 +39,57 @@ export async function getRecommendations<
   if (!isAlgoliaResponse(root)) {
     return []
   }
-  return (
-    (await context.algoliaRecommend.Query.algolia_getRecommendations({
-      key: { keyInput, objectId: atob(root.uid) },
-      argsFromKeys: (keys) => argsFromKeysInput(keys, args, context),
-      valuesFromResults: (res, keys) =>
-        keys
-          .map((_key, index) => res?.results[index])
-          .map((r) => r?.hits.map((hit) => hit && mapper(hit)).filter(nonNullable)) ?? null,
-      selectionSet: /* GraphQL */ `
-        {
-          results {
-            nbHits
-            hits {
-              ... on AlgoliarecommendHit {
-                objectID
-                additionalProperties
+  try {
+    return (
+      (await context.algoliaRecommend.Query.algolia_getRecommendations({
+        key: { keyInput, objectId: atob(root.uid) },
+        argsFromKeys: (keys) => ({
+          input: {
+            requests: keys
+              .map(
+                (key) =>
+                  ({
+                    [key.keyInput]: {
+                      model: inputToModel[key.keyInput as string],
+                      indexName: getIndexName(context),
+
+                      ...args,
+                      objectID: key.objectId,
+                    },
+                  }) as unknown as AlgoliarecommendationsRequest_Input,
+              )
+              .filter(nonNullable),
+          },
+        }),
+        valuesFromResults: (res, keys) =>
+          keys
+            .map((_key, index) => res?.results[index])
+            .map((r) => r?.hits.map((hit) => hit && mapper(hit)).filter(nonNullable)) ?? null,
+        selectionSet: /* GraphQL */ `
+          {
+            results {
+              nbHits
+              hits {
+                ... on AlgoliarecommendHit {
+                  objectID
+                  additionalProperties
+                }
               }
             }
           }
-        }
-      `,
-      context,
-      info,
-    })) ?? null
-  )
+        `,
+        context,
+        info,
+      })) ?? null
+    )
+  } catch (e) {
+    if (isGraphQLError(e)) {
+      console.log(
+        'There was an error retrieving Algolia Recommendations, make sure the recommendation models are created',
+        e,
+      )
+    }
+
+    return null
+  }
 }

package/mesh/resolvers.ts

@@ -87,11 +87,12 @@ type ProductResolver = ResolverFn<
 >
 
 if (isEnabled(import.meta.graphCommerce.algolia.relatedProducts)) {
+  const fieldName = enumToLocation(import.meta.graphCommerce.algolia.relatedProducts)
   const resolve: ProductResolver = async (root, args, context, info) => {
     const { objectID, threshold, fallbackParameters, maxRecommendations, queryParameters } =
       await getRecommendationsArgs(root, args, context)
 
-    return getRecommendations(
+    const recommendations = await getRecommendations(
       root,
       'Related_products_Input',
       { objectID, threshold, fallbackParameters, maxRecommendations, queryParameters },
@@ -99,11 +100,12 @@ if (isEnabled(import.meta.graphCommerce.algolia.relatedProducts)) {
       info,
       await createProductMapper(context),
     )
+    return recommendations ?? root[fieldName] ?? null
   }
 
   productInterfaceTypes.forEach((productType) => {
     if (!resolvers[productType]) resolvers[productType] = {}
-    resolvers[productType][enumToLocation(import.meta.graphCommerce.algolia.relatedProducts)] = {
+    resolvers[productType][fieldName] = {
       selectionSet: `{ uid }`,
       resolve,
     }
@@ -111,10 +113,11 @@ if (isEnabled(import.meta.graphCommerce.algolia.relatedProducts)) {
 }
 
 if (isEnabled(import.meta.graphCommerce.algolia.lookingSimilar)) {
+  const fieldName = enumToLocation(import.meta.graphCommerce.algolia.lookingSimilar)
   const resolve: ProductResolver = async (root, args, context, info) => {
     const { objectID, threshold, fallbackParameters, maxRecommendations, queryParameters } =
       await getRecommendationsArgs(root, args, context)
-    return getRecommendations(
+    const recommendations = await getRecommendations(
       root,
       'Looking_similar_Input',
       { objectID, threshold, fallbackParameters, maxRecommendations, queryParameters },
@@ -122,11 +125,12 @@ if (isEnabled(import.meta.graphCommerce.algolia.lookingSimilar)) {
       info,
       await createProductMapper(context),
     )
+    return recommendations ?? root[fieldName] ?? null
   }
 
   productInterfaceTypes.forEach((productType) => {
     if (!resolvers[productType]) resolvers[productType] = {}
-    resolvers[productType][enumToLocation(import.meta.graphCommerce.algolia.lookingSimilar)] = {
+    resolvers[productType][fieldName] = {
       selectionSet: `{ uid }`,
       resolve,
     }
@@ -134,11 +138,12 @@ if (isEnabled(import.meta.graphCommerce.algolia.lookingSimilar)) {
 }
 
 if (isEnabled(import.meta.graphCommerce.algolia.frequentlyBoughtTogether)) {
-  const resolver: ProductResolver = async (root, args, context, info) => {
+  const fieldName = enumToLocation(import.meta.graphCommerce.algolia.frequentlyBoughtTogether)
+
+  const resolve: ProductResolver = async (root, args, context, info) => {
     const { objectID, threshold, maxRecommendations, queryParameters } =
       await getRecommendationsArgs(root, args, context)
-
-    return getRecommendations(
+    const recommendations = await getRecommendations(
       root,
       'Frequently_bought_together_Input',
       { objectID, threshold, maxRecommendations, queryParameters },
@@ -146,13 +151,12 @@ if (isEnabled(import.meta.graphCommerce.algolia.frequentlyBoughtTogether)) {
       info,
       await createProductMapper(context),
     )
+    return recommendations ?? root[fieldName] ?? null
   }
 
   productInterfaceTypes.forEach((productType) => {
     if (!resolvers[productType]) resolvers[productType] = {}
-    resolvers[productType][
-      enumToLocation(import.meta.graphCommerce.algolia.frequentlyBoughtTogether)
-    ] = resolver
+    resolvers[productType][fieldName] = { selectionSet: `{ uid }`, resolve }
   })
 }
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/algolia-recommend",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "9.0.0-canary.85",
+  "version": "9.0.0-canary.87",
   "sideEffects": false,
   "prettier": "@graphcommerce/prettier-config-pwa",
   "eslintConfig": {
@@ -15,11 +15,11 @@
     "generate": "tsx scripts/generate-recommend-spec.mts"
   },
   "peerDependencies": {
-    "@graphcommerce/algolia-products": "^9.0.0-canary.85",
-    "@graphcommerce/graphql": "^9.0.0-canary.85",
-    "@graphcommerce/graphql-mesh": "^9.0.0-canary.85",
-    "@graphcommerce/next-config": "^9.0.0-canary.85",
-    "@graphcommerce/next-ui": "^9.0.0-canary.85",
+    "@graphcommerce/algolia-products": "^9.0.0-canary.87",
+    "@graphcommerce/graphql": "^9.0.0-canary.87",
+    "@graphcommerce/graphql-mesh": "^9.0.0-canary.87",
+    "@graphcommerce/next-config": "^9.0.0-canary.87",
+    "@graphcommerce/next-ui": "^9.0.0-canary.87",
     "react": "^18.2.0"
   },
   "devDependencies": {