Refactor audits, certificates, and screenshots queues to publishers by ChiragAgg5k · Pull Request #11851 · appwrite/appwrite

ChiragAgg5k · 2026-04-10T10:52:56Z

What does this PR do?

Migrates the next queue resource slice from mutable queueForX resources to typed publisherForX resources for audits, certificates, and screenshots.

This adds strongly typed DTOs and publishers for each queue, replaces audit request-state mutation with a dedicated auditContext, updates the affected producers and workers to publish typed messages, and switches the related health endpoints to read queue size through the new publishers.

Test Plan

composer format on all touched PHP files
composer lint on all touched PHP files
php -l on all touched PHP files
git diff --check
rg -n "queueFor(Audits|Certificates|Screenshots)" app src

Related PRs and Issues

Follow-up to Migrate executions, migrations, and stats resources to publishers #11850

Checklist

Have you read the Contributing Guidelines on issues?
If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

greptile-apps · 2026-04-10T10:59:49Z

Greptile Summary

This PR continues the publisher-pattern migration by replacing queueForAudits, queueForCertificates, and queueForScreenshots with typed DTOs and dedicated publisher classes, and introduces AuditContext as a request-scoped mutable state object that decouples audit data collection from queue dispatch. The refactoring is consistent and complete — all producers, workers, health endpoints, and task runners are updated, and rg -n "queueFor(Audits|Certificates|Screenshots)" returns no results.

Confidence Score: 5/5

Safe to merge — the migration is complete, all queue references are updated, and no P0/P1 issues were found.

All legacy queueForAudits, queueForCertificates, and queueForScreenshots references have been removed. The shutdown-hook audit logic is preserved with a more defensive null-check. Worker field access is correctly rewritten to typed DTOs. The only finding is P2 (an unused isEmpty() method on AuditContext).

No files require special attention.

Important Files Changed

Filename	Overview
src/Appwrite/Event/Context/Audit.php	New request-scoped DTO replacing mutable Audit event object; clean design with nullable fields and an `isEmpty()` helper that is currently unused
src/Appwrite/Event/Message/Audit.php	New typed message DTO; `fromContext` factory covers all fields from the old `Audit::preparePayload()`, `fromArray` round-trips cleanly
src/Appwrite/Event/Message/Certificate.php	New typed Certificate message DTO; faithfully mirrors old `Certificate::preparePayload()` and `fromArray` round-trips correctly
src/Appwrite/Event/Message/Screenshot.php	New typed Screenshot message DTO; drops the unused `platform` field from the old queue object, keeping only `project` and `deploymentId`
src/Appwrite/Event/Publisher/Audit.php	New typed Audit publisher with best-effort delivery (catches Throwable and logs, doesn't fail the request lifecycle); consistent with the audit queue's non-critical semantics
app/controllers/shared/api.php	Replaces `queueForAudits` DI resource with `auditContext` + `publisherForAudits`; shutdown hook logic preserved including the null-guard on `auditContext->user` (now more defensive than the old `getUser()->isEmpty()` call)
src/Appwrite/Platform/Workers/Audits.php	Drops DI-injected `project` in favour of `$auditMessage->project` from message payload; all fields the worker needs (`$id`, `$sequence`, `database`) are present in the serialized project
src/Appwrite/Platform/Workers/Certificates.php	Clean migration to typed message DTO; `$certificateMessage->project` is embedded but not consumed (same as old behaviour), all other fields correctly propagated
app/init/resources.php	Registers `publisherForAudits`, `publisherForCertificates`, and `publisherForScreenshots`; `publisherForCertificates` is also registered in `cli.php` (a duplicate already flagged in a prior thread)
app/init/resources/request.php	Removes `queueForAudits`, `queueForCertificates`, `queueForScreenshots`; registers `auditContext` following the same factory pattern as `usage` (safe for Swoole coroutine isolation)
src/Appwrite/Platform/Modules/Functions/Workers/Builds.php	Injects `publisherForScreenshots` and enqueues a typed `Screenshot` message after successful site build; correct
src/Appwrite/Platform/Tasks/Maintenance.php	Migrates `renewCertificates` to typed publisher; now explicitly builds sparse project Document from rule attributes where old code left project as null
src/Appwrite/Platform/Modules/Health/Http/Health/Queue/Failed/Get.php	Replaces three legacy Event subclasses with typed publishers in the queue-size match statement; duck-typed `getSize(failed: true)` call still works since all objects expose the method

_{Reviews (11): Last reviewed commit: "Merge branch '1.9.x' into chore-migrate-..." | Re-trigger Greptile}

github-actions · 2026-04-10T11:22:24Z

🔄 PHP-Retry Summary

Flaky tests detected across commits:

Commit a31cb67 - 5 flaky tests

Test	Retries	Total Time	Details
`UsageTest::testFunctionsStats`	1	10.23s	Logs
`UsageTest::testPrepareSitesStats`	1	6ms	Logs
`UsageTest::testEmbeddingsTextUsageDoesNotBreakProjectUsage`	1	5ms	Logs
`LegacyCustomClientTest::testAttributeResponseModels`	1	241.77s	Logs
`LegacyCustomServerTest::testAttributeResponseModels`	1	242.43s	Logs

Commit 86cfea0 - 5 flaky tests

Test	Retries	Total Time	Details
`UsageTest::testFunctionsStats`	1	10.22s	Logs
`UsageTest::testPrepareSitesStats`	1	7ms	Logs
`UsageTest::testEmbeddingsTextUsageDoesNotBreakProjectUsage`	1	5ms	Logs
`TablesDBTransactionsCustomClientTest::testUpsertAutoIdThenUpdate`	1	240.56s	Logs
`TablesDBTransactionsCustomServerTest::testBulkDeleteOperations`	1	240.55s	Logs

Commit 5d53685 - 5 flaky tests

Test	Retries	Total Time	Details
`UsageTest::testFunctionsStats`	1	10.23s	Logs
`UsageTest::testPrepareSitesStats`	1	7ms	Logs
`UsageTest::testEmbeddingsTextUsageDoesNotBreakProjectUsage`	1	5ms	Logs
`TablesDBConsoleClientTest::testTimeout`	1	240.41s	Logs
`TablesDBCustomClientTest::testEnforceCollectionPermissions`	1	240.46s	Logs

Commit b2884dd - 7 flaky tests

Test	Retries	Total Time	Details
`UsageTest::testFunctionsStats`	1	10.24s	Logs
`UsageTest::testPrepareSitesStats`	1	7ms	Logs
`UsageTest::testEmbeddingsTextUsageDoesNotBreakProjectUsage`	1	5ms	Logs
`LegacyConsoleClientTest::testListDocumentsWithCache`	1	1.09s	Logs
`LegacyConsoleClientTest::testListDocumentsCachePurgedByUpdate`	1	1.63s	Logs
`LegacyCustomClientTest::testAttributeResponseModels`	1	241.07s	Logs
`LegacyTransactionsCustomServerTest::testOperationsOnNonExistentDocuments`	1	240.18s	Logs

Commit 29be9b6 - 5 flaky tests

Test	Retries	Total Time	Details
`UsageTest::testFunctionsStats`	1	10.26s	Logs
`UsageTest::testPrepareSitesStats`	1	9ms	Logs
`UsageTest::testEmbeddingsTextUsageDoesNotBreakProjectUsage`	1	8ms	Logs
`TablesDBCustomClientTest::testEnforceCollectionAndDocumentPermissions`	1	86ms	Logs
`TablesDBCustomClientTest::testNotContains`	1	240.54s	Logs

Note: Flaky test results are tracked for the last 5 commits

github-actions · 2026-04-10T11:27:27Z

✨ Benchmark results

Requests per second: 1,799
Requests with 200 status code: 323,828
P99 latency: 0.098562372

⚡ Benchmark Comparison

Metric	This PR	Latest version
RPS	1,799	1,382
200	323,828	248,728
P99	0.098562372	0.1468687

…ts-to-publishers

greptile-apps Bot reviewed Apr 10, 2026

View reviewed changes

Comment thread src/Appwrite/Event/Message/Screenshot.php

Comment thread app/cli.php

ChiragAgg5k added 2 commits April 10, 2026 16:44

refactor: migrate audits certificates screenshots to publishers

dc0a5c8

chore: address review feedback

0de26be

ChiragAgg5k force-pushed the chore-migrate-audits-certificates-screenshots-to-publishers branch from b4eb8cb to 0de26be Compare April 10, 2026 11:15

This comment has been minimized.

Sign in to view

ChiragAgg5k added 5 commits April 11, 2026 08:49

Merge branch '1.9.x' into chore-migrate-audits-certificates-screensho…

9ae804f

…ts-to-publishers

chore: remove unrelated queue resources

ec5472f

fix: register certificate publisher in cli

5ecd15a

Merge branch '1.9.x' into chore-migrate-audits-certificates-screensho…

a31cb67

…ts-to-publishers

refactor: simplify audit event context

d40a355

This comment has been minimized.

Sign in to view

ChiragAgg5k added 6 commits April 13, 2026 18:32

fix: update audit context usage

a1342b4

Merge branch '1.9.x' into chore-migrate-audits-certificates-screensho…

86cfea0

…ts-to-publishers

Merge branch '1.9.x' into chore-migrate-audits-certificates-screensho…

5d53685

…ts-to-publishers

Simplify audit message construction

82798fa

Use audit message context helper

b2884dd

Merge branch '1.9.x' into chore-migrate-audits-certificates-screensho…

29be9b6

…ts-to-publishers

loks0n approved these changes Apr 15, 2026

View reviewed changes

ChiragAgg5k merged commit 49c93c6 into 1.9.x Apr 15, 2026
80 of 81 checks passed

ChiragAgg5k deleted the chore-migrate-audits-certificates-screenshots-to-publishers branch April 15, 2026 09:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor audits, certificates, and screenshots queues to publishers#11851

Refactor audits, certificates, and screenshots queues to publishers#11851
ChiragAgg5k merged 13 commits into1.9.xfrom
chore-migrate-audits-certificates-screenshots-to-publishers

ChiragAgg5k commented Apr 10, 2026

Uh oh!

greptile-apps Bot commented Apr 10, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 10, 2026 •

edited

Loading

Uh oh!

This comment has been minimized.

github-actions Bot commented Apr 10, 2026 •

edited

Loading

Uh oh!

This comment has been minimized.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

ChiragAgg5k commented Apr 10, 2026

What does this PR do?

Test Plan

Related PRs and Issues

Checklist

Uh oh!

greptile-apps Bot commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔄 PHP-Retry Summary

Uh oh!

This comment has been minimized.

github-actions Bot commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✨ Benchmark results

⚡ Benchmark Comparison

Uh oh!

This comment has been minimized.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

greptile-apps Bot commented Apr 10, 2026 •

edited

Loading

github-actions Bot commented Apr 10, 2026 •

edited

Loading

github-actions Bot commented Apr 10, 2026 •

edited

Loading