Serverless emit #4038
Serverless emit #4038
Conversation
|
@brianneisler @eahefnawy @pmuens what are our plans regarding documentation on |
lib/plugins/emit/index.js
Outdated
| this.data = JSON.parse(this.options.data); | ||
| resolve(); | ||
| } catch (exception) { | ||
| reject(new Error("Couldn't parse the provided data to a JSON structure.")); |
There was a problem hiding this comment.
data can't be simply strings? is JSON a requirement of the gateway?
There was a problem hiding this comment.
Data is not always JSON. We will need to support other data formats eventually.
lib/plugins/emit/index.js
Outdated
| this.data = JSON.parse(input); | ||
| resolve(); | ||
| } catch (exception) { | ||
| reject(new Error("Couldn't parse the provided data to a JSON structure.")); |
There was a problem hiding this comment.
same comment. I think in invoke/local we catch and ignore, we don't throw an error.
| } | ||
|
|
||
| emitEvent() { | ||
| userStats.track('service_emitted'); |
There was a problem hiding this comment.
❤️ ❤️ ❤️ ❤️ ❤️ ❤️
I should add that to serverless run too!
lib/plugins/emit/index.js
Outdated
| return eventGateway | ||
| .emit({ | ||
| event: name, | ||
| data: JSON.stringify(data), |
There was a problem hiding this comment.
hmmm so we JSON.parse, then we JSON.stringify? can't we just pass the data as it is?
lib/plugins/emit/index.js
Outdated
| usage: 'input data', | ||
| shortcut: 'd', | ||
| }, | ||
| url: { |
There was a problem hiding this comment.
I think the url is always local host, imo it'd be better DX to just provide the port.
Actually, ideally we'd be providing all of that via serverless.yml, but we decided not to do that yet.
There was a problem hiding this comment.
It's localhost for now, but if you want to emit to a hosted gateway it will be a different url. We use localhost:4000 as default, but this is a feature already optimised to be future-proof. I suggest to keep url
There was a problem hiding this comment.
Agreed, this should remain url. We will need a way of specifying the url of the gateway when it is hosted on the cloud.
|
Just had a call with the team. We will try to parse JSON and if it works we send the content type json. If it doesn't we send the content-type text. To provide good UX we print out the structure and content type. This also can be improved in invoke. |
lib/plugins/emit/index.js
Outdated
| lifecycleEvents: ['emit'], | ||
| options: { | ||
| name: { | ||
| usage: 'Event name', |
There was a problem hiding this comment.
Can we rename this to type please?
|
tried it out with the following command: and I got the following in event gateway logs: Thanks @nikgraf 🙌 merging... ✨ |
What did you implement:
Closes #4023
How did you implement it:
The priority of the parameters as wells as how data is based on invoke, but I polished it a bit more here. To emit the events we use the FDK.
How can we verify it:
Spin up a server accepting an HTTP endpoint, spin up an event gateway, register the function and subscription and run
serverless emitTodos:
Is this ready for review?: YES
Is it a breaking change?: NO