Skip to content

Remove auto-dispatching on destruct #172

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

Merged
alganet merged 1 commit into from
Mar 18, 2026
Merged

Remove auto-dispatching on destruct #172

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
6 changes: 0 additions & 6 deletions src/DispatchEngine.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ public function handle(ServerRequestInterface $request): ResponseInterface

public function dispatchContext(DispatchContext $context): DispatchContext
{
$this->router->isAutoDispatched = false;
$this->router->context = $context;
$context->setRoutinePipeline($this->routinePipeline);

Expand All @@ -70,11 +69,6 @@ public function dispatchContext(DispatchContext $context): DispatchContext
return $context;
}

public function run(DispatchContext $context): ResponseInterface|null
{
return $this->dispatchContext($context)->response();
}

/**
* @param array<int, AbstractRoute> $routes
*
Expand Down
21 changes: 0 additions & 21 deletions src/Router.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@
*/
final class Router implements MiddlewareInterface
{
public bool $isAutoDispatched = true;

public DispatchContext|null $context = null;

/** @var array<int, Routines\Routinable> */
Expand Down Expand Up @@ -184,11 +182,6 @@ public function instanceRoute(string $method, string $path, object $instance): R
return $route;
}

public function run(DispatchContext $context): ResponseInterface|null
{
return $this->dispatchEngine()->run($context);
}

public function staticRoute(string $method, string $path, mixed $staticValue): Routes\StaticValue
{
$route = new Routes\StaticValue($method, $path, $staticValue);
Expand Down Expand Up @@ -265,20 +258,6 @@ private function streamFactory(): StreamFactoryInterface
return $this->httpFactories->streams;
}

public function __destruct()
{
if (!$this->isAutoDispatched || !$this->context) {
return;
}

$response = $this->context->response();
if ($response === null) {
return;
}

echo (string) $response->getBody();
}

