Files
ReadMeABook/src/lib/utils/url.ts
T
kikootwo 682836237b Implement centralized logging with RMABLogger
Replaces scattered console statements with a unified RMABLogger across backend API routes and services. Adds LOG_LEVEL-based filtering, job-aware database persistence, and context-based logging. Updates documentation to describe the new logging system and usage patterns. Also documents qBittorrent CSRF header fix
2026-01-28 11:41:58 -05:00

78 lines
2.4 KiB
TypeScript

/**
* URL Utilities for OAuth and Redirects
* Documentation: documentation/backend/services/environment.md
*/
import { RMABLogger } from './logger';
const logger = RMABLogger.create('URL');
/**
* Get application base URL for OAuth callbacks and redirects
*
* Priority order:
* 1. PUBLIC_URL - Primary documented environment variable
* 2. NEXTAUTH_URL - Legacy fallback for backward compatibility
* 3. BASE_URL - Alternative fallback
* 4. http://localhost:3030 - Development default
*
* @returns Normalized base URL (no trailing slash)
*
* @example
* // With PUBLIC_URL set
* process.env.PUBLIC_URL = 'https://example.com/'
* getBaseUrl() // Returns: 'https://example.com'
*
* // Without any env vars (development)
* getBaseUrl() // Returns: 'http://localhost:3030'
*/
export function getBaseUrl(): string {
const publicUrl = process.env.PUBLIC_URL?.trim();
const nextAuthUrl = process.env.NEXTAUTH_URL?.trim();
const baseUrl = process.env.BASE_URL?.trim();
// Priority: PUBLIC_URL > NEXTAUTH_URL > BASE_URL > localhost
let url = publicUrl || nextAuthUrl || baseUrl || 'http://localhost:3030';
// Normalize: remove trailing slash
url = url.replace(/\/$/, '');
// Validate URL format
if (!url.startsWith('http://') && !url.startsWith('https://')) {
logger.warn(`Invalid base URL format: ${url}. URLs must start with http:// or https://`);
}
// Production warning if using localhost
if (process.env.NODE_ENV === 'production' && url.includes('localhost')) {
logger.warn('Using localhost URL in production. OAuth callbacks may fail. Set PUBLIC_URL environment variable.');
}
// Log which variable is being used (debug only)
const source = publicUrl ? 'PUBLIC_URL' :
nextAuthUrl ? 'NEXTAUTH_URL' :
baseUrl ? 'BASE_URL' :
'default (localhost)';
logger.debug(`Using base URL from ${source}: ${url}`);
return url;
}
/**
* Build full OAuth callback URL
*
* @param path - Callback path (e.g., '/api/auth/oidc/callback')
* @returns Full callback URL
*
* @example
* getCallbackUrl('/api/auth/oidc/callback')
* // Returns: 'https://example.com/api/auth/oidc/callback'
*/
export function getCallbackUrl(path: string): string {
const baseUrl = getBaseUrl();
// Ensure path starts with /
const normalizedPath = path.startsWith('/') ? path : `/${path}`;
return `${baseUrl}${normalizedPath}`;
}