Writing stream with file rotating based on timestamp. 

Writing stream with file rotating based on timestamp

dex4er

file-timestamp-stream

- Closer's timer is `unref`-ed to prevent holding a NodeJS runtime.

- Use stream.finished@1.1.1 with Typescript support.

- Do not use `timers-obj` as far as pure NodeJS timers have better support for

- Close file if its file name is already changed even if there is no new data

  written: this check is made by interval timer.

- `newFilename` should be overriden in subclass so it is no argument for

- `_final` calls rather `stream.end` than `close` because of callback.

- New streams are `WriteStream` so `close` method can be used instead `end`.

- Clean up streams more carefully after they are not needed anymore.

- New syntax of import in plain Javascript.

- `newFilename` function has `FileTimestampStream` object as its first argument.

- `newFilename` function has `path` as its first argument.

- Implemented `_writev` method which corks file stream, then makes this writter

- Support `import FileTimestampStream from 'file-timestamp-stream'` syntax.

- Typescript: export options as `FileTimestampStreamOptions`.

- Implemented `_final` method which calls `end` on file stream.

- Only public interface of Writable is used.

- Implemented `_destroy` method which cleans up file stream.

- Exports also as a class and namespace and the default.

- Property `wstream` was renamed to `stream`.

- Upgraded chai@4.0.2, standard@10.0.2, tap@10.5.1, tap-given@0.4.1

- Minor optimizations and better error handling

Object.defineProperty(exports, "__esModule", { value: true });

const fs_1 = tslib_1.__importDefault(require("fs"));

const stream_finished_1 = tslib_1.__importDefault(require("stream.finished"));

const ultra_strftime_1 = tslib_1.__importDefault(require("ultra-strftime"));

class FileTimestampStream extends stream_1.Writable {

        this.streamCancelFinishers = new Map();

        this.streamErrorHandlers = new Map();

        this.flags = options.flags || "a";

        this.fs = options.fs || fs_1.default;

        this.path = options.path || "out.log";

            return callback(new Error("write after destroy"));

            this.stream.write(chunk, encoding, callback);

