Port parts of Structured Errors to TS + Add two more errors (#20597)

* Convert first error files over to TS + add Joi typings

* Type more stuff

* Error 85926

* Rename tests

* Error 85927

* Fix ts type errors for test

* WIP: Warn on using .gif in image sharp

* Some more typing stuff

* Remove WIP .gif stuff

* Convert another test to TS

* Update snapshot, add describe block

* Update snapshot

* Fix missing return type

* Fix type error and explicitly type error map

Co-authored-by: Matt Kane <[email protected]>

Author: LekoArts

package.json

@@ -11,6 +11,7 @@
     "@types/fs-extra": "^8.0.1",
     "@types/got": "^9.6.9",
     "@types/jest": "^24.0.23",
+    "@types/joi": "^14.3.4",
     "@types/lodash": "^4.14.149",
     "@types/node": "^12.12.11",
     "@types/webpack": "^4.41.0",

packages/gatsby-cli/src/reporter/index.js

@@ -48,7 +48,7 @@ const tracer = require(`opentracing`).globalTracer()
 
 const { getErrorFormatter } = require(`./errors`)
 const { getStore } = require(`./redux`)
-const constructError = require(`../structured-errors/construct-error`)
+import constructError from "../structured-errors/construct-error"
 
 const errorFormatter = getErrorFormatter()
 

packages/gatsby-cli/src/structured-errors/__tests__/construct-error.js renamed to packages/gatsby-cli/src/structured-errors/__tests__/construct-error.ts

@@ -1,18 +1,21 @@
-const constructError = require(`../construct-error`)
+import constructError from "../construct-error"
 
 let log
 let processExit
 beforeEach(() => {
   log = jest.spyOn(console, `log`).mockImplementation(() => {})
-  processExit = jest.spyOn(process, `exit`).mockImplementation(() => {})
+  processExit = ((jest.spyOn(
+    process,
+    `exit`
+  ) as unknown) as jest.Mock).mockImplementation(() => {})
 
   log.mockReset()
   processExit.mockReset()
 })
 
 afterAll(() => {
-  console.log.mockClear()
-  process.exit.mockClear()
+  ;(console.log as jest.Mock).mockClear()
+  ;((process.exit as unknown) as jest.Mock).mockClear()
 })
 
 test(`it exits on invalid error schema`, () => {

packages/gatsby-cli/src/structured-errors/__tests__/error-map.js renamed to packages/gatsby-cli/src/structured-errors/__tests__/error-map.ts

@@ -1,4 +1,4 @@
-const { errorMap, defaultError } = require(`../error-map`)
+import { errorMap, defaultError } from "../error-map"
 
 test(`it defaults to generic error`, () => {
   expect(defaultError).toEqual(

packages/gatsby-cli/src/structured-errors/__tests__/error-schema.js renamed to packages/gatsby-cli/src/structured-errors/__tests__/error-schema.ts

@@ -1,4 +1,4 @@
-const schema = require(`../error-schema`)
+import schema from "../error-schema"
 
 test(`throws invalid on an invalid error`, () => {
   expect(schema.validate({ lol: `true` })).rejects.toBeDefined()

packages/gatsby-cli/src/structured-errors/construct-error.js

@@ -0,0 +1,75 @@
+import Joi from "@hapi/joi"
+import stackTrace from "stack-trace"
+import errorSchema from "./error-schema"
+import { errorMap, defaultError, IErrorMapEntry, ErrorId } from "./error-map"
+import { sanitizeStructuredStackTrace } from "../reporter/errors"
+
+interface IConstructError {
+  details: {
+    id?: ErrorId
+    context?: Record<string, string>
+    error?: string
+    [key: string]: unknown
+  }
+}
+
+interface ILocationPosition {
+  line: number
+  column: number
+}
+
+interface IStructuredError {
+  code?: string
+  text: string
+  stack: {
+    fileName: string
+    functionName?: string
+    lineNumber?: number
+    columnNumber?: number
+  }[]
+  filePath?: string
+  location?: {
+    start: ILocationPosition
+    end?: ILocationPosition
+  }
+  error?: unknown
+  group?: string
+  level: IErrorMapEntry["level"]
+  type?: IErrorMapEntry["type"]
+  docsUrl?: string
+}
+
+// Merge partial error details with information from the errorMap
+// Validate the constructed object against an error schema
+const constructError = ({
+  details: { id, ...otherDetails },
+}: IConstructError): IStructuredError => {
+  const result: IErrorMapEntry = (id && errorMap[id]) || defaultError
+
+  // merge
+  const structuredError: IStructuredError = {
+    context: {},
+    ...otherDetails,
+    ...result,
+    text: result.text(otherDetails.context),
+    stack: otherDetails.error
+      ? sanitizeStructuredStackTrace(stackTrace.parse(otherDetails.error))
+      : null,
+    docsUrl: result.docsUrl || `https://gatsby.dev/issue-how-to`,
+  }
+
+  if (id) {
+    structuredError.code = id
+  }
+
+  // validate
+  const { error } = Joi.validate(structuredError, errorSchema)
+  if (error !== null) {
+    console.log(`Failed to validate error`, error)
+    process.exit(1)
+  }
+
+  return structuredError
+}
+
+export default constructError