RFC: take 2 on streams #249
Conversation
masad-frost
requested review from
jackyzha0 and
Monkatraz
and removed request for
a team
| @@ -72,8 +73,7 @@ type UploadFn< | |||
| > = ( | |||
| reqInit: ProcInit<Router, ProcName>, | |||
| options?: CallOptions, | |||
| ) => { | |||
| reqWriter: WriteStream<ProcInput<Router, ProcName>>; | |||
| ) => Writable<ProcInput<Router, ProcName>> & { | |||
There was a problem hiding this comment.
rename Router -> Service as a more accurate description
There was a problem hiding this comment.
will fix in another PR when fixing the client.
router/procedures.ts
Outdated
| ): Promise<Result<Static<ResponseData>, Static<ResponseErr>>>; | ||
| } | ||
|
|
||
| export class UploadProcedureHandlerParam< |
There was a problem hiding this comment.
I feel like the name of these classes is non-intuitive despite their verbosity - I feel like they could have plain names, like in this case something like UploadStream or HandlerUploadStream
There was a problem hiding this comment.
How about UploadReadable? I'm trying to avoid using the term stream tbh, it's quite overloaded
|
As much as I hate to merge into protocolv2 and leaving the branch non-functional/broken, I'm gonna go ahead an merge this to keep my PRs small and build on top of these abstractions without dealing with stacked branches too much. |
## Why Follow up on #249 to actually use the new interfaces. Removed extra refactor done in #249 that merges the interfaces as that proved to be a challenging API (un-yak-shave 🙅 🐃) ## What changed - Removed close requests (mostly cherry-picked from #248) - Otherwise a simple swapping out of the interfaces ## Versioning - [ ] Breaking protocol change - [ ] Breaking ts/js API change <!-- Kind reminder to add tests and updated documentation if needed -->
Got some comments on streams being complicated, so this is a take on simplified API.
streamcall would have both read and write capabilities on the same object)