Skip to content

Add configurable deployment and build size #9863

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.

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 2 commits into from
May 22, 2025

Conversation

vermakhushboo
Copy link
Member

@vermakhushboo vermakhushboo commented May 22, 2025

What does this PR do?

Add configurable deployment and build size

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?

Summary by CodeRabbit

  • New Features

    • Added ability to customize deployment and build size limits for functions and sites based on plan settings.
  • Enhancements

    • Deployment and build size limits now reflect plan-specific values, allowing for more flexible resource management.

@vermakhushboo vermakhushboo requested a review from Meldiron May 22, 2025 12:32
Copy link

coderabbitai bot commented May 22, 2025

Walkthrough

A new plan resource has been introduced and injected into several deployment and build-related classes. This resource allows dynamic overriding of deployment and build size limits based on values in the plan array, replacing previously fixed or environment-based limits. Method signatures and constructor dependencies are updated accordingly. Additionally, a blank line was added after the 'log' resource registration in the server container.

Changes

File(s) Change Summary
app/worker.php Added a blank line after registering the 'log' resource in the Server container; no functional changes.
src/Appwrite/Platform/Modules/Functions/Http/Deployments/Create.php Injected plan into constructor and action method; used plan['deploymentSize'] to override deployment size limit.
src/Appwrite/Platform/Modules/Functions/Workers/Builds.php Injected plan into constructor, action, and buildDeployment; used plan to override deployment and build size limits.
src/Appwrite/Platform/Modules/Sites/Http/Deployments/Create.php Injected plan into constructor and action method; used plan['deploymentSize'] to override deployment file size limit.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant CreateFunctionDeployment
    participant PlanResource

    Client->>Server: Initiate deployment
    Server->>CreateFunctionDeployment: Call action(..., plan)
    CreateFunctionDeployment->>PlanResource: Access plan['deploymentSize']
    alt plan['deploymentSize'] present
        CreateFunctionDeployment->>CreateFunctionDeployment: Override size limit
    else
        CreateFunctionDeployment->>CreateFunctionDeployment: Use default size limit
    end
    CreateFunctionDeployment->>Server: Return deployment result
    Server->>Client: Respond
Loading
sequenceDiagram
    participant Worker
    participant BuildsWorker
    participant PlanResource

    Worker->>BuildsWorker: Call action(..., plan)
    BuildsWorker->>PlanResource: Access plan['deploymentSize'], plan['buildSize']
    alt plan values present
        BuildsWorker->>BuildsWorker: Override size limits
    else
        BuildsWorker->>BuildsWorker: Use default size limits
    end
    BuildsWorker->>Worker: Return build result
Loading

Suggested reviewers

  • Meldiron

Poem

In the warren, plans now grow,
With limits set, the bytes may flow.
If your builds are large or small,
The plan will guide and cover all.
Hopping forward, code in hand—
Dynamic limits, just as planned!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 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 b727b8c and 9321f58.

📒 Files selected for processing (1)
  • app/worker.php (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/worker.php
⏰ Context from checks skipped due to timeout of 90000ms (20)
  • GitHub Check: E2E Service Test (Webhooks)
  • GitHub Check: E2E Service Test (Migrations)
  • GitHub Check: E2E Service Test (Teams)
  • GitHub Check: E2E Service Test (VCS)
  • GitHub Check: E2E Service Test (Storage)
  • GitHub Check: E2E Service Test (Tokens)
  • GitHub Check: E2E Service Test (Proxy)
  • GitHub Check: E2E Service Test (Locale)
  • GitHub Check: E2E Service Test (Projects)
  • GitHub Check: E2E Service Test (FunctionsSchedule)
  • GitHub Check: E2E Service Test (Sites)
  • GitHub Check: E2E Service Test (GraphQL)
  • GitHub Check: E2E Service Test (Avatars)
  • GitHub Check: E2E Service Test (Functions)
  • GitHub Check: E2E Service Test (Databases)
  • GitHub Check: E2E Service Test (Console)
  • GitHub Check: E2E Service Test (Dev Keys)
  • GitHub Check: E2E General Test
  • GitHub Check: Unit Test
  • GitHub Check: scan
✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • @coderabbitai modularize this function.
  • 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 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.

Copy link

github-actions bot commented May 22, 2025

Security Scan Results for PR

Docker Image Scan Results

Package Version Vulnerability Severity
binutils 2.42-r0 CVE-2025-0840 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
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

Source Code Scan Results

🎉 No vulnerabilities found!

Copy link

@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: 1

🧹 Nitpick comments (2)
src/Appwrite/Platform/Modules/Sites/Http/Deployments/Create.php (1)

141-145: Configurable deployment size limit implementation.

The site deployment size limit is now dynamically configurable based on the plan parameter, which allows for more flexible deployment sizes based on different plan tiers.

Consider adding a comment documenting the unit conversion (MB to bytes) to make the code more maintainable for future developers.

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

140-144: Configurable deployment size limit implementation.

The function deployment size limit is now dynamically configurable based on the plan parameter, which allows for more flexible deployment sizes based on different plan tiers.

For consistency across the codebase, consider using the same variable naming convention. In this file it's $functionSizeLimit while in other files it's $sizeLimit or $siteSizeLimit. A more generic name like $deploymentSizeLimit might be more maintainable.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9df0045 and b727b8c.

📒 Files selected for processing (4)
  • app/worker.php (1 hunks)
  • src/Appwrite/Platform/Modules/Functions/Http/Deployments/Create.php (3 hunks)
  • src/Appwrite/Platform/Modules/Functions/Workers/Builds.php (8 hunks)
  • src/Appwrite/Platform/Modules/Sites/Http/Deployments/Create.php (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Setup & Build Appwrite Image
  • GitHub Check: Setup & Build Appwrite Image
  • GitHub Check: scan
🔇 Additional comments (12)
src/Appwrite/Platform/Modules/Sites/Http/Deployments/Create.php (3)

88-88: LGTM: New plan parameter injected.

The plan resource is now injected into the constructor.


107-108: LGTM: Action method signature updated.

The action method signature now includes the injected plan parameter.


147-148: LGTM: FileSize validator uses the configurable limit.

The FileSize validator now uses the dynamically configured size limit.

src/Appwrite/Platform/Modules/Functions/Workers/Builds.php (6)

76-76: LGTM: New plan parameter injected.

The plan resource is now injected into the constructor.


116-117: LGTM: Action method signature updated.

The action method signature now includes the injected plan parameter.


485-487: Configurable deployment size limit implementation.

The function deployment size limit is now dynamically configurable based on the plan parameter.


489-491: Improved error message with human-readable size format.

The error message now displays the size limit in a more user-friendly format (decimal megabytes).


816-818: Configurable build size limit implementation.

The build size limit is now dynamically configurable based on the plan parameter.


820-821: Improved error message with human-readable size format.

The error message now displays the size limit in a more user-friendly format (decimal megabytes).

src/Appwrite/Platform/Modules/Functions/Http/Deployments/Create.php (3)

89-89: LGTM: New plan parameter injected.

The plan resource is now injected into the constructor.


106-107: LGTM: Action method signature updated.

The action method signature now includes the injected plan parameter.


147-147: LGTM: FileSize validator uses the configurable limit.

The FileSize validator now uses the dynamically configured size limit.

Copy link

github-actions bot commented May 22, 2025

✨ Benchmark results

  • Requests per second: 878
  • Requests with 200 status code: 158,150
  • P99 latency: 0.209280879

⚡ Benchmark Comparison

Metric This PR Latest version
RPS 878 1,136
200 158,150 204,571
P99 0.209280879 0.164147361

@Meldiron Meldiron merged commit 4adea70 into main May 22, 2025
38 checks passed
@coderabbitai coderabbitai bot mentioned this pull request May 22, 2025
2 tasks
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.

3 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy