8000 Fix request filters with multi-method routes by abnegate · Pull Request #9743 · appwrite/appwrite · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix request filters with multi-method routes #9743

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
merged 4 commits into from
May 12, 2025
Merged

Fix request filters with multi-method routes #9743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3203ea5
Fix request filters with multi-method routes
abnegate May 12, 2025
d04e43c
Improve matched case
abnegate May 12, 2025
0099eef
Faster short-path for single method routes
abnegate May 12, 2025
800dd8b
Remove redundant filter, action checks which parameter sets are allowed
abnegate May 12, 2025
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
12 changes: 6 additions & 6 deletions composer.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

57 changes: 36 additions & 21 deletions src/Appwrite/Utopia/Request.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Appwrite\Utopia;

use Appwrite\Auth\Auth;
use Appwrite\SDK\Method;
use Appwrite\Utopia\Request\Filter;
use Swoole\Http\Request as SwooleRequest;
use Utopia\Database\Validator\Authorization;
Expand All @@ -29,37 +30,51 @@ public function getParams(): array
{
$parameters = parent::getParams();

if ($this->hasFilters() && self::hasRoute()) {
$methods = self::getRoute()->getLabel('sdk', null);

if (!\is_array($methods)) {
$methods = [$methods];
}
if (!$this->hasFilters() || !self::hasRoute()) {
return $parameters;
}

$params = [];
$methods = self::getRoute()->getLabel('sdk', null);

foreach ($methods as $method) {
/** @var \Appwrite\SDK\Method $method */
if (empty($method)) {
$endpointIdentifier = 'unknown.unknown';
} else {
$endpointIdentifier = $method->getNamespace() . '.' . $method->getMethodName();
}
if (empty($methods)) {
return $parameters;
}

$params += $method->getParameters();
if (!\is_array($methods)) {
$id = $methods->getNamespace() . '.' . $methods->getMethodName();
foreach ($this->getFilters() as $filter) {
$parameters = $filter->parse($parameters, $id);
}
return $parameters;
}

if (!empty($params)) {
$parameters = array_filter($parameters, function ($key) use ($params) {
return array_key_exists($key, $params);
}, \ARRAY_FILTER_USE_KEY);
$matched = null;
foreach ($methods as $method) {
/** @var Method|null $method */
if ($method === null) {
continue;
}

foreach ($this->getFilters() as $filter) {
$parameters = $filter->parse($parameters, $endpointIdentifier);
// Find the method that matches the parameters passed
$methodParamNames = \array_map(fn ($param) => $param->getName(), $method->getParameters());
$invalidParams = \array_diff(\array_keys($parameters), $methodParamNames);

// No params defined, or all params are valid
if (empty($methodParamNames) || empty($invalidParams)) {
$matched = $method;
break;
}
}

$id = $matched !== null
? $matched->getNamespace() . '.' . $matched->getMethodName()
: 'unknown.unknown';

// Apply filters
foreach ($this->getFilters() as $filter) {
$parameters = $filter->parse($parameters, $id);
}

return $parameters;
}

Expand Down
127 changes: 127 additions & 0 deletions tests/unit/Utopia/RequestTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Tests\Unit\Utopia;

use Appwrite\SDK\Method;
use Appwrite\SDK\Parameter;
use Appwrite\Utopia\Request;
use PHPUnit\Framework\TestCase;
use Swoole\Http\Request as SwooleRequest;
Expand Down Expand Up @@ -57,4 +58,130 @@ public function testFilters(): void
$this->assertTrue($output['second']);
$this->assertArrayNotHasKey('deleted', $output);
}

public function testGetParamsWithMultipleMethods(): void
{
$this->setupMultiMethodRoute();

// Pass only "foo", should match Method A
$this->request->setQueryString([
'foo' => 'valueFoo',
]);

$params = $this->request->getParams();

$this->assertArrayHasKey('foo', $params);
$this->assertSame('valueFoo', $params['foo']);
$this->assertArrayNotHasKey('baz', $params);
}

public function testGetParamsWithAllRequired(): void
{
$this->setupMultiMethodRoute();

// Pass "foo" and "bar", should match Method A
$this->request->setQueryString([
'foo' => 'valueFoo',
'bar' => 'valueBar',
]);

$params = $this->request->getParams();
$this->assertArrayHasKey('foo', $params);
$this->assertSame('valueFoo', $params['foo']);
$this->assertArrayHasKey('bar', $params);
$this->assertSame('valueBar', $params['bar']);
$this->assertArrayNotHasKey('baz', $params);
}

public function testGetParamsWithAllOptional(): void
{
$this->setupMultiMethodRoute();

// Pass only "bar", should match Method A
$this->request->setQueryString([
'bar' => 'valueBar',
]);

$params = $this->request->getParams();

$this->assertArrayHasKey('bar', $params);
$this->assertSame('valueBar', $params['bar']);
$this->assertArrayNotHasKey('foo', $params);
$this->assertArrayNotHasKey('baz', $params);
}

public function testGetParamsMatchesMethodB(): void
{
$this->setupMultiMethodRoute();

// Pass only "baz", should match Method B
$this->request->setQueryString([
'baz' => 'valueBaz',
]);

$params = $this->request->getParams();

$this->assertArrayHasKey('baz', $params);
$this->assertSame('valueBaz', $params['baz']);
$this->assertArrayNotHasKey('foo', $params);
}

public function testGetParamsFallbackForMixedAndUnknown(): void
{
$this->setupMultiMethodRoute();

// Mixed and unknown should fallback to raw params
$this->request->setQueryString([
'foo' => 'valueFoo',
'baz' => 'valueBaz',
'extra' => 'unexpected',
]);

$params = $this->request->getParams();

$this->assertArrayHasKey('foo', $params);
$this->assertSame('valueFoo', $params['foo']);
$this->assertArrayHasKey('baz', $params);
$this->assertSame('valueBaz', $params['baz']);
$this->assertArrayHasKey('extra', $params);
$this->assertSame('unexpected', $params['extra']);
}

/**
* Helper to attach a route with multiple SDK methods to the request.
*/
8000 private function setupMultiMethodRoute(): void
{
$route = new Route(Request::METHOD_GET, '/multi');

$methodA = new Method(
namespace: 'namespace',
group: 'group',
name: 'methodA',
description: 'desc',
auth: [],
responses: [],
parameters: [
new Parameter('foo'),
new Parameter('bar', optional: true),
],
);

$methodB = new Method(
namespace: 'namespace',
group: 'group',
name: 'methodB',
description: 'desc',
auth: [],
responses: [],
parameters: [
new Parameter('baz'),
],
);

$route->label('sdk', [$methodA, $methodB]);
$this->request->addFilter(new First());
$this->request->addFilter(new Second());
$this->request->setRoute($route);
}
}
0