2.0.0: Asynchronous loading and null-on-failed-parse #14

fluggo · 2016-04-18T20:26:02Z

I'm using this library for parsing syslog, and I wanted to offer some changes I've made in my fork. This is a rollup of three changes, two of which break backwards compatibility:

Asynchronous loading. Previous versions of load and loadDefault were actually synchronous; the callback was called before the function returned. I've made them asynchronous. This is a breaking change because it rearranges the parameters in one of the callbacks to match nodejs standards.
Null on parse failure. If the entire pattern fails, the previous code returned an empty object, which is difficult to check for. This version responds with null instead.
Uppercase characters allowed in field names.

Please do let me know if I need to make any changes.

The previous version was synchronous no matter what. This version uses fs.readFile to make the call actually asynchronous.

This should be up to the caller, who can decide if they might want to reload the patterns list later, or have multiple collections with different default patterns.

The reversal of parameters to loadDefault could have been handled automatically in code, but the callback needed an error parameter, and that goes first. This is a breaking change.

This uses the async library to load all of the files in parallel.

Null is much easier to test for than an empty object.

This version change comes at the end of a few suggested breaking changes: * Asynchronous loading, which is breaking because it rearranges parameters in the callback * Null on parse fail In addition to one non-breaking change: * Allow uppercase characters in field names

fluggo · 2016-05-06T17:02:10Z

Thanks much!

Beh01der · 2016-05-09T07:57:46Z

No worries. I've just released 2.0.1 to npm

Brian Crowell added 8 commits April 18, 2016 15:18

Asynchronous pattern loading

06e467b

The previous version was synchronous no matter what. This version uses fs.readFile to make the call actually asynchronous.

Remove singleton patterns collection

8918f38

This should be up to the caller, who can decide if they might want to reload the patterns list later, or have multiple collections with different default patterns.

Rearrange function parameters in expectation of async code

c6aa85d

The reversal of parameters to loadDefault could have been handled automatically in code, but the callback needed an error parameter, and that goes first. This is a breaking change.

Asynchronous loadDefault

156d7cf

This uses the async library to load all of the files in parallel.

Verify that parse is asynchronous

c4adaf5

Return null when a parse fails

fb92d2e

Null is much easier to test for than an empty object.

Allow uppercase characters in field names

f92541b

2.0.0

9c47859

This version change comes at the end of a few suggested breaking changes: * Asynchronous loading, which is breaking because it rearranges parameters in the callback * Null on parse fail In addition to one non-breaking change: * Allow uppercase characters in field names

Beh01der merged commit 33a25a9 into Beh01der:master May 6, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2.0.0: Asynchronous loading and null-on-failed-parse #14

2.0.0: Asynchronous loading and null-on-failed-parse #14

fluggo commented Apr 18, 2016

fluggo commented May 6, 2016

Beh01der commented May 9, 2016

2.0.0: Asynchronous loading and null-on-failed-parse #14

2.0.0: Asynchronous loading and null-on-failed-parse #14

Conversation

fluggo commented Apr 18, 2016

fluggo commented May 6, 2016

Beh01der commented May 9, 2016