Skip to content

perf(response): Flush requests early to clients #57991

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.

Sign up for GitHub

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

Draft
nickvergessen wants to merge 1 commit into
base: master
Choose a base branch
from
+27 −0
Draft

perf(response): Flush requests early to clients #57991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions lib/private/AppFramework/App.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,5 +213,10 @@ public static function main(
$io->setOutput($output);
}
}

if ($response->getFlushEarly()) {
ob_flush();
Copy link
Collaborator

@Altahrim Altahrim Feb 10, 2026

Choose a reason for hiding this comment

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

Suggested change
ob_flush();
while (ob_get_level() > 0) {
ob_end_flush();
}

I would go with this snippet to ensure all is flushed

flush();
}
}
}
22 changes: 22 additions & 0 deletions lib/public/AppFramework/Http/Response.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ class Response {

/** @var bool */
private $throttled = false;
private bool $flushEarly = true;
/** @var array */
private $throttleMetadata = [];

Expand Down Expand Up @@ -412,4 +413,25 @@ public function getThrottleMetadata() {
public function isThrottled() {
return $this->throttled;
}

/**
* Request the response should be flushed to the connected client immediately
*
* @since 34.0.0
*/
public function setFlushEarly(bool $flushEarly): void {
$this->flushEarly = $flushEarly;
}
Comment on lines +422 to +424
Copy link
Collaborator

@Altahrim Altahrim Feb 10, 2026

Choose a reason for hiding this comment

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

Since the default is to flush early, maybe this is more explicit:

Suggested change
public function setFlushEarly(bool $flushEarly): void {
$this->flushEarly = $flushEarly;
}
public function dontFlushEarly(): void {
$this->flushEarly = false;
}

Copy link
Member Author

@nickvergessen nickvergessen Feb 10, 2026

Choose a reason for hiding this comment

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

Since the default is to flush early

That's TBD. It could be problematic in some cases, but in theory it could break things unintentionally, or at least be a behaviour change


/**
* Whether the response should be flushed to the connected client immediately
*
* If not, the response will wait for async actions, e.g. HTTP requests from
* IClientService, to be finished before returning.
*
* @since 34.0.0
*/
public function getFlushEarly(): bool {
return $this->flushEarly;
}
}
Loading