Skip to content

Better logging and hard failure on config errors #1246

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: main
Choose a base branch
from
Draft

Better logging and hard failure on config errors #1246

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
35 changes: 33 additions & 2 deletions packages/chaire-lib-backend/src/config/server.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,8 +418,39 @@ try {
);
}
setProjectConfiguration(configFromFile);
} catch {
console.error(`Error loading server configuration in file ${configFileNormalized}`);
} catch (error: unknown) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a comment to explain why we have such complex error handling here and not elsewhere.

console.error(`Failed to load server configuration from ${configFileNormalized}:`);

// Type guard for Error objects
if (error instanceof Error) {
console.error(`Error: ${error.message}`);

if (error.stack) {
console.error('Stack trace:');
console.error(error.stack);
}

// Check for specific error types
if ('code' in error && error.code === 'MODULE_NOT_FOUND') {
console.error('The configuration file does not exist or cannot be accessed');
} else if (error instanceof SyntaxError) {
console.error('The configuration file contains invalid JSON or JavaScript syntax');
}

// Application-specific error handling
if (process.env.NODE_ENV === 'production') {
// In production, you might want to use a default configuration
// or terminate the process
process.exit(1);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a console log before the process exit?

} else {
// In development, rethrow for better debugging
throw error;
}
} else {
// Handle cases where the caught value isn't an Error object
console.error('An unknown error occurred:', error);
throw new Error('Configuration loading failed: Unknown error');
}
}

/** Application configuration, does not include the server configuration */
Expand Down
Loading