Skip to content

Latest commit

 

History

History
150 lines (117 loc) · 5.19 KB

CHANGELOG.md

File metadata and controls

150 lines (117 loc) · 5.19 KB

Changelog

Relevant new features, bugfixes, etc. for each version will be maintained here.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

No unreleased changes

[3.2.0] - 2019-07-16

Fixed

  • Added error handling for situations where the entire status.json file is not yet written to disk and we try to access it, which would result in a crash due to attempting to parse improperly formatted JSON.

[3.1.0] - 2019-03-13

Added

  • Added broadcasting of the contents of ancillary files (e.g. status.json) as events

Housekeeping

  • Fixed several misspelled words throughout the project

[3.0.1] - 2019-03-10

Fixed

  • Ignore ECONNRESET error from WebSocket to prevent application crashing when it would normally just reconnect

[3.0.0] - 2017-10-20

Added

  • Added heartbeat pings between server and clients
  • Added ability for clients to register names
  • Added ability to force clients to register
  • Added ability to prevent subscriptions
  • Added ability to define custom default subscriptions
  • Added ability to configure error messages
  • Added error messages
  • Added some other directories and files to make things a bit easier to follow and less cluttered

Changed

  • Reformatted config Object for constuctor
  • Updated README.md to reflect latest changes

Fixed

  • Fixed issue with lint script looking at outdated, non-existant path

Deprecated

  • Previous configuration format

[2.5.1] - 2017-10-18

Fixed

  • Fixed port 0 when running outside of test scripts
  • Actually using httpServer with ws correctly

Notes

This came up when testing launching a Journal Server inside of an Electron Application and things were failing without telling the http server to listen and then grabbing the port.

[2.5.0] - 2017-10-18

Added

  • Ability to use 0 for port to get randomly assigned port from OS

[2.4.3] - 2017-10-17

Fixed

  • Removed process declaration from src/index.js

[2.4.2] - 2017-10-17

Changed

  • Suppressed broadcast of Journal Events during initial indexing of Journal at startup

Housekeeping

  • .github diretory for storing GitHub-specific files
  • .github/issue_template.md to help with bug reporting
  • .github/pull_request_template.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md referenced Issue template and reduced Bug Reporting verbiage; added link to Issues page
  • Added .github to .npmignore so it isn't published
  • Added CODE_OF_CONDUCT.md to .npmignore
  • Reworded some of Contributing Guidelines
  • Added basic Journals to examples/mocks for testing

[2.4.1] - 2017-10-16

Added

  • Added .npmignore

Changed

  • Incrementing patch version to republish with .npmignore update

[2.4.0] - 2017-10-16

Added

  • Ability to specify custom polling interval for Journal watcher

Changed

  • Added CHANGELOG.md
  • Updated version in package.json and README.md

[2.3.0] - 2017-10-16

Added

  • Ability to specify custom headers Object to add to broadcasts
  • pre-commit package enforcing npm run lint before committing

Changed

  • Fixed ESLint errors
  • Added CONTRIBUTING.md info
  • Changed server logs to say "broadcast" instead of "emit"

[2.2.0] - 2017-10-16

Added

  • Journal Server version number returned in broadcast headers
  • Service Name for Network Discovery is now configurable

Changed

  • Better README.md documentation formatting
  • Better organization for examples directory

[2.1.0] - 2017-10-15

Added

  • Bonjour/Zeroconf for Network Discover of Journal Server
  • Graceful shutdown of Journal Server

[2.0.1] - 2017-10-15

Changed

  • Updated README.md with more accurate documentation

[2.0.0] - 2017-10-14

Added

  • Allow client to subscribe to specific Journal Events