Feat: Customizable SMS mock

[Meldiron]

What does this PR do?

adds methods to customize sms mock endpoint, to allow to point to different containers, for example splitting sms mock and webhooks mock

Test Plan

PR in Appwrite

Related PRs and Issues

appwrite/appwrite#10066

Have you read the Contributing Guidelines on issues?

Yes

Summary by CodeRabbit

• New Features
  • Added the ability to view and update the endpoint URL used for sending mock SMS messages, allowing for more flexible configuration.

[coderabbitai]

Walkthrough

The Mock class in the SMS adapter now features a configurable endpoint URL via a new protected property. Two public methods, getEndpoint() and setEndpoint(), allow retrieval and modification of this endpoint. The process method now uses this property instead of a hardcoded URL for sending mock SMS requests.

Changes

File	Change Summary
src/Utopia/Messaging/Adapter/SMS/Mock.php	Added $url property, getEndpoint(), and setEndpoint() methods; updated process() to use $url value.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant MockSMS
    participant RequestHandler

    Caller->>MockSMS: setEndpoint(newUrl)
    Caller->>MockSMS: process(smsData)
    MockSMS->>RequestHandler: request($url, smsData)
    RequestHandler-->>MockSMS: response
    MockSMS-->>Caller: result

Loading

Poem

A rabbit hops with code anew,
Now SMS endpoints change their view.
No more hardwired, fixed in place—
URLs can run the race!
With get and set, the path is clear,
Mocking texts from far and near.
🐇📱

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/Utopia/Messaging/Adapter/SMS/Mock.php (1)

35-39: Consider adding URL validation for improved security and reliability.

While the fluent interface implementation is good, the lack of URL validation could lead to runtime errors or security concerns.

Consider adding basic URL validation:

 public function setEndpoint(string $url): self
 {
+    if (!filter_var($url, FILTER_VALIDATE_URL)) {
+        throw new \InvalidArgumentException('Invalid URL provided');
+    }
     $this->url = $url;
     return $this;
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c151aa5 and 1f761b5.

📒 Files selected for processing (1)

• src/Utopia/Messaging/Adapter/SMS/Mock.php (3 hunks)

🔇 Additional comments (3)

src/Utopia/Messaging/Adapter/SMS/Mock.php (3)

13-13: LGTM! Good encapsulation with backward compatibility.

The protected property with a sensible default value maintains backward compatibility while enabling customization.

---

30-33: LGTM! Clean getter implementation.

The method follows standard getter patterns with proper typing and clear naming.

---

59-59: Excellent! This change enables the core functionality.

The modification correctly uses the configurable URL property, achieving the PR objective of making the SMS mock endpoint customizable.