winstonjs/winston

File logging reconfiguration issue (Error: write after end)

Open

#1573 opened on Jan 23, 2019

View on GitHub
 (33 comments) (18 reactions) (0 assignees)JavaScript (21,967 stars) (1,789 forks)batch import
BugGood First IssueHelp WantedImportant

Description

Please tell us about your environment:

  • winston version?
    • winston@2
    • [ X] winston@3
  • _node -v outputs:_v10.15.0
  • _Operating System?_Windows 10
  • _Language? JavaScript (pure Node)

What is the problem?

When logger is reconfigured, the open streams are destroyed and winston tries to write to an already destroyed stream.

I created a really simple playground to replicate it (less than 10 lines of actual code): https://github.com/peterbakonyi05/winston-log-rotate-reconfiguration-issue/blob/master/index.js

What do you expect to happen instead?

winston creates a new stream and handles reconfiguration.

Note

Alternatively, instead of reconfiguring winston a new instance can be created, in case someone else has the same issue. Just call .close on the old instance and create a new from scratch.

Contributor guide

Tech stack
nodejsjavascript
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Node.js knowledgeUnderstanding of streams
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue describes a bug where reconfiguring a winston logger causes a 'write after end' error because open streams are destroyed. The reproduction is at https://github.com/peterbakonyi05/winston log rotate reconfiguration issue/blob/master/index.js. To fix this, investigate winston's Logger.prototype.configure method in the lib/winston/logger.js file and how it handles stream cleanup and reinitialization. The discussion in the issue may contain additional insights.