fix(v2): force terminate building if client bundle failed

[lex111]

Motivation

Resolve #2311.

Server build uses the WaitPlugin plugin, which waits until a client bundle is created. This wait is infinite, so if the building of client bundle fails, the build process enters idle mode.

docusaurus/packages/docusaurus/src/webpack/server.ts

Lines 49 to 52 in 32c1a92

	// Wait until manifest from client bundle is generated
	new WaitPlugin({
	filepath: path.join(generatedFilesDir, 'client-manifest.json'),
	}),

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

• In a MDX file try to import unresolvable dependency e.g.:

---
id: mdx
title: MDX page
---

import Blah from 'Blah';

Heading...

Prior to this fix, the build process became idle and needed to be killed (for example, by pressing CTRL + C)

Now the build process in case of an error in the client bundle terminated immediately.

Results:

Before (idle)	After (forced terminated)

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

[lex111]

Perhaps this tiny plugin needs to be created in a separate file or class (in same file), but not sure about it. But feel free to change that. Something like ClientBundleCheckerPlugin??

[lex111]

fix(v2) -> chore(v2) ?

Not sure exactly how the type of commit here accurately reflects the situation...

[mohrash92]

Perhaps this tiny plugin needs to be created in a separate file or class (in same file), but not sure about it. But feel free to change that. Something like ClientBundleCheckerPlugin??

I feel like you are right here. It can be made a separate plugin. Don't wish to take away your thunder and all your hard work on this but I can try do that if you want? :)

[docusaurus-bot]

Deploy preview for docusaurus-2 ready!

Built with commit d2e4f14

https://deploy-preview-2345--docusaurus-2.netlify.com

[lex111]

Although it is recommended that we use the CommonJS module format (import chalk = require('chalk');) to import chalk, but when using this style, tests will fail with such an error:

 `import =` is not supported by @babel/plugin-transform-typescript
Please consider using `import <moduleName> from '<moduleName>';` alongside Typescript's --allowSyntheticDefaultImports option.

It is OK?

[mohrash92]

Seems like this is a known limitation. That is fine then :)