Renamed 'VORTEX_NGINX_MAINTENANCE_MODE' to 'VORTEX_WEBSERVER_MAINTENANCE_MODE'. by AlexSkrypnyk · Pull Request #3234 · drevops/vortex

AlexSkrypnyk · 2026-10-25T20:58:01Z

Summary

The static maintenance page is now switched on with VORTEX_WEBSERVER_MAINTENANCE_MODE=1 instead of VORTEX_NGINX_MAINTENANCE_MODE=1. The envplate placeholder in .docker/config/nginx/maintenance.conf, the nginx service pass-through in docker-compose.yml, and every doc that tells you how to flip the switch all use the new name.

The old name tied a hosting-level toggle to 1 specific webserver. You set it on the environment (Lagoon --scope runtime) to say "serve the maintenance page", which doesn't care what's answering requests, so baking NGINX into the name would turn into a breaking rename the day the webserver changes. Better to rename it now, while it's only been out since 1.42.0.

After merge, a project that has VORTEX_NGINX_MAINTENANCE_MODE set on an environment needs to set VORTEX_WEBSERVER_MAINTENANCE_MODE instead. The old name isn't read anymore, so leaving it in place keeps the site serving normally. Nothing else moves: the nginx container, maintenance.html, the 503 response and the "only 1 turns it on" rule all stay as they are.

Before / After

BEFORE
  lagoon add variable --name VORTEX_NGINX_MAINTENANCE_MODE --value 1
        │
        ▼
  docker-compose.yml  nginx.environment.VORTEX_NGINX_MAINTENANCE_MODE
        │
        ▼
  maintenance.conf    set $vortex_maintenance "${VORTEX_NGINX_MAINTENANCE_MODE:-0}"
        │
        ▼
  503 + maintenance.html

AFTER
  lagoon add variable --name VORTEX_WEBSERVER_MAINTENANCE_MODE --value 1
        │
        ▼
  docker-compose.yml  nginx.environment.VORTEX_WEBSERVER_MAINTENANCE_MODE
        │
        ▼
  maintenance.conf    set $vortex_maintenance "${VORTEX_WEBSERVER_MAINTENANCE_MODE:-0}"
        │
        ▼
  503 + maintenance.html   (unchanged)

Changes

Template

.docker/config/nginx/maintenance.conf - placeholder and header comment use the new name (comment re-wrapped to stay under the line limit).
docker-compose.yml - nginx pass-through entry and its comment use the new name.
docs/deployment.md - consumer-facing maintenance page instructions.

Documentation site

.vortex/docs/.utils/variables/extra/lagoon.variables.sh - the variable source the docs table is generated from.
.vortex/docs/content/development/variables.mdx - regenerated with ahoy update-docs, so the anchor id is now vortex_webserver_maintenance_mode (nothing linked to the old one).
.vortex/docs/content/hosting/lagoon.mdx - lagoon add variable, lagoon delete variable and local preview commands.
.vortex/docs/content/development/environment/docker.mdx - the nginx pass-through note.

Tests

.vortex/tests/phpunit/Traits/Subtests/SubtestAhoyTrait.php - the functional subtest that brings nginx up in maintenance mode now sets the new name.
.vortex/tests/phpunit/Fixtures/docker-compose.*.json and the installer handler_process fixtures (_baseline plus the 5 Lagoon docs/deployment.md deltas) - regenerated with ahoy update-snapshots, which now passes all 160 scenarios.

Summary by CodeRabbit

Documentation
- Updated maintenance-mode configuration instructions to use VORTEX_WEBSERVER_MAINTENANCE_MODE instead of the previous variable name.
Bug Fixes
- Aligned the web server’s maintenance-mode setting with the updated configuration name. The maintenance response behavior is unchanged.

…NCE_MODE'.

coderabbitai · 2026-10-25T20:58:19Z

No actionable comments were generated in the recent review.

Recent review info

Run configuration

Source mode: Auto
Repository: Unavailable
Branch: Unavailable
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Repository UI
Review profile: ASSERTIVE
Plan: Team
Run ID: 4b9419a4-39e3-4d41-972a-1392ef2911b2

Commits

Reviewing files that changed from the base of the PR and between 4c56bc4 and 8210db8.

Files ignored due to path filters: 7

