fix(gatsby): warnOnce => reportOnce for verbose support (gatsbyjs#33529)

MaxMood96 · Oct 14, 2021 · eb7fb9a · eb7fb9a
1 parent e4c6efe
commit eb7fb9a
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 11 deletions.
diff --git a/packages/gatsby/src/query/__tests__/data-tracking.js b/packages/gatsby/src/query/__tests__/data-tracking.js
@@ -53,6 +53,7 @@ jest.mock(`gatsby-cli/lib/reporter`, () => {
     info: jest.fn(),
     warn: jest.fn(),
     error: jest.fn(),
+    verbose: jest.fn(),
     panicOnBuild: console.log,
     activityTimer: () => {
       return {

diff --git a/packages/gatsby/src/redux/actions/public.js b/packages/gatsby/src/redux/actions/public.js
@@ -27,7 +27,7 @@ const { getPageMode } = require(`../../utils/page-mode`)
 const normalizePath = require(`../../utils/normalize-path`).default
 import { createJobV2FromInternalJob } from "./internal"
 import { maybeSendJobToMainProcess } from "../../utils/jobs/worker-messaging"
-import { warnOnce } from "../../utils/warn-once"
+import { reportOnce } from "../../utils/report-once"
 import fs from "fs-extra"
 
 const isNotTestEnv = process.env.NODE_ENV !== `test`
@@ -1198,7 +1198,7 @@ actions.createJob = (job: Job, plugin?: ?Plugin = null) => {
   if (plugin?.name) {
     msg = msg + ` (called by ${plugin.name})`
   }
-  warnOnce(msg)
+  reportOnce(msg)
 
   return {
     type: `CREATE_JOB`,
@@ -1252,7 +1252,7 @@ actions.setJob = (job: Job, plugin?: ?Plugin = null) => {
   if (plugin?.name) {
     msg = msg + ` (called by ${plugin.name})`
   }
-  warnOnce(msg)
+  reportOnce(msg)
 
   return {
     type: `SET_JOB`,
@@ -1279,7 +1279,7 @@ actions.endJob = (job: Job, plugin?: ?Plugin = null) => {
   if (plugin?.name) {
     msg = msg + ` (called by ${plugin.name})`
   }
-  warnOnce(msg)
+  reportOnce(msg)
 
   return {
     type: `END_JOB`,

diff --git a/packages/gatsby/src/schema/__tests__/queries.js b/packages/gatsby/src/schema/__tests__/queries.js
@@ -15,6 +15,7 @@ jest.mock(`gatsby-cli/lib/reporter`, () => {
     info: jest.fn(),
     warn: jest.fn(),
     error: jest.fn(),
+    verbose: jest.fn(),
     activityTimer: () => {
       return {
         start: jest.fn(),

diff --git a/packages/gatsby/src/schema/__tests__/rebuild-schema.js b/packages/gatsby/src/schema/__tests__/rebuild-schema.js
@@ -20,6 +20,7 @@ jest.mock(`gatsby-cli/lib/reporter`, () => {
     log: jest.fn(),
     info: jest.fn(),
     warn: jest.fn(),
+    verbose: jest.fn(),
     activityTimer: () => {
       return {
         start: jest.fn(),

diff --git a/packages/gatsby/src/schema/infer/__tests__/infer-input.js b/packages/gatsby/src/schema/infer/__tests__/infer-input.js
@@ -14,6 +14,7 @@ jest.mock(`gatsby-cli/lib/reporter`, () => {
     info: jest.fn(),
     warn: jest.fn(),
     error: jest.fn(),
+    verbose: jest.fn(),
     activityTimer: () => {
       return {
         start: jest.fn(),

diff --git a/packages/gatsby/src/schema/infer/__tests__/infer.js b/packages/gatsby/src/schema/infer/__tests__/infer.js
@@ -18,6 +18,7 @@ jest.mock(`gatsby-cli/lib/reporter`, () => {
     info: jest.fn(),
     warn: jest.fn(),
     error: jest.fn(),
+    verbose: jest.fn(),
     activityTimer: () => {
       return {
         start: jest.fn(),

diff --git a/packages/gatsby/src/schema/infer/__tests__/merge-types.js b/packages/gatsby/src/schema/infer/__tests__/merge-types.js
@@ -10,6 +10,7 @@ jest.mock(`gatsby-cli/lib/reporter`, () => {
     info: jest.fn(),
     warn: jest.fn(),
     error: jest.fn(),
+    verbose: jest.fn(),
     activityTimer: () => {
       return {
         start: jest.fn(),

diff --git a/packages/gatsby/src/schema/infer/add-inferred-fields.js b/packages/gatsby/src/schema/infer/add-inferred-fields.js
@@ -7,7 +7,7 @@ const report = require(`gatsby-cli/lib/reporter`)
 import { isFile } from "./is-file"
 import { isDate } from "../types/date"
 import { addDerivedType } from "../types/derived-types"
-import { warnOnce } from "../../utils/warn-once"
+import { reportOnce } from "../../utils/report-once"
 import { is32BitInteger } from "../../utils/is-32-bit-integer"
 const { getDataStore } = require(`../../datastore`)
 
@@ -35,10 +35,11 @@ const addInferredFields = ({
   })
 
   if (deprecatedNodeKeys.size > 0) {
-    warnOnce(
+    reportOnce(
       `The ___NODE convention is deprecated. Please use the @link directive instead.\nType: ${typeComposer.getTypeName()}, Keys: ${Array.from(
         deprecatedNodeKeys
-      ).join(`, `)}\nMigration: https://gatsby.dev/node-convention-deprecation`
+      ).join(`, `)}\nMigration: https://gatsby.dev/node-convention-deprecation`,
+      `verbose`
     )
   }
 }

diff --git a/packages/gatsby/src/schema/types/__tests__/filter-input.js b/packages/gatsby/src/schema/types/__tests__/filter-input.js
@@ -8,6 +8,7 @@ jest.mock(`gatsby-cli/lib/reporter`, () => {
     info: jest.fn(),
     warn: jest.fn(),
     error: jest.fn(),
+    verbose: jest.fn(),
     activityTimer: () => {
       return {
         start: jest.fn(),

diff --git a/packages/gatsby/src/utils/page-mode.ts b/packages/gatsby/src/utils/page-mode.ts
@@ -5,7 +5,7 @@ import {
   IMaterializePageMode,
   PageMode,
 } from "../redux/types"
-import { warnOnce } from "./warn-once"
+import { reportOnce } from "./report-once"
 
 /**
  * In develop IGatsbyPage["mode"] can change at any time, so as a general rule we need to resolve it
@@ -48,7 +48,7 @@ function resolvePageMode(
     pageMode !== `SSG` &&
     (page.path === `/404.html` || page.path === `/500.html`)
   ) {
-    warnOnce(
+    reportOnce(
       `Status page "${page.path}" ignores page mode ("${pageMode}") and force sets it to SSG (this page can't be lazily rendered).`
     )
     pageMode = `SSG`

diff --git a/packages/gatsby/src/utils/warn-once.ts → packages/gatsby/src/utils/report-once.ts b/packages/gatsby/src/utils/warn-once.ts → packages/gatsby/src/utils/report-once.ts
@@ -3,10 +3,14 @@ import { isWorker } from "gatsby-worker"
 
 const displayedWarnings = new Set<string>()
 
-export const warnOnce = (message: string, key?: string): void => {
+export const reportOnce = (
+  message: string,
+  method: "log" | "warn" | "info" | "success" | "verbose" | "error" = `warn`,
+  key?: string
+): void => {
   const messageId = key ?? message
   if (!displayedWarnings.has(messageId) && !isWorker) {
     displayedWarnings.add(messageId)
-    reporter.warn(message)
+    reporter[method](message)
   }
 }