Route Resolver Error: An invalid API response was returned

[soulfarm.dev (SoulFarm SoulFarm)]

Hi! I've started to get the following error:

Error: An invalid API response was returned

I'm using Next.JS (latest version)
Slice machine latest version

This is my slicemachine.config.json

{ "repositoryName": "soulfarm-prismic", "adapter": "@slicemachine/adapter-next", "libraries": ["./src/slices"], "localSliceSimulatorURL": "http://localhost:3000/slice-simulator" }
I've found here that it seems to be a Prismic issue and to write privately if we had some issues in our repos. I've contact through the private support who told me to write in the forum...so here I am.
@Phil

Thanks!

[Phil (Phil Snow)]

Hi @soulfarm.dev ,

I'll be happy to help

So this can be a number of things. For Next.js users, there have been issues around caching and there are a number of solutions offered here:

Caching issue with Next.js App Router - Vercel Deployment

Hello everyone! I wanted to join the conversation as I built the Prismic website using Next.js. I've encountered similar issues as all of you have reported after migrating to app router. I've tried various solutions over the past few months. However, since version 14.0.2, we haven't experienced any problems with revalidateTag() not revalidating. The only unconventional setup we still have in place is VERCEL_FORCE_NO_BUILD_CACHE=1. As Nathan mentioned earlier, this is used to opt out of Verce…

The main takeaway is that the master ref is being cached by Next.js, and this will break your website as you always need to most up-to-date ref to get the latest content.

Let me know if this thread helps.

If not please check that you're not doing any caching in your app itself, and if you can give me more detail about where/when this error is being thrown, that will really help. As much info about the error as possible will help us debug quicker.

Also if you can send me the query or URL querystring that will allow me to debug much faster as well.

Thanks.

[soulfarm.dev (SoulFarm SoulFarm)]

@Phil Hi Phil, thanks for the quick answer!
Actually this is happening to me during local development (and production environment deployed in vercel as well), so I don't think the issue could be the cache (I've tried to remove the .next folder just in case but nothing, still getting the same issue).
I get this error every time the app tries to connect to the repository.

If can help, this is the log of client object that I get when I call prismic.createClient

 client: Client {
    endpoint: 'https://soulfarm-prismic.cdn.prismic.io/api/v2',
    accessToken: undefined,
    routes: undefined,
    brokenRoute: undefined,
    fetchFn: [Function: bound ] AsyncFunction,
    fetchOptions: { next: [Object] },
    defaultParams: undefined,
    refState: { mode: 'Master', autoPreviewsEnabled: true },
    cachedRepository: undefined,
    cachedRepositoryExpiration: 0,
    fetchJobs: {},
    graphQLFetch: [Function: bound graphQLFetch] AsyncFunction
  }

[Phil (Phil Snow)]

So I can see for sure it's not an issue with the API because your docs are returned here:
https://soulfarm-prismic.prismic.io/api/v2/documents/search?ref=ZebzuBEAAB4AmJlA&src=apibrowser#format=json

Can you send me the query you're trying to do? As much code as you can show me as possible will help.

[soulfarm.dev (SoulFarm SoulFarm)]

@Phil Ok thanks for the clarification; after some debug it seems that the issue is with one product type, now I have to see where the problem is. Thanks for the clarification!

[soulfarm.dev (SoulFarm SoulFarm)]

@Phil Sorry it's me again; it seems that the issue lays with the Products custom type, but I cannot determinate which one of them. So, going back, the issue seems to be when I assign to the client an array of routes, to generate a list of routes for the product page.

The following list of routes are ok:

