Skip to content

Fix: logs order#10052

Merged
Meldiron merged 6 commits into1.7.xfrom
fix-logs-order
Jun 26, 2025
Merged

Fix: logs order#10052
Meldiron merged 6 commits into1.7.xfrom
fix-logs-order

Conversation

@Meldiron
Copy link
Copy Markdown
Contributor

@Meldiron Meldiron commented Jun 24, 2025

What does this PR do?

Fixes screenshot vs distribution logs order. Also improves how we parse SSR logs more safely

Test Plan

Before:

CleanShot 2025-06-24 at 14 53 38@2x

After:

CleanShot 2025-06-24 at 16 09 02@2x

Related PRs and Issues

x

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 Jun 24, 2025

📝 Walkthrough

"""

Walkthrough

This change refines the handling of log segments demarcated by {APPWRITE_DETECTION_SEPARATOR_START} and {APPWRITE_DETECTION_SEPARATOR_END} within build deployment processing. The logic for skipping and extracting these segments during log streaming is improved to handle cases where both separators appear in the same chunk. The extraction of detection logs is simplified using array-based splitting. The signature and invocation location of the afterBuildSuccess method are updated, now accepting a Realtime queue parameter and being called after deployment updates. Error message processing related to separators is also streamlined, and additional log and deployment updates occur when the resource is a site.

Possibly related PRs

Suggested reviewers

  • christyjacob4
    """

📜 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 6cb3e35 and 56347e4.

📒 Files selected for processing (1)
  • src/Appwrite/Platform/Modules/Functions/Workers/Builds.php (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/Appwrite/Platform/Modules/Functions/Workers/Builds.php
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Benchmark
  • GitHub Check: Setup & Build Appwrite Image
  • 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.

@github-actions
Copy link
Copy Markdown

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

Source Code Scan Results

🎉 No vulnerabilities found!

@Meldiron Meldiron marked this pull request as ready for review June 24, 2025 14:09
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)
src/Appwrite/Platform/Modules/Functions/Workers/Builds.php (1)

877-888: Log order fix looks good but consider optimizing database operations.

The repositioning of afterBuildSuccess and addition of screenshot capturing logs correctly addresses the log order issue mentioned in the PR objectives. However, the additional database update and realtime trigger after adding the screenshot log might be unnecessary overhead.

Consider consolidating the log updates to reduce database operations:

 $this->afterBuildSuccess($queueForRealtime, $dbForProject, $deployment);
-$logs = $deployment->getAttribute('buildLogs', '');

 if ($resource->getCollection() === 'sites') {
+    $logs = $deployment->getAttribute('buildLogs', '');
     $date = \date('H:i:s');
     $logs .= "[90m[$date] [90m[[0mappwrite[90m][97m Screenshot capturing started. [0m\n";
     $deployment->setAttribute('buildLogs', $logs);
-    $deployment = $dbForProject->updateDocument('deployments', $deployment->getId(), $deployment);
-    $queueForRealtime
-        ->setPayload($deployment->getArrayCopy())
-        ->trigger();
 }

The deployment update and realtime trigger in the screenshot section (lines 1036-1040) will handle the log updates.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c04c2d2 and 6cb3e35.

📒 Files selected for processing (1)
  • src/Appwrite/Platform/Modules/Functions/Workers/Builds.php (5 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 (4)
src/Appwrite/Platform/Modules/Functions/Workers/Builds.php (4)

750-756: Good improvement for handling separator edge cases.

The enhanced logic properly handles cases where both start and end separators appear within the same log chunk, preventing partial log omission. The implementation correctly extracts the leftover after the start separator and processes the end separator if present.


839-843: Excellent simplification of detection log parsing.

The replacement of manual strpos/substr operations with explode-based splitting is much cleaner and more readable. The logic correctly extracts detection logs and reconstructs the remaining logs without the detection segment.


1237-1238: Good simplification of error message processing.

The replacement of complex separator-searching logic with simple str_replace operations is much cleaner and more comprehensive. Using a limit of 1 for each replacement correctly handles only the first occurrence of each separator.


1327-1327: Method signature change requires verification of all callers.

The signature update for afterBuildSuccess is correctly implemented with proper PHPDoc and runtime assertion. However, ensure all callers of this method are updated to match the new signature.

#!/bin/bash
# Description: Search for calls to afterBuildSuccess method to ensure compatibility with new signature
# Expected: Only the call on line 877 should exist, which already matches the new signature

# Search for method calls
rg -A 3 -B 1 'afterBuildSuccess\(' --type php

# Search for method declarations in case there are overrides
ast-grep --pattern 'function afterBuildSuccess($_) { $$$ }'

Also applies to: 1332-1332, 1334-1334

@Meldiron Meldiron merged commit 2fa3ca2 into 1.7.x Jun 26, 2025
37 of 38 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Aug 16, 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.

2 participants