            for (const chunk of chunks) {

                this.stream.write(chunk.chunk, chunk.encoding);

            process.nextTick(() => this.stream.uncork());

        if (this.streamErrorHandlers.size > 0) {

            for (const [filename, handler] of this.streamErrorHandlers) {

                const stream = this.streams.get(filename);

                    stream.removeListener("error", handler);

            this.streamErrorHandlers.clear();

        if (this.streamCancelFinishers.size > 0) {

            for (const [filename, cancel] of this.streamCancelFinishers) {

                this.streamCancelFinishers.delete(filename);

            this.streamCancelFinishers.clear();

            for (const stream of this.streams.values()) {

                if (typeof stream.destroy === "function") {

            for (const closer of this.closers.values()) {

     * This method can be overriden in subclass

            }, FileTimestampStream.CLOSE_UNUSED_FILE_AFTER);

            this.closers.set(newFilename, newCloser);

            const newStreamCancelFinisher = stream_finished_1.default(newStream, () => {

                clearInterval(newCloser);

                this.closers.delete(newFilename);

                if (typeof newStream.destroy === "function") {

                this.streamCancelFinishers.delete(newFilename);

                this.streams.delete(newFilename);

            this.streamCancelFinishers.set(newFilename, newStreamCancelFinisher);

            this.currentFilename = newFilename;

FileTimestampStream.CLOSE_UNUSED_FILE_AFTER = 1000;

exports.FileTimestampStream = FileTimestampStream;

//# sourceMappingURL=file-timestamp-stream.js.map

  "description": "Writing stream with file rotating based on timestamp",

  "main": "lib/file-timestamp-stream.js",

  "typings": "lib/file-timestamp-stream.d.ts",

    "url": "https://github.com/dex4er/js-file-timestamp-stream"

    "url": "https://github.com/dex4er/js-file-timestamp-stream/issues"

  "homepage": "http://github.com/dex4er/js-file-timestamp-stream",

    "compile": "tsc --pretty --project .",

    "clean": "npm run clean:compile && npm run clean:coverage",

    "clean:coverage": "shx rm -rf coverage .nyc_output",

    "lint": "npm run compile && tsc --pretty -p examples && tsc --pretty -p test && eslint . && tslint -t stylish -p . && tslint -t stylish -p examples && tslint -t stylish -p test && prettier --ignore-path .gitignore --list-different '**/*.{js,json,md,ts,yml}' && markdownlint \"*.md\"",

    "postpublish": "git tag v$npm_package_version -a -m \"Release v$npm_package_version\" && git push --tags",

    "test:spec": "npm run ts-mocha -- \"test/*.ts\"",

    "test:coverage": "npm run clean:coverage && cross-env NYC=\"nyc --no-clean --reporter=lcov\" npm run test:spec && nyc report --reporter=text-summary --color",

    "ts-mocha": "$NYC mocha --use_strict --throw-deprecation --require source-map-support/register --require ts-node/register --timeout 90000"

import {Writable, WritableOptions} from "stream"

export interface FileTimestampStreamOptions extends WritableOptions {

  /** a string with [flags](https://nodejs.org/api/fs.html#fs_fs_open_path_flags_mode_callback) for opened stream (default: `'a'`) */

  /** a custom [fs](https://nodejs.org/api/fs.html) module (optional) */

  /** a template for new filenames (default: `'out.log'`) */

export class FileTimestampStream extends Writable {

  static readonly CLOSE_UNUSED_FILE_AFTER = 1000

  /** contains current [fs.WriteStream](https://nodejs.org/api/fs.html#fs_class_fs_writestream) object */

  private streams: Map<string, WriteStream> = new Map()

  private streamCancelFinishers: Map<string, () => void> = new Map()

  private streamErrorHandlers: Map<string, (err: Error) => void> = new Map()

  private closers: Map<string, NodeJS.Timer> = new Map()

  constructor(options: FileTimestampStreamOptions = {}) {

    this.path = options.path || "out.log"

  _write(chunk: any, encoding: string, callback: (error?: Error | null) => void): void {

      return callback(new Error("write after destroy"))

      this.stream!.write(chunk, encoding, callback)

  _writev(chunks: Array<{chunk: any; encoding: string}>, callback: (error?: Error | null) => void): void {

        this.stream!.write(chunk.chunk, chunk.encoding)

      process.nextTick(() => this.stream!.uncork())

  _final(callback: (error?: Error | null) => void): void {

  _destroy(error: Error | null, callback: (error: Error | null) => void): void {

    if (this.streamErrorHandlers.size > 0) {

      for (const [filename, handler] of this.streamErrorHandlers) {

        const stream = this.streams.get(filename)

          stream.removeListener("error", handler)

    if (this.streamCancelFinishers.size > 0) {

      for (const [filename, cancel] of this.streamCancelFinishers) {

          this.closers.delete(newFilename)

      }, FileTimestampStream.CLOSE_UNUSED_FILE_AFTER)

      this.closers.set(newFilename, newCloser)

      const newStreamCancelFinisher = finished(newStream, () => {

        if (typeof newStream.destroy === "function") {

        this.streamCancelFinishers.delete(newFilename)

      this.streamCancelFinishers.set(newFilename, newStreamCancelFinisher)

		# Changelog

		## v2.2.0 2019-06-17

		- Closer's timer is `unref`-ed to prevent holding a NodeJS runtime.

		## v2.1.4 2019-06-04
		@@ -4,0 +8,0 @@

		@@ -138,2 +138,3 @@ "use strict";
		}, FileTimestampStream.CLOSE_UNUSED_FILE_AFTER);
		newCloser.unref();
		this.closer = closer;
		@@ -140,0 +141,0 @@ this.closers.set(newFilename, newCloser);

		{
		"name": "file-timestamp-stream",
		"version": "2.1.4",
		"version": "2.2.0",
		"description": "Writing stream with file rotating based on timestamp",
		@@ -27,3 +27,3 @@ "main": "lib/file-timestamp-stream.js",
		"stream.finished": "^1.2.0",
		"tslib": "^1.9.3",
		"tslib": "^1.10.0",
		"ultra-strftime": "^1.0.2"
		@@ -35,22 +35,22 @@ },
		"@types/mocha": "^5.2.7",
		"@types/node": "^12.0.4",
		"@types/node": "^12.0.8",
		"@types/ultra-strftime": "^1.0.0",
		"chai": "^4.2.0",
		"coveralls": "^3.0.3",
		"coveralls": "^3.0.4",
		"cross-env": "^5.2.0",
		"dirty-chai": "^2.0.1",
		"eslint": "^5.16.0",
		"eslint-config-prettier": "^4.3.0",
		"eslint-config-prettier": "^5.0.0",
		"eslint-plugin-import": "^2.17.3",
		"eslint-plugin-node": "^9.1.0",
		"eslint-plugin-promise": "^4.1.1",
		"markdownlint-cli": "^0.16.0",
		"markdownlint-cli": "^0.17.0",
		"mocha": "^6.1.4",
		"nyc": "^14.1.1",
		"prettier": "^1.17.1",
		"prettier": "^1.18.2",
		"shx": "^0.3.2",
		"ts-node": "^8.2.0",
		"ts-node": "^8.3.0",
		"tslint": "^5.17.0",
		"tslint-config-prettier": "^1.18.0",
		"typescript": "^3.5.1"
		"typescript": "^3.5.2"
		},
		@@ -57,0 +57,0 @@ "scripts": {

		@@ -170,6 +170,6 @@ /// <reference types="node" />
		this.closers.delete(newFilename)

		newStream.end()
		}
		}, FileTimestampStream.CLOSE_UNUSED_FILE_AFTER)
		newCloser.unref()
		this.closer = closer
		@@ -176,0 +176,0 @@ this.closers.set(newFilename, newCloser)

Improved metrics

Dependency changes