refactor(gatsby): Introduce built-in GraphQL types #19951
Conversation
… and `Directory` at the moment)
|
|
||
| exports.createSchemaCustomization = ({ actions }) => { | ||
| actions.createTypes(require(`../../schema/types/built-in-types`)()) | ||
| } |
There was a problem hiding this comment.
Not sure if internal-data-bridge is the right place for this. Open to suggestions.
There was a problem hiding this comment.
Moved this from internal-data-bridge to schema/index.js. This has a side effect that now those types show up in some test snapshots.
| const fileType = ` | ||
| type File implements Node @infer { | ||
| sourceInstanceName: String | ||
| absolutePath: String |
There was a problem hiding this comment.
Are all those really nullable? I think many (?) of those might not be. Not sure.
There was a problem hiding this comment.
That's how gatsby-plugin-schema-snapshot printed them. I guess we can change it for the next major but for now, we should probably stay consistent with the current version?
There was a problem hiding this comment.
Nullable to non-nullable shouldn't be a breaking change if they actually can't be null, I think it's a good idea to have less nullable fields if it's possible.
There was a problem hiding this comment.
So most stats are an output of fs.stat. We should check out TS signature for that and assign non-nullness accordingly.
There was a problem hiding this comment.
Changed this.
We have our own typings in gatsby-source-filesystem: https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-source-filesystem/index.d.ts#L58-L96
Interestingly sourceInstanceName is also non-null. @pieh you mentioned it could be null?
vladar
changed the title
vladar
added
the
bot: merge on green
* refactor(gatsby): Use schema customization for built-in types (`File` and `Directory` at the moment) * Move built-in types from internal-data-bridge to schema/index * One more field nullability change
Description
Before this PR the
FileNode type in Gatsby was inferred from example files present in the site. This caused issues when users deleted example files - things just broke.This PR is a step forward to having types defined explicitly when possible instead of inference.
Documentation
This is an internal refactoring which shouldn't affect end-users. It uses
createSchemaCustomizationAPI under the hood.Related Issues
Closes #18804