fix(gatsby): validate local plugin options schema

[kamranayub]

Description

Fix for pluginOptionsSchema not being validated for locally resolved plugins.

Changes

• Use resolvePlugins when validating options
• Add integration test for local plugin loading/validation
• Add integration test to CI configuration

Tasks

• Provide failing test case for local plugin (with require.resolve)
• Provide failing test case for local plugin (without require.resolve)
• Backport for v2 🆘 🤚 Need assistance/guidance with this.

Documentation

Related Issues

Fixes #29785
Related to #27242

[kamranayub]

Will need to handle when using require.resolve as the IPluginRefObject looks like this:

 {
      resolve: 'E:\\Development\\Contrib\\gatsby\\packages\\gatsby\\src\\bootstrap\\load-plugins\\__tests__\\fixtures\\local-plugin\\index.js',
      options: { optionalString: 1234 }
    }

So the following line in validate.ts won't work like you'd expect:

gatsbyNode = require(`${plugin.resolve}/gatsby-node`)

[kamranayub]

It looks like there's a snapshot failing unrelated to this PR; it was failing in master too when I ran this suite.

I took a cue from resolvePlugin in load to check whether the path is absolute and if so, to grab the dirname and use slash to normalize paths for Windows/Linux.

[kamranayub]

Integration test passes locally (when using linked package)

[kamranayub]

I am not sure if an e2e test is more appropriate for this or my integration test, let me know 😄

[kamranayub]

I realized local-plugin was resolving to the require.resolve and the other one was being dropped in the integration test; split them up, now I can see there's still an issue with local paths.

Will continue investigating proposed fix tomorrow. Fixing require.resolve will unblock my course dev/recording since I can use local patch (🙈) and uptake this when it's backported to V2 officially.

[LekoArts]

Hi, thanks for the PR!

Backport for v2 🆘 🤚 Need assistance/guidance with this.

We'll handle this :)

I am not sure if an e2e test is more appropriate for this or my integration test, let me know

Integration test is fine

I did not see any docs in the integration test README but to actually test against my WIP changes, I had to use yarn link. If I didn't, I was getting an error with missing node modules

For local development we use yarn workspaces and our own CLI gatsby-dev-cli: #29787

So to copy your changes to the integration test, you can run gatsby-dev inside the directory, while running yarn watch --scope=gatsby in the monorepo itself.

[kamranayub]

@LekoArts Thanks, that worked nicely 👍

[kamranayub]

I think the tests that are failing are unrelated; I see the same ones failing in other approved PRs too. 😞 But this should be ready to go.

[kamranayub]

Just confirming that this works when using gatsby-dev in my demo app:

[kamranayub]

@LekoArts Anything else I need to do? Thanks!

[sidyes]

Is there anyway this can be pushed as the solution has already been provided as a PR?

[kamranayub]

I'll be recording my demos next week and this would be amazing to get in so I don't have to keep using local dev fork 😄

[LekoArts]

Hey @kamranayub - sorry for the delay here, we were (and are) busy with follow-up work of the v3 launch.
We'll release the next minor on March 30, 2021 and I'll see to get this reviewed and merged before that :)

[kamranayub]

Awesome, thanks!

[LekoArts]

Thanks!