feat: site shared paths by loadinglucian · Pull Request #93 · loadinglucian/deployer-php

loadinglucian · 2025-11-18T12:36:12Z

Summary by CodeRabbit

New Features
- Two new commands for managing shared site configurations
- Ability to verify file existence in remote repositories
Improvements
- PHP version selection now integrated into site creation workflow
- Added provisioning validation to ensure sites are properly set up before operations
- Enhanced file removal utilities with bulk operation support
- Passwordless sudo configuration for deployer account operations

coderabbitai · 2025-11-18T12:36:22Z

Walkthrough

Refactors site creation to integrate PHP version selection into site info gathering; adds provisioning validation to shared commands; extends FilesystemService and GitService with new capabilities; registers new commands; and enhances deployment scripts with sudoers configuration.

Changes

Cohort / File(s)	Summary
Site Command Refactoring `app/Console/Site/SiteAddCommand.php`, `app/Console/Site/SiteSharedPullCommand.php`, `app/Console/Site/SiteSharedPushCommand.php`	SiteAddCommand integrates PHP version selection into gatherSiteInfo, which now accepts server info and returns an extended structure including phpVersion. SiteSharedPullCommand and SiteSharedPushCommand add validateSiteProvisioned checks before path resolution to ensure sites are provisioned on the server.
Service Layer Extensions `app/Services/FilesystemService.php`, `app/Services/GitService.php`	FilesystemService adds a new remove method for bulk file/directory deletion. GitService adds FilesystemService dependency and a new checkRemoteFilesExist method to verify file existence in remote repositories via shallow clone with cleanup.
Application Registration `app/SymfonyApp.php`	Registers two new commands: SiteSharedPushCommand and SiteSharedPullCommand in the command registry.
Trait Enhancements `app/Traits/SitesTrait.php`	Adds SSHService dependency and introduces validateSiteProvisioned method to verify site provisioning (directory and Caddy config) via remote SSH check.
Deployment Configuration `playbooks/install-deployer.sh`	Adds configure_deployer_sudo function to create sudoers configuration enabling passwordless sudo for deployer user on caddy and php\*-fpm systemctl commands.

Sequence Diagrams

sequenceDiagram
    participant User
    participant SiteAddCmd as SiteAddCommand
    participant SitesTrait as SitesTrait
    participant Provisioner
    
    User->>SiteAddCmd: execute()
    SiteAddCmd->>SitesTrait: gatherSiteInfo(serverInfo)
    Note over SitesTrait: Now accepts server info parameter
    SiteAddCmd->>SitesTrait: selectPhpVersion(serverInfo)
    SitesTrait-->>SiteAddCmd: phpVersion
    Note over SiteAddCmd: Check if int (failure)
    SiteAddCmd->>Provisioner: provision(site, phpVersion)
    Note over SiteAddCmd: phpVersion now included throughout
    Provisioner-->>SiteAddCmd: success
    SiteAddCmd-->>User: Next steps

sequenceDiagram
    participant User
    participant SharedCmd as SiteShared(Push/Pull)Command
    participant SitesTrait as SitesTrait
    participant SSHService
    participant Server
    
    User->>SharedCmd: execute()
    SharedCmd->>SitesTrait: getServerInfo()
    SitesTrait-->>SharedCmd: serverInfo
    Note over SharedCmd: NEW: Validate provisioning
    SharedCmd->>SitesTrait: validateSiteProvisioned(server, site)
    SitesTrait->>SSHService: executeRemoteCheck(test commands)
    SSHService->>Server: Check directory & Caddy config
    Server-->>SSHService: result
    SSHService-->>SitesTrait: success/failure
    SitesTrait-->>SharedCmd: null or Command::FAILURE
    alt Validation Success
        SharedCmd->>SharedCmd: Resolve paths & continue
    else Validation Failure
        SharedCmd-->>User: Error
    end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Focus areas:
- SiteAddCommand's refactored gatherSiteInfo integration with PHP version handling and propagation through provisioning chain
- New validateSiteProvisioned logic in SitesTrait and its integration into shared commands' control flow
- GitService's new checkRemoteFilesExist method with shallow clone and cleanup logic
- Cross-file dependencies and interactions (e.g., FilesystemService used in GitService, SSHService validation in shared commands)

Possibly related PRs

feat: add site:shared push pull commands for shared files #92: Introduced SiteSharedPushCommand and SiteSharedPullCommand, which this PR extends with provisioning validation checks.
feat: site management add delete #90: Modified SiteAddCommand's PHP version selection and gatherSiteInfo flow that this PR further refactors and integrates.
refactor: site remove local source support #87: Changed SiteAddCommand's site-gathering method signature and return shape, providing foundation for this PR's phpVersion integration.

Poem

🐰 A rabbit hops through code so clean,
Provisioning checks in between,
Files are removed, remotes are checked,
PHP versions neatly wrecked!
Shared commands dance with validation's grace,
Deployer's sudoers find their place! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat: site shared paths' is directly related to the changeset, which adds functionality for handling shared site paths including new commands (SiteSharedPushCommand, SiteSharedPullCommand) and provisioning validation.
Docstring Coverage	✅ Passed	Docstring coverage is 92.86% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/site-shared-paths

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

app/Console/Site/SiteAddCommand.php (1)

231-286: Consider inlining single-use method selectPhpVersion.

The selectPhpVersion method is only called once from gatherSiteInfo (Line 362). While the extraction improves readability, it adds method call overhead for a single-use case.

As per coding guidelines, consider inlining this logic directly into gatherSiteInfo to eliminate the single-use method, or keep it separate if you anticipate future reuse in other commands.

app/Services/GitService.php (1)

93-98: Consider logging cleanup failures for observability.

If remove() fails in the finally block, the exception is silently swallowed. While this prevents masking the primary operation's result, it could leave temporary directories orphaned.

Consider adding optional cleanup failure logging (if a logging mechanism is available) to track orphaned temp directories for operational awareness.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 401ed45 and 30c89f1.

⛔ Files ignored due to path filters (1)

bun.lock is excluded by !**/*.lock

📒 Files selected for processing (8)

app/Console/Site/SiteAddCommand.php (4 hunks)
app/Console/Site/SiteSharedPullCommand.php (1 hunks)
app/Console/Site/SiteSharedPushCommand.php (1 hunks)
app/Services/FilesystemService.php (1 hunks)
app/Services/GitService.php (2 hunks)
app/SymfonyApp.php (4 hunks)
app/Traits/SitesTrait.php (2 hunks)
playbooks/install-deployer.sh (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.php

📄 CodeRabbit inference engine (.cursor/rules/00-main.mdc)

**/*.php: Eliminate single-use methods: inline if a method is called only once
Cache computed values: initialize expensive calculations in the constructor
Avoid method call overhead: prefer direct property access when appropriate

Files:

app/Console/Site/SiteSharedPullCommand.php
app/Services/FilesystemService.php
app/Services/GitService.php
app/Traits/SitesTrait.php
app/Console/Site/SiteSharedPushCommand.php
app/SymfonyApp.php
app/Console/Site/SiteAddCommand.php

🧠 Learnings (12)