Enhance error handling across package Wiki routes with user-facing error mapping and improved loader functions

Author: Oksamies

apps/cyberstorm-remix/app/p/tabs/Wiki/Wiki.tsx

@@ -9,6 +9,7 @@ import {
   Await,
   type LoaderFunctionArgs,
   Outlet,
+  useLoaderData,
   useOutletContext,
 } from "react-router";
 import { useLoaderData } from "react-router";
@@ -17,79 +18,96 @@ import { type OutletContextShape } from "~/root";
 import { NewButton, NewIcon, SkeletonBox } from "@thunderstore/cyberstorm";
 import { DapperTs } from "@thunderstore/dapper-ts";
 import { getPackageWiki } from "@thunderstore/dapper-ts/src/methods/package";
+import { NewButton, NewIcon, SkeletonBox } from "@thunderstore/cyberstorm";
+import { faPlus } from "@fortawesome/pro-solid-svg-icons";
+import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
+import { type OutletContextShape } from "~/root";
+import { Suspense } from "react";
+import { handleLoaderError } from "cyberstorm/utils/errors/handleLoaderError";
+import { createNotFoundMapping } from "cyberstorm/utils/errors/loaderMappings";
+import {
+  NimbusAwaitErrorElement,
+  NimbusDefaultRouteErrorBoundary,
+} from "cyberstorm/utils/errors/NimbusErrorBoundary";
+import { throwUserFacingPayloadResponse } from "cyberstorm/utils/errors/userFacingErrorResponse";
+import { getLoaderTools } from "cyberstorm/utils/getLoaderTools";
+
+export const wikiErrorMappings = [
+  createNotFoundMapping(
+    "Wiki not available.",
+    "We could not find the requested wiki."
+  ),
+];
 
 import { ApiError } from "../../../../../../packages/thunderstore-api/src";
 import "./Wiki.css";
 
 export async function loader({ params }: LoaderFunctionArgs) {
   if (params.communityId && params.namespaceId && params.packageId) {
-    const publicEnvVariables = getPublicEnvVariables(["VITE_API_URL"]);
-    const dapper = new DapperTs(() => {
+    const { dapper } = getLoaderTools();
+    try {
+      const wiki = await dapper.getPackageWiki(
+        params.namespaceId,
+        params.packageId
+      );
+
       return {
-        apiHost: publicEnvVariables.VITE_API_URL,
-        sessionId: undefined,
+        wiki,
+        communityId: params.communityId,
+        namespaceId: params.namespaceId,
+        packageId: params.packageId,
+        slug: params.slug,
+        permissions: undefined,
       };
-    });
-
-    let wiki: Awaited<ReturnType<typeof getPackageWiki>> | undefined;
-
-    try {
-      wiki = await dapper.getPackageWiki(params.namespaceId, params.packageId);
     } catch (error) {
-      if (error instanceof ApiError) {
-        if (error.response.status === 404) {
-          wiki = undefined;
-        } else {
-          wiki = undefined;
-          console.error("Error fetching package wiki:", error);
-        }
-      }
+      handleLoaderError(error, { mappings: wikiErrorMappings });
     }
-
-    return {
-      wiki: wiki,
-      communityId: params.communityId,
-      namespaceId: params.namespaceId,
-      packageId: params.packageId,
-      slug: params.slug,
-      permissions: undefined,
-    };
   } else {
-    throw new Error("Namespace ID or Package ID is missing");
+    throwUserFacingPayloadResponse({
+      headline: "Wiki not available.",
+      description: "We could not find the requested wiki.",
+      category: "not_found",
+      status: 404,
+    });
   }
 }
 
 export async function clientLoader({ params }: LoaderFunctionArgs) {
   if (params.communityId && params.namespaceId && params.packageId) {
-    const tools = getSessionTools();
-    const dapper = new DapperTs(() => {
-      return {
-        apiHost: tools?.getConfig().apiHost,
-        sessionId: tools?.getConfig().sessionId,
-      };
-    });
+    const { dapper } = getLoaderTools();
 
-    const wiki = dapper.getPackageWiki(params.namespaceId, params.packageId);
+    const wikiPromise = dapper.getPackageWiki(
+      params.namespaceId,
+      params.packageId
+    );
 
-    const permissions = dapper.getPackagePermissions(
+    const permissionsPromise = dapper.getPackagePermissions(
       params.communityId,
       params.namespaceId,
       params.packageId
     );
 
     return {
-      wiki: wiki,
+      wiki: wikiPromise,
       communityId: params.communityId,
       namespaceId: params.namespaceId,
       packageId: params.packageId,
       slug: params.slug,
-      permissions: permissions,
+      permissions: permissionsPromise,
     };
   } else {
-    throw new Error("Namespace ID or Package ID is missing");
+    throwUserFacingPayloadResponse({
+      headline: "Wiki not available.",
+      description: "We could not find the requested wiki.",
+      category: "not_found",
+      status: 404,
+    });
   }
 }
 
+/**
+ * Displays the package wiki navigation and nested routes, relying on Suspense for data.
+ */
 export default function Wiki() {
   const { wiki, communityId, namespaceId, packageId, slug, permissions } =
     useLoaderData<typeof loader | typeof clientLoader>();
@@ -100,7 +118,10 @@ export default function Wiki() {
     <div className="package-wiki">
       <div className="package-wiki-nav">
         <Suspense>
-          <Await resolve={permissions}>
+          <Await
+            resolve={permissions}
+            errorElement={<NimbusAwaitErrorElement />}
+          >
             {(resolvedValue) =>
               resolvedValue?.permissions.can_manage ? (
                 <div className="package-wiki-nav__header">
@@ -126,7 +147,7 @@ export default function Wiki() {
             <Suspense
               fallback={<SkeletonBox className="package-wiki-nav__skeleton" />}
             >
-              <Await resolve={wiki} errorElement={<></>}>
+              <Await resolve={wiki} errorElement={<NimbusAwaitErrorElement />}>
                 {(resolvedValue) =>
                   resolvedValue &&
                   resolvedValue.pages.map((page, index) => {
@@ -194,3 +215,7 @@ export default function Wiki() {
     </div>
   );
 }
+
+export function ErrorBoundary() {
+  return <NimbusDefaultRouteErrorBoundary />;
+}

apps/cyberstorm-remix/app/p/tabs/Wiki/WikiContent.tsx

@@ -13,6 +13,7 @@ import { Heading, NewButton, NewIcon } from "@thunderstore/cyberstorm";
 import { type PackageWikiPageResponseData } from "@thunderstore/thunderstore-api";
 
 import "./Wiki.css";
+import { NimbusAwaitErrorElement } from "cyberstorm/utils/errors/NimbusErrorBoundary";
 
 interface WikiContentProps {
   page: PackageWikiPageResponseData;
@@ -51,7 +52,7 @@ export const WikiContent = memo(function WikiContent({
           </div>
         </div>
         <Suspense>
-          <Await resolve={canManage}>
+          <Await resolve={canManage} errorElement={<NimbusAwaitErrorElement />}>
             {(resolvedValue) =>
               resolvedValue ? (
                 <div className="package-wiki-content__actions">