-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Fix aborted$ event and add completed$ event to KibanaRequest #73898
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
18 changes: 18 additions & 0 deletions
18
...lopment/core/server/kibana-plugin-core-server.kibanarequestevents.completed_.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) > [completed$](./kibana-plugin-core-server.kibanarequestevents.completed_.md) | ||
|
||
## KibanaRequestEvents.completed$ property | ||
|
||
Observable that emits once if and when the request has been completely handled. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
completed$: Observable<void>; | ||
``` | ||
|
||
## Remarks | ||
|
||
The request may be considered completed if: - A response has been sent to the client; or - The request was aborted. | ||
|
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -64,6 +64,16 @@ export interface KibanaRequestEvents { | |
* Observable that emits once if and when the request has been aborted. | ||
*/ | ||
aborted$: Observable<void>; | ||
|
||
/** | ||
* Observable that emits once if and when the request has been completely handled. | ||
* | ||
* @remarks | ||
* The request may be considered completed if: | ||
* - A response has been sent to the client; or | ||
* - The request was aborted. | ||
*/ | ||
completed$: Observable<void>; | ||
} | ||
|
||
/** | ||
|
@@ -186,11 +196,16 @@ export class KibanaRequest< | |
|
||
private getEvents(request: Request): KibanaRequestEvents { | ||
const finish$ = merge( | ||
fromEvent(request.raw.req, 'end'), // all data consumed | ||
fromEvent(request.raw.res, 'finish'), // Response has been sent | ||
fromEvent(request.raw.req, 'close') // connection was closed | ||
).pipe(shareReplay(1), first()); | ||
|
||
const aborted$ = fromEvent<void>(request.raw.req, 'aborted').pipe(first(), takeUntil(finish$)); | ||
const completed$ = merge<void, void>(finish$, aborted$).pipe(shareReplay(1), first()); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's becoming complicated 😓 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Open to any ideas on how to improve, but this seemed the most clear for now. |
||
|
||
return { | ||
aborted$: fromEvent<void>(request.raw.req, 'aborted').pipe(first(), takeUntil(finish$)), | ||
aborted$, | ||
completed$, | ||
} as const; | ||
} | ||
|
||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The initial implementation was based on nodejs/node#21705 discussion and asserted by test #55061 (comment), showing that
Request.end
happens afterResponse.finish
, even though it shouldn't. I mistakenly assumed the fact that this behavior is consistent across all requests.