[
{
type: 'product',
uid: 'antico-piemonte',
path: '/prodotti/latte-e-derivati/antico-piemonte'
},
{
type: 'product',
uid: 'sciroppo-menta',
path: '/prodotti/sciroppi-e-liquori/sciroppo-menta'
},
{
type: 'product',
uid: 'liquore-fragola',
path: '/prodotti/sciroppi-e-liquori/liquore-fragola'
},
{
type: 'product',
uid: 'sciroppo-sambuco',
path: '/prodotti/sciroppi-e-liquori/sciroppo-sambuco'
},
{
type: 'product',
uid: 'liquore-menta',
path: '/prodotti/sciroppi-e-liquori/liquore-menta'
},
{
type: 'product',
uid: 'liquore-pesca',
path: '/prodotti/sciroppi-e-liquori/liquore-pesca'
},
{
type: 'product',
uid: 'peperoni-agrodolce',
path: '/prodotti/composte-e-conserve/peperoni-agrodolce'
},
{
type: 'product',
uid: 'liquore-susine',
path: '/prodotti/sciroppi-e-liquori/liquore-susine'
},
{
type: 'product',
uid: 'ceci-disidratati',
path: '/prodotti/legumi-e-farine/ceci-disidratati'
},
{
type: 'product',
uid: 'gelato',
path: '/prodotti/latte-e-derivati/gelato'
},
{
type: 'product',
uid: 'liquore-fiori-robinia',
path: '/prodotti/sciroppi-e-liquori/liquore-fiori-robinia'
},
{
type: 'product',
uid: 'liquore-amarena-ciliegia',
path: '/prodotti/sciroppi-e-liquori/liquore-amarena-ciliegia'
},
{
type: 'product',
uid: 'nostrano',
path: '/prodotti/latte-e-derivati/nostrano'
},
{
type: 'product',
uid: 'confettura-susine',
path: '/prodotti/composte-e-conserve/confettura-susine'
},
{
type: 'product',
uid: 'frollini-caste',
path: '/prodotti/cereali-antichi/frollini-caste'
},
{
type: 'product',
uid: 'confettura-pesche',
path: '/prodotti/composte-e-conserve/confettura-pesche'
},
{
type: 'product',
uid: 'confettura-mele',
path: '/prodotti/composte-e-conserve/confettura-mele'
},
{
type: 'product',
uid: 'ortaggi-verdure-stagione',
path: '/prodotti/ortaggi-e-verdure-fresche/ortaggi-verdure-stagione'
},
{
type: 'product',
uid: 'dai-maiali-di-razza-nero-di-lomellina-allevati-in-',
path: '/prodotti/carne-suina/dai-maiali-di-razza-nero-di-lomellina-allevati-in-'
},
{
type: 'product',
uid: 'mandorle',
path: '/prodotti/frutta-secca/mandorle'
},
{
type: 'product',
uid: 'olive',
path: '/prodotti/composte-e-conserve/olive'
},
{
type: 'product',
uid: 'confettura-zucca-cedrina',
path: '/prodotti/composte-e-conserve/confettura-zucca-cedrina'
},
{
type: 'product',
uid: 'confettura-albicocche',
path: '/prodotti/composte-e-conserve/confettura-albicocche'
},
{
type: 'product',
uid: 'ortolana-agrodolce',
path: '/prodotti/composte-e-conserve/ortolana-agrodolce'
},
{
type: 'product',
uid: 'liquore-cedrina',
path: '/prodotti/sciroppi-e-liquori/liquore-cedrina'
},
{
type: 'product',
uid: 'confettura-amarene',
path: '/prodotti/composte-e-conserve/confettura-amarene'
}
]

This list, instead, give me error:

[
{
type: 'product',
uid: 'pianeggio',
path: '/prodotti/latte-e-derivati/pianeggio'
},
{
type: 'product',
uid: 'antico-piemonte',
path: '/prodotti/latte-e-derivati/antico-piemonte'
},
{
type: 'product',
uid: 'sciroppo-menta',
path: '/prodotti/sciroppi-e-liquori/sciroppo-menta'
},
{
type: 'product',
uid: 'liquore-fragola',
path: '/prodotti/sciroppi-e-liquori/liquore-fragola'
},
{
type: 'product',
uid: 'sciroppo-sambuco',
path: '/prodotti/sciroppi-e-liquori/sciroppo-sambuco'
},
{
type: 'product',
uid: 'liquore-menta',
path: '/prodotti/sciroppi-e-liquori/liquore-menta'
},
{
type: 'product',
uid: 'liquore-pesca',
path: '/prodotti/sciroppi-e-liquori/liquore-pesca'
},
{
type: 'product',
uid: 'peperoni-agrodolce',
path: '/prodotti/composte-e-conserve/peperoni-agrodolce'
},
{
type: 'product',
uid: 'liquore-susine',
path: '/prodotti/sciroppi-e-liquori/liquore-susine'
},
{
type: 'product',
uid: 'ceci-disidratati',
path: '/prodotti/legumi-e-farine/ceci-disidratati'
},
{
type: 'product',
uid: 'gelato',
path: '/prodotti/latte-e-derivati/gelato'
},
{
type: 'product',
uid: 'liquore-fiori-robinia',
path: '/prodotti/sciroppi-e-liquori/liquore-fiori-robinia'
},
{
type: 'product',
uid: 'liquore-amarena-ciliegia',
path: '/prodotti/sciroppi-e-liquori/liquore-amarena-ciliegia'
},
{
type: 'product',
uid: 'nostrano',
path: '/prodotti/latte-e-derivati/nostrano'
},
{
type: 'product',
uid: 'confettura-susine',
path: '/prodotti/composte-e-conserve/confettura-susine'
},
{
type: 'product',
uid: 'frollini-caste',
path: '/prodotti/cereali-antichi/frollini-caste'
},
{
type: 'product',
uid: 'confettura-pesche',
path: '/prodotti/composte-e-conserve/confettura-pesche'
},
{
type: 'product',
uid: 'confettura-mele',
path: '/prodotti/composte-e-conserve/confettura-mele'
},
{
type: 'product',
uid: 'ortaggi-verdure-stagione',
path: '/prodotti/ortaggi-e-verdure-fresche/ortaggi-verdure-stagione'
},
{
type: 'product',
uid: 'dai-maiali-di-razza-nero-di-lomellina-allevati-in-',
path: '/prodotti/carne-suina/dai-maiali-di-razza-nero-di-lomellina-allevati-in-'
},
{
type: 'product',
uid: 'mandorle',
path: '/prodotti/frutta-secca/mandorle'
},
{
type: 'product',
uid: 'olive',
path: '/prodotti/composte-e-conserve/olive'
},
{
type: 'product',
uid: 'confettura-zucca-cedrina',
path: '/prodotti/composte-e-conserve/confettura-zucca-cedrina'
},
{
type: 'product',
uid: 'confettura-albicocche',
path: '/prodotti/composte-e-conserve/confettura-albicocche'
},
{
type: 'product',
uid: 'ortolana-agrodolce',
path: '/prodotti/composte-e-conserve/ortolana-agrodolce'
},
{
type: 'product',
uid: 'liquore-cedrina',
path: '/prodotti/sciroppi-e-liquori/liquore-cedrina'
},
{
type: 'product',
uid: 'confettura-amarene',
path: '/prodotti/composte-e-conserve/confettura-amarene'
}
]

