Convert internal plugins to use schema customization API

[vladar]

A follow up for #12272. Now that createSchemaCustomization API is stable it is time to start using it for internal Gatsby plugins. Not all plugins are applicable for this API. For such plugins, we should outline why and maybe consider alternatives.

Source plugins:

• gatsby-source-contentful (feat(gatsby-source-contentful): provide gql type definitions using content model introspection and schema-customization #12816)
• gatsby-source-wordpress (WordPress source V4 & Theme Epic #19292)
• gatsby-source-drupal
• gatsby-source-faker
• gatsby-source-filesystem
• gatsby-source-hacker-news (feat(gatsby-source-hacker-news): use schema customization API #20070)
• gatsby-source-lever (feat(gatsby-source-lever): use schema customization API (#20069) #20521)
• gatsby-source-medium (feat(gatsby-source-medium): define types explicitly via createSchemaCustomization (#20069) #22377)
• gatsby-source-mongodb
• gatsby-source-npm-package-search
• gatsby-source-wikipedia
• gatsby-source-shopify

Transformer plugins:

• gatsby-transformer-sharp (refactor(gatsby-transformer-sharp): Use explicit graphql type definition vs inferring #18871)
• gatsby-transformer-react-docgen (fix(gatsby-transformer-react-docgen): clean up and declare types for react-docgen #19514)
• gatsby-transformer-csv
• gatsby-transformer-json
• gatsby-transformer-yaml

Help wanted

If you are familiar with the schema customization API or would like to try it - I encourage you to pick a plugin from the list above which is not being worked on yet, try converting it and publish a PR. I will be happy to help.

If the plugin is not in the list - mention me and name the plugin you would like to work on.

Also if you know community plugins which already use schema customization - please mention them in this issue as well.

[Powell-v2]

Hi @vladar, I'd like to help you out with this task! Which plugins are up for grabs?

[vladar]

This is great! Thanks for your initiative.

You could pick any plugin from the list above that has no link to existing PR/Epic associated with it. I suggest you mention the one you chose here so that I could update this list to avoid collisions.

One issue though is that some source plugins are too dynamic/complicated (like drupal for instance) so it can be hard to start with those. I think gatsby-source-medium could be a low hanging fruit.

You can use gatsby-plugin-schema-snapshot to print a snapshot of a schema, audit and use related type definitions in the plugin.

[Powell-v2]

Thanks! I was actually wondering which one of the plugins has the least amount of pitfalls associated with it as I'm just starting out as a contributor. I appreciate your help - will proceed with your suggestion (gatsby-source-medium).

[Qovaros985]

Hi @vladar, I just created a PR for gatsby-source-lever. Could you please guide me, whether that is what we want?

[vladar]

@Powell-v2 See also #14765 (just noticed this issue)

[graygilmore]

Hey @vladar! I'm just starting to dig into Gatsby and GraphQL but I'd love to lend a hand here if I could. In particular I'm playing around with the Shopify so I might try that one! Let me know if I'm biting off more than I can chew 😄

[vladar]

@graygilmore Sure, go for it! I don't think Shopify types are that complex.

One approach that worked for me in the past was to use gatsby-plugin-schema-snapshot on a site with source plugin and use those snapshots to extract types for schema customization API.

Thanks for offering help and feel free to ping me if you need advice!

[rugggger]

Hi @vladar , I would like to help for the gatsby-source-drupal plugin.

[reobin]

Quick question: Would this allow one to customize the name of a node coming from gatsby-source-mongodb, for example?

If for example, nodes are created with the name mongodbDbnameCollectionname, but I would like to rename it to something more simple and reusable through various databases (with different names) in the same mongodb cluster.

[talohana]

Hi @vladar I would like to help and learn, is gatsby-source-wikipedia beginner friendly?

Thanks!