Cache issue related to GraphQL query that sorts based on a resolver field

[fturmel]

Here's a simple repo to illustrate the problem: https://github.com/fturmel/gatsby-sort-resolver-bug

I think it's a bug, but maybe I'm missing something? I'd love some insights. Thanks!

[fturmel]

Let me add more details here in case no one read the repo readme and looked at the example.

Again, the issue is that GraphQL queries that sort based on a resolver field do not always appear to correctly run the resolver and use cached values.

Our sources are multiple video#.json files in a directory (node type VideosJson), and one videos-order.json file with an array of file names in the desired order, node type ContentJson. They are handled by the gatsby-transformer-json plugin.

In gatsby-node.js, we have a resolver:

exports.createSchemaCustomization = ({ actions }) => {
  const schema = `
    type VideosJson implements Node {
    order: Int!
  }
`;
  actions.createTypes(schema);
};

exports.createResolvers = ({ createResolvers }) => {
  createResolvers({
    VideosJson: {
      order: {
        type: 'Int!',
        resolve: async (source, args, context, info) => {
          const { order } = await context.nodeModel.findOne({
            type: `ContentJson`,
          });
          const { relativePath } = await context.nodeModel.getNodeById({ id: source.parent });
          const index = order.indexOf(relativePath);
          return index !== -1 ? index : 999;
        },
      },
    },
  });
};

And in the index page, we query the VideosJson in ascending order using the order resolver field.

import { graphql } from 'gatsby';
import * as React from 'react';

const IndexPage = ({ data }) => {
  return (
  <main>
    <div>
      {data.videos.nodes.map(({ title, order }) => (
        <div key={title}>
          Title: {title} | Order: {order}
        </div>
      ))}
    </div>
  </main>
  );
};

export default IndexPage;

export const query = graphql`
query {
  videos: allVideosJson(sort: { order: ASC }) {
    nodes {
      title
      order
    }
  }
}
`;

If we change the file order in videos-order.json and save, the order value displayed by the index page is correct and reflects the change, but the query's sorting does not and displays in the same order as before. We need to run npm run clean and build again for the change to take effect.

1. initial state

2. After updating videos-order.json (correct order value, wrong sorting order)

3. After cleaning Gatsby cache

I have also observed the same behavior in GraphiQL if you run the same query. The resolver returns the correct value, but the sorting order is wrong (cached?).