public function __toString(): string
{
$string = '';
Expand Down
55 changes: 7 additions & 48 deletions tests/RouterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,6 @@ public function GET(): string
public function testMagicConstructorCanRouteToStaticValue(mixed $staticValue, string $reason): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$staticRoute = $router->get('/', $staticValue);
$concreteStaticRoute = $router->staticRoute('GET', '/', $staticValue);

Expand Down Expand Up @@ -228,7 +227,7 @@ public function testMagicConstructorCannotRouteSomeStaticValues(mixed $staticVal
$router = self::newRouter();
$nonStaticRoute = $router->get('/', $staticValue);

$router->run(self::newContextForRouter($router, new ServerRequest('GET', '/')));
$router->dispatchContext(self::newContextForRouter($router, new ServerRequest('GET', '/')))->response();

self::assertNotInstanceOf(
'Respect\\Rest\\Routes\\StaticValue',
Expand Down Expand Up @@ -418,17 +417,6 @@ public function testDeveloperCanSetUpAVirtualHostPathOnConstructor(): void
);
}

/** @covers Respect\Rest\Router::__destruct */
public function testRouterDoesNotAutoDispatchAfterManualDispatch(): void
{
$router = self::newRouter();
$router->get('/', 'Hello Respect');
$router->dispatch(new ServerRequest('GET', '/'));
unset($router);

self::expectOutputString('');
}

/**
* @covers Respect\Rest\Router::dispatch
* @covers Respect\Rest\DispatchEngine::dispatch
Expand Down Expand Up @@ -1537,7 +1525,6 @@ public function testCreateUri(): void
'/users/alganet/test/php',
$ro->createUri('alganet', 'php'),
);
$r->isAutoDispatched = false;
}

public function testForward(): void
Expand Down Expand Up @@ -1573,7 +1560,6 @@ public function test_optional_parameter_in_class_routes(): void
public function test_bad_request_header(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'ok';
})->when(static function () {
Expand All @@ -1587,7 +1573,6 @@ public function test_bad_request_header(): void
public function test_method_not_allowed_header(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'ok';
});
Expand All @@ -1606,7 +1591,6 @@ public function test_method_not_allowed_header(): void
public function test_method_not_allowed_header_with_conneg(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'ok';
})
Expand All @@ -1627,7 +1611,6 @@ public function test_method_not_allowed_header_with_conneg(): void
public function test_transparent_options_allow_methods(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'ok';
});
Expand All @@ -1646,7 +1629,6 @@ public function test_transparent_options_allow_methods(): void
public function test_transparent_global_options_allow_methods(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'ok';
});
Expand All @@ -1665,7 +1647,6 @@ public function test_transparent_global_options_allow_methods(): void
public function test_method_not_acceptable(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'ok';
})
Expand Down Expand Up @@ -1716,7 +1697,6 @@ public function test_accept_matches_media_type_with_parameters(): void
public function test_append_routine_honours_routine_chaining(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/one-time', static function () {
return 'one-time';
})
Expand All @@ -1737,7 +1717,6 @@ public function test_append_routine_honours_routine_chaining(): void
public function test_callback_gets_param_array(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
/** @phpstan-ignore-next-line */
$router->get('/one-time/*', static function ($frag, $param1, $param2) {
return 'one-time-' . $frag . '-' . $param1 . '-' . $param2;
Expand All @@ -1749,7 +1728,6 @@ public function test_callback_gets_param_array(): void
public function test_http_method_head(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function (ResponseInterface $response) {
$response->getBody()->write('ok');

Expand All @@ -1766,14 +1744,15 @@ public function test_http_method_head(): void
public function test_http_method_head_run_returns_response_without_body(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function (ResponseInterface $response) {
$response->getBody()->write('ok');

return $response->withHeader('X-Handled-By', 'GET');
});

$response = $router->run(self::newContextForRouter($router, new ServerRequest('HEAD', '/')));
$response = $router->dispatchContext(
self::newContextForRouter($router, new ServerRequest('HEAD', '/')),
)->response();

self::assertNotNull($response);
self::assertSame('GET', $response->getHeaderLine('X-Handled-By'));
Expand All @@ -1788,7 +1767,6 @@ public function testDispatchEngineImplementsRequestHandlerInterface(): void
public function testDispatchEngineHandleReturnsSameResponseAsDispatch(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'handled';
});
Expand All @@ -1805,7 +1783,6 @@ public function testDispatchEngineHandleReturnsSameResponseAsDispatch(): void
public function testDispatchEngineHandleReturns500ForUncaughtExceptions(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function (): void {
throw new InvalidArgumentException('boom');
});
Expand All @@ -1818,7 +1795,6 @@ public function testDispatchEngineHandleReturns500ForUncaughtExceptions(): void
public function testDispatchEngineHandlePreservesExceptionRoutes(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function (): void {
throw new InvalidArgumentException('boom');
});
Expand All @@ -1840,7 +1816,6 @@ public function testRouterImplementsMiddlewareInterface(): void
public function testRouterProcessHandlesRequestWithoutDelegating(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'processed';
});
Expand All @@ -1865,7 +1840,6 @@ public function handle(ServerRequestInterface $request): ResponseInterface
public function test_http_method_head_with_class_routes_and_routines(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
/** @phpstan-ignore-next-line */
$router->get('/', HeadTestStub::class, ['X-Burger: With Cheese!'])
->when(static function () {
Expand All @@ -1882,7 +1856,6 @@ public function test_http_method_head_with_class_routes_and_routines(): void
public function test_http_method_head_with_instance_routes_uses_get_fallback(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->instanceRoute('ANY', '/users/*', new MyController('ok'));

$response = $router->dispatch(new ServerRequest('HEAD', '/users/alganet'))->response();
Expand All @@ -1896,7 +1869,6 @@ public function test_http_method_head_with_instance_routes_uses_get_fallback():
public function test_http_method_head_with_factory_routes_uses_get_fallback(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->factoryRoute('ANY', '/', HeadFactoryController::class, static function () {
return new HeadFactoryController();
});
Expand All @@ -1911,7 +1883,6 @@ public function test_http_method_head_with_factory_routes_uses_get_fallback(): v
public function test_explicit_head_route_overrides_get_fallback(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function (ResponseInterface $response) {
$response->getBody()->write('get');

Expand Down Expand Up @@ -1948,7 +1919,6 @@ public function test_user_agent_class(): void
public function test_user_agent_content_negotiation(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'unknown';
})->userAgent([
Expand All @@ -1967,7 +1937,6 @@ public function test_user_agent_content_negotiation(): void
public function test_user_agent_content_negotiation_fallback(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'unknown';
})->userAgent([
Expand All @@ -1983,7 +1952,6 @@ public function test_user_agent_content_negotiation_fallback(): void
public function test_user_agent_can_block_before_handler_runs(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$ran = false;
$router->get('/', static function () use (&$ran) {
$ran = true;
Expand All @@ -2005,7 +1973,6 @@ public function test_user_agent_can_block_before_handler_runs(): void
public function test_user_agent_single_routine_can_run_before_and_after_route(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$calls = [];
$router->get('/', static function () use (&$calls) {
$calls[] = 'route';
Expand Down Expand Up @@ -2033,7 +2000,6 @@ public function test_user_agent_single_routine_can_run_before_and_after_route():
public function test_user_agent_with_response_transformer_signature_skips_pre_route_execution(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$calls = [];
$router->get('/', static function () use (&$calls) {
$calls[] = 'route';
Expand Down Expand Up @@ -2062,7 +2028,6 @@ public function test_stream_routine(): void
$serverRequest = (new ServerRequest('GET', '/input'))
->withHeader('Accept-Encoding', 'deflate');
$request = self::newContextForRouter($router, $serverRequest);
$router->isAutoDispatched = false;
$router->get('/input', static function () {
return fopen('php://input', 'r+');
})
Expand All @@ -2076,7 +2041,7 @@ public function test_stream_routine(): void
},
]);

$response = $router->run($request);
$response = $router->dispatchContext($request)->response();
self::assertTrue($done);
self::assertInstanceOf(ResponseInterface::class, $response);
}
Expand Down Expand Up @@ -2226,7 +2191,6 @@ public function test_request_forward(): void
public function test_negotiate_acceptable_complete_headers(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/accept', static function () {
return 'ok';
})
Expand Down Expand Up @@ -2318,7 +2282,6 @@ public function test_negotiate_respects_existing_response_headers(): void
public function test_accept_content_type_header(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'ok';
})
Expand All @@ -2336,7 +2299,6 @@ public function test_accept_content_type_header(): void
public function test_accept_content_language_header(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/', static function () {
return 'ok';
})
Expand Down Expand Up @@ -2415,15 +2377,14 @@ public function test_route_ordering_with_when(): void
public function test_when_should_be_called_only_on_existent_methods(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;

$r1 = $router->any('/meow/*', StubRoutable::class);
$r1->accept(['application/json' => 'json_encode']);

$router->any('/moo/*', RouteKnowsNothing::class);

$serverRequest = (new ServerRequest('get', '/meow/blub'))->withHeader('Accept', 'application/json');
$response = $router->run(self::newContextForRouter($router, $serverRequest));
$response = $router->dispatchContext(self::newContextForRouter($router, $serverRequest))->response();
self::assertNotNull($response);
$out = (string) $response->getBody();

Expand All @@ -2434,14 +2395,13 @@ public function test_request_should_be_available_from_router_after_dispatching()
{
$router = self::newRouter();
$request = self::newContextForRouter($router, new ServerRequest('get', '/foo'));
$router->isAutoDispatched = false;
$phpunit = $this;
$router->get('/foo', static function () use ($router, $request, $phpunit) {
$phpunit->assertSame($request, $router->context);

return spl_object_hash($router->context);
});
$response = $router->run($request);
$response = $router->dispatchContext($request)->response();
self::assertNotNull($response);
$out = (string) $response->getBody();
self::assertEquals($out, spl_object_hash($request));
Expand All @@ -2451,7 +2411,6 @@ public function test_request_should_be_available_from_router_after_dispatching()
public function testToStringReturnsCurrentDispatchResponseBody(): void
{
$router = self::newRouter();
$router->isAutoDispatched = false;
$router->get('/foo', 'bar');

$router->dispatch(new ServerRequest('GET', '/foo'));
Expand Down
1 change: 0 additions & 1 deletion tests/Routines/AuthBasicTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ protected function setUp(): void
{
$factory = new Psr17Factory();
$this->router = new Router(new HttpFactories($factory, $factory));
$this->router->isAutoDispatched = false;
}

public function shunt_wantedParams(): void
Expand Down
Loading