From 91b92fcd0831050c1829cf24257a7598a404c8d5 Mon Sep 17 00:00:00 2001
From: Shanmughapriyan S <priyanshan03@gmail.com>
Date: Wed, 26 Oct 2022 18:18:25 +0530
Subject: [PATCH] fix(plugin-content-docs): fix error message context (error
 cause) when doc processing fails (#8234)

Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
---
 .../src/__tests__/docs.test.ts                | 45 ++++++++++++++-----
 .../src/docs.ts                               | 10 +++--
 2 files changed, 40 insertions(+), 15 deletions(-)

diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
index 4ccff773817c..39a762f714ca 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
@@ -93,6 +93,18 @@ function createTestUtils({
     });
   }
 
+  // Makes it easier to assert failure cases
+  async function getProcessDocFileError(
+    docFileArg: DocFile | string,
+  ): Promise<Error> {
+    try {
+      await processDocFile(docFileArg);
+      return new Error("unexpected: getProcessDocFileError didn't crash");
+    } catch (e) {
+      return e as Error;
+    }
+  }
+
   async function testMeta(
     docFileSource: string,
     expectedMetadata: Optional<
@@ -172,7 +184,13 @@ function createTestUtils({
     };
   }
 
-  return {processDocFile, testMeta, testSlug, generateNavigation};
+  return {
+    processDocFile,
+    getProcessDocFileError,
+    testMeta,
+    testSlug,
+    generateNavigation,
+  };
 }
 
 describe('simple site', () => {
@@ -683,16 +701,21 @@ describe('simple site', () => {
 
   it('docs with invalid id', async () => {
     const {defaultTestUtils} = await loadSite();
-    await expect(async () =>
-      defaultTestUtils.processDocFile(
-        createFakeDocFile({
-          source: 'some/fake/path',
-          frontMatter: {
-            id: 'Hello/world',
-          },
-        }),
-      ),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(
+
+    const error = await defaultTestUtils.getProcessDocFileError(
+      createFakeDocFile({
+        source: 'some/fake/path',
+        frontMatter: {
+          id: 'Hello/world',
+        },
+      }),
+    );
+
+    expect(error.message).toMatchInlineSnapshot(
+      `"Can't process doc metadata for doc at path path=some/fake/path in version name=current"`,
+    );
+    expect(error.cause).toBeDefined();
+    expect(error.cause!.message).toMatchInlineSnapshot(
       `"Document id "Hello/world" cannot include slash."`,
     );
   });
diff --git a/packages/docusaurus-plugin-content-docs/src/docs.ts b/packages/docusaurus-plugin-content-docs/src/docs.ts
index 7d13e40eb8cd..40fe33eb52da 100644
--- a/packages/docusaurus-plugin-content-docs/src/docs.ts
+++ b/packages/docusaurus-plugin-content-docs/src/docs.ts
@@ -316,7 +316,7 @@ async function doProcessDocMetadata({
   };
 }
 
-export function processDocMetadata(args: {
+export async function processDocMetadata(args: {
   docFile: DocFile;
   versionMetadata: VersionMetadata;
   context: LoadContext;
@@ -324,10 +324,12 @@ export function processDocMetadata(args: {
   env: DocEnv;
 }): Promise<DocMetadataBase> {
   try {
-    return doProcessDocMetadata(args);
+    return await doProcessDocMetadata(args);
   } catch (err) {
-    logger.error`Can't process doc metadata for doc at path path=${args.docFile.filePath} in version name=${args.versionMetadata.versionName}`;
-    throw err;
+    throw new Error(
+      `Can't process doc metadata for doc at path path=${args.docFile.filePath} in version name=${args.versionMetadata.versionName}`,
+      {cause: err as Error},
+    );
   }
 }