Skip to content
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

Remove parameterised queries #84

Merged
merged 5 commits into from
Feb 25, 2025
Merged

Remove parameterised queries #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
30da3c6
Remove parameterised queries
abnegate Feb 25, 2025
357f589
Fix stan
abnegate Feb 25, 2025
d8d46ed
Merge branch 'main' into feat-pass-queries
abnegate Feb 25, 2025
18a4028
Fix tests
abnegate Feb 25, 2025
c2a1fc8
Merge branch 'feat-pass-queries' of github.com:utopia-php/audit into …
abnegate Feb 25, 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
112 changes: 22 additions & 90 deletions src/Audit/Audit.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,9 +229,6 @@ public function logBatch(array $events): bool
* Get all logs by user ID.
*
* @param string $userId
* @param int|null $limit
* @param int|null $offset
* @param Document|null $orderAfter
* @param array<Query> $queries
* @return array<Document>
*
Expand All @@ -241,27 +238,13 @@ public function logBatch(array $events): bool
*/
public function getLogsByUser(
string $userId,
?int $limit = null,
?int $offset = null,
?Document $orderAfter = null,
array $queries = []
): array
{
): array {
/** @var array<Document> $result */
$result = Authorization::skip(function () use ($queries, $userId, $limit, $offset, $orderAfter) {
$result = Authorization::skip(function () use ($queries, $userId) {
$queries[] = Query::equal('userId', [$userId]);
$queries[] = Query::orderDesc();

if (! \is_null($limit)) {
$queries[] = Query::limit($limit);
}
if (! \is_null($offset)) {
$queries[] = Query::offset($offset);
}
if (! \is_null($orderAfter)) {
$queries[] = Query::cursorAfter($orderAfter);
}

return $this->db->find(
collection: Audit::COLLECTION,
queries: $queries,
Expand All @@ -282,8 +265,7 @@ public function getLogsByUser(
public function countLogsByUser(
string $userId,
array $queries = []
): int
{
): int {
/** @var int $count */
$count = Authorization::skip(function () use ($queries, $userId) {
return $this->db->count(
Expand All @@ -302,9 +284,6 @@ public function countLogsByUser(
* Get all logs by resource.
*
* @param string $resource
* @param int|null $limit
* @param int|null $offset
* @param Document|null $orderAfter
* @param array<Query> $queries
* @return array<Document>
*
Expand All @@ -314,26 +293,12 @@ public function countLogsByUser(
*/
public function getLogsByResource(
string $resource,
?int $limit = 25,
?int $offset = null,
?Document $orderAfter = null,
array $queries = [],
): array
{
): array {
/** @var array<Document> $result */
$result = Authorization::skip(function () use ($queries, $resource, $limit, $offset, $orderAfter) {
$result = Authorization::skip(function () use ($queries, $resource) {
$queries[] = Query::equal('resource', [$resource]);
$queries[] = Query::orderDesc('');

if (! \is_null($limit)) {
$queries[] = Query::limit($limit);
}
if (! \is_null($offset)) {
$queries[] = Query::offset($offset);
}
if (! \is_null($orderAfter)) {
$queries[] = Query::cursorAfter($orderAfter);
}
$queries[] = Query::orderDesc();

return $this->db->find(
collection: Audit::COLLECTION,
Expand All @@ -353,8 +318,10 @@ public function getLogsByResource(
*
* @throws \Utopia\Database\Exception
*/
public function countLogsByResource(string $resource, array $queries = []): int
{
public function countLogsByResource(
string $resource,
array $queries = []
): int {
/** @var int $count */
$count = Authorization::skip(function () use ($resource, $queries) {
return $this->db->count(
Expand All @@ -374,9 +341,6 @@ public function countLogsByResource(string $resource, array $queries = []): int
*
* @param string $userId
* @param array<int,string> $events
* @param int|null $limit
* @param int|null $offset
* @param Document|null $orderAfter
* @param array<Query> $queries
* @return array<Document>
*
Expand All @@ -387,27 +351,13 @@ public function countLogsByResource(string $resource, array $queries = []): int
public function getLogsByUserAndEvents(
string $userId,
array $events,
?int $limit = null,
?int $offset = null,
?Document $orderAfter = null,
array $queries = [],
): array
{
): array {
/** @var array<Document> $result */
$result = Authorization::skip(function () use ($userId, $events, $limit, $offset, $orderAfter, $queries) {
$result = Authorization::skip(function () use ($userId, $events, $queries) {
$queries[] = Query::equal('userId', [$userId]);
$queries[] = Query::equal('event', $events);
$queries[] = Query::orderDesc('');

if (! \is_null($limit)) {
$queries[] = Query::limit($limit);
}
if (! \is_null($offset)) {
$queries[] = Query::offset($offset);
}
if (! \is_null($orderAfter)) {
$queries[] = Query::cursorAfter($orderAfter);
}
$queries[] = Query::orderDesc();

return $this->db->find(
collection: Audit::COLLECTION,
Expand All @@ -432,8 +382,7 @@ public function countLogsByUserAndEvents(
string $userId,
array $events,
array $queries = [],
): int
{
): int {
/** @var int $count */
$count = Authorization::skip(function () use ($userId, $events, $queries) {
return $this->db->count(
Expand All @@ -454,9 +403,6 @@ public function countLogsByUserAndEvents(
*
* @param string $resource
* @param array<int,string> $events
* @param int|null $limit
* @param int|null $offset
* @param Document|null $orderAfter
* @param array<Query> $queries
* @return array<Document>
*
Expand All @@ -467,27 +413,13 @@ public function countLogsByUserAndEvents(
public function getLogsByResourceAndEvents(
string $resource,
array $events,
?int $limit = null,
?int $offset = null,
?Document $orderAfter = null,
array $queries = [],
): array
{
): array {
/** @var array<Document> $result */
$result = Authorization::skip(function () use ($resource, $events, $limit, $offset, $orderAfter, $queries) {
$result = Authorization::skip(function () use ($resource, $events, $queries) {
$queries[] = Query::equal('resource', [$resource]);
$queries[] = Query::equal('event', $events);
$queries[] = Query::orderDesc('');

if (! \is_null($limit)) {
$queries[] = Query::limit($limit);
}
if (! \is_null($offset)) {
$queries[] = Query::offset($offset);
}
if (! \is_null($orderAfter)) {
$queries[] = Query::cursorAfter($orderAfter);
}
$queries[] = Query::orderDesc();

return $this->db->find(
collection: Audit::COLLECTION,
Expand All @@ -501,18 +433,18 @@ public function getLogsByResourceAndEvents(
/**
* Count logs by resource and events.
*
* @param string $resource
* @param array<int,string> $events
* @param string $resource
* @param array<int,string> $events
* @param array<Query> $queries
* @return int
*
* @throws \Exception
* @throws \Utopia\Database\Exception
*/
public function countLogsByResourceAndEvents(
string $resource,
array $events,
array $queries = [],
): int
{
): int {
/** @var int $count */
$count = Authorization::skip(function () use ($resource, $events, $queries) {
return $this->db->count(
Expand Down
18 changes: 9 additions & 9 deletions tests/Audit/AuditTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ public function testGetLogsByUser(): void
$logsCount = $this->audit->countLogsByUser('userId');
$this->assertEquals(3, $logsCount);

$logs1 = $this->audit->getLogsByUser('userId', 1, 1);
$logs1 = $this->audit->getLogsByUser('userId', [Query::limit(1), Query::offset(1)]);
$this->assertEquals(1, \count($logs1));
$this->assertEquals($logs1[0]->getId(), $logs[1]->getId());

$logs2 = $this->audit->getLogsByUser('userId', 1, 0, $logs[0]);
$logs2 = $this->audit->getLogsByUser('userId', [Query::limit(1), Query::offset(1)]);
$this->assertEquals(1, \count($logs2));
$this->assertEquals($logs2[0]->getId(), $logs[1]->getId());
}
Expand All @@ -87,12 +87,12 @@ public function testGetLogsByUserAndEvents(): void
$this->assertEquals(2, $logsCount1);
$this->assertEquals(3, $logsCount2);

$logs3 = $this->audit->getLogsByUserAndEvents('userId', ['update', 'delete'], 1, 1);
$logs3 = $this->audit->getLogsByUserAndEvents('userId', ['update', 'delete'], [Query::limit(1), Query::offset(1)]);

$this->assertEquals(1, \count($logs3));
$this->assertEquals($logs3[0]->getId(), $logs2[1]->getId());

$logs4 = $this->audit->getLogsByUserAndEvents('userId', ['update', 'delete'], 1, 0, $logs2[0]);
$logs4 = $this->audit->getLogsByUserAndEvents('userId', ['update', 'delete'], [Query::limit(1), Query::offset(1)]);

$this->assertEquals(1, \count($logs4));
$this->assertEquals($logs4[0]->getId(), $logs2[1]->getId());
Expand All @@ -112,12 +112,12 @@ public function testGetLogsByResourceAndEvents(): void
$this->assertEquals(1, $logsCount1);
$this->assertEquals(2, $logsCount2);

$logs3 = $this->audit->getLogsByResourceAndEvents('database/document/2', ['update', 'delete'], 1, 1);
$logs3 = $this->audit->getLogsByResourceAndEvents('database/document/2', ['update', 'delete'], [Query::limit(1), Query::offset(1)]);

$this->assertEquals(1, \count($logs3));
$this->assertEquals($logs3[0]->getId(), $logs2[1]->getId());

$logs4 = $this->audit->getLogsByResourceAndEvents('database/document/2', ['update', 'delete'], 1, 0, $logs2[0]);
$logs4 = $this->audit->getLogsByResourceAndEvents('database/document/2', ['update', 'delete'], [Query::limit(1), Query::offset(1)]);

$this->assertEquals(1, \count($logs4));
$this->assertEquals($logs4[0]->getId(), $logs2[1]->getId());
Expand All @@ -137,11 +137,11 @@ public function testGetLogsByResource(): void
$this->assertEquals(1, $logsCount1);
$this->assertEquals(2, $logsCount2);

$logs3 = $this->audit->getLogsByResource('database/document/2', 1, 1);
$logs3 = $this->audit->getLogsByResource('database/document/2', [Query::limit(1), Query::offset(1)]);
$this->assertEquals(1, \count($logs3));
$this->assertEquals($logs3[0]->getId(), $logs2[1]->getId());

$logs4 = $this->audit->getLogsByResource('database/document/2', 1, 0, $logs2[0]);
$logs4 = $this->audit->getLogsByResource('database/document/2', [Query::limit(1), Query::offset(1)]);
$this->assertEquals(1, \count($logs4));
$this->assertEquals($logs4[0]->getId(), $logs2[1]->getId());
}
Expand Down Expand Up @@ -224,7 +224,7 @@ public function testLogByBatch(): void
public function testGetLogsCustomFilters(): void
{
$logs = $this->audit->getLogsByUser('userId', queries: [
Query::greaterThan('time', DateTime::addSeconds(new \DateTime(), -10))->toString()
Query::greaterThan('time', DateTime::addSeconds(new \DateTime(), -10))
]);

$this->assertEquals(3, \count($logs));
Expand Down