Simple persistence for all Apollo Client 3.0 cache implementations, including
InMemoryCache
and Hermes
.
Supports web and React Native. See all storage providers.
To get started, simply pass your Apollo cache and an
underlying storage provider to persistCache
.
By default, the contents of your Apollo cache will be immediately restored (asynchronously, see how to persist data before rendering), and will be persisted upon every write to the cache (with a short debounce interval).
import AsyncStorage from '@react-native-community/async-storage';
import { InMemoryCache } from '@apollo/client/core';
import { persistCache } from 'apollo3-cache-persist';
const cache = new InMemoryCache({...});
// await before instantiating ApolloClient, else queries might run before the cache is persisted
await persistCache({
cache,
storage: AsyncStorage,
});
// Continue setting up Apollo as usual.
const client = new ApolloClient({
cache,
...
});
import { InMemoryCache } from '@apollo/client/core';
import { persistCache } from 'apollo3-cache-persist';
const cache = new InMemoryCache({...});
// await before instantiating ApolloClient, else queries might run before the cache is persisted
await persistCache({
cache,
storage: window.localStorage,
});
// Continue setting up Apollo as usual.
const client = new ApolloClient({
cache,
...
});
persistCache
and the constructor for CachePersistor
accept the following
options:
persistCache({
/**
* Required options.
*/
// Reference to your Apollo cache.
cache: ApolloCache<TSerialized>,
// Reference to your storage provider.
storage: PersistentStorage<TPersisted>,
/**
* Trigger options.
*/
// When to persist the cache.
//
// 'write': Persist upon every write to the cache. Default.
// 'background': Persist when your app moves to the background. React Native only.
//
// For a custom trigger, provide a function. See below for more information.
// To disable automatic persistence and manage persistence manually, provide false.
trigger?: 'write' | 'background' | function | false,
// Debounce interval between persists (in ms).
// Defaults to 0 for 'background' and 1000 for 'write' and custom triggers.
debounce?: number,
/**
* Storage options.
*/
// Key to use with the storage provider. Defaults to 'apollo-cache-persist'.
key?: string,
// Whether to serialize to JSON before/after persisting. Defaults to true.
serialize?: boolean,
// Maximum size of cache to persist (in bytes).
// Defaults to 1048576 (1 MB). For unlimited cache size, provide false.
// If exceeded, persistence will pause and app will start up cold on next launch.
maxSize?: number | false,
/**
* Debugging options.
*/
// Enable console logging.
debug?: boolean,
}): Promise<void>;
Instead of using persistCache
, you can instantiate a CachePersistor
, which
will give you fine-grained control of persistence.
CachePersistor
accepts the same options as persistCache
and returns an
object with the following methods:
const persistor = new CachePersistor({...});
persistor.restore(); // Immediately restore the cache. Returns a Promise.
persistor.persist(); // Immediately persist the cache. Returns a Promise.
persistor.purge(); // Immediately purge the stored cache. Returns a Promise.
persistor.pause(); // Pause persistence. Triggers are ignored while paused.
persistor.resume(); // Resume persistence.
persistor.remove(); // Remove the persistence trigger. Manual persistence required after calling this.
// Obtain the most recent 30 persistor loglines.
// `print: true` will print them to the console; `false` will return an array.
persistor.getLogs(print);
// Obtain the current persisted cache size in bytes. Returns a Promise.
// Resolves to 0 for empty and `null` when `serialize: true` is in use.
persistor.getSize();
For control over persistence timing, provide a function to the trigger
option.
The custom trigger should accept one argument (a persist
callback function),
and it should return a function that can be called to uninstall the trigger.
The TypeScript signature for this function is as follows:
(persist: () => void) => (() => void)
For example, this custom trigger will persist every 10 seconds:
// This code is for illustration only.
// We do not recommend persisting on an interval.
const trigger = persist => {
// Call `persist` every 10 seconds.
const interval = setInterval(persist, 10000);
// Return function to uninstall this custom trigger.
return () => clearInterval(interval);
};
The following storage providers work 'out of the box', with no additional dependencies:
AsyncStorage
on React Nativewindow.localStorage
on webwindow.sessionStorage
on weblocalForage
on webIonic storage
on web and mobile
apollo3-cache-persist
uses the same storage provider API as
redux-persist
, so you can also make
use of the providers
listed here,
including:
If you're using React Native and set a maxSize
in excess of 2 MB, you must use
a filesystem-based storage provider, such as
redux-persist-fs-storage
.
AsyncStorage
does not support
individual values in excess of 2 MB on Android.
Quite simply, because mobile apps are different than web apps.
Mobile apps are rarely terminated before transitioning to the background. This is helped by the fact that an app is moved to the background whenever the user returns home, activates the multitasking view, or follows a link to another app. There's almost always an opportunity to persist.
On web, we could support a 'background' trigger with the Page Visibility API; however, data would be lost if the user closed the tab/window directly. Given this prevalence of this user behavior and the substantially better performance of the 'write' trigger on web, we've omitted a 'background' trigger on web.
persistCache
(as well as persistor.restore()
) returns a promise that will
resolve once the cache has been restored, which you can await before rendering
your app.
This library, like Apollo Client, is framework agnostic; however, since many people have asked, here's an example of how to handle this in React. PRs with examples from other frameworks are welcome.
import React, { Component } from 'react';
import { ApolloProvider } from '@apollo/client/react';
import { InMemoryCache } from '@apollo/client/core';
import { persistCache } from 'apollo3-cache-persist';
class App extends Component {
state = {
client: null,
loaded: false,
};
async componentDidMount() {
const cache = new InMemoryCache({...});
// Setup your Apollo Link, and any other Apollo packages here.
const client = new ApolloClient({
cache,
...
});
try {
// See above for additional options, including other storage providers.
await persistCache({
cache,
storage: window.localStorage,
});
} catch (error) {
console.error('Error restoring Apollo cache', error);
}
this.setState({
client,
loaded: true,
});
}
render() {
const { client, loaded } = this.state;
if (!loaded) {
return <div>Loading...</div>;
}
return (
<ApolloProvider client={client}>
{/* the rest of your app goes here */}
</ApolloProvider>
);
}
}
import React,{ useState, useEffect } from 'react';
import { ApolloClient } from 'apollo-client';
import { InMemoryCache } from '@apollo/client/core';
import { ApolloProvider } from "@apollo/react-hooks"
import { persistCache } from 'apollo3-cache-persist';
const App: React.FC = () => {
const [client, setClient] = useState(undefined);
useEffect(() => {
const cache = new InMemoryCache({...});
const client = new ApolloClient({
cache,
...
});
const initData = {
{/* your initial data */}
};
cache.writeData({ data: initData })
// See above for additional options, including other storage providers.
persistCache({
cache,
storage: window.localStorage
}).then(() => {
client.onResetStore(async () => cache.writeData({ data: initData }));
setClient(client);
});
return () => {};
}, []);
if (client === undefined) return <div>Loading...</div>;
return (
<ApolloProvider client={client}>
{/* the rest of your app goes here */}
</ApolloProvider>
);
};
export default App;
persistCache
method is asynchronous to conform to production ready storage interfaces
which offer only asynchronous API.
apollo-cache-persist offers alternative persistCacheSync
method that should be used only with small cache sizes and synchronous storage provider (e.g. window.localStorage). persistCacheSync
is best suited for demo applications because it blocks UI rendering until the cache is restored.
import { InMemoryCache } from '@apollo/client/core';
import { persistCacheSync } from 'apollo3-cache-persist';
const cache = new InMemoryCache({...});
persistCacheSync({
cache,
storage: window.localStorage,
});
persistCacheSync
works by instantiating subclasses of CachePeristor
, Persistor
, and Storage
that implement a method for restoring the cache synchronously.
Unfortunately, this is not yet possible. You can only persist and restore the cache in its entirety.
This library depends upon the extract
and persist
methods defined upon the
cache interface in Apollo Client 2.0. The payload returned and consumed by these
methods is opaque and differs from cache to cache. As such, we cannot reliably
transform the output.
Alternatives have been recommended in
#2,
including using logic in your UI to filter potentially-outdated information.
Furthermore, the maxSize
option and
methods on CachePersistor
provide facilities to
manage the growth of the cache.
For total control over the cache contents, you can setup a background task to
periodically reset the cache to contain only your appβs most important data. (On
the web, you can use a service worker; on React Native, thereβs
react-native-background-task
.)
The background task would start with an empty cache, query the most important
data from your GraphQL API, and then persist. This strategy has the added
benefit of ensuring the cache is loaded with fresh data when your app launches.
Finally, it's worth mentioning that the Apollo community is in the early stages of designing fine-grained cache controls, including the ability to utilize directives and metadata to control cache policy on a per-key basis, so the answer to this question will eventually change.
For the same reasons given in the preceding answer, it's not possible to migrate
or transform your persisted cache data. However, by using the
methods on CachePersistor
, it's simple to reset the
cache upon changes to the schema.
Simply instantiate a CachePersistor
and only call restore()
if the app's
schema hasn't change. (You'll need to track your schema version yourself.)
Here's an example of how this could look:
import AsyncStorage from '@react-native-community/async-storage';
import { InMemoryCache } from '@apollo/client/core';
import { CachePersistor } from 'apollo3-cache-persist';
const SCHEMA_VERSION = '3'; // Must be a string.
const SCHEMA_VERSION_KEY = 'apollo-schema-version';
async function setupApollo() {
const cache = new InMemoryCache({...});
const persistor = new CachePersistor({
cache,
storage: AsyncStorage,
});
// Read the current schema version from AsyncStorage.
const currentVersion = await AsyncStorage.getItem(SCHEMA_VERSION_KEY);
if (currentVersion === SCHEMA_VERSION) {
// If the current version matches the latest version,
// we're good to go and can restore the cache.
await persistor.restore();
} else {
// Otherwise, we'll want to purge the outdated persisted cache
// and mark ourselves as having updated to the latest version.
await persistor.purge();
await AsyncStorage.setItem(SCHEMA_VERSION_KEY, SCHEMA_VERSION);
}
// Continue setting up Apollo as usual.
}
Specifically, this error:
BaseError: Couldn't read row 0, col 0 from CursorWindow. Make sure the Cursor is initialized correctly before accessing data from it.
This is the result of a 2 MB per key limitation of AsyncStorage
on Android.
Set a smaller maxSize
or switch to a different storage provider, such
as
redux-persist-fs-storage
or react-native-mmkv-storage
.
In some cases like user logout we want to wipe out application cache.
To do it effectively with Apollo Cache Persist please use client.clearStore()
method that will
eventually reset persistence layer.