Skip to content

Feat: Make functions worker customizable#10287

Merged
Meldiron merged 2 commits into1.7.xfrom
feat-customizable-function-broker
Aug 8, 2025
Merged

Feat: Make functions worker customizable#10287
Meldiron merged 2 commits into1.7.xfrom
feat-customizable-function-broker

Conversation

@Meldiron
Copy link
Copy Markdown
Contributor

@Meldiron Meldiron commented Aug 8, 2025

What does this PR do?

(Provide a description of what this PR does and why it's needed.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Screenshots may also be helpful.)

Related PRs and Issues

  • (Related PR or issue)

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?

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Aug 8, 2025

📝 Walkthrough

Walkthrough

This change introduces new resources named publisherFunctions and consumerFunctions across multiple application entry points and resource registries (app/cli.php, app/init/resources.php, and app/worker.php). These resources return the respective BrokerPool instances for publisher and consumer roles, specifically for handling function-related queues. The injection identifier for the publisher in the /v1/health/queue/functions API endpoint is updated to use publisherFunctions. The ScheduleBase class is modified to inject and store a publisherFunctions property, and the instantiation of the Func event publisher in scheduled task classes (ScheduleExecutions and ScheduleFunctions) is updated to use this new property.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Possibly related PRs

  • feat: stats-usage on redis #10156: Adds new publisher and consumer resources and updates related injection points, similar to this PR's pattern of extending BrokerPool resource management for different queue categories.

Suggested reviewers

  • lohanidamodar
  • abnegate

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b3a852 and 9a6c4c5.

📒 Files selected for processing (1)
  • app/controllers/api/health.php (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/controllers/api/health.php
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)
  • GitHub Check: E2E Service Test (Sites)
  • GitHub Check: E2E Service Test (Users)
  • GitHub Check: E2E Service Test (Storage)
  • GitHub Check: E2E Service Test (Locale)
  • GitHub Check: E2E Service Test (Messaging)
  • GitHub Check: E2E Service Test (Tokens)
  • GitHub Check: E2E Service Test (VCS)
  • GitHub Check: E2E Service Test (Realtime)
  • GitHub Check: E2E Service Test (Proxy)
  • GitHub Check: E2E Service Test (Teams)
  • GitHub Check: E2E Service Test (Functions)
  • GitHub Check: E2E Service Test (Projects)
  • GitHub Check: E2E Service Test (FunctionsSchedule)
  • GitHub Check: E2E Service Test (Databases)
  • GitHub Check: E2E Service Test (Console)
  • GitHub Check: E2E Service Test (Account)
  • GitHub Check: E2E Service Test (Site Screenshots)
  • GitHub Check: E2E General Test
  • GitHub Check: E2E Service Test (Dev Keys)
  • GitHub Check: Unit Test
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat-customizable-function-broker

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 8, 2025

Security Scan Results for PR

Docker Image Scan Results

Package Version Vulnerability Severity
binutils 2.42-r0 CVE-2025-0840 HIGH
git 2.45.3-r0 CVE-2025-48384 HIGH
git 2.45.3-r0 CVE-2025-48385 HIGH
git-init-template 2.45.3-r0 CVE-2025-48384 HIGH
git-init-template 2.45.3-r0 CVE-2025-48385 HIGH
icu 74.2-r0 CVE-2025-5222 HIGH
icu-data-en 74.2-r0 CVE-2025-5222 HIGH
icu-dev 74.2-r0 CVE-2025-5222 HIGH
icu-libs 74.2-r0 CVE-2025-5222 HIGH
libexpat 2.6.4-r0 CVE-2024-8176 HIGH
libxml2 2.12.7-r0 CVE-2024-56171 HIGH
libxml2 2.12.7-r0 CVE-2025-24928 HIGH
libxml2 2.12.7-r0 CVE-2025-27113 HIGH
libxml2 2.12.7-r0 CVE-2025-32414 HIGH
libxml2 2.12.7-r0 CVE-2025-32415 HIGH
pyc 3.12.9-r0 CVE-2024-12718 HIGH
pyc 3.12.9-r0 CVE-2025-4138 HIGH
pyc 3.12.9-r0 CVE-2025-4330 HIGH
pyc 3.12.9-r0 CVE-2025-4517 HIGH
python3 3.12.9-r0 CVE-2024-12718 HIGH
python3 3.12.9-r0 CVE-2025-4138 HIGH
python3 3.12.9-r0 CVE-2025-4330 HIGH
python3 3.12.9-r0 CVE-2025-4517 HIGH
python3-pyc 3.12.9-r0 CVE-2024-12718 HIGH
python3-pyc 3.12.9-r0 CVE-2025-4138 HIGH
python3-pyc 3.12.9-r0 CVE-2025-4330 HIGH
python3-pyc 3.12.9-r0 CVE-2025-4517 HIGH
python3-pycache-pyc0 3.12.9-r0 CVE-2024-12718 HIGH
python3-pycache-pyc0 3.12.9-r0 CVE-2025-4138 HIGH
python3-pycache-pyc0 3.12.9-r0 CVE-2025-4330 HIGH
python3-pycache-pyc0 3.12.9-r0 CVE-2025-4517 HIGH
sqlite-libs 3.45.3-r1 CVE-2025-29087 HIGH
xz 5.6.2-r0 CVE-2025-31115 HIGH
xz-libs 5.6.2-r0 CVE-2025-31115 HIGH
golang.org/x/crypto v0.31.0 CVE-2025-22869 HIGH
golang.org/x/oauth2 v0.24.0 CVE-2025-22868 HIGH

Source Code Scan Results

🎉 No vulnerabilities found!

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🔭 Outside diff range comments (1)
app/init/resources.php (1)

106-109: Injection list mismatch (pre-existing bug)

consumerStatsUsage returns $consumer but declares ['publisher'] as its only dependency.
Switch to ['consumer'] to avoid accidental container mis-resolves.

🧹 Nitpick comments (4)
app/init/resources.php (1)

86-88: Consider wiring queueForFunctions to this new pool too

publisherFunctions is registered but queueForFunctions (Line 140) still injects the generic publisher.
For clarity and future config isolation, wire queueForFunctions to publisherFunctions instead.

app/cli.php (1)

197-199: Resource added, but queues still use generic publisher

Nice addition. Consider also switching the queueForFunctions resource (Line 212-214) to inject publisherFunctions for consistency with the scheduler changes.

app/worker.php (1)

254-256: Publisher alias added – check downstream wiring

Same note: downstream queueForFunctions still pulls the generic publisher (Line 322-325). Aligning it with publisherFunctions will complete the separation.

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

689-695: Optional: unify naming to 'publisherFunctions' for consistency

Other places (e.g., platform tasks) use publisherFunctions. Consider renaming this injection to reduce cognitive load.

Apply locally if the DI container uses publisherFunctions:

-    ->inject('publisherForFunctions')
+    ->inject('publisherFunctions')
@@
-    ->action(function (int|string $threshold, Publisher $publisherForFunctions, Response $response) {
+    ->action(function (int|string $threshold, Publisher $publisherFunctions, Response $response) {
@@
-        $size = $publisherForFunctions->getQueueSize(new Queue(Event::FUNCTIONS_QUEUE_NAME));
+        $size = $publisherFunctions->getQueueSize(new Queue(Event::FUNCTIONS_QUEUE_NAME));

If publisherForFunctions is the intended canonical name, consider adding an alias for publisherFunctions in resources to match usage elsewhere.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f430622 and 2b3a852.

📒 Files selected for processing (7)
  • app/cli.php (1 hunks)
  • app/controllers/api/health.php (1 hunks)
  • app/init/resources.php (2 hunks)
  • app/worker.php (2 hunks)
  • src/Appwrite/Platform/Tasks/ScheduleBase.php (3 hunks)
  • src/Appwrite/Platform/Tasks/ScheduleExecutions.php (1 hunks)
  • src/Appwrite/Platform/Tasks/ScheduleFunctions.php (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
src/Appwrite/Platform/Tasks/ScheduleFunctions.php (1)
src/Appwrite/Utopia/Response/Model/Func.php (1)
  • Func (8-207)
src/Appwrite/Platform/Tasks/ScheduleExecutions.php (1)
src/Appwrite/Utopia/Response/Model/Func.php (1)
  • Func (8-207)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Setup & Build Appwrite Image
  • GitHub Check: Setup & Build Appwrite Image
  • GitHub Check: scan
🔇 Additional comments (7)
app/init/resources.php (1)

101-103: Symmetry looks good

👍 consumerFunctions mirrors the existing pattern and lists the correct dependency.

src/Appwrite/Platform/Tasks/ScheduleFunctions.php (1)

93-94: Verify $this->publisherFunctions is initialised

The new Func($this->publisherFunctions) assumes ScheduleBase now stores that property.
If any subclass calls this before ScheduleBase::action() injects it, a fatal error will occur. Please double-check initialisation.

src/Appwrite/Platform/Tasks/ScheduleExecutions.php (1)

33-34: Same initialisation concern

Ensure $this->publisherFunctions is always populated; otherwise coroutine startup will crash.

app/worker.php (1)

274-276: Consumer alias looks correct

consumerFunctions mirrors existing pattern. No issues spotted.

src/Appwrite/Platform/Tasks/ScheduleBase.php (3)

29-29: Property added for function-specific publisher looks good

Typed BrokerPool property is consistent with existing $publisher and $publisherMigrations. No issues spotted.


45-50: Dependency ‘publisherFunctions’ correctly registered in DI
The publisherFunctions resource is explicitly registered via App::setResource('publisherFunctions', …) in app/init/resources.php (and mirrored in app/cli.php and app/worker.php), so the ->inject('publisherFunctions') in ScheduleBase.php will resolve without issue.


72-80: Action signature update is safe – no subclass overrides
The added BrokerPool $publisherFunctions parameter and its assignment match the DI order and won’t break existing code: none of the three ScheduleBase subclasses override action(). No further changes are needed.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 8, 2025

✨ Benchmark results

  • Requests per second: 1,000
  • Requests with 200 status code: 180,053
  • P99 latency: 0.183055715

⚡ Benchmark Comparison

Metric This PR Latest version
RPS 1,000 991
200 180,053 178,388
P99 0.183055715 0.197558054

@Meldiron Meldiron merged commit 3510b9d into 1.7.x Aug 8, 2025
40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants