feat(gatsby-plugin-utils): save validation resulting value to plugin options

packages/gatsby-plugin-utils/package.json

@@ -32,11 +32,14 @@
     "rimraf": "^3.0.2",
     "typescript": "^3.9.5"
   },
+  "peerDependencies": {
+    "gatsby": "^2.24.79"
+  },
   "files": [
     "dist/",
     "src/"
   ],
   "engines": {
     "node": ">=10.13.0"
   }
-}
+}

packages/gatsby-plugin-utils/src/__tests__/test-plugin-options-schema.ts

@@ -1,5 +1,5 @@
 import { testPluginOptionsSchema } from "../test-plugin-options-schema"
-import { ObjectSchema } from "../utils/plugin-options-schema-joi-type"
+import { ObjectSchema } from "../joi"
 
 describe(`testPluginOptionsSchema`, () => {
   it(`should partially validate one value of a schema`, () => {

packages/gatsby-plugin-utils/src/validate.ts

@@ -1,7 +1,8 @@
-import { BaseValidationOptions } from "joi"
-import { ObjectSchema } from "./utils/plugin-options-schema-joi-type"
+import { ValidationOptions } from "joi"
+import { ObjectSchema } from "./joi"
+import { IPluginInfoOptions } from "gatsby"
 
-const validationOptions: BaseValidationOptions = {
+const validationOptions: ValidationOptions = {
   // Show all errors at once, rather than only the first one every time
   abortEarly: false,
   cache: true,
@@ -11,19 +12,19 @@ interface IOptions {
   validateExternalRules?: boolean
 }
 
-export async function validateOptionsSchema<PluginOptions = object>(
+export async function validateOptionsSchema(
   pluginSchema: ObjectSchema,
-  pluginOptions: PluginOptions,
-  options: IOptions = {}
-): Promise<PluginOptions> {
-  if (options.validateExternalRules === false) {
-    const result = pluginSchema.validate(pluginOptions, {
-      ...validationOptions,
-      externals: false,
-    })
-    if (result.error) throw result.error
-    return result.value
+  pluginOptions: IPluginInfoOptions,
+  options: IOptions = {
+    validateExternalRules: true,
   }
+): Promise<IPluginInfoOptions> {
+  const { validateExternalRules } = options
 
-  return pluginSchema.validateAsync(pluginOptions, validationOptions)
+  const value = await pluginSchema.validateAsync(pluginOptions, {
+    ...validationOptions,
+    externals: validateExternalRules,
+  })
+
+  return value
 }

packages/gatsby/index.d.ts

@@ -26,6 +26,8 @@ export {
   withAssetPrefix,
 } from "gatsby-link"
 
+export { IPluginInfoOptions } from "./src/bootstrap/load-plugins/types"
+
 export const useScrollRestoration: (
   key: string
 ) => {

packages/gatsby/src/bootstrap/load-plugins/__tests__/__snapshots__/load-plugins.ts.snap

@@ -208,6 +208,9 @@ Array [
       "onCreateWebpackConfig",
     ],
     "pluginOptions": Object {
+      "allExtensions": false,
+      "isTSX": true,
+      "jsxPragma": "React",
       "plugins": Array [],
     },
     "resolve": "",
@@ -485,6 +488,9 @@ Array [
       "onCreateWebpackConfig",
     ],
     "pluginOptions": Object {
+      "allExtensions": false,
+      "isTSX": true,
+      "jsxPragma": "React",
       "plugins": Array [],
     },
     "resolve": "",
@@ -770,6 +776,9 @@ Array [
       "onCreateWebpackConfig",
     ],
     "pluginOptions": Object {
+      "allExtensions": false,
+      "isTSX": true,
+      "jsxPragma": "React",
       "plugins": Array [],
     },
     "resolve": "",

packages/gatsby/src/bootstrap/load-plugins/__tests__/load-plugins.ts

@@ -120,21 +120,7 @@ describe(`Load plugins`, () => {
       expect(plugins).toEqual(
         expect.arrayContaining([
           expect.objectContaining({
-            browserAPIs: [],
-            id: ``,
             name: `gatsby-plugin-typescript`,
-            nodeAPIs: [
-              `pluginOptionsSchema`,
-              `resolvableExtensions`,
-              `onCreateBabelConfig`,
-              `onCreateWebpackConfig`,
-            ],
-            pluginOptions: {
-              plugins: [],
-            },
-            resolve: ``,
-            ssrAPIs: [],
-            version: `1.0.0`,
           }),
         ])
       )
@@ -169,8 +155,10 @@ describe(`Load plugins`, () => {
               `onCreateWebpackConfig`,
             ],
             pluginOptions: {
-              plugins: [],
+              allExtensions: false,
+              isTSX: true,
               jsxPragma: `h`,
+              plugins: [],
             },
             resolve: ``,
             ssrAPIs: [],
@@ -290,5 +278,34 @@ describe(`Load plugins`, () => {
       `)
       expect(mockProcessExit).toHaveBeenCalledWith(1)
     })
+
+    it(`defaults plugin options to the ones defined in the schema`, async () => {
+      let plugins = await loadPlugins({
+        plugins: [
+          {
+            resolve: `gatsby-plugin-google-analytics`,
+            options: {
+              trackingId: `fake`,
+            },
+          },
+        ],
+      })
+
+      plugins = replaceFieldsThatCanVary(plugins)
+
+      expect(
+        plugins.find(plugin => plugin.name === `gatsby-plugin-google-analytics`)
+          .pluginOptions
+      ).toEqual({
+        // All the options that have defaults are defined
+        anonymize: false,
+        exclude: [],
+        head: false,
+        pageTransitionDelay: 0,
+        plugins: [],
+        respectDNT: false,
+        trackingId: `fake`,
+      })
+    })
   })
 })

packages/gatsby/src/bootstrap/load-plugins/validate.ts

@@ -198,16 +198,23 @@ export async function validatePluginOptions({
           }
 
           try {
-            // All plugins have "plugins: []"" added to their options in load.ts, even if they
-            // do not have subplugins. We add plugins to the schema if it does not exist already
-            // to make sure they pass validation.
+            if (typeof plugin.pluginOptions === `undefined`) {
+              return null
+            }
+
             if (!optionsSchema.describe().keys.plugins) {
+              // All plugins have "plugins: []"" added to their options in load.ts, even if they
+              // do not have subplugins. We add plugins to the schema if it does not exist already
+              // to make sure they pass validation.
               optionsSchema = optionsSchema.append({
                 plugins: Joi.array().length(0),
               })
             }
 
-            await validateOptionsSchema(optionsSchema, plugin.pluginOptions)
+            plugin.pluginOptions = await validateOptionsSchema(
+              optionsSchema,
+              plugin.pluginOptions
+            )
           } catch (error) {
             if (error instanceof Joi.ValidationError) {
               reporter.error({