Skip to content

[HttpFoundation][HttpKernel][WebProfilerBundle] Add support for the QUERY HTTP method #61173

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

Open
wants to merge 1 commit into
base: 7.4
Choose a base branch
from
Open

[HttpFoundation][HttpKernel][WebProfilerBundle] Add support for the QUERY HTTP method #61173

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 src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

7.4
---

* Add support for the `QUERY` HTTP method in the profiler

7.3
---

Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/WebProfilerBundle/Resources/views/Profiler/search.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
{% if 'command' == profile_type %}
{% set methods = ['BATCH', 'INTERACTIVE'] %}
{% else %}
{% set methods = ['DELETE', 'GET', 'HEAD', 'PATCH', 'POST', 'PUT'] %}
{% set methods = ['DELETE', 'GET', 'HEAD', 'PATCH', 'POST', 'PUT', 'QUERY'] %}
{% endif %}
{% for m in methods %}
<option {{ m == method ? 'selected="selected"' }}>{{ m }}</option>
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/HttpFoundation/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ CHANGELOG
---

* Deprecate using `Request::sendHeaders()` after headers have already been sent; use a `StreamedResponse` instead
* Add support for the `QUERY` HTTP method

7.3
---
Expand Down
12 changes: 7 additions & 5 deletions src/Symfony/Component/HttpFoundation/Request.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ class Request
public const METHOD_OPTIONS = 'OPTIONS';
public const METHOD_TRACE = 'TRACE';
public const METHOD_CONNECT = 'CONNECT';
public const METHOD_QUERY = 'QUERY';

/**
* @var string[]
Expand Down Expand Up @@ -254,7 +255,7 @@ public static function createFromGlobals(): static
$request = self::createRequestFromFactory($_GET, $_POST, [], $_COOKIE, $_FILES, $_SERVER);

if (str_starts_with($request->headers->get('CONTENT_TYPE', ''), 'application/x-www-form-urlencoded')
&& \in_array(strtoupper($request->server->get('REQUEST_METHOD', 'GET')), ['PUT', 'DELETE', 'PATCH'], true)
&& \in_array(strtoupper($request->server->get('REQUEST_METHOD', 'GET')), ['PUT', 'DELETE', 'PATCH', 'QUERY'], true)
) {
parse_str($request->getContent(), $data);
$request->request = new InputBag($data);
Expand Down Expand Up @@ -350,6 +351,7 @@ public static function create(string $uri, string $method = 'GET', array $parame
case 'POST':
case 'PUT':
case 'DELETE':
case 'QUERY':
if (!isset($server['CONTENT_TYPE'])) {
$server['CONTENT_TYPE'] = 'application/x-www-form-urlencoded';
}
Expand Down Expand Up @@ -1175,7 +1177,7 @@ public function getMethod(): string

$method = strtoupper($method);

if (\in_array($method, ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'PATCH', 'PURGE', 'TRACE'], true)) {
if (\in_array($method, ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'PATCH', 'PURGE', 'TRACE', 'QUERY'], true)) {
return $this->method = $method;
}

Expand Down Expand Up @@ -1351,15 +1353,15 @@ public function isMethod(string $method): bool
*/
public function isMethodSafe(): bool
{
return \in_array($this->getMethod(), ['GET', 'HEAD', 'OPTIONS', 'TRACE'], true);
return \in_array($this->getMethod(), ['GET', 'HEAD', 'OPTIONS', 'TRACE', 'QUERY'], true);
}

/**
* Checks whether or not the method is idempotent.
*/
public function isMethodIdempotent(): bool
{
return \in_array($this->getMethod(), ['HEAD', 'GET', 'PUT', 'DELETE', 'TRACE', 'OPTIONS', 'PURGE'], true);
return \in_array($this->getMethod(), ['HEAD', 'GET', 'PUT', 'DELETE', 'TRACE', 'OPTIONS', 'PURGE', 'QUERY'], true);
}

/**
Expand All @@ -1369,7 +1371,7 @@ public function isMethodIdempotent(): bool
*/
public function isMethodCacheable(): bool
{
return \in_array($this->getMethod(), ['GET', 'HEAD'], true);
return \in_array($this->getMethod(), ['GET', 'HEAD', 'QUERY'], true);
}

