Skip to content

tests: fix flaky messaging test#9957

Merged
christyjacob4 merged 1 commit intospr/1.7.x/35fcc17dfrom
spr/1.7.x/336a4f07
Jun 2, 2025
Merged

tests: fix flaky messaging test#9957
christyjacob4 merged 1 commit intospr/1.7.x/35fcc17dfrom
spr/1.7.x/336a4f07

Conversation

@loks0n
Copy link
Copy Markdown
Member

@loks0n loks0n commented Jun 2, 2025

Stack:

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jun 2, 2025

Warning

Rate limit exceeded

@loks0n has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 45 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ea8e769 and b9579c8.

📒 Files selected for processing (1)
  • tests/e2e/Services/Messaging/MessagingConsoleClientTest.php (1 hunks)

Walkthrough

The test for retrieving topic logs in the messaging console client has been updated to use an eventual assertion mechanism. This change allows the test to repeatedly attempt fetching and asserting the logs until the expected conditions are met or a timeout occurs, accommodating scenarios with eventual consistency.

Changes

File(s) Change Summary
tests/e2e/Services/Messaging/MessagingConsoleClientTest.php Wrapped topic logs retrieval and assertions in an assertEventually closure for retry behavior.

Poem

In the warren of tests, we wait and see,
Logs may take time—eventually!
With patient hops, we check once more,
Until the logs arrive at our door.
A gentle reminder from a rabbit so wise:
Sometimes, good things need retries!

✨ 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
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: 0

🧹 Nitpick comments (1)
tests/e2e/Services/Messaging/MessagingConsoleClientTest.php (1)

362-370: Consider eventual consistency for message logs as well.

The testGetMessageLogs method has a similar pattern where it creates a message, updates it, and then immediately checks for 2 log entries. This might also benefit from eventual consistency handling to prevent potential flakiness.

Consider wrapping this section in assertEventually() as well:

-        $logs = $this->client->call(Client::METHOD_GET, '/messaging/messages/' . $email['body']['$id'] . '/logs', \array_merge([
-            'content-type' => 'application/json',
-            'x-appwrite-project' => $this->getProject()['$id'],
-        ], $this->getHeaders()));
-
-        $this->assertEquals($logs['headers']['status-code'], 200);
-        $this->assertIsArray($logs['body']['logs']);
-        $this->assertIsNumeric($logs['body']['total']);
-        $this->assertCount(2, $logs['body']['logs']);
+        $this->assertEventually(function () use ($email) {
+            $logs = $this->client->call(Client::METHOD_GET, '/messaging/messages/' . $email['body']['$id'] . '/logs', \array_merge([
+                'content-type' => 'application/json',
+                'x-appwrite-project' => $this->getProject()['$id'],
+            ], $this->getHeaders()));
+
+            $this->assertEquals($logs['headers']['status-code'], 200);
+            $this->assertIsArray($logs['body']['logs']);
+            $this->assertIsNumeric($logs['body']['total']);
+            $this->assertCount(2, $logs['body']['logs']);
+        });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 75f00a4 and ea8e769.

📒 Files selected for processing (1)
  • tests/e2e/Services/Messaging/MessagingConsoleClientTest.php (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/e2e/Services/Messaging/MessagingConsoleClientTest.php (1)
src/Executor/Executor.php (1)
  • call (302-428)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: scan
  • GitHub Check: Setup & Build Appwrite Image
  • GitHub Check: Setup & Build Appwrite Image
🔇 Additional comments (1)
tests/e2e/Services/Messaging/MessagingConsoleClientTest.php (1)

209-219: Good fix for handling eventual consistency!

This change appropriately addresses the flaky test issue by wrapping the log retrieval and assertions in assertEventually(). This allows the test to retry until the expected 2 log entries (create + update operations) are available, which is essential for handling eventual consistency in distributed systems.

The implementation follows the same pattern used earlier in testGetProviderLogs (lines 61-71) and maintains consistency with the existing codebase.

@github-actions
Copy link
Copy Markdown

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!

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 2, 2025

✨ Benchmark results

  • Requests per second: 888
  • Requests with 200 status code: 159,858
  • P99 latency: 0.215675565

⚡ Benchmark Comparison

Metric This PR Latest version
RPS 888 1,069
200 159,858 192,524
P99 0.215675565 0.175631343

@loks0n loks0n force-pushed the spr/1.7.x/336a4f07 branch from ea8e769 to b9579c8 Compare June 2, 2025 18:05
@loks0n loks0n force-pushed the spr/1.7.x/35fcc17d branch from 75f00a4 to c19d123 Compare June 2, 2025 18:05
@christyjacob4 christyjacob4 merged commit d14eb3f into spr/1.7.x/35fcc17d Jun 2, 2025
68 of 79 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