Exit process with error code when reporters fail

[MonicaOlejniczak]

↪️ Pull Request

This change modifies the process exit code when a reporter fails, ensuring that builds do not pass when something goes wrong in a reporter (e.g. generating a file).

Adding this exit code is the simplest mechanism for failing the build, as it does not require changing the existing API or introducing new APIs.

🚨 Test instructions

yarn test:integration

[devongovett]

I wonder if it is unexpected to do this for people using the Parcel programmatic API rather than our CLI? Should we store our own property here (rather than setting the global exit code), and then throw/emit an error from the main Parcel object that the CLI could pick up? We do already set an exit code in the CLI when an error is thrown.

[marcins]

What if we just removed this catch and let the error propagate naturally?

[MonicaOlejniczak]

I was trying to avoid propagating the errors because not all of the calls are awaited on, and doing so could regress performance.

As for storing something that the CLI can pickup, I can try doing that but it will only get emitted at the end of the build unless the aforementioned un-awaited cases are changed.

Alternatively, I could only propagate and await on buildSuccess events as that's the main use-case anyway.

Anyways the latest commit throws any received errors just before returning the build success event. I also initialise the reporters earlier so errors are seen earlier + adding to them becomes simpler.

[marcins]

You could simplify this fixutre by using fsFixture - example of an integration test with a reporter using fsFixture:

parcel/packages/core/integration-tests/test/api.js

Lines 62 to 109 in 89a69f5

	describe('Reporter API', () => {
	it('should pass the parcel version to plugins', async () => {
	const dir = path.join(__dirname, 'plugin-parcel-version');
	overlayFS.mkdirp(dir);
	await fsFixture(overlayFS, dir)`
	index.js:
	export default 'Hi';
	.parcelrc:
	{
	extends: "@parcel/config-default",
	reporters: ["./reporter-plugin.js", "..."],
	}
	package.json:
	{
	"version": "1234"
	}
	yarn.lock:
	reporter-plugin.js:
	import {Reporter} from '@parcel/plugin';
	import path from 'node:path';
	export default new Reporter({
	async report({event, options}) {
	if (event.type === 'buildSuccess') {
	await options.outputFS.writeFile(path.join(options.projectRoot, 'parcel-version.txt'), options.parcelVersion);
	}
	}
	})
	`;
	await bundle(path.join(dir, 'index.js'), {
	inputFS: overlayFS,
	outputFS: overlayFS,
	});
	assert.equal(
	await overlayFS.readFile(path.join(dir, 'parcel-version.txt')),
	PARCEL_VERSION,
	);
	});
	});
	});

[MonicaOlejniczak]

I initially had an fs fixture, but want to test the CLI as well which requires the files to live on disk

[yamadapc]

it'd be nice to test for cases where there is a delay here