In this case it seems that the issue is with this route:

{
type: 'product',
uid: 'pianeggio',
path: '/prodotti/latte-e-derivati/pianeggio'
}

And the error i get is with this query/url:

Blockquote

Also, if I render the list of products which doesn't throw, and then I try to access this route -> /prodotti/latte-e-derivati/pianeggio which technically if included in the list of routes throws, I see no error.
It seems that the issue exist only if I add the product to the list of routes passed to prismic client
I really don't know where to look here :/

UPDATE: I believe there's some kind of issue with the products, because I've unpblished and published again a bunch of products and some of them are still in the archived section, so basically for some of them there're two versions, one published and one archived.

[Phil (Phil Snow)]

So that error is because a document by this UID doesn't exist:
https://soulfarm-prismic.prismic.io/api/v2/documents/search?ref=ZeitFhAAACUACGXG&q=[[at(my.product.uid%2C+"pianeggio+")]]&src=apibrowser#format=html

Your routes are overly complicated as well.

This entire list could be done with one route:

{
    type: 'product',
    resolvers: {
      category: 'category',
    },
    path: '/prodotti/:category/:uid',
  },

The category would come from a content relationship you add to the product type and link to parent docs like 'latte-e-derivati', 'composte-e-conserve', 'sciroppi-e-liquori'/

Read more about the resolver here:

Route Resolver

And the content relationships here:

Content Relationship

Configuring the resolver like this is dynamic and doesn't require constant updates everytime you add a new document and won't break because of spelling mistakes or unpublished documents.

[soulfarm.dev (SoulFarm SoulFarm)]

@Phil Sorry but I don't really understand the category part. Now I've added a content relationship to the product document type, which is link_category.

Now this is the object I'm passing to client.routes:

{
  type: 'product',
  path: '/prodotti/:product_category/:uid',
  resolvers: {
    product_category: 'link_category',
  },
},

Don't know if this is correct, because now i'm getting this error:
Error: [Link resolver error] The following resolvers are missing for page type product:
- product

[Phil (Phil Snow)]

You need to then, in all of the product pages, link to a category, it cannot be empty in any of the product pages. This link_category content relationship needs to be on the top level of the document and not be in a Slice.

[soulfarm.dev (SoulFarm SoulFarm)]

@Phil Ok thanks! One last thing; as I've mentioned before, I have some products that are both archived and both published; could be this somehow bug on prismic side?

UPDATE: I've added the relationship to every product, still getting the error
`
Error: [Link resolver error] The following resolvers are missing for page type product:

• product
  `
  

It worked when I update link_category (the name of the field of the API) with category, the label name of the field.

[Phil (Phil Snow)]

So it's working or not? I'm a bit confused by this last message.

Can you give me an example of the published and archived doc? With screenshots maybe?

[soulfarm.dev (SoulFarm SoulFarm)]

@Phil Regarding archived products I've remove the duplicated so from that side it's ok.

Regarding the resolver, yes now it's working too, thanks.