Adds option to exit process on logger error

[w3nl]

Introduces the exitOnError option to the logger configuration. This allows the logger to exit the process when an error is logged, providing a mechanism to halt execution in critical failure scenarios.

Summary by CodeRabbit

• New Features

  • Added an exitOnError configuration to the logger to control error-exit behavior; defaults to false for backward compatibility.

• Tests

  • Updated tests to cover the new option and to verify the default behavior when no logger configuration is provided.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Added an exitOnError option to the logger factory API (default false) and passed it through to Winston's createLogger. Updated tests to assert explicit and default exitOnError behavior.

Changes

Cohort / File(s)	Summary
Logger Configuration src/logger.js	Default export signature extended with exitOnError = false; value forwarded into winston.createLogger; JSDoc updated to document options.exitOnError.
Tests src/__tests__/logger.feature.test.js	Updated test cases to assert exitOnError: true when provided and to expect exitOnError: false when no loggers/options supplied.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Improves logging and error handling #381: Modifies src/logger.js export signature similarly — likely related change to logger factory API handling.

Poem

🐰 I tweaked a little switch today,
Exit or stay — you choose the way.
Logs whisper softly, clear and bright,
Errors handled, day or night.
Hopping off with a thankful bite 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title 'Adds option to exit process on logger error' directly and clearly summarizes the main change in the changeset—adding an exitOnError option to the logger factory.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature-exit-on-error

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Adds an exitOnError option to the logger factory so callers can control Winston’s exitOnError behavior via this library’s createLogger wrapper.

Changes:

• Documented a new options.exitOnError parameter in the createLogger JSDoc.
• Added exitOnError to the createLogger options destructuring with a default value.
• Passed exitOnError through to winston.createLogger(...).

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@src/logger.js`:
- Around line 43-49: The logger config passes exitOnError to
winston.createLogger but you manually handle exceptions with
process.on('uncaughtException'), so either remove the exitOnError option from
the logger construction or enable Winston's exception handling instead; to fix,
update the winston.createLogger call (symbol: logger) by deleting the
exitOnError property if you want manual handling, or replace manual handling by
configuring a transport with handleExceptions: true or using exceptionHandlers
in the winston setup and remove the process.on('uncaughtException', ...) handler
accordingly.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🌐 Web query:

winston 3 exitOnError option behavior

💡 Result:

In winston v3, exitOnError controls whether the Node.js process should exit after winston logs an uncaughtException (i.e., when you’ve enabled exception handling via handleExceptions: true on a transport or via exceptionHandlers). By default, winston will exit after logging the uncaught exception. [1][2]

You can change this behavior:

• Never exit after an uncaught exception log:

  const logger = winston.createLogger({ exitOnError: false });
  // or later:
  logger.exitOnError = false;

  [1][2]

• Conditional exit (function form): exitOnError(err) can decide per error whether to exit. Example shown in docs:

  function ignoreEpipe(err) {
    return err.code !== 'EPIPE';
  }
  const logger = winston.createLogger({ exitOnError: ignoreEpipe });

  (In this example, it won’t exit for EPIPE, but will exit for other errors.) [1][2]

Note: exitOnError is specifically documented in the context of uncaught exception handling, not normal logger.error(...) calls. [1][2]

Sources: [1] [2]

---

🏁 Script executed:

# Find and examine the logger.js file to understand context
find . -name "logger.js" -type f

Repository: trojs/logger

Length of output: 157

---

🏁 Script executed:

# Examine the main logger.js file to understand the full context
cat -n ./src/logger.js

Repository: trojs/logger

Length of output: 4957

---

Remove unused exitOnError parameter or configure Winston exception handling.

The exitOnError option only takes effect when Winston is configured to handle uncaught exceptions (via handleExceptions: true on a transport or exceptionHandlers). This code manually handles exceptions with process.on('uncaughtException', ...) instead, making exitOnError ineffective. Either remove the parameter or switch to Winston's built-in exception handling if that's the intent.

🤖 Prompt for AI Agents

In `@src/logger.js` around lines 43 - 49, The logger config passes exitOnError to
winston.createLogger but you manually handle exceptions with
process.on('uncaughtException'), so either remove the exitOnError option from
the logger construction or enable Winston's exception handling instead; to fix,
update the winston.createLogger call (symbol: logger) by deleting the
exitOnError property if you want manual handling, or replace manual handling by
configuring a transport with handleExceptions: true or using exceptionHandlers
in the winston setup and remove the process.on('uncaughtException', ...) handler
accordingly.