Caching

#Overview

All Content APIs are served via our globally distributed edge cache. Whenever a query is sent to the content API, its response is cached in multiple POP (data centers) around the globe.

Hygraph CDN Map

Hygraph comes with two different content API endpoints, served by 2 different CDN providers. To understand which endpoint you should use, look at the following table.

#Regular read & write endpoint

The Regular read & write endpoint allows for reads and writes. All your requests are cached, and any mutation will invalidate the cache for your project.

Even though this endpoint is eventually consistent, within a single region you will get read-after-write consistency.

This endpoint is ideal for delivering content around the globe with one endpoint, but it only has basic caching logic.

#High performance endpoint

We use a state-of-the-art caching approach, and we have developed a high-performance edge service on the Fastly Compute Edge platform. The service is deployed close to your users around the world.

This endpoint is ideal for delivering content around the globe with low latency and high read-throughput.

#Consistency

To understand both endpoints better, you should have a basic knowledge of cache consistency modes. You can be sure that any changes have persisted at Hygraph if your response was successful.

#Eventual consistency

Some changes are not visible immediately after the update. For example, if you create, delete or update content the update is distributed around the globe with a short delay. Theoretically, if you read content right after a mutation, you may receive stale content.

#Read-after-write consistency

In contrast, read-after-write consistency guarantees that a subsequent read after an update, delete, or create can see those changes immediately. This is only valid for operations hitting the same POP (point-of-presence).

#Model + stage based invalidation

Model + stage based invalidation, which is only available for our High performance endpoint, allows invalidating only the models that were changed based on the mutations used for content and schema changes, rather than invalidate the complete cache.

Regarding queries that fetch related content that needs to be invalidated: We analyze query responses and invalidate only the cached queries that contain the changed model.

For example:

Considering invalidation after a schema change, if a user were to update the Author model shown in the example above, this cached query would be invalidated, as it also returned the Author model.

For content changes, we also take the stage into account, meaning that updating an Author entry, and not publishing it, would invalidate all cached queries that returned the DRAFT stage and the Author model. Queries that returned the PUBLISHED stage will remain cached.

#Smart cache invalidation

Our System understands if mutations are flowing through the cache and invalidates the affected resources with an eventual consistency guarantee.

#Entry-based cache invalidation

In some cases, cache invalidation can be done on an entry basis.

There are three scenarios where entry-level tagging is applied and invalidation becomes more granular, targeting only responses embedding specific entries:

• Query of a single entry by id
• Single reference fields
• Query of multiple models with a where argument involving only unique fields (like a slug)

#Query of a single entry by id

Following our recipe website example situation, in this scenario we query a single recipe (entry). When that recipe is found, the cached response for the query is only invalidated if there are mutations sent that affect this specific entry.

The cached response will remain valid after mutations targeting other recipes, or any other model.

# Invalidated on
# - changes to Recipe 'cltx865t89nu607uj4tvaact5' [EBC]
query {
  recipe(where: {
    id: "cltx865t89nu607uj4tvaact5"
  }){
    id
    title
    description
  }
}

#Single reference fields

In this scenario and following our example situation, the query targets multiple recipes along with their associated chefs.

Here, the cache mechanism becomes a little more complex as it has to deal with multiple relationships:

# Invalidated on:
# - changes or creation of any Recipe
# - changes of specific Chef related to the returned recipes [EBC]
query {
  recipes(first: 5) {
    chef { #single reference field
      id
      name
      bio
    }
  }
}

Changing any of the recipes or adding new recipes, will invalidate the cache associated with this query.

This is because the query fetches the first five recipes, and any changes or additions could potentially alter this result.

Additionally, any changes to the specific chefs who are directly associated with the returned recipes will also invalidate the cache. Other chefs' information will not affect the response and so it does not invalidate the cache.

The EBC behavior from the previous snippet does not apply if chef parameters are part of the query where argument:

