feat(site): add site:https command for enabling HTTPS by loadinglucian · Pull Request #97 · loadinglucian/deployer-php

loadinglucian · 2025-11-20T13:26:06Z

Add SiteHttpsCommand class with domain selection and playbook execution
Add site-https.sh playbook that configures Caddy for automatic HTTPS
Support different WWW redirect modes (redirect-to-root, redirect-to-www)
Display HTTPS-enabled URL after successful configuration

Summary by CodeRabbit

New Features
- Added --www-mode option when adding sites and a new site:https command to enable HTTPS and show the accessible HTTPS URL.
- Server info now detects and displays per-domain PHP version, WWW mode and HTTPS status.
Refactor
- Site provisioning now generates Caddy vhosts dynamically based on selected www mode; playbooks updated to support www-mode flows.
Documentation
- Next-steps output and DNS guidance updated to show per-domain URLs and record recommendations.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

- Add SiteHttpsCommand class with domain selection and playbook execution - Add site-https.sh playbook that configures Caddy for automatic HTTPS - Support different WWW redirect modes (redirect-to-root, redirect-to-www) - Display HTTPS-enabled URL after successful configuration

coderabbitai · 2025-11-20T13:26:15Z

Walkthrough

Adds configurable WWW redirect handling across site provisioning and HTTPS enablement, a new site:https command, server-site detection in server-info, dynamic Caddy vhost generation for site-add/site-https, and trait/UI updates to propagate and display per-site wwwMode and PHP/HTTPS info.

Changes

Cohort / File(s)	Summary
HTTPS Command `app/Console/Site/SiteHttpsCommand.php`	New Symfony command `site:https` to enable HTTPS for an existing site; validates input, loads site/server/site-config, invokes `playbooks/site-https.sh` with DEPLOYER_* env vars (including DEPLOYER_WWW_MODE), and prints the HTTPS URL.
Site Addition CLI `app/Console/Site/SiteAddCommand.php`	Added `--www-mode` option; gatherSiteInfo now collects/returns `wwwMode`; wwwMode propagated into provisioning payload, DEPLOYER_WWW_MODE, command replay payload, and next-steps/DNS output.
Command Registration `app/SymfonyApp.php`	Registers the new `SiteHttpsCommand` in the application commands list.
Server display & helpers `app/Traits/ServersTrait.php`	Added `getSiteConfig(array $info, string $domain): ?array`; extended displayServerInfo() to render a "Sites Config" section showing per-domain PHP version, www_mode, and HTTPS status.
Site helpers `app/Traits/SitesTrait.php`	Added `normalizeDomain(string $domain)` and updated `validateSiteDomain()` to normalize domains (lowercase/trim/strip leading `www.`) before validation.
Server-info playbook `playbooks/server-info.sh`	Added `get_sites_config()` to detect Caddy site configs (domain, PHP socket/version, www redirect mode, HTTPS flag) and emit a `sites_config` block into DEPLOYER_OUTPUT_FILE (YAML-like).
Site-add playbook `playbooks/site-add.sh`	Switched vhost generation to use DEPLOYER_WWW_MODE; builds dynamic Caddy config (cases: `redirect-to-root`, `redirect-to-www`) instead of a single static vhost block.
Site-https playbook `playbooks/site-https.sh`	New playbook to update a site's Caddy config for HTTPS: validates env, updates vhost per www_mode, reloads services, and emits YAML-like success output (`https_enabled: true`).

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant User
    participant CLI_Add as SiteAddCommand
    participant CLI_HTTPS as SiteHttpsCommand
    participant Traits
    participant Playbook_Add as playbooks/site-add.sh
    participant Playbook_HTTPS as playbooks/site-https.sh
    participant Caddy

    User->>CLI_Add: run site:add (optionally --www-mode)
    CLI_Add->>Traits: gatherSiteInfo (returns wwwMode)
    CLI_Add->>Playbook_Add: execute with DEPLOYER_WWW_MODE
    Playbook_Add->>Caddy: write/update vhost file (mode-specific)
    Playbook_Add-->>CLI_Add: exit status & output
    CLI_Add->>User: show site URL and DNS guidance (based on wwwMode)

    User->>CLI_HTTPS: run site:https --domain example.com
    CLI_HTTPS->>Traits: select site, load server/site config (wwwMode)
    CLI_HTTPS->>Playbook_HTTPS: execute with DEPLOYER_WWW_MODE
    Playbook_HTTPS->>Caddy: update vhost file and reload services
    Playbook_HTTPS-->>CLI_HTTPS: success output (https_enabled:true)
    CLI_HTTPS->>User: display HTTPS URL (considering wwwMode)

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Areas needing extra attention:
- playbooks/server-info.sh: parsing of Caddy configs and robustness for varied file formats.
- playbooks/site-add.sh and playbooks/site-https.sh: correctness of generated Caddy blocks for both redirect modes and error handling when writing/reloading.
- SiteAddCommand: gatherSiteInfo changes and replay payload compatibility.
- ServersTrait display changes: handling of missing/malformed sites_config entries.

