Missing AC3 documentation improvements ☔

[hwillson]

This issue tracks the docs items that weren't completed in #6429.

TODO:

• Refactor all pagination documentation
  • Overhaul https://www.apollographql.com/docs/react/data/pagination/
    • Rewrite documentation for custom pagination with field policies #7175
• Deprecate fetchMode's updateQuery, replacing with field policies (Deprecate fetchMore updateQuery function, and provide basic field policy helper functions #6464)
  • Please don't remove updateQuery. #8915 (comment)
• Explain what keyArgs: false does
  • See https://deploy-preview-7175--apollo-client-docs.netlify.app/docs/react/pagination/key-args/
    /6852#issuecomment-674984235)
• @apollo/client/core, @apollo/client/utilities, @apollo/client/testing, @apollo/client/cache, etc. entry points
• Properly explain how cache.writeQuery/Fragment broadcasting can be silenced using the broadcast option (and what the advantages are to doing so - reference: Allow silencing broadcast for cache update methods. #6288) 👉 adds broadcast false details #9978
• Explain how to use cache.performTransaction() to batch writes without broadcasting until they've all finished. cache.batch (introduced in Introduce new cache.batch(options) method for InMemoryCache. #7819) provides a better API and essentially wraps performTransaction, so it’s the one we should recommend people use. 👉 Cache.batch docs #9987
• Document merge: false (e.g. Warn when clobbering non-normalized data in the cache. #6372 (comment)) 👉 Field policy merge docs #9969
• Document useReactiveVar (Implement useReactiveVar hook for consuming reactive variables in React components. #6867) 👉 Use reactive var hook #9906
• Document type policy inheritance, using possibleTypes (Support inheritance of typePolicies, according to possibleTypes. #7065) 👉 Type policy inheritance #9905
• Document custom merge function support in type policies (Allow custom merge functions (including merge:true and merge:false) in type policies. #7070)
• Explain how to properly test local state using MockedProvider, by passing a configured cache into MockedProvider itself (MockedProvider not returning data when @client is specified #4532) PR Mockprovider docs updates #9867
• Remove deprecated language from dataIdFromObject Remove deprecated language from dataIdFromObject  #9817
• updateQuery documentation error updateQuery documentation error #9832
• Missing docs about aborted requests for V3 Missing docs about aborted requests for V3 #9882
• Potential Missing docs for MyQueryInterface (typescript): Request for adding different types(interfaces) for the query data from useQuery and subscribeToMore data #9946
• Allow registering named fragments with InMemoryCache to support using ...FragmentName in queries without redeclaring FragmentName in every query Allow registering named fragments with InMemoryCache to support using ...FragmentName in queries without redeclaring FragmentName in every query #9764
• Avoid letting defaultDataIdFromObject normalize objects with nullish ids Avoid letting defaultDataIdFromObject normalize objects with nullish ids #9862

[JimboFromLimbo]

Would be good to get some more clarification around testing especially around client directives and reactive variables.

[abdonrd]

Meanwhile where we can find information about pagination? Thanks!

[hwillson]

@abdonrd We're working on overhauling the main pagination section of the docs, but in the meantime you can find some details here: https://www.apollographql.com/docs/react/caching/cache-field-behavior/#handling-pagination

[tyler-dot-earth]

Regardless of whether #6619 is a bug or intended behavior, this comment indicates a section of the documentation that could use some love to clarify intention WRT merging variables on mutate calls. Similarly, information about the change (if intentional) should also be conveyed in migration guides, changelogs, etc.

[JesseZomer]

I'm looking for documentation for local-only mutations. I see there's still a checkbox missing with the mutation example, but if someone could explain to me what I'm doing wrong, that would be great.

Our application makes use of the old local resolvers. Now I want to 'update' them to typePolicies. My old resolver looked like:

resolvers: {
         ....
        Mutation: {
           createCategorie(...)
        }
}

Now I changed it to this typePolicy:

const inMemoryCache = new InMemoryCache({
    typePolicies: {
        Query: {
            fields: {
                ....
            },
        },
        Mutation: {
            fields: {
                createCategorie(...) {
                    console.log('in create');
                }
            }
        },
       ...

the mutation gets called like this:

gql`
 mutation createCategorie(...) {
 createCategorie(...) @client
}`,

However the console.log never gets called. Is there something I'm missing?

edit: found my answer here: https://spectrum.chat/apollo/apollo-client/ac3-client-mutation~a0f064bf-731b-4129-8016-601217d45971

[tyler-dot-earth]

I think this issue about undefined old data when loading new data could use some love in the documentation / migration guides too.