Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ReadStream implementation #130

Merged
merged 5 commits into from
May 20, 2024
Merged

ReadStream implementation #130

merged 5 commits into from
May 20, 2024

Conversation

masad-frost
Copy link
Member

@masad-frost masad-frost commented May 19, 2024

Why

Implementation for read stream from #111

and #118

What changed

Reduced the API surface area since the RFC removing "break" stuff, drain is now how you can interrupt iteration. Otherwise, just implementation and tests for ReadStream.

Removed tee from the interface for now.

@masad-frost masad-frost requested a review from a team as a code owner May 19, 2024 03:42
@masad-frost masad-frost requested review from Monkatraz and removed request for a team May 19, 2024 03:42
Copy link
Contributor

@Monkatraz Monkatraz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have questions but the code and tests look great

router/streams.ts Outdated Show resolved Hide resolved
router/streams.ts Show resolved Hide resolved
router/streams.ts Show resolved Hide resolved
router/streams.ts Show resolved Hide resolved
router/streams.ts Outdated Show resolved Hide resolved
@masad-frost masad-frost merged commit cad81fe into protocolv2 May 20, 2024
3 checks passed
@masad-frost masad-frost deleted the fm-stream-impl branch May 20, 2024 23:35
@masad-frost masad-frost mentioned this pull request May 20, 2024
32 tasks
masad-frost added a commit that referenced this pull request May 21, 2024
* ReadStream implementation

* remove tee for now

* Make the stream itself an iterable

* Implement return for iterator

* comment
masad-frost added a commit that referenced this pull request May 21, 2024
* ReadStream implementation

* remove tee for now

* Make the stream itself an iterable

* Implement return for iterator

* comment
masad-frost added a commit that referenced this pull request May 29, 2024
* ReadStream implementation

* remove tee for now

* Make the stream itself an iterable

* Implement return for iterator

* comment
masad-frost added a commit that referenced this pull request May 31, 2024
* ReadStream implementation

* remove tee for now

* Make the stream itself an iterable

* Implement return for iterator

* comment
masad-frost added a commit that referenced this pull request Jun 6, 2024
* ReadStream implementation

* remove tee for now

* Make the stream itself an iterable

* Implement return for iterator

* comment
masad-frost added a commit that referenced this pull request Jun 11, 2024
* ReadStream implementation

* remove tee for now

* Make the stream itself an iterable

* Implement return for iterator

* comment
masad-frost added a commit that referenced this pull request Jun 13, 2024
* ReadStream implementation

* remove tee for now

* Make the stream itself an iterable

* Implement return for iterator

* comment
masad-frost added a commit that referenced this pull request Jun 20, 2024
* ReadStream implementation

* remove tee for now

* Make the stream itself an iterable

* Implement return for iterator

* comment
masad-frost added a commit that referenced this pull request Jun 24, 2024
* ReadStream implementation

* remove tee for now

* Make the stream itself an iterable

* Implement return for iterator

* comment
masad-frost added a commit that referenced this pull request Aug 16, 2024
All the changes are documented in `Protocol.md` but here's a summary:
- Handle invalid client requests by sending a close with an error back
- This was the main motivation for the change. While we could sort-of
implement this error response without the other changes, things are
setup in such a way where it is very hard to implement correctly without
deeper changes in how we handle closing.
- Add more robust closing mechanics
  - Half-close states
  - Close signals from read end of the pipes
  - Abort full-closure (for errors and cancellation)
- Switch from `Pushable` and `AsyncIterator` APIs to a `ReadStream` and
`WriteStream`
- All procedures have `init` and some have `input`

While the changes are not strictly backwards compatible, hence the major
protocol bump, the system can still operate across versions to some
extent.

See PRs linked below for more information on the above

# TODOs
- [x] Define protocol and update doc #111 
- [x] Design stream abstractions #118 
  - [x] Redsigned in #249 
- [x] Implement stream abstractions
  - [x] ReadStream #130
  - [x] WriteStream #132
- [x] All streams have init, some have input.
  - [x] Protocol change documented in #153
  - [x] Implementation change #159  
- [x] Use stream abstractions & implement protocol closing semantics
  - [x] Protocol: Implement close requests from readers #165 
  - [x] Protocol: Implement half-close
    - [x] Client #162 
    - [x] Server #163 
  - [x] Simple s/Pushable/Stream replacement
    - [x] Client #136 
    - [x] Server #137 
- [x] Make `Input` iterator on the server use `Result` so we can signal
stream closes, client disconnects, and aborts #172
- [x] Add Abort mechanism
  - [x] Docs update #175
  - [x] Implement abort
    - [x] Client #193
    - [x] Server #200
  - [x] Add `INVALID_REQUEST` to schema #107
- [x] Handle/send back `INVALID_REQUEST` errors with an abort bit #203
  - [x] Handle/send back `INTERNAL_RIVER_ERROR` with an abort bit #203 
  - [x] Send abort bit with `UNCAUGHT_ERROR` #201 
  - [x] Abort tombstones #204

- [ ] Try to find uncovered areas to test
   - [ ] `undefined` value for `init`, `input`, & `output`. 
- [ ] Update docs
- [ ] Changelog

---------

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants