feat: expose a mode and version agnostic event receiver #120
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Event receivers in the wild may not always know what version or mode an
incoming event is. Instead of requiring developers to inspect the headers
themselves, the SDK should provide an HTTP receiver that is capable of
figuring out what the version and mode (structured/binary) of an incoming
event is and handle it appropriately.
In determining the best way to expose this, I chose to modify the API a
little bit. Now, instead of `const CloudEvent = require('cloudevents-sdk');`
users need to destructure it.
```js
const { HTTPReceiver, CloudEvent } = require('cloudevents-sdk');
```
This change should not be backported to 1.x.
Fixes: cloudevents#93
Signed-off-by: Lance Ball <lball@redhat.com>
grant
approved these changes
May 5, 2020
danbev
approved these changes
May 5, 2020
danbev
reviewed
May 5, 2020
lance
added a commit
to lance/faas-js-runtime
that referenced
this pull request
May 5, 2020
The cloudevents sdk has some inconsistencies with how it exposed the unmarshalling. Version 0.3 and earlier had an async API, while 1.0 (smartly) changed that. As a result, the impl in this file was pretty ugly. By using the receivers directly, we can avoid that and clean up this code. These changes are based on: cloudevents/sdk-javascript#120 Once those changes land in a released version of the cloudevents sdk this file can be even simpler as the sdk will handle most of this work. As an aside - dropped support for 0.2. Normally I wouldn't be so casual about dropping support, but upstream sdk has no 0.2 support in the next release and cloud events spec says only the two most recent versions are required to be supported.
lance
added a commit
to lance/faas-js-runtime
that referenced
this pull request
May 5, 2020
The cloudevents sdk has some inconsistencies with how it exposed the unmarshalling. Version 0.3 and earlier had an async API, while 1.0 (smartly) changed that. As a result, the impl in this file was pretty ugly. By using the receivers directly, we can avoid that and clean up this code. These changes are based on: cloudevents/sdk-javascript#120 Once those changes land in a released version of the cloudevents sdk this file can be even simpler as the sdk will handle most of this work. As an aside - dropped support for 0.2. Normally I wouldn't be so casual about dropping support, but upstream sdk has no 0.2 support in the next release and cloud events spec says only the two most recent versions are required to be supported.
lance
added a commit
to lance/faas-js-runtime
that referenced
this pull request
May 5, 2020
The cloudevents sdk has some inconsistencies with how it exposed the unmarshalling. Version 0.3 and earlier had an async API, while 1.0 (smartly) changed that. As a result, the impl in this file was pretty ugly. By using the receivers directly, we can avoid that and clean up this code. These changes are based on: cloudevents/sdk-javascript#120 Once those changes land in a released version of the cloudevents sdk this file can be even simpler as the sdk will handle most of this work. As an aside - dropped support for 0.2. Normally I wouldn't be so casual about dropping support, but upstream sdk has no 0.2 support in the next release and cloud events spec says only the two most recent versions are required to be supported.
Signed-off-by: Lance Ball <lball@redhat.com>
|
@danbev thanks for the review - the PR has been updated. |
helio-frota
approved these changes
May 5, 2020
Closed
lance
added a commit
to nodeshift/faas-js-runtime
that referenced
this pull request
May 7, 2020
The cloudevents sdk has some inconsistencies with how it exposed the unmarshalling. Version 0.3 and earlier had an async API, while 1.0 (smartly) changed that. As a result, the impl in this file was pretty ugly. By using the receivers directly, we can avoid that and clean up this code. These changes are based on: cloudevents/sdk-javascript#120 Once those changes land in a released version of the cloudevents sdk this file can be even simpler as the sdk will handle most of this work. As an aside - dropped support for 0.2. Normally I wouldn't be so casual about dropping support, but upstream sdk has no 0.2 support in the next release and cloud events spec says only the two most recent versions are required to be supported.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Event receivers in the wild may not always know what version or mode an
incoming event is. Instead of requiring developers to inspect the headers
themselves, the SDK should provide an HTTP receiver that is capable of
figuring out what the version and mode (structured/binary) of an incoming
event is and handle it appropriately.
In determining the best way to expose this, I chose to modify the API a
little bit. Now, instead of
const CloudEvent = require('cloudevents-sdk');users need to destructure it.
This change should not be backported to 1.x.
Fixes: #93
Signed-off-by: Lance Ball lball@redhat.com