[TEST] [Request]: Add note for @strapi/plugin-graphql and @apollo/client consumers about InMemoryCache

[pwizla]

Summary

Add a note for @strapi/plugin-graphql and @apollo/client consumers to configure InMemoryCache to work with documentId

Why is it needed?

I'm using Strapi v5, and were configuring Apollo Client, and could not find any note about this in the docs.

As Strapi v5 is using documentId instead of id, would be good to notify users that they need to configure the InMemoryCache if they would like it to work fine.

Suggested solution(s)

const apolloClient = new ApolloClient({
cache: new InMemoryCache({
dataIdFromObject: (o) => {
const maybeEntityId = o["documentId"]
const maybeComponentId = o["id"]
const id = maybeEntityId ?? maybeComponentId
return ${o.__typename}:${id}
},
}),
});
https://www.apollographql.com/docs/react/caching/cache-configuration#customizing-identifier-generation-globally

Related issue(s)/PR(s)

No response

[github-actions]

🤖 I've analyzed your question and here's what I found:

Thank you so much for raising this, and for taking the time to share your experience and suggestion! We really appreciate your attention to detail and your willingness to help improve the Strapi experience for everyone using the GraphQL plugin with Apollo Client.

You're absolutely right: with Strapi v5, the primary identifier for documents in the Content API has changed from id to documentId. This is a key breaking change, and it can indeed affect how Apollo Client's InMemoryCache identifies and normalizes objects. If the cache is still configured to use id, you may encounter issues with cache consistency or updates not being reflected as expected.

Currently, the official Strapi documentation highlights the switch from id to documentId in API responses and recommends updating custom code and integrations accordingly, especially when migrating from v4 to v5. However, there isn't a specific note or example in the docs about configuring Apollo Client's cache for this change [Strapi v5 breaking change: use documentId].

Your suggested configuration is spot on for Apollo Client users:

const apolloClient = new ApolloClient({
  cache: new InMemoryCache({
    dataIdFromObject: (o) => {
      const maybeEntityId = o["documentId"];
      const maybeComponentId = o["id"];
      const id = maybeEntityId ?? maybeComponentId;
      return `${o.__typename}:${id}`;
    },
  }),
});

This approach ensures that Apollo's cache uses documentId as the unique identifier for Strapi documents, falling back to id for other types (like components or legacy data). For more details on customizing Apollo's cache, you can refer to the Apollo documentation on cache configuration.

Next steps:

• We'll flag this for the documentation team to consider adding a dedicated note or example for Apollo Client users in the GraphQL plugin docs.
• In the meantime, your workaround is the recommended approach for anyone integrating Strapi v5 with Apollo Client.

If you have further questions or want to discuss this with the community, feel free to join our Discord or post in the Strapi Forum. And if you have more suggestions or feature requests, you can always submit them at feedback.strapi.io.

Thanks again for your valuable feedback and for helping make Strapi better for everyone! 🚀

📚 Relevant documentation:

• Release notes|5.5.0
• Release notes|5.4.0
• GraphQL plugin|Middlewares
• GraphQL API|Mutations
• Apollo Server v3 upgraded to Apollo Server v4|Apollo Server v3 upgraded to Apollo Server v4
• Release notes|Updated content
• Release notes|Chore, fixes, typos, and other improvements
• GraphQL plugin|Middlewares
• GraphQL API|GraphQL API
• Release notes|Chore, fixes, typos, and other improvements
• Release notes|New content
• Community & Support|Community & Support
• GraphQL plugin|Code-based configuration
• The GraphQL API has been updated|Migration
• documentId should be used instead of id in Content API calls|documentId should be used instead of id in Content API calls

---

ℹ️ This response was generated automatically. If this doesn't fully answer your question or if you need further assistance, please mention @pwizla in a comment and a human maintainer will help you.

You can also try our interactive AI chat for more detailed assistance.

💡 For feature requests or product feedback, visit feedback.strapi.io.