Skip to content

Fix clients filtering when using doctrine persistence #257

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 1 commit into from
Nov 6, 2025
+44 −29
Merged

Fix clients filtering when using doctrine persistence #257

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
50 changes: 29 additions & 21 deletions src/Manager/Doctrine/ClientManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace League\Bundle\OAuth2ServerBundle\Manager\Doctrine;

use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\QueryBuilder;
use League\Bundle\OAuth2ServerBundle\Event\PreSaveClientEvent;
use League\Bundle\OAuth2ServerBundle\Manager\ClientFilter;
use League\Bundle\OAuth2ServerBundle\Manager\ClientManagerInterface;
Expand Down Expand Up @@ -74,38 +75,45 @@ public function remove(ClientInterface $client): void
public function list(?ClientFilter $clientFilter): array
{
$repository = $this->entityManager->getRepository($this->clientFqcn);
$criteria = self::filterToCriteria($clientFilter);
$qb = $repository->createQueryBuilder('c');
self::setQueryBuilderFilters($qb, $clientFilter);

/** @var list<AbstractClient> */
return $repository->findBy($criteria);
return $qb->getQuery()->getResult();
}

/**
* @return array{grants?: list<Grant>, redirect_uris?: list<RedirectUri>, scopes?: list<Scope>}
*/
private static function filterToCriteria(?ClientFilter $clientFilter): array
private static function setQueryBuilderFilters(QueryBuilder $qb, ?ClientFilter $clientFilter): void
{
if (null === $clientFilter || false === $clientFilter->hasFilters()) {
return [];
return;
}

$criteria = [];
self::setFieldFilter($qb, 'grants', $clientFilter->getGrants());

$grants = $clientFilter->getGrants();
if ($grants) {
$criteria['grants'] = $grants;
}
self::setFieldFilter($qb, 'redirect_uris', $clientFilter->getRedirectUris());

$redirectUris = $clientFilter->getRedirectUris();
if ($redirectUris) {
$criteria['redirect_uris'] = $redirectUris;
}
self::setFieldFilter($qb, 'scopes', $clientFilter->getScopes());
}

$scopes = $clientFilter->getScopes();
if ($scopes) {
$criteria['scopes'] = $scopes;
/**
* @param list<Scope>|list<RedirectUri>|list<Grant> $values
*/
private static function setFieldFilter(QueryBuilder $qb, string $field, array $values): void
{
foreach ($values as $key => $value) {
$qb->andWhere(
$qb->expr()->orX(
$qb->expr()->eq('c.' . $field, ':' . $field . $key),
$qb->expr()->like('c.' . $field, ':space_' . $field . $key),
$qb->expr()->like('c.' . $field, ':' . $field . '_space' . $key),
$qb->expr()->like('c.' . $field, ':space_' . $field . '_space' . $key),
)
)
->setParameter($field . $key, (string) $value)
->setParameter('space_' . $field . $key, '% ' . (string) $value)
->setParameter($field . '_space' . $key, (string) $value . ' %')
->setParameter('space_' . $field . '_space' . $key, '% ' . (string) $value . ' %')
;
}

return $criteria;
}
}
13 changes: 10 additions & 3 deletions tests/Acceptance/ListClientsCommandTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,20 +91,27 @@ public function testListClientColumns(): void

public function testListFiltersClients(): void
{
$clientA = $this->fakeAClient('client', 'client-a', 'client-a-secret');
$clientA = $this->fakeAClient('client', 'client-a', 'client-a-secret')
->setScopes(new Scope('client-a-scope'), new Scope('other-scope-1'));
$this->getClientManager()->save($clientA);

$clientB = $this
->fakeAClient('client', 'client-b', 'client-b-secret')
->setScopes(new Scope('client-b-scope'))
->setScopes(new Scope('client-b-scope'), new Scope('other-scope'))
;
$this->getClientManager()->save($clientB);

$clientC = $this
->fakeAClient('client', 'client-c', 'client-c-secret')
->setScopes(new Scope('client-c-scope'), new Scope('1-other-scope'))
;
$this->getClientManager()->save($clientC);

$command = $this->command();
$commandTester = new CommandTester($command);
$commandTester->execute([
'command' => $command->getName(),
'--scope' => $clientB->getScopes(),
'--scope' => ['other-scope'],
]);
$output = $commandTester->getDisplay();

Expand Down
10 changes: 5 additions & 5 deletions tests/Acceptance/resource/list-filters-clients.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

-------- ------------ ----------------- ---------------- -------------- ------------
name identifier secret scope redirect uri grant type
-------- ------------ ----------------- ---------------- -------------- ------------
client client-b client-b-secret client-b-scope
-------- ------------ ----------------- ---------------- -------------- ------------
-------- ------------ ----------------- ----------------------------- -------------- ------------
name identifier secret scope redirect uri grant type
-------- ------------ ----------------- ----------------------------- -------------- ------------
client client-b client-b-secret client-b-scope, other-scope
-------- ------------ ----------------- ----------------------------- -------------- ------------