Return event IDs when sending events #195
Conversation
🦋 Changeset detectedLatest commit: 361d7fc The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Hey @jpwilliams - this looks great! The only question that I have on this one is whether we want the return value to be just the event IDs, or is there a possibility in the future to add more data to the response in which case we may want to return an object? e.g.
const { ids } = await inngest.send([...])I don't currently have any other ideas, but before shipping, I might challenge us to ask the team to think if there are any other ideas in which we might want to pass them through to the client.
| json: () => Promise.resolve({}), | ||
| json: () => | ||
| Promise.resolve({ | ||
| ids: Array.isArray(input) ? input.map((_, i) => `${i}`) : ["0"], |
There was a problem hiding this comment.
Seeing this and the test below, I noticed we may not have a test w/ an array of multiple events, but we do have one w/ an array. Is that something we should cover?
| ids: z.array(z.string()), | ||
| status: z.number().min(200).max(299), | ||
| }) | ||
| .parseAsync(rawBody); |
There was a problem hiding this comment.
If we decide at some point to return more data from the response and the shape of the response changes, would this parsing fail? Or will it only parse the data expected and ignore the rest?
There was a problem hiding this comment.
On second review after reviewing the middleware docs @jpwilliams, I'm kind of leaning towards returning the entire response here instead of just the string. We may return other metadata and just returning a string array limits us in the future instead of just returning an object.
|
Closing for #256. |
## Summary We should return the response data from the Event API, including `ids` when events are sent. This returns an object for future extensibility beyond `ids`. Applies the changes in #195, but in a post-2.0, post-Middleware setup. - [x] Add return data to `inngest.send()` - [ ] Add return data to `steps.sendEvent()` --------- Co-authored-by: Jack Williams <1736957+jpwilliams@users.noreply.github.com>
Summary
When events are sent to Inngest, return the event IDs from the response.