chore:update all QiankunError usage

umijs · Nov 22, 2023 · 43a31d3 · 43a31d3
1 parent 15f7ef2
commit 43a31d3
Show file tree

Hide file tree

Showing 14 changed files with 117 additions and 11 deletions.
diff --git a/.dumi/pages/error/codes/2.tsx b/.dumi/pages/error/codes/2.tsx
@@ -0,0 +1,10 @@
+import React from 'react'
+import CodeSnippet from '../CodeSnippet'
+
+export default function ErrorCode1(props) {
+    return (
+        <>
+            <h1>#2: You should not set multiply entry script in one entry html, but {props.getErrorCodeArg(0)} has at least 2 entry scripts</h1>
+        </>
+    )
+}
diff --git a/.dumi/pages/error/codes/3.tsx b/.dumi/pages/error/codes/3.tsx
@@ -0,0 +1,10 @@
+import React from 'react'
+import CodeSnippet from '../CodeSnippet'
+
+export default function ErrorCode1(props) {
+    return (
+        <>
+            <h1>#3: entry {props.getErrorCodeArg(0)} load failed as entry script {props.getErrorCodeArg(1)} load failed</h1>
+        </>
+    )
+}
diff --git a/.dumi/pages/error/codes/4.tsx b/.dumi/pages/error/codes/4.tsx
@@ -0,0 +1,10 @@
+import React from 'react'
+import CodeSnippet from '../CodeSnippet'
+
+export default function ErrorCode1(props) {
+    return (
+        <>
+            <h1>#4: entry {props.getErrorCodeArg(0)} response body is empty!</h1>
+        </>
+    )
+}
diff --git a/.dumi/pages/error/codes/5.tsx b/.dumi/pages/error/codes/5.tsx
@@ -0,0 +1,10 @@
+import React from 'react'
+import CodeSnippet from '../CodeSnippet'
+
+export default function ErrorCode1(props) {
+    return (
+        <>
+            <h1>#5: {props.getErrorCodeArg(0)} entry {props.getErrorCodeArg(1)} load failed as it not export lifecycles</h1>
+        </>
+    )
+}
diff --git a/.dumi/pages/error/codes/6.tsx b/.dumi/pages/error/codes/6.tsx
@@ -0,0 +1,10 @@
+import React from 'react'
+import CodeSnippet from '../CodeSnippet'
+
+export default function ErrorCode1(props) {
+    return (
+        <>
+            <h1>#6: You need to export lifecycle functions in {props.getErrorCodeArg(0)} entry</h1>
+        </>
+    )
+}
diff --git a/.dumi/pages/error/codes/7.tsx b/.dumi/pages/error/codes/7.tsx
@@ -0,0 +1,10 @@
+import React from 'react'
+import CodeSnippet from '../CodeSnippet'
+
+export default function ErrorCode1(props) {
+    return (
+        <>
+            <h1>#7: {props.getErrorCodeArg(0)} head element not existed while accessing document.head!</h1>
+        </>
+    )
+}
diff --git a/.dumi/pages/error/codes/8.tsx b/.dumi/pages/error/codes/8.tsx
@@ -0,0 +1,10 @@
+import React from 'react'
+import CodeSnippet from '../CodeSnippet'
+
+export default function ErrorCode1(props) {
+    return (
+        <>
+            <h1>#8: {props.getErrorCodeArg(0)} container {props.getErrorCodeArg(1)} element not ready while rebuilding!</h1>
+        </>
+    )
+}
diff --git a/.dumi/pages/error/index.tsx b/.dumi/pages/error/index.tsx
@@ -20,7 +20,7 @@ export default function CodeSnippet() {
                 getErrorCodeArg={getErrorCodeArg}
                 errorCode={code} />
         </div>
-    ) : (<div>请输入错误码code</div>)
+    ) : (<div>Please enter the error code</div>)
 
     function getErrorCodeArg(index, argName) {
         const missingArg = argName ? `(${argName})` : `(unknown)`;

diff --git a/packages/loader/src/index.ts b/packages/loader/src/index.ts
@@ -121,7 +121,9 @@ export async function loadEntry<T>(entry: Entry, container: HTMLElement, opts: L
           if (isEntryScript(script)) {
             if (foundEntryScript) {
               throw new QiankunError(
+                2,
                 `You should not set multiply entry script in one entry html, but ${entry} has at least 2 entry scripts`,
+                entry,
               );
             }
 
@@ -139,7 +141,12 @@ export async function loadEntry<T>(entry: Entry, container: HTMLElement, opts: L
                   onEntryLoaded();
                 } else {
                   entryScriptLoadedDeferred.reject(
-                    new QiankunError(`entry ${entry} load failed as entry script ${script.src} load failed}`),
+                    new QiankunError(
+                      3,
+                      `entry ${entry} load failed as entry script ${script.src} load failed`,
+                      entry,
+                      script.src,
+                    ),
                   );
                 }
               }
@@ -171,5 +178,5 @@ export async function loadEntry<T>(entry: Entry, container: HTMLElement, opts: L
     return entryScriptLoadedDeferred.promise;
   }
 
-  throw new QiankunError(`entry ${entry} response body is empty!`);
+  throw new QiankunError(4, `entry ${entry} response body is empty!`, entry);
 }
diff --git a/packages/qiankun/src/core/loadApp.ts b/packages/qiankun/src/core/loadApp.ts
@@ -10,7 +10,7 @@ import { moduleResolver as defaultModuleResolver, transpileAssets, wrapFetchWith
 import { concat, isFunction, mergeWith } from 'lodash';
 import type { ParcelConfigObject } from 'single-spa';
 import getAddOns from '../addons';
-import { QiankunError } from '../error';
+import { QiankunError } from '@qiankunjs/shared';
 import type { AppConfiguration, LifeCycleFn, LifeCycles, LoadableApp, MicroAppLifeCycles, ObjectType } from '../types';
 import {
   getPureHTMLStringWithoutScripts,
@@ -94,7 +94,8 @@ export default async function loadApp<T extends ObjectType>(
   await execHooksChain(toArray(beforeLoad), app, global);
 
   const lifecycles = await lifecyclesPromise;
-  if (!lifecycles) throw new QiankunError(`${appName} entry ${entry} load failed as it not export lifecycles`);
+  if (!lifecycles)
+    throw new QiankunError(5, `${appName} entry ${entry} load failed as it not export lifecycles`, appName, entry);
   const { bootstrap, mount, unmount, update } = getLifecyclesFromExports(
     lifecycles,
     appName,
@@ -235,7 +236,7 @@ function getLifecyclesFromExports(
     return globalVariableExports;
   }
 
-  throw new QiankunError(`You need to export lifecycle functions in ${appName} entry`);
+  throw new QiankunError(6, `You need to export lifecycle functions in ${appName} entry`, appName);
 }
 
 function calcPublicPath(entry: string): string {

diff --git a/packages/qiankun/src/error.ts b/packages/qiankun/src/error.ts
@@ -1,5 +1,13 @@
 export class QiankunError extends Error {
-  constructor(message: string) {
-    super(`[qiankun]: ${message}`);
+  constructor(code: number, message: string, ...args: string[]) {
+    let errorMessage = `[qiankun #${code}]: ${message ? message + ' ' : ''}`;
+    if (process.env.NODE_ENV === 'production') {
+      errorMessage += `See https://qiankun.umijs.org/error/?code=${code}${
+        args.length ? `&arg=${args.join('&arg=')}` : ''
+      }`;
+    } else {
+      console.warn('args', ...args);
+    }
+    super(errorMessage);
   }
 }
diff --git a/packages/sandbox/src/patchers/dynamicAppend/forStandardSandbox.ts b/packages/sandbox/src/patchers/dynamicAppend/forStandardSandbox.ts
@@ -78,7 +78,11 @@ function patchDocument(sandbox: Sandbox, getContainer: () => HTMLElement): Calla
     const container = getContainer();
     const containerHeadElement = getContainerHeadElement(container);
     if (!containerHeadElement) {
-      throw new QiankunError(`${sandbox.name} head element not existed while accessing document.head!`);
+      throw new QiankunError(
+        7,
+        `${sandbox.name} head element not existed while accessing document.head!`,
+        sandbox.name,
+      );
     }
     return containerHeadElement;
   };
@@ -374,7 +378,10 @@ export function patchStandardSandbox(
                     const containerHeadElement = getContainerHeadElement(container);
                     if (!containerHeadElement) {
                       throw new QiankunError(
+                        8,
                         `${appName} container ${qiankunHeadTagName} element not ready while rebuilding!`,
+                        appName,
+                        qiankunHeadTagName,
                       );
                     }
                     return containerHeadElement;

diff --git a/packages/shared/src/error/QiankunError.ts b/packages/shared/src/error/QiankunError.ts
@@ -0,0 +1,13 @@
+export class QiankunError extends Error {
+  constructor(code: number, message: string, ...args: string[]) {
+    let errorMessage = `[qiankun #${code}]: ${message ? message + ' ' : ''}`;
+    if (process.env.NODE_ENV === 'production') {
+      errorMessage += `See https://qiankun.umijs.org/error/?code=${code}${
+        args.length ? `&arg=${args.join('&arg=')}` : ''
+      }`;
+    } else {
+      console.warn('args', ...args);
+    }
+    super(errorMessage);
+  }
+}
diff --git a/packages/shared/src/reporter/QiankunError.ts b/packages/shared/src/reporter/QiankunError.ts
@@ -1,7 +1,7 @@
 export class QiankunError extends Error {
-  constructor(message: string, code?: number,  ...args: string[]) {
+  constructor(code: number, message: string, ...args: string[]) {
     let errorMessage = `[qiankun #${code}]: ${message ? message + ' ' : ''}`;
-    if (process.env.NODE_ENV === 'production' && typeof(code) !== 'undefined') {
+    if (process.env.NODE_ENV === 'production') {
       errorMessage += `See https://qiankun.umijs.org/error/?code=${code}${
         args.length ? `&arg=${args.join('&arg=')}` : ''
       }`;