.vortex/installer/tests/Fixtures/handler_process/_baseline/.docker/config/nginx/maintenance.conf is excluded by !.vortex/installer/tests/Fixtures/**
.vortex/installer/tests/Fixtures/handler_process/_baseline/docker-compose.yml is excluded by !.vortex/installer/tests/Fixtures/**
.vortex/installer/tests/Fixtures/handler_process/hosting_lagoon/docs/deployment.md is excluded by !.vortex/installer/tests/Fixtures/**
.vortex/installer/tests/Fixtures/handler_process/hosting_project_name___lagoon/docs/deployment.md is excluded by !.vortex/installer/tests/Fixtures/**
.vortex/installer/tests/Fixtures/handler_process/migration_disabled_lagoon/docs/deployment.md is excluded by !.vortex/installer/tests/Fixtures/**
.vortex/installer/tests/Fixtures/handler_process/migration_enabled_lagoon/docs/deployment.md is excluded by !.vortex/installer/tests/Fixtures/**
.vortex/installer/tests/Fixtures/handler_process/provision_database_lagoon/docs/deployment.md is excluded by !.vortex/installer/tests/Fixtures/**

Files selected for processing: 12

.docker/config/nginx/maintenance.conf
.vortex/docs/.utils/variables/extra/lagoon.variables.sh
.vortex/docs/content/development/environment/docker.mdx
.vortex/docs/content/development/variables.mdx
.vortex/docs/content/hosting/lagoon.mdx
.vortex/tests/phpunit/Fixtures/docker-compose.env.json
.vortex/tests/phpunit/Fixtures/docker-compose.env_local.json
.vortex/tests/phpunit/Fixtures/docker-compose.env_mod.json
.vortex/tests/phpunit/Fixtures/docker-compose.noenv.json
.vortex/tests/phpunit/Traits/Subtests/SubtestAhoyTrait.php
docker-compose.yml
docs/deployment.md

Included review availability: This review used your included allowance. 9 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 10 reviews per hour.

Walkthrough

The nginx maintenance-mode variable was renamed to VORTEX_WEBSERVER_MAINTENANCE_MODE across configuration, Compose settings, test fixtures, test setup, and documentation. The nginx configuration retains its default value of 0.

Changes

Maintenance mode variable rename

Layer / File(s)	Summary
Runtime configuration and test setup `.docker/config/nginx/maintenance.conf`, `docker-compose.yml`, `.vortex/tests/phpunit/Fixtures/*`, `.vortex/tests/phpunit/Traits/Subtests/SubtestAhoyTrait.php`	The nginx configuration, Compose environment, fixtures, and maintenance-mode test setup now use `VORTEX_WEBSERVER_MAINTENANCE_MODE`. The configuration default remains `0`.
Variable documentation `.vortex/docs/.utils/variables/extra/lagoon.variables.sh`, `.vortex/docs/content/development/environment/docker.mdx`, `.vortex/docs/content/development/variables.mdx`, `.vortex/docs/content/hosting/lagoon.mdx`, `docs/deployment.md`	Variable references and maintenance-page instructions now use `VORTEX_WEBSERVER_MAINTENANCE_MODE`.

Priority: Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Refactor

Merge Risk: Minimal · up to 8210d

No actionable merge-blocking risk was identified in the variable rename.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (10 skipped: 1…	Write docstrings for the functions missing them to satisfy the coverage threshold.

Passed checks: 4 passed

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the primary change: renaming the maintenance-mode environment variable across the project.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (10 skipped: 10 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

Finishing Touches: 💡 1

📝 Generate docstrings: 💡

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

🔧 LanguageTool

.vortex/docs/content/development/variables.mdx

LanguageTool checks are incomplete because the per-file request limit of 5 was reached. Remaining text was skipped; findings from completed checks are retained.

_{I’m a rabbit, hopping by,
A new name greets my curious eye.
Config and guides now match in line,
The default stays just as fine.
I nibble clover, then I go,
With one clear name for all to know.}

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

github-actions · 2026-10-25T21:09:51Z

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   100.00% (233/233)

Per-class coverage

Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

AlexSkrypnyk · 2026-10-25T21:11:33Z

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   100.00% (233/233)

Per-class coverage

Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

codecov · 2026-10-25T21:13:10Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.09%. Comparing base (4c56bc4) to head (8210db8).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3234      +/-   ##
==========================================
- Coverage   92.28%   92.09%   -0.20%     
==========================================
  Files         113      105       -8     
  Lines        5097     4931     -166     
  Branches       49        3      -46     
==========================================
- Hits         4704     4541     -163     
+ Misses        393      390       -3

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2026-10-25T21:14:22Z

📖 Documentation preview for this pull request has been deployed to Netlify:

https://6ade7128d2385a814538feef--vortex-docs.netlify.app

This preview is rebuilt on every commit and is not the production documentation site.

AlexSkrypnyk added 3 commits October 26, 2026 07:51

Renamed 'VORTEX_NGINX_MAINTENANCE_MODE' to 'VORTEX_WEBSERVER_MAINTENA…

ecac6e6

…NCE_MODE'.

Updated Docker Compose test fixtures.

7dc56cd

Updated snapshots.

8210db8

github-project-automation Bot added this to Vortex 1.x Oct 25, 2026

AlexSkrypnyk added the A2 Working clone index A2 label Oct 25, 2026

github-project-automation Bot moved this to BACKLOG in Vortex 1.x Oct 25, 2026

github-actions Bot assigned AlexSkrypnyk Oct 25, 2026

This comment has been minimized.

Sign in to view

AlexSkrypnyk added the Needs review Pull request needs a review from assigned developers label Oct 25, 2026

AlexSkrypnyk added this to the 1.43.0 milestone Oct 25, 2026

AlexSkrypnyk merged commit 0c64cc8 into main Oct 25, 2026
48 checks passed

AlexSkrypnyk deleted the feature/rename-maint-mode branch October 25, 2026 23:16

github-project-automation Bot moved this from BACKLOG to Release queue in Vortex 1.x Oct 25, 2026

Navigation Menu

Repository navigation

Renamed 'VORTEX_NGINX_MAINTENANCE_MODE' to 'VORTEX_WEBSERVER_MAINTENANCE_MODE'. - #3234

Renamed 'VORTEX_NGINX_MAINTENANCE_MODE' to 'VORTEX_WEBSERVER_MAINTENANCE_MODE'.#3234
AlexSkrypnyk merged 3 commits into
mainfrom
feature/rename-maint-mode

AlexSkrypnyk commented Oct 25, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Oct 25, 2026 •

edited

Loading

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions Bot commented Oct 25, 2026

Uh oh!

AlexSkrypnyk commented Oct 25, 2026

Uh oh!

codecov Bot commented Oct 25, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 25, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

AlexSkrypnyk commented Oct 25, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Before / After

Changes

Template

Documentation site

Tests

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Oct 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions Bot commented Oct 25, 2026

Uh oh!

AlexSkrypnyk commented Oct 25, 2026

Uh oh!

codecov Bot commented Oct 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented Oct 25, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

AlexSkrypnyk commented Oct 25, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Oct 25, 2026 •

edited

Loading

codecov Bot commented Oct 25, 2026 •

edited

Loading