Possibly related PRs

bigpixelrocket/deployer-php#77 — Overlaps ServersTrait/displayServerInfo and server-info playbook output changes; likely touches the same site-config emission and display logic.
bigpixelrocket/deployer-php#60 — Related edits to SiteAddCommand and playbook/site-add flow; relevant to the new --www-mode option and propagation.
bigpixelrocket/deployer-php#90 — Prior work on SiteAddCommand and site-add playbook refactors; closely related to the dynamic Caddy configuration updates.

Poem

🐇 I hopped through configs, gentle and spry,

I set the WWW where redirects lie.
Caddy now sings with secure TLS,
Domains bloom tidy, no more mess.
A rabbity cheer — safe sites, oh my!

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 PR title clearly and concisely summarizes the main feature being added: a new site:https command for enabling HTTPS, which directly matches the primary changes in the changeset.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% 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-https-support

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

coderabbitai

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

app/Traits/SitesTrait.php (1)
137-158: Normalize domain consistently when resolving sites (selectSite vs validation)

You now normalize domains in validateSiteDomain() / gatherSiteInfo() via normalizeDomain(), but selectSite() still passes the raw --domain option straight into $this->sites->findByDomain($domain). That means site:https --domain=www.Example.com can fail to match an existing example.com entry that was normalized at creation time.

Consider normalizing the domain in selectSite() before lookup, e.g.:
$domain = $this->normalizeDomain($domain);
$site = $this->sites->findByDomain($domain);
to keep domain handling consistent across creation, validation, and selection.

Also applies to: 160-172

🧹 Nitpick comments (3)

app/Traits/ServersTrait.php (1)
73-102: Consider reusing getSiteConfig() in displayServerInfo()

getSiteConfig() encapsulates the parsing/normalization for php_version, www_mode, and https_enabled from sites_config, but displayServerInfo() re-implements similar extraction logic when building the “Sites Config” lines.

Not a correctness issue, but you could simplify and centralize behavior by using getSiteConfig() inside the loop, e.g.:
foreach ($info['sites_config'] as $domain => $_) {
    $config = $this->getSiteConfig($info, (string) $domain);
    if ($config === null) {
        continue;
    }

    $sitesItems[] = sprintf(
        '%s: PHP %s, %s, %s',
        $domain,
        $config['php_version'],
        $config['www_mode'],
        $config['https_enabled'] ? '<fg=green>HTTPS</>' : '<fg=yellow>HTTP</>'
    );
}
This keeps the parsing rules in one place and reduces duplication.

Also applies to: 425-449
playbooks/server-info.sh (1)

379-432: Sites configuration detection is coherent; consider updating header docs

The new get_sites_config() implementation and the sites_config YAML emission align with how site-add and site-https write Caddy configs (comments and http:// vs https:// usage), so HTTPS status and WWW mode should be detected reliably.

You might also:

Update the header “Returns YAML with:” section to mention the new sites_config block for completeness.

(Optional) quote php_version / www_mode / https_enabled in the YAML to avoid them being parsed as non-strings in some YAML consumers, though your PHP side already normalizes these safely.

Also applies to: 595-621

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

41-43: WWW mode plumbing from CLI to playbooks is correct; consider validating CLI values

The new --www-mode option is correctly:

Captured in gatherSiteInfo() (with a sensible interactive default and description).

Returned as wwwMode and wired into:

DEPLOYER_WWW_MODE for the site-add playbook.

The initial HTTP URL shown in “Next steps”.

The replay payload for site:add.

This end-to-end wiring looks solid.

You might optionally add validation for CLI-provided --www-mode (similar to how you validate php-version) so that typos are caught before hitting the remote playbook, rather than only via the “Invalid WWW mode” error from Bash.

Also applies to: 105-111, 130-141, 168-181, 187-195, 304-407

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 350388d and b367631.

📒 Files selected for processing (8)

app/Console/Site/SiteAddCommand.php (8 hunks)
app/Console/Site/SiteHttpsCommand.php (1 hunks)
app/SymfonyApp.php (2 hunks)
app/Traits/ServersTrait.php (2 hunks)
app/Traits/SitesTrait.php (2 hunks)
playbooks/server-info.sh (2 hunks)
playbooks/site-add.sh (5 hunks)
playbooks/site-https.sh (1 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/Traits/SitesTrait.php
app/Traits/ServersTrait.php
app/Console/Site/SiteHttpsCommand.php
app/SymfonyApp.php
app/Console/Site/SiteAddCommand.php

🧠 Learnings (8)