fix(gatsby-plugin-sharp): catch errors when writing base64 images

[KyleAMathews]

Possibly fixes #24774 (comment)

We caught read errors for images but not write errors.

New error:

[pvdz]

Great that we're now catching this one but it makes me wonder what other errors ought to be trapped that currently are not.

[KyleAMathews]

Yeah, more generic trapping makes sense to me. I'm not familiar enough with plugin-sharp's history over the past year or so to know what's been tried/considered.

[KyleAMathews]

without this, messages show up in the console looking like: ERROR [object Object] ...

[KyleAMathews]

it seems like reporter.error broke the old-skool way of sending errors?

[ascorbic]

This could also fix #28203 and [ch19324], but may need to be moved elsewhere to make it work if the error is in another sharp operation.

[wardpeet]

@KyleAMathews this is not really fixing the issue, this is working around it.

The root problem is here

gatsby/packages/gatsby-cli/src/reporter/reporter.ts

Lines 128 to 130 in 4cfc0bb

	details.context = {
	sourceMessage: errorMeta + ` ` + error.message,
	}

[KyleAMathews]

@wardpeet thanks for the pointer. I assumed it'd gotten broken somewhere in there but didn't have context.

[wardpeet]

But +1 for structured logs 👍

[KyleAMathews]

may need to be moved elsewhere to make it work if the error is in another sharp operation.

@ascorbic what need moved?

[ascorbic]

@KyleAMathews The error handler. This only catches one specific sharp operation, and other operations would likely have the same error which could be uncaught if there was no base64 image

[KyleAMathews]

@ascorbic can you point me to the error handler? plugin-sharp is a lot to sort through :-D Agree that's the right fix per @pvdz and my conversation above.

[ascorbic]

I mean the one you just added!

[KyleAMathews]

Oh haha I see. I thought there was a generic error handler. Yeah I'll do a quick scan through other read/write calls in plugin-sharp to see if there's any others we've missed.

[ascorbic]

One good test would be to see what happens in your test site if you remove the base64 query. Does it bail elsewhere?

[sidharthachatterjee]

Agreed with everyone's comments but we can iterate on that. Shipping this now since it is valuable by itself and unblocks one of my broken builds.

Thank you @KyleAMathews 🤗

[sidharthachatterjee]

Approving again after fixing a formatting issue

[sidharthachatterjee]

This is out on the next release channel

[KyleAMathews]

Identified a few other places where we don't appear to trap sharp errors #28640

[LekoArts]

Published in gatsby-plugin-sharp@2.11.1