feature: new immediate-style API to replace Promise/events …#130
feature: new immediate-style API to replace Promise/events …#130tkurki merged 5 commits intoSignalK:masterfrom
Conversation
sarfata
force-pushed
the
refactor/immediate-api
branch
from
84bd7e2 to
d73e657
Compare
Loading the list of hooks from the filesystem at runtime was very fancy but it does not work well when the project is webpacked and used in a browser.
lodash was used in only one place in the project, as was lib/types.js. I have inlined them like we do in most other places.
This changes the hook API. Instead of receiving a reference to the parser (which only VDM used for AIS sessions) and the sentence parts as the second argument, the hooks now receive the sentence parts first and the session as the second argument. Because most hooks do not use it, they can just ignore the second argument making them completely stateless.
Some sentences are supported but not listed in the README. Add them.
Replace the mix of promises and events in the old API by a simpler API that returns a SignalK Delta object, null if there was no valid data (invalid gps fix, unsupported sentence or partial AIS message for example) and throws exception when something goes wrong (invalid checksum, invalid data fields, etc). Not using promises makes it easier for callers to use the library and should result in less memory usage and slightly improve performance.
sarfata
force-pushed
the
refactor/immediate-api
branch
from
d73e657 to
4c00fed
Compare
|
|
||
| parse (sentence) { | ||
| if (typeof sentence === 'string' && sentence.trim().length > 0) { | ||
| this.emit('nmea0183', sentence.trim()) |
There was a problem hiding this comment.
This is something we want to keep: emitting the raw sentences. These are available within the server for plugins and for example over tcp.
There was a problem hiding this comment.
Would it be hard to emit the sentences from the same place where you call parser.parse()?
I can re-introduce it but it seems pretty orthogonal to the library itself. There is absolutely no value added besides .trim().
|
I have my SK server glasses on, but there the logical component that knows what is supposedly an NMEA0183 sentence is the parser. We aren't quite doing it though, because every line in the input is emitted as NMEA0183, no matter what. On second thought we can move this functionality to the NMEA0183 provider. Just something to do when we deploy this in the server. These changes bump the major version anyway. |
|
Are we done here? Could you take care of changes in the server next? |
|
@tkurki I am looking into the server now. Can you publish version 2.5.0 of the package to npm? |
|
Master is no longer backwards compatible, publishing it as 2.x would break things. Let’s work out the kinks off git and then publish 3.0. |
2 participants
Collection of changes that lead to:
Biggest change is the last one:
We need to merge SignalK/specification#498 and update the dependency before we are really compatible with webpack.