# Invalidated on:
# - changes or creation of any Recipe
# - changes or creation of any Chef
query {
  recipes(where: {
    chef: {
      birthdate_gt: "1990-04-05T00:00:00Z"
    }
  }) {
    chef {
      id
      name
      bio
    }
  }
}

Since the chef's birthdate is now a determining factor in the query results, any changes or additions to the chefs - regardless of their association with the returned recipes - can potentially alter the result of this query. For example, the birthday of another chef is updated and becomes included by the filter.

Because of this, even modifying or adding chefs not directly associated with the returned recipes invalidates the cache.

#Nested references

Entry-based cache invalidation also applies when the reference fields are nested deeply in the query tree, even if they are children of multi reference fields.

# Invalidated on:
# - changes or creation of any Chef
# - changes or creation of any Recipe
# - changes of specific RecipeWalkthrough related to
#   the returned recipes [EBC]
# - changes of specific Asset(video) related to
#   the returned RecipeWalkthrough [EBC] 
query {
  chefs { # multi model query
    name
    recipes {  # multi reference field
      recipeWalkthrough { # single reference field
        video { # single reference field
          fileName
          url
        }
      }
    }
  }
}

In this scenario, where the query involves multiple models and their relationships, the cache invalidation becomes a bit complex.

Following our recipe website schema example: Any changes or additions to the chefs, recipes, or recipe walkthroughs, will invalidate the cache associated with this query. Additionally, any changes or additions to the specific assets (videos) related to the returned recipe walkthroughs will invalidate the cache as well.

Modifying or adding assets not directly associated with the returned recipe walkthroughs does not affect the cache, so it will remain valid.

#Multi-model query with unique fields only

In the following example, we are querying for a single recipe based on a unique field - the slug:

# Invalidated on:
# - changes of specific `Recipe` with slug "classic-spaghetti-carbonara"
query {
  recipe(where:{ slug: "classic-spaghetti-carbonara"}) {
    id
    slug
    title
    description
    createdAt
  }
}

The cache will be invalidated only if there are changes to the specific recipe with the slug "classic-spaghetti-carbonara".

Any changes to other recipes will not affect the cache associated with this query.

In this other example, the query fetches chefs and the recipes associated with each chef based on a unique field - the slug:

# Invalidated on:
# - changes or creation of any Chef
# - changes of specific `Recipe` with slug "classic-spaghetti-carbonara"
query {
  chefs {
    id
    name
    recipes(where: {slug: "classic-spaghetti-carbonara"}) {
      id
      title
      description
    }
  }
}

The cache will be invalidated if there are changes to the specific recipe with the slug "classic-spaghetti-carbonara" or any changes or additions to the chefs.

Any changes to other recipes not having the slug "classic-spaghetti-carbonara" will not affect the cache associated with this query.

#stale-if-error

In case of an outage of our APIs - this includes remote field origin errors as well- we will fall back for at least 24h to the latest cached content on our edge servers. This adds an additional reliability layer.

You can use a header for the High performance endpoint that lets you set stale-if-error on a per query basis.

{
  "hyg-stale-if-error": "21600"
}

The values are in seconds.

#stale-while-revalidate

With the High performance endpoint you will get cached responses directly, while we update the content in the background. This means your content is always served on the edge, with low latency for your users.

Staleness refers to how long we deliver stale data while we revalidate the cache in the background if the cache was invalidated.

You can use a header for the High performance endpoint that lets you set stale-while-revalidate on a per query basis.

{
  "hyg-stale-while-revalidate": "27"
}

The values are in seconds.

#Remote fields

GraphQL queries that contain remote fields are cached differently. By default, a response is marked as cacheable when all remote field responses are cacheable according to rfc7234. You can control the TTL (Time-to-Live) cache by returning the Cache-Control response header.

By default, we will set a TTL of 900s, you can set a minimum TTL of 60s. While it is also possible to respond with a no-store cache directive to disable the cache, this is not recommended, as it marks the entire response as not cacheable and will increase the load on your origin.