fix(gatsby-plugin-sharp): avoid joi validation error when using reporter.panic

[rburgst]

Description

fix joi error when image conversion fails

previously just passing the error object would produce the following joi error

Failed to validate error Error [ValidationError]: "name" is not allowed
    at Object.exports.process (/myproject/node_modules/@hapi/joi/lib/errors.js:202:19)
    at internals.Object._validateWithOptions (/myproject/node_modules/@hapi/joi/lib/types/any/index.js:763:31)
    at internals.Object.validate (/myproject/node_modules/@hapi/joi/lib/types/any/index.js:797:21)
    at constructError (/myproject/node_modules/gatsby-cli/lib/structured-errors/construct-error.js:52:32)
    at Reporter.error (/myproject/node_modules/gatsby-cli/lib/reporter/reporter.js:135:59)
    at Reporter.panic (/myproject/node_modules/gatsby-cli/lib/reporter/reporter.js:75:34)
    at Object.panic (/myproject/node_modules/gatsby/src/utils/api-runner-node.js:201:16)
    at /myproject/node_modules/gatsby-plugin-sharp/index.js:162:14 {
  isJoi: true,

Related Issues

• N/A

[pieh]

Thanks.

It seems something is throwing an object with unexpected name field here, right? In any case - this is ok to get in as-is

When I tried artificially cause this:

I got

Failed to validate error Error [ValidationError]: "name" is not allowed
    at Object.exports.process (/Users/misiek/dev/gatsby-starter-blog/node_modules/@hapi/joi/lib/errors.js:202:19)
    at internals.Object._validateWithOptions (/Users/misiek/dev/gatsby-starter-blog/node_modules/@hapi/joi/lib/types/any/index.js:763:31)
    at internals.Object.validate (/Users/misiek/dev/gatsby-starter-blog/node_modules/@hapi/joi/lib/types/any/index.js:797:21)
    at constructError (/Users/misiek/dev/gatsby-starter-blog/node_modules/gatsby-cli/lib/structured-errors/construct-error.js:52:32)
    at Reporter.error (/Users/misiek/dev/gatsby-starter-blog/node_modules/gatsby-cli/lib/reporter/reporter.js:135:59)
    at Reporter.panic (/Users/misiek/dev/gatsby-starter-blog/node_modules/gatsby-cli/lib/reporter/reporter.js:75:34)
    at Object.panic (/Users/misiek/dev/gatsby-starter-blog/node_modules/gatsby/src/utils/api-runner-node.js:201:16)
    at /Users/misiek/dev/gatsby-starter-blog/node_modules/gatsby-plugin-sharp/index.js:162:14 {
  isJoi: true,
  details: [
    {
      message: '"name" is not allowed',
      path: [Array],
      type: 'object.allowUnknown',
      context: [Object]
    }
  ],
  _object: {
    context: {},
    name: 'WorkerError',
    pluginName: 'gatsby-transformer-sharp',
    text: 'There was an error',
    level: 'ERROR',
    stack: [],
    docsUrl: 'https://gatsby.dev/issue-how-to'
  },
  annotate: [Function]
}

and with your change I got:

 ERROR 

[object Object] {"name":true}



  WorkerError: {"name":true}
  
  - jobs-manager.ts:318 enqueueJob
    [gatsby-starter-blog]/[gatsby]/src/utils/jobs-manager.ts:318:21
  

Which is still not great, but at least the thrown thing is not hidden

Thanks again!

[pieh]

I just published gatsby-plugin-sharp@2.9.1 to npm with this change.

It might take some time to propagate (npm info gatsby-plugin-sharp already shows it, but https://www.npmjs.com/package/gatsby-plugin-sharp doesn't yet) - this is just info in case someone has trouble installing it right now