/**
Expand Down
3 changes: 3 additions & 0 deletions src/Symfony/Component/HttpFoundation/Tests/RequestTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2330,6 +2330,7 @@ public static function methodIdempotentProvider()
['OPTIONS', true],
['TRACE', true],
['CONNECT', false],
['QUERY', true],
];
}

Expand All @@ -2356,6 +2357,7 @@ public static function methodSafeProvider()
['OPTIONS', true],
['TRACE', true],
['CONNECT', false],
['QUERY', true],
];
}

Expand All @@ -2382,6 +2384,7 @@ public static function methodCacheableProvider()
['OPTIONS', false],
['TRACE', false],
['CONNECT', false],
['QUERY', true],
];
}

Expand Down
5 changes: 5 additions & 0 deletions src/Symfony/Component/HttpKernel/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

7.4
---

* Add support for the `QUERY` HTTP method

7.3
---

Expand Down
10 changes: 9 additions & 1 deletion src/Symfony/Component/HttpKernel/HttpCache/Store.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,15 @@ public function getPath(string $key): string
*/
protected function generateCacheKey(Request $request): string
{
return 'md'.hash('sha256', $request->getUri());
$key = $request->getUri();

if ('QUERY' === $request->getMethod()) {
// add null byte to separate the URI from the body and avoid boundary collisions
// which could lead to cache poisoning
$key .= "\0".$request->getContent();
}

return 'md'.hash('sha256', $key);
}

/**
Expand Down
87 changes: 87 additions & 0 deletions src/Symfony/Component/HttpKernel/Tests/HttpCache/HttpCacheTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2070,6 +2070,93 @@ public function testTraceLevelShort()
$this->assertTrue($this->response->headers->has('X-Symfony-Cache'));
$this->assertEquals('miss', $this->response->headers->get('X-Symfony-Cache'));
}

public function testQueryMethodIsCacheable()
{
$this->setNextResponse(200, ['Cache-Control' => 'public, max-age=10000'], 'Query result', function (Request $request) {
$this->assertSame('QUERY', $request->getMethod());

return '{"query": "users"}' === $request->getContent();
});

$this->kernel->reset();
$this->store = $this->createStore();
$this->cacheConfig['debug'] = true;
$this->cache = new HttpCache($this->kernel, $this->store, null, $this->cacheConfig);

$request1 = Request::create('/', 'QUERY', [], [], [], [], '{"query": "users"}');
$this->response = $this->cache->handle($request1, HttpKernelInterface::MAIN_REQUEST, $this->catch);

$this->assertSame(200, $this->response->getStatusCode());
$this->assertTraceContains('miss');
$this->assertSame('Query result', $this->response->getContent());

$request2 = Request::create('/', 'QUERY', [], [], [], [], '{"query": "users"}');
$this->response = $this->cache->handle($request2, HttpKernelInterface::MAIN_REQUEST, $this->catch);

$this->assertSame(200, $this->response->getStatusCode());
$this->assertTrue($this->response->headers->has('Age'));
$this->assertSame('Query result', $this->response->getContent());
}

public function testQueryMethodDifferentBodiesCreateDifferentCacheEntries()
{
$this->setNextResponses([
[
'status' => 200,
'body' => 'Users result',
'headers' => ['Cache-Control' => 'public, max-age=10000'],
],
[
'status' => 200,
'body' => 'Posts result',
'headers' => ['Cache-Control' => 'public, max-age=10000'],
],
]);

$this->store = $this->createStore();
$this->cacheConfig['debug'] = true;
$this->cache = new HttpCache($this->kernel, $this->store, null, $this->cacheConfig);

$request1 = Request::create('/', 'QUERY', [], [], [], [], '{"query": "users"}');
$this->response = $this->cache->handle($request1, HttpKernelInterface::MAIN_REQUEST, $this->catch);

$this->assertSame('Users result', $this->response->getContent());
$this->assertTraceContains('miss');

$request2 = Request::create('/', 'QUERY', [], [], [], [], '{"query": "posts"}');
$this->response = $this->cache->handle($request2, HttpKernelInterface::MAIN_REQUEST, $this->catch);

$this->assertSame('Posts result', $this->response->getContent());
$this->assertTraceContains('miss');

$request3 = Request::create('/', 'QUERY', [], [], [], [], '{"query": "users"}');
$this->response = $this->cache->handle($request3, HttpKernelInterface::MAIN_REQUEST, $this->catch);

$this->assertSame('Users result', $this->response->getContent());
$this->assertTrue($this->response->headers->has('Age'));
}

public function testQueryMethodWithEmptyBodyIsCacheable()
{
$this->setNextResponse(200, ['Cache-Control' => 'public, max-age=10000'], 'Empty query result');
$this->kernel->reset();
$this->store = $this->createStore();
$this->cacheConfig['debug'] = true;
$this->cache = new HttpCache($this->kernel, $this->store, null, $this->cacheConfig);

$request1 = Request::create('/', 'QUERY', [], [], [], [], '');
$this->response = $this->cache->handle($request1, HttpKernelInterface::MAIN_REQUEST, $this->catch);

$this->assertSame(200, $this->response->getStatusCode());
$this->assertTraceContains('miss');

$request2 = Request::create('/', 'QUERY', [], [], [], [], '');
$this->response = $this->cache->handle($request2, HttpKernelInterface::MAIN_REQUEST, $this->catch);

$this->assertSame(200, $this->response->getStatusCode());
$this->assertTrue($this->response->headers->has('Age'));
}
}

class TestKernel implements HttpKernelInterface
Expand Down
83 changes: 83 additions & 0 deletions src/Symfony/Component/HttpKernel/Tests/HttpCache/StoreTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,4 +378,87 @@ protected function getStorePath($key)

return $m->invoke($this->store, $key);
}

public function testQueryMethodCacheKeyIncludesBody()
{
$response = new Response('test', 200, ['Cache-Control' => 'max-age=420']);

$request1 = Request::create('/', 'QUERY', [], [], [], [], '{"query": "users"}');
$request2 = Request::create('/', 'QUERY', [], [], [], [], '{"query": "posts"}');
$request3 = Request::create('/', 'QUERY', [], [], [], [], '{"query": "users"}');

$key1 = $this->store->write($request1, $response);
$key2 = $this->store->write($request2, $response);
$key3 = $this->store->write($request3, $response);

$this->assertNotSame($key1, $key2);
$this->assertSame($key1, $key3);

$this->assertNotEmpty($this->getStoreMetadata($key1));
$this->assertNotEmpty($this->getStoreMetadata($key2));

$this->assertNotNull($this->store->lookup($request1));
$this->assertNotNull($this->store->lookup($request2));
$this->assertNotNull($this->store->lookup($request3));
}

public function testQueryMethodCacheKeyDiffersFromGet()
{
$response = new Response('test', 200, ['Cache-Control' => 'max-age=420']);

$getRequest = Request::create('/');
$queryRequest = Request::create('/', 'QUERY', [], [], [], [], '{"query": "test"}');

$getKey = $this->store->write($getRequest, $response);
$queryKey = $this->store->write($queryRequest, $response);

$this->assertNotSame($getKey, $queryKey);

$this->assertNotEmpty($this->getStoreMetadata($getKey));
$this->assertNotEmpty($this->getStoreMetadata($queryKey));

$this->assertNotNull($this->store->lookup($getRequest));
$this->assertNotNull($this->store->lookup($queryRequest));
}

public function testOtherMethodsCacheKeyIgnoresBody()
{
$response1 = new Response('test 1', 200, ['Cache-Control' => 'max-age=420']);
$response2 = new Response('test 2', 200, ['Cache-Control' => 'max-age=420']);

$getRequest1 = Request::create('/', 'GET', [], [], [], [], '{"data": "test"}');
$getRequest2 = Request::create('/', 'GET', [], [], [], [], '{"data": "different"}');

$key1 = $this->store->write($getRequest1, $response1);
$key2 = $this->store->write($getRequest2, $response2);

$this->assertSame($key1, $key2);

$lookup1 = $this->store->lookup($getRequest1);
$lookup2 = $this->store->lookup($getRequest2);
$this->assertNotNull($lookup1);
$this->assertNotNull($lookup2);

$this->assertCount(1, $this->getStoreMetadata($key1));
$this->assertSame($lookup1->getContent(), $lookup2->getContent());
}

public function testQueryMethodCacheKeyAvoidsBoundaryCollisions()
{
$response = new Response('test', 200, ['Cache-Control' => 'max-age=420']);

$request1 = Request::create('/api/query', 'QUERY', [], [], [], [], 'test');
$request2 = Request::create('/api/que', 'QUERY', [], [], [], [], 'rytest');

$key1 = $this->store->write($request1, $response);
$key2 = $this->store->write($request2, $response);

$this->assertNotSame($key1, $key2);

$this->assertNotEmpty($this->getStoreMetadata($key1));
$this->assertNotEmpty($this->getStoreMetadata($key2));

$this->assertNotNull($this->store->lookup($request1));
$this->assertNotNull($this->store->lookup($request2));
}
}
2 changes: 1 addition & 1 deletion src/Symfony/Component/HttpKernel/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"symfony/deprecation-contracts": "^2.5|^3",
"symfony/error-handler": "^6.4|^7.0|^8.0",
"symfony/event-dispatcher": "^7.3|^8.0",
"symfony/http-foundation": "^7.3|^8.0",
"symfony/http-foundation": "^7.4|^8.0",
"symfony/polyfill-ctype": "^1.8",
"psr/log": "^1|^2|^3"
},
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy