Feat disable count by shimonewman · Pull Request #10668 · appwrite/appwrite

shimonewman · 2025-10-19T12:50:54Z

Disable list total response given, includeTotal param === false

…ount control

…ling total count in database queries

…eter for total count control in database queries

…ntrol total count in responses

coderabbitai · 2025-10-19T12:51:20Z

📝 Walkthrough

Walkthrough

Adds a boolean query parameter total (exposed internally as includeTotal, default true, Boolean-validated) to many list and log endpoints across API controllers and platform modules. The parameter is declared in route definitions, propagated into action/method signatures, and used to gate total-count computation: when false the response total is set to 0; when true existing count logic is retained. End-to-end tests were extended to assert total === 0 for total=false requests.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Areas needing extra attention:

Widespread public API signature changes across controllers and platform modules — verify routing, dependency injection, and backward compatibility.
Consistency of the new total param name vs internal includeTotal variable across all endpoints.
Constructor/endpoint parameter additions in many XList classes and correct placement of the new bool parameter in action signatures.
Database count gating (ensure no unintended elimination of required counts and consider performance semantics).
Numerous test additions that duplicate assertions — check for flakiness or redundant cases.
New imports of Utopia\Validator\Boolean and any related linter or dependency issues.

Suggested reviewers

eldadfux
abnegate
Meldiron

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 14.58% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.
Title Check	❓ Inconclusive	The pull request title "Feat disable count" refers to a real aspect of the changeset—specifically, the feature to conditionally disable total count calculations in list endpoints. However, the title uses vague shorthand terminology that requires prior knowledge to fully understand. It does not clearly convey what is being disabled (total counts in list endpoints), how it works (via an includeTotal parameter), or the scope of the change (across numerous list endpoints). The phrasing is somewhat generic and lacks the specificity needed for a developer scanning the git history to immediately understand the primary change.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	The pull request description "Disable list total response given, includeTotal param === false" directly describes the core functionality introduced by the changeset. It clearly articulates the objective: when the includeTotal parameter is set to false, the list endpoints should not return or calculate the total count. This is directly related to the extensive changes made across multiple list endpoints (messaging, migrations, projects, storage, teams, users, vcs, databases, functions, etc.) that all follow this same pattern. Although terse, the description conveys meaningful information about the changeset's purpose.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat-disable-count

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2025-10-19T12:53:27Z

Security Scan Results for PR

Docker Image Scan Results

Package	Version	Vulnerability	Severity
binutils	2.44-r2	CVE-2025-5244	HIGH
binutils	2.44-r2	CVE-2025-5245	HIGH
libxml2	2.13.8-r0	CVE-2025-49794	CRITICAL
libxml2	2.13.8-r0	CVE-2025-49796	CRITICAL
libxml2	2.13.8-r0	CVE-2025-49795	HIGH
libxml2	2.13.8-r0	CVE-2025-6021	HIGH
pcre2	10.43-r1	CVE-2025-58050	CRITICAL
golang.org/x/crypto	v0.31.0	CVE-2025-22869	HIGH
golang.org/x/oauth2	v0.24.0	CVE-2025-22868	HIGH
stdlib	1.22.10	CVE-2025-47907	HIGH

Source Code Scan Results

🎉 No vulnerabilities found!

coderabbitai

Actionable comments posted: 47

🧹 Nitpick comments (2)

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 254f026 and d0e0f67.

📒 Files selected for processing (27)

app/controllers/api/account.php (2 hunks)
app/controllers/api/messaging.php (8 hunks)
app/controllers/api/migrations.php (2 hunks)
app/controllers/api/projects.php (6 hunks)
app/controllers/api/storage.php (4 hunks)
app/controllers/api/teams.php (5 hunks)
app/controllers/api/users.php (6 hunks)
app/controllers/api/vcs.php (2 hunks)
src/Appwrite/Platform/Modules/Databases/Http/Databases/Collections/Attributes/XList.php (3 hunks)
src/Appwrite/Platform/Modules/Databases/Http/Databases/Collections/Documents/XList.php (3 hunks)
src/Appwrite/Platform/Modules/Databases/Http/Databases/Collections/Indexes/XList.php (3 hunks)
src/Appwrite/Platform/Modules/Databases/Http/Databases/Collections/XList.php (3 hunks)
src/Appwrite/Platform/Modules/Databases/Http/Databases/XList.php (3 hunks)
src/Appwrite/Platform/Modules/Databases/Http/TablesDB/Tables/Columns/XList.php (2 hunks)
src/Appwrite/Platform/Modules/Databases/Http/TablesDB/Tables/Indexes/XList.php (2 hunks)
src/Appwrite/Platform/Modules/Databases/Http/TablesDB/Tables/Rows/XList.php (2 hunks)
src/Appwrite/Platform/Modules/Databases/Http/TablesDB/Tables/XList.php (2 hunks)
src/Appwrite/Platform/Modules/Databases/Http/TablesDB/XList.php (2 hunks)
src/Appwrite/Platform/Modules/Functions/Http/Deployments/XList.php (4 hunks)
src/Appwrite/Platform/Modules/Functions/Http/Executions/XList.php (4 hunks)
src/Appwrite/Platform/Modules/Functions/Http/Functions/XList.php (4 hunks)
src/Appwrite/Platform/Modules/Projects/Http/Projects/XList.php (3 hunks)
src/Appwrite/Platform/Modules/Proxy/Http/Rules/XList.php (4 hunks)
src/Appwrite/Platform/Modules/Sites/Http/Deployments/XList.php (4 hunks)
src/Appwrite/Platform/Modules/Sites/Http/Logs/XList.php (3 hunks)
src/Appwrite/Platform/Modules/Sites/Http/Sites/XList.php (3 hunks)
src/Appwrite/Platform/Modules/Tokens/Http/Tokens/Buckets/Files/XList.php (3 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-08-11T10:32:38.142Z

Learnt from: abnegate
PR: appwrite/appwrite#10297
File: app/controllers/api/users.php:649-657
Timestamp: 2025-08-11T10:32:38.142Z
Learning: In Appwrite's utopia-php/database (version 0.77.* and later), the database layer internally handles filter separation for count operations. When using `$dbForProject->count()` within a `skipFilters` closure, there's no need to manually separate filter queries using `Query::groupByType($queries)['filters']` as the database handles this automatically.

Applied to files:

app/controllers/api/migrations.php
src/Appwrite/Platform/Modules/Functions/Http/Functions/XList.php
src/Appwrite/Platform/Modules/Projects/Http/Projects/XList.php
app/controllers/api/users.php
app/controllers/api/teams.php
app/controllers/api/storage.php
app/controllers/api/vcs.php

🧬 Code graph analysis (27)

src/Appwrite/Platform/Modules/Databases/Http/TablesDB/Tables/Rows/XList.php (1)

src/Appwrite/Platform/Modules/Tokens/Http/Tokens/Buckets/Files/XList.php (2)

src/Appwrite/Platform/Modules/Functions/Http/Deployments/XList.php (1)

src/Appwrite/Platform/Modules/Sites/Http/Deployments/XList.php (1)

app/controllers/api/migrations.php (1)

src/Appwrite/Platform/Modules/Databases/Http/Databases/Collections/Attributes/XList.php (5)

src/Appwrite/Platform/Modules/Functions/Http/Executions/XList.php (1)

src/Appwrite/Platform/Modules/Databases/Http/Databases/Collections/XList.php (5)

src/Appwrite/Platform/Modules/Sites/Http/Sites/XList.php (2)

src/Appwrite/Platform/Modules/Databases/Http/TablesDB/Tables/Columns/XList.php (1)

src/Appwrite/Platform/Modules/Functions/Http/Functions/XList.php (1)

src/Appwrite/Platform/Modules/Sites/Http/Logs/XList.php (3)

src/Appwrite/Platform/Modules/Databases/Http/TablesDB/XList.php (1)

src/Appwrite/Platform/Modules/Projects/Http/Projects/XList.php (4)

src/Appwrite/Platform/Modules/Databases/Http/Databases/XList.php (5)

src/Appwrite/Platform/Modules/Databases/Http/TablesDB/Tables/XList.php (1)

app/controllers/api/projects.php (1)

src/Appwrite/Platform/Modules/Proxy/Http/Rules/XList.php (1)

app/controllers/api/users.php (1)

app/controllers/api/teams.php (1)

app/controllers/api/storage.php (1)

src/Appwrite/Platform/Modules/Databases/Http/Databases/Collections/Documents/XList.php (4)

src/Appwrite/Platform/Modules/Databases/Http/TablesDB/Tables/Indexes/XList.php (1)

app/controllers/api/messaging.php (1)

app/controllers/api/account.php (2)

app/controllers/api/vcs.php (1)

src/Appwrite/Platform/Modules/Databases/Http/Databases/Collections/Indexes/XList.php (4)

🪛 GitHub Actions: Linter

src/Appwrite/Platform/Modules/Databases/Http/TablesDB/Tables/Rows/XList.php