Skip to content

Enhance error handling in all package readme routes #1632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: 11-19-_ts-api-react-actions_enhance_error_handling_in_api_actions_and_hooks_with_user-facing_error_mapping
Choose a base branch
from
Draft

Enhance error handling in all package readme routes #1632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 59 additions & 50 deletions apps/cyberstorm-remix/app/p/tabs/Readme/PackageVersionReadme.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,78 +10,87 @@
import { DapperTs } from "@thunderstore/dapper-ts";

import "./Readme.css";
import { handleLoaderError } from "cyberstorm/utils/errors/handleLoaderError";
import { createNotFoundMapping } from "cyberstorm/utils/errors/loaderMappings";
import { throwUserFacingPayloadResponse } from "cyberstorm/utils/errors/userFacingErrorResponse";
import {
NimbusAwaitErrorElement,
NimbusDefaultRouteErrorBoundary,
} from "cyberstorm/utils/errors/NimbusErrorBoundary";
Comment on lines +16 to +19

Check failure

Code scanning / ESLint

Ensure code is properly formatted, use insertion, deletion, or replacement to obtain desired formatting. Error

Replace ⏎··NimbusAwaitErrorElement,⏎··NimbusDefaultRouteErrorBoundary,⏎}·from·"cyberstorm/utils/errors/NimbusErrorBoundary with ·getLoaderTools·}·from·"cyberstorm/utils/getLoaderTools";⏎import·{·Suspense·}·from·"react";⏎import·{·Await,·type·LoaderFunctionArgs·}·from·"react-router
import { getLoaderTools } from "cyberstorm/utils/getLoaderTools";

Check failure

Code scanning / ESLint

Ensure code is properly formatted, use insertion, deletion, or replacement to obtain desired formatting. Error

Replace getLoaderTools·}·from·"cyberstorm/utils/getLoaderTool with useLoaderData·}·from·"react-router";⏎⏎import·{·SkeletonBox·}·from·"@thunderstore/cyberstorm";⏎import·{·DapperTs·}·from·"@thunderstore/dapper-ts";⏎⏎import·"./Readme.cs

export async function loader({ params }: LoaderFunctionArgs) {
if (params.namespaceId && params.packageId && params.packageVersion) {
const publicEnvVariables = getPublicEnvVariables(["VITE_API_URL"]);
const dapper = new DapperTs(() => {
return {
apiHost: publicEnvVariables.VITE_API_URL,
sessionId: undefined,
};
});
return {
readme: await dapper.getPackageReadme(
const { dapper } = getLoaderTools();
try {
const readme = await dapper.getPackageReadme(
params.namespaceId,
params.packageId,
params.packageVersion
),
};
);

return {
readme,
};
} catch (error) {
handleLoaderError(error, {
mappings: [
createNotFoundMapping(
"Readme not available.",
"We could not find a readme for this package version."
),
],
});
}
}
return {
status: "error",
message: "Failed to load readme",
readme: { html: "" },
};
throwUserFacingPayloadResponse({
headline: "Readme not available.",
description: "We could not find a readme for this package version.",
category: "not_found",
status: 404,
});
}

export async function clientLoader({ params }: LoaderFunctionArgs) {
export function clientLoader({ params }: LoaderFunctionArgs) {
if (params.namespaceId && params.packageId && params.packageVersion) {
const tools = getSessionTools();
const dapper = new DapperTs(() => {
return {
apiHost: tools?.getConfig().apiHost,
sessionId: tools?.getConfig().sessionId,
};
});
const { dapper } = getLoaderTools();
const readme = dapper.getPackageReadme(
params.namespaceId,
params.packageId,
params.packageVersion
);

return {
readme: dapper.getPackageReadme(
params.namespaceId,
params.packageId,
params.packageVersion
),
readme,
};
}
return {
status: "error",
message: "Failed to load readme",
readme: { html: "" },
};
throwUserFacingPayloadResponse({
headline: "Readme not available.",
description: "We could not find a readme for this package version.",
category: "not_found",
status: 404,
});
}

export default function PackageVersionReadme() {
const { status, message, readme } = useLoaderData<
typeof loader | typeof clientLoader
>();
const { readme } = useLoaderData<typeof loader | typeof clientLoader>();

if (status === "error") return <div>{message}</div>;
return (
<Suspense fallback={<SkeletonBox className="package-readme__skeleton" />}>
<Await
resolve={readme}
errorElement={<div>Error occurred while loading description</div>}
>
<Await resolve={readme} errorElement={<NimbusAwaitErrorElement />}>
{(resolvedValue) => (
<>
<div className="markdown-wrapper">
<div
dangerouslySetInnerHTML={{ __html: resolvedValue.html }}
className="markdown"
/>
</div>
</>
<div className="markdown-wrapper">
<div
dangerouslySetInnerHTML={{ __html: resolvedValue.html }}
className="markdown"
/>
</div>
)}
</Await>
</Suspense>
);
}

export function ErrorBoundary() {
return <NimbusDefaultRouteErrorBoundary />;
}
101 changes: 51 additions & 50 deletions apps/cyberstorm-remix/app/p/tabs/Readme/PackageVersionWithoutCommunityReadme.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,78 +10,79 @@
import { DapperTs } from "@thunderstore/dapper-ts";

import "./Readme.css";
import { handleLoaderError } from "cyberstorm/utils/errors/handleLoaderError";
import { throwUserFacingPayloadResponse } from "cyberstorm/utils/errors/userFacingErrorResponse";
import {
NimbusAwaitErrorElement,
NimbusDefaultRouteErrorBoundary,
} from "cyberstorm/utils/errors/NimbusErrorBoundary";
Comment on lines +15 to +18

Check failure

Code scanning / ESLint

Ensure code is properly formatted, use insertion, deletion, or replacement to obtain desired formatting. Error

Replace ⏎··NimbusAwaitErrorElement,⏎··NimbusDefaultRouteErrorBoundary,⏎}·from·"cyberstorm/utils/errors/NimbusErrorBoundary with ·getLoaderTools·}·from·"cyberstorm/utils/getLoaderTools";⏎import·{·Suspense·}·from·"react";⏎import·{·Await,·type·LoaderFunctionArgs·}·from·"react-router
import { getLoaderTools } from "cyberstorm/utils/getLoaderTools";

Check failure

Code scanning / ESLint

Ensure code is properly formatted, use insertion, deletion, or replacement to obtain desired formatting. Error

Replace getLoaderTools·}·from·"cyberstorm/utils/getLoaderTool with useLoaderData·}·from·"react-router";⏎⏎import·{·SkeletonBox·}·from·"@thunderstore/cyberstorm";⏎import·{·DapperTs·}·from·"@thunderstore/dapper-ts";⏎⏎import·"./Readme.cs

export async function loader({ params }: LoaderFunctionArgs) {
if (params.namespaceId && params.packageId && params.packageVersion) {
const publicEnvVariables = getPublicEnvVariables(["VITE_API_URL"]);
const dapper = new DapperTs(() => {
return {
apiHost: publicEnvVariables.VITE_API_URL,
sessionId: undefined,
};
});
return {
readme: await dapper.getPackageReadme(
const { dapper } = getLoaderTools();
try {
const readme = await dapper.getPackageReadme(
params.namespaceId,
params.packageId,
params.packageVersion
),
};
);

return {
readme,
};
} catch (error) {
handleLoaderError(error);
}
}
return {
status: "error",
message: "Failed to load readme",
readme: { html: "" },
};
throwUserFacingPayloadResponse({
headline: "Readme not available.",
description: "We could not find a readme for this package version.",
category: "not_found",
status: 404,
});
}

export async function clientLoader({ params }: LoaderFunctionArgs) {
export function clientLoader({ params }: LoaderFunctionArgs) {
if (params.namespaceId && params.packageId && params.packageVersion) {
const tools = getSessionTools();
const dapper = new DapperTs(() => {
return {
apiHost: tools?.getConfig().apiHost,
sessionId: tools?.getConfig().sessionId,
};
});
const { dapper } = getLoaderTools();
const readme = dapper.getPackageReadme(
params.namespaceId,
params.packageId,
params.packageVersion
);

return {
readme: dapper.getPackageReadme(
params.namespaceId,
params.packageId,
params.packageVersion
),
readme,
};
}
return {
status: "error",
message: "Failed to load readme",
readme: { html: "" },
};
throwUserFacingPayloadResponse({
headline: "Readme not available.",
description: "We could not find a readme for this package version.",
category: "not_found",
status: 404,
});
}

export default function PackageVersionReadme() {
const { status, message, readme } = useLoaderData<
typeof loader | typeof clientLoader
>();
const { readme } = useLoaderData<typeof loader | typeof clientLoader>();

if (status === "error") return <div>{message}</div>;
return (
<Suspense fallback={<SkeletonBox className="package-readme__skeleton" />}>
<Await
resolve={readme}
errorElement={<div>Error occurred while loading description</div>}
>
<Await resolve={readme} errorElement={<NimbusAwaitErrorElement />}>
{(resolvedValue) => (
<>
<div className="markdown-wrapper">
<div
dangerouslySetInnerHTML={{ __html: resolvedValue.html }}
className="markdown"
/>
</div>
</>
<div className="markdown-wrapper">
<div
dangerouslySetInnerHTML={{ __html: resolvedValue.html }}
className="markdown"
/>
</div>
)}
</Await>
</Suspense>
);
}

export function ErrorBoundary() {
return <NimbusDefaultRouteErrorBoundary />;
}
13 changes: 13 additions & 0 deletions apps/cyberstorm-remix/app/p/tabs/Readme/Readme.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,17 @@
.package-readme__skeleton {
height: 500px;
}

.package-readme__error {
display: flex;
flex-direction: column;
gap: 1rem;
align-items: flex-start;
padding: 3rem 0;
}

.package-readme__error-description {
max-width: 40rem;
color: var(--Color-text-muted, rgb(180 189 255 / 0.8));
}
}
Loading
Loading