Skip to content

[feat]: add Gatsby Cloud functionality and "hot reloading" #15

Open
@DSchau

Description

@DSchau

Summary

Right now -- this plugin has several areas that could be augmented to better support the Gatsby ecosystem, particularly with Gatsby Cloud. Specifically:

  1. Images are sourced from static.ghost.org rather than tying into createRemoteFileNode functionality (See Add gatsby-transformer-sharp support #5)
  2. No ability to "live update" data from Ghost, e.g. when content is created, updated or deleteed

Let's focus on #2 for this issue.

Live Updating

Gatsby Cloud uses webhooks to synchronize content from the CMS with the running Gatsby application. Ghost already supports webhooks, so we're part of the way there towards supporting hot reloading of data.

How it works under the hood is that the sourceNodes function in gatsby-node.js is re-invoked whenever we receive a web hook. What's missing now is some way to incrementally know what has been changed, and how to take the current state of the GraphQL schema and update it to match the new Ghost data.

To best support plugin authors, we've put together an Integration Guide that outlines several approaches in updating a plugin to have great Gatsby Cloud support. The eventual result of this work would be:

  1. This plugin has a way to request changed data
  2. This plugin (when sourceNodes is invoked) calls createNode, deleteNode, and touchNode to get the schema consistent with Ghost

@JohnONolan question -- does the webhook that's triggered receive a payload? That could be a relatively low-effort way to get the updated content!

Adding Gatsby Cloud as an Integration

For anyone else who may be working on this, adding Gatsby Cloud will look something like this:

Screen Shot 2019-06-20 at 5 07 50 PM

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions