Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

tests: fix flaky account tests #9954

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 2, 2025
Merged

tests: fix flaky account tests #9954

merged 1 commit into from
Jun 2, 2025
+27 −17

Conversation

loks0n
Copy link
Member

@loks0n loks0n commented Jun 2, 2025 •
edited
Loading

commit-id:3865765d

Stack:

⚠️ Part of a stack created by spr. Do not merge manually using the UI - doing so may have unexpected results.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 2, 2025 •
edited
Loading

Walkthrough

A new protected method, assertLastRequest, was added to the test scope class, introducing retry-based assertion logic for HTTP request validation. Existing end-to-end tests were updated to use this method, replacing manual sleep and assertion code, and removing retry annotations from affected test methods.

Changes

File(s) Change Summary
tests/e2e/Scopes/Scope.php Added Async trait and new protected method assertLastRequest for retry-based request assertions.
tests/e2e/Services/Account/AccountCustomClientTest.php Removed #[Retry] attributes; refactored tests to use assertLastRequest instead of manual sleep/assertions.

Poem

In the warren of tests, a new trick appears,
With retries and probes, we chase away fears.
No more sleepy delays as requests hop by—
Now rabbits assert, and bugs say goodbye!
With paws on the code, we bound ever fast,
Our tests are more clever, our worries are past.
🐇✨

📜 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 c449144 and 854304d.

📒 Files selected for processing (2)
  • tests/e2e/Scopes/Scope.php (3 hunks)
  • tests/e2e/Services/Account/AccountCustomClientTest.php (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/e2e/Services/Account/AccountCustomClientTest.php (2)
tests/e2e/Scopes/Scope.php (1)
  • assertLastRequest (48-58)
src/Appwrite/Auth/OAuth2.php (1)
  • request (188-216)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Linter
  • GitHub Check: Setup & Build Appwrite Image
  • GitHub Check: scan
🔇 Additional comments (4)
tests/e2e/Scopes/Scope.php (2)

5-5: LGTM: Async trait integration for retry logic.

The addition of the Async trait import and usage is appropriate for implementing the retry-based assertion functionality. This provides the assertEventually method used in the new assertLastRequest method.

Also applies to: 14-14

48-58: Well-designed retry-based assertion method.

The assertLastRequest method provides a robust solution for testing HTTP requests with built-in retry logic. The implementation correctly:

  • Uses assertEventually for retry behavior with configurable timeout/wait parameters
  • Fetches requests from the request catcher service
  • Decodes nested JSON data properly
  • Applies user-provided probe functions for flexible validation
  • Returns the decoded request for further use

This approach should significantly improve test reliability by replacing sleep-based waits with proper retry logic.

tests/e2e/Services/Account/AccountCustomClientTest.php (2)

2060-2068: Excellent improvement replacing manual sleep with retry-based assertions.

The testCreatePhone method has been properly updated to use the new assertLastRequest method. The probe function comprehensively validates:

  • Request URL and headers (User-Agent, authentication)
  • HTTP method
  • SMS data (from/to phone numbers)

This approach eliminates the need for manual sleep calls and provides more reliable test execution with built-in retry logic.

2415-2418: Streamlined request validation with proper retry logic.

The testPhoneVerification method effectively uses assertLastRequest with a simple probe function that validates the presence of required data structure (data key containing message key). This replaces the previous manual request fetching approach with robust retry-based validation.

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

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 2, 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!

@loks0n loks0n mentioned this pull request Jun 2, 2025
Merged
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 2, 2025

✨ Benchmark results

  • Requests per second: 905
  • Requests with 200 status code: 162,994
  • P99 latency: 0.208904498

⚡ Benchmark Comparison

Metric This PR Latest version
RPS 905 1,116
200 162,994 200,875
P99 0.208904498 0.167974601

This was referenced Jun 2, 2025
Merged
Merged
@christyjacob4 christyjacob4 merged commit 7ed1d7b into 1.7.x Jun 2, 2025
65 of 66 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christyjacob4 christyjacob4 christyjacob4 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@loks0n @christyjacob4
Morty Proxy This is a proxified and sanitized view of the page, visit original site.