todos part 2 (#29414)

* todos part 2 * tests * mock panic * remove obsolete snapshot
gatsbyjs · Feb 11, 2021 · ae12e63 · ae12e63
1 parent a7c36de
commit ae12e63
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 129 deletions.
diff --git a/packages/gatsby-plugin-google-gtag/src/__tests__/gatsby-ssr.js b/packages/gatsby-plugin-google-gtag/src/__tests__/gatsby-ssr.js
@@ -75,23 +75,4 @@ describe(`respectDNT`, () => {
       DO_NOT_TRACK_STRING
     )
   })
-
-  it(`listens to respectDNT deprecated option`, () => {
-    const mocks = {
-      setHeadComponents: jest.fn(),
-      setPostBodyComponents: jest.fn(),
-    }
-    const pluginOptions = {
-      trackingIds: [`GA_TRACKING_ID`],
-      respectDNT: true,
-      pluginConfig: {},
-    }
-
-    onRenderBody(mocks, pluginOptions)
-    const [, config] = mocks.setPostBodyComponents.mock.calls[0][0]
-
-    expect(config.props.dangerouslySetInnerHTML.__html).toContain(
-      DO_NOT_TRACK_STRING
-    )
-  })
 })
diff --git a/packages/gatsby-plugin-google-gtag/src/gatsby-ssr.js b/packages/gatsby-plugin-google-gtag/src/gatsby-ssr.js
@@ -42,10 +42,6 @@ exports.onRenderBody = (
     ? setHeadComponents
     : setPostBodyComponents
 
-  // TODO: remove pluginOptions.respectDNT in the next major release of this plugin.
-  // See issue https://github.com/gatsbyjs/gatsby/issues/11159 for the discussion.
-  const respectDNT = pluginConfig.respectDNT || pluginOptions.respectDNT
-
   const renderHtml = () => `
       ${
         excludeGtagPaths.length
@@ -59,7 +55,7 @@ exports.onRenderBody = (
           : ``
       }
       if(${
-        respectDNT
+        pluginConfig.respectDNT
           ? `!(navigator.doNotTrack == "1" || window.doNotTrack == "1")`
           : `true`
       }) {

diff --git a/packages/gatsby-plugin-mdx/utils/default-options.js b/packages/gatsby-plugin-mdx/utils/default-options.js
@@ -17,8 +17,6 @@ module.exports = ({ mdPlugins, hastPlugins, ...pluginOptions }) => {
       plugins: [],
       root: process.cwd(),
       gatsbyRemarkPlugins: [],
-      // TODO: Remove globalScope option in next major as it's deprecated in favor of shortcodes, see https://github.com/ChristopherBiscardi/gatsby-mdx/issues/239#issuecomment-507322221
-      globalScope: `export default {}`,
       shouldBlockNodeFromTransformation: () => false,
     },
     pluginOptions

diff --git a/packages/gatsby-plugin-netlify/src/__tests__/__snapshots__/build-headers-program.js.snap b/packages/gatsby-plugin-netlify/src/__tests__/__snapshots__/build-headers-program.js.snap
@@ -1,95 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`build-headers-program with badly headers configuration 1`] = `
-"## Created with gatsby-plugin-netlify
-
-/*
-  X-Frame-Options: DENY
-  X-XSS-Protection: 1; mode=block
-  X-Content-Type-Options: nosniff
-  Referrer-Policy: same-origin
-X-Frame-Options
-  sameorigin
-/component---node-modules-gatsby-plugin-offline-app-shell-js-78f9e4dea04737fa062d.js
-  Cache-Control: public, max-age=31536000, immutable
-/0-0180cd94ef2497ac7db8.js
-  Cache-Control: public, max-age=31536000, immutable
-/component---src-templates-blog-post-js-517987eae96e75cddbe7.js
-  Cache-Control: public, max-age=31536000, immutable
-/component---src-pages-404-js-53e6c51a5a7e73090f50.js
-  Cache-Control: public, max-age=31536000, immutable
-/component---src-pages-index-js-0bdd01c77ee09ef0224c.js
-  Cache-Control: public, max-age=31536000, immutable
-/webpack-runtime-acaa8994f1f704475e21.js
-  Cache-Control: public, max-age=31536000, immutable
-/styles.1025963f4f2ec7abbad4.css
-  Cache-Control: public, max-age=31536000, immutable
-/styles-565f081c8374bbda155f.js
-  Cache-Control: public, max-age=31536000, immutable
-/app-f33c13590352da20930f.js
-  Cache-Control: public, max-age=31536000, immutable
-/static/*
-  Cache-Control: public, max-age=31536000, immutable
-/sw.js
-  Cache-Control: no-cache
-/offline-plugin-app-shell-fallback/
-  Link: </webpack-runtime-acaa8994f1f704475e21.js>; rel=preload; as=script
-  Link: </styles-565f081c8374bbda155f.js>; rel=preload; as=script
-  Link: </app-f33c13590352da20930f.js>; rel=preload; as=script
-  Link: </component---node-modules-gatsby-plugin-offline-app-shell-js-78f9e4dea04737fa062d.js>; rel=preload; as=script
-  Link: </page-data/app-data.json>; rel=preload; as=fetch; crossorigin
-  Link: </page-data/offline-plugin-app-shell-fallback/page-data.json>; rel=preload; as=fetch; crossorigin
-/hi-folks/
-  Link: </webpack-runtime-acaa8994f1f704475e21.js>; rel=preload; as=script
-  Link: </styles-565f081c8374bbda155f.js>; rel=preload; as=script
-  Link: </app-f33c13590352da20930f.js>; rel=preload; as=script
-  Link: </0-0180cd94ef2497ac7db8.js>; rel=preload; as=script
-  Link: </component---src-templates-blog-post-js-517987eae96e75cddbe7.js>; rel=preload; as=script
-  Link: </page-data/app-data.json>; rel=preload; as=fetch; crossorigin
-  Link: </page-data/hi-folks/page-data.json>; rel=preload; as=fetch; crossorigin
-/my-second-post/
-  Link: </webpack-runtime-acaa8994f1f704475e21.js>; rel=preload; as=script
-  Link: </styles-565f081c8374bbda155f.js>; rel=preload; as=script
-  Link: </app-f33c13590352da20930f.js>; rel=preload; as=script
-  Link: </0-0180cd94ef2497ac7db8.js>; rel=preload; as=script
-  Link: </component---src-templates-blog-post-js-517987eae96e75cddbe7.js>; rel=preload; as=script
-  Link: </page-data/app-data.json>; rel=preload; as=fetch; crossorigin
-  Link: </page-data/my-second-post/page-data.json>; rel=preload; as=fetch; crossorigin
-/hello-world/
-  Link: </webpack-runtime-acaa8994f1f704475e21.js>; rel=preload; as=script
-  Link: </styles-565f081c8374bbda155f.js>; rel=preload; as=script
-  Link: </app-f33c13590352da20930f.js>; rel=preload; as=script
-  Link: </0-0180cd94ef2497ac7db8.js>; rel=preload; as=script
-  Link: </component---src-templates-blog-post-js-517987eae96e75cddbe7.js>; rel=preload; as=script
-  Link: </page-data/app-data.json>; rel=preload; as=fetch; crossorigin
-  Link: </page-data/hello-world/page-data.json>; rel=preload; as=fetch; crossorigin
-/404/
-  Link: </webpack-runtime-acaa8994f1f704475e21.js>; rel=preload; as=script
-  Link: </styles-565f081c8374bbda155f.js>; rel=preload; as=script
-  Link: </app-f33c13590352da20930f.js>; rel=preload; as=script
-  Link: </0-0180cd94ef2497ac7db8.js>; rel=preload; as=script
-  Link: </component---src-pages-404-js-53e6c51a5a7e73090f50.js>; rel=preload; as=script
-  Link: </page-data/app-data.json>; rel=preload; as=fetch; crossorigin
-  Link: </page-data/404/page-data.json>; rel=preload; as=fetch; crossorigin
-/
-  Link: </webpack-runtime-acaa8994f1f704475e21.js>; rel=preload; as=script
-  Link: </styles-565f081c8374bbda155f.js>; rel=preload; as=script
-  Link: </app-f33c13590352da20930f.js>; rel=preload; as=script
-  Link: </0-0180cd94ef2497ac7db8.js>; rel=preload; as=script
-  Link: </component---src-pages-index-js-0bdd01c77ee09ef0224c.js>; rel=preload; as=script
-  Link: </page-data/app-data.json>; rel=preload; as=fetch; crossorigin
-  Link: </page-data/index/page-data.json>; rel=preload; as=fetch; crossorigin
-/404.html
-  Link: </webpack-runtime-acaa8994f1f704475e21.js>; rel=preload; as=script
-  Link: </styles-565f081c8374bbda155f.js>; rel=preload; as=script
-  Link: </app-f33c13590352da20930f.js>; rel=preload; as=script
-  Link: </0-0180cd94ef2497ac7db8.js>; rel=preload; as=script
-  Link: </component---src-pages-404-js-53e6c51a5a7e73090f50.js>; rel=preload; as=script
-  Link: </page-data/app-data.json>; rel=preload; as=fetch; crossorigin
-  Link: </page-data/404.html/page-data.json>; rel=preload; as=fetch; crossorigin
-"
-`;
-
 exports[`build-headers-program with caching headers 1`] = `
 "## Created with gatsby-plugin-netlify
 

diff --git a/packages/gatsby-plugin-netlify/src/__tests__/build-headers-program.js b/packages/gatsby-plugin-netlify/src/__tests__/build-headers-program.js
@@ -16,7 +16,7 @@ describe(`build-headers-program`, () => {
 
   beforeEach(() => {
     reporter = {
-      warn: jest.fn(),
+      panic: jest.fn(),
     }
     fs.existsSync.mockClear()
     fs.existsSync.mockReturnValue(true)
@@ -175,7 +175,7 @@ describe(`build-headers-program`, () => {
 
     await buildHeadersProgram(pluginData, pluginOptions, reporter)
 
-    expect(reporter.warn).not.toHaveBeenCalled()
+    expect(reporter.panic).not.toHaveBeenCalled()
     const output = await fs.readFile(
       pluginData.publicFolder(`_headers`),
       `utf8`
@@ -210,7 +210,7 @@ describe(`build-headers-program`, () => {
 
     await buildHeadersProgram(pluginData, pluginOptions, reporter)
 
-    expect(reporter.warn).not.toHaveBeenCalled()
+    expect(reporter.panic).not.toHaveBeenCalled()
     const output = await fs.readFile(
       pluginData.publicFolder(`_headers`),
       `utf8`
@@ -242,7 +242,7 @@ describe(`build-headers-program`, () => {
 
     await buildHeadersProgram(pluginData, pluginOptions, reporter)
 
-    expect(reporter.warn).not.toHaveBeenCalled()
+    expect(reporter.panic).not.toHaveBeenCalled()
     const output = await fs.readFile(
       pluginData.publicFolder(`_headers`),
       `utf8`
@@ -261,7 +261,7 @@ describe(`build-headers-program`, () => {
 
     await buildHeadersProgram(pluginData, pluginOptions, reporter)
 
-    expect(reporter.warn).not.toHaveBeenCalled()
+    expect(reporter.panic).not.toHaveBeenCalled()
     expect(
       await fs.readFile(pluginData.publicFolder(`_headers`), `utf8`)
     ).toMatchSnapshot()
@@ -284,7 +284,7 @@ describe(`build-headers-program`, () => {
 
     await buildHeadersProgram(pluginData, pluginOptions, reporter)
 
-    expect(reporter.warn).not.toHaveBeenCalled()
+    expect(reporter.panic).not.toHaveBeenCalled()
     expect(
       await fs.readFile(pluginData.publicFolder(`_headers`), `utf8`)
     ).toMatchSnapshot()
@@ -303,10 +303,6 @@ describe(`build-headers-program`, () => {
 
     await buildHeadersProgram(pluginData, pluginOptions, reporter)
 
-    expect(reporter.warn).toHaveBeenCalled()
-
-    expect(
-      await fs.readFile(pluginData.publicFolder(`_headers`), `utf8`)
-    ).toMatchSnapshot()
+    expect(reporter.panic).toHaveBeenCalled()
   })
 })
diff --git a/packages/gatsby-plugin-netlify/src/build-headers-program.js b/packages/gatsby-plugin-netlify/src/build-headers-program.js
@@ -30,8 +30,7 @@ function validHeaders(headers, reporter) {
       _.every(headersList, header => {
         if (_.isString(header)) {
           if (!getHeaderName(header)) {
-            // TODO panic on builds on v3
-            reporter.warn(
+            reporter.panic(
               `[gatsby-plugin-netlify] ${path} contains an invalid header (${header}). Please check your plugin configuration`
             )
           }