generated from nhcarrigan/template
a36c8e72a5
## Summary
- Add comprehensive try/catch error handling across all API routes, middleware, and the Hono global error handler, piping every unhandled error to the `@nhcarrigan/logger` service to prevent silent crashes and unhandled Promise rejections
- Add a `logError` utility on the frontend that forwards errors through the overridden `console.error` to the backend telemetry endpoint; apply it to every silent `catch {}` block in the game context, sound, notification, and clipboard utilities, and wrap the React tree in an `ErrorBoundary`
- Add Plausible analytics, Open Graph + Twitter Card meta tags, Tree-Nation widget, and Google Ads to `index.html`
- Make the game sidebar sticky with a `--resource-bar-height` CSS custom property offset so it stays viewport-height without overlapping the resource bar; reset sticky behaviour in the mobile responsive override
## Test plan
- [ ] Lint passes: `pnpm lint`
- [ ] Build passes: `pnpm build`
- [ ] Verify errors thrown in API routes appear in the logger service rather than crashing the process
- [ ] Verify frontend errors appear in the `/api/fe/error` backend log
- [ ] Verify Open Graph tags render correctly when sharing the URL
- [ ] Verify Plausible analytics fires on page load
- [ ] Verify Tree-Nation badge renders in the sidebar
- [ ] Verify sidebar stays fixed while the main content scrolls on desktop
- [ ] Verify mobile layout is unaffected
✨ This issue was created with help from Hikari~ 🌸
Reviewed-on: #44
Co-authored-by: Hikari <hikari@nhcarrigan.com>
Co-committed-by: Hikari <hikari@nhcarrigan.com>
137 lines
4.1 KiB
TypeScript
137 lines
4.1 KiB
TypeScript
/**
|
|
* @file Discord OAuth helpers for token exchange, user fetching, and URL building.
|
|
* @copyright nhcarrigan
|
|
* @license Naomi's Public License
|
|
* @author Naomi Carrigan
|
|
*/
|
|
/* eslint-disable @typescript-eslint/naming-convention -- Discord API requires snake_case fields and HTTP headers require Pascal-Case */
|
|
import { logger } from "./logger.js";
|
|
|
|
interface DiscordTokenResponse {
|
|
access_token: string;
|
|
token_type: string;
|
|
expires_in: number;
|
|
refresh_token: string;
|
|
scope: string;
|
|
}
|
|
|
|
interface DiscordUser {
|
|
id: string;
|
|
username: string;
|
|
discriminator: string;
|
|
avatar: string | null;
|
|
}
|
|
|
|
/**
|
|
* Exchanges a Discord OAuth authorisation code for an access token.
|
|
* @param code - The authorisation code received from Discord's OAuth callback.
|
|
* @returns The Discord token response containing the access token.
|
|
* @throws {Error} If OAuth environment variables are missing or the exchange fails.
|
|
*/
|
|
const exchangeCode = async(
|
|
code: string,
|
|
): Promise<DiscordTokenResponse> => {
|
|
const clientId = process.env.DISCORD_CLIENT_ID;
|
|
const clientSecret = process.env.DISCORD_CLIENT_SECRET;
|
|
const redirectUri = process.env.DISCORD_REDIRECT_URI;
|
|
|
|
if (
|
|
clientId === undefined || clientId === ""
|
|
|| clientSecret === undefined || clientSecret === ""
|
|
|| redirectUri === undefined || redirectUri === ""
|
|
) {
|
|
throw new Error("Discord OAuth environment variables are required");
|
|
}
|
|
|
|
const parameters = new URLSearchParams({
|
|
client_id: clientId,
|
|
client_secret: clientSecret,
|
|
code: code,
|
|
grant_type: "authorization_code",
|
|
redirect_uri: redirectUri,
|
|
});
|
|
|
|
try {
|
|
const response = await fetch("https://discord.com/api/v10/oauth2/token", {
|
|
body: parameters.toString(),
|
|
headers: { "Content-Type": "application/x-www-form-urlencoded" },
|
|
method: "POST",
|
|
});
|
|
|
|
if (!response.ok) {
|
|
throw new Error(`Discord token exchange failed: ${response.statusText}`);
|
|
}
|
|
|
|
/* eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Response JSON matches DiscordTokenResponse shape */
|
|
return await (response.json() as Promise<DiscordTokenResponse>);
|
|
} catch (error) {
|
|
void logger.error(
|
|
"discord_exchange_code",
|
|
error instanceof Error
|
|
? error
|
|
: new Error(String(error)),
|
|
);
|
|
throw error;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Fetches the Discord user profile for the given access token.
|
|
* @param accessToken - A valid Discord OAuth access token.
|
|
* @returns The Discord user object.
|
|
* @throws {Error} If the user fetch fails.
|
|
*/
|
|
const fetchDiscordUser = async(
|
|
accessToken: string,
|
|
): Promise<DiscordUser> => {
|
|
try {
|
|
const response = await fetch("https://discord.com/api/v10/users/@me", {
|
|
headers: { Authorization: `Bearer ${accessToken}` },
|
|
});
|
|
|
|
if (!response.ok) {
|
|
throw new Error(`Discord user fetch failed: ${response.statusText}`);
|
|
}
|
|
|
|
/* eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Response JSON matches DiscordUser shape */
|
|
return await (response.json() as Promise<DiscordUser>);
|
|
} catch (error) {
|
|
void logger.error(
|
|
"discord_fetch_user",
|
|
error instanceof Error
|
|
? error
|
|
: new Error(String(error)),
|
|
);
|
|
throw error;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Builds the Discord OAuth authorisation URL.
|
|
* @returns The full OAuth URL to redirect the user to.
|
|
* @throws {Error} If OAuth environment variables are missing.
|
|
*/
|
|
const buildOAuthUrl = (): string => {
|
|
const clientId = process.env.DISCORD_CLIENT_ID;
|
|
const redirectUri = process.env.DISCORD_REDIRECT_URI;
|
|
|
|
if (
|
|
clientId === undefined || clientId === ""
|
|
|| redirectUri === undefined || redirectUri === ""
|
|
) {
|
|
throw new Error("Discord OAuth environment variables are required");
|
|
}
|
|
|
|
const parameters = new URLSearchParams({
|
|
client_id: clientId,
|
|
redirect_uri: redirectUri,
|
|
response_type: "code",
|
|
scope: "identify",
|
|
});
|
|
|
|
return `https://discord.com/api/oauth2/authorize?${parameters.toString()}`;
|
|
};
|
|
|
|
export type { DiscordTokenResponse, DiscordUser };
|
|
export { buildOAuthUrl, exchangeCode, fetchDiscordUser };
|