Skip to content

[#3103] Corrected stale stage mail comment in 'dataProviderMailCollector()'. - #3104

Merged
AlexSkrypnyk merged 2 commits into
mainfrom
feature/3103-stage-mail-comment
Sep 8, 2026
Merged

AlexSkrypnyk merged 2 commits into
mainfrom
feature/3103-stage-mail-comment

Conversation

@AlexSkrypnyk

@AlexSkrypnyk AlexSkrypnyk commented Sep 8, 2026

Copy link
Copy Markdown
Member

Closes #3103

Summary

This change corrects no behavior; it fixes a stale comment in dataProviderMailCollector() in tests/phpunit/Drupal/SwitchableSettingsTest.php, mirrored into the installer's snapshot fixture at the equivalent path under .vortex/installer/tests/Fixtures/handler_process/_baseline/.

The ENVIRONMENT_STAGE yield carried // Stage: delivered to the original recipients., a description of the routing behavior from before web/sites/default/includes/modules/settings.reroute_email.php enabled reroute_email for every environment except ENVIRONMENT_LOCAL, ENVIRONMENT_CI and ENVIRONMENT_PROD, so ENVIRONMENT_STAGE has been taking the same rerouting branch as ENVIRONMENT_DEV.

The stage comment now reads // Stage: rerouted, then delivered to the rerouting address., matching the // Dev: rerouted, then delivered to the rerouting address. comment a few yields above; the yield's assertion, the ENVIRONMENT_PROD comment, and the test_mail_collector configuration that settings.system.php sets only for ENVIRONMENT_CI are untouched.

Before / After

┌───────────────────┬───────────────┬──────────────────────────────────────────────────────────────┬───────────────────────────────┐
│ Environment       │ reroute_email │ dataProviderMailCollector() comment                          │ Note                          │
├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┼───────────────────────────────┤
│ ENVIRONMENT_DEV   │ enabled       │ // Dev: rerouted, then delivered to the rerouting address.   │ unchanged                     │
├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┼───────────────────────────────┤
│ ENVIRONMENT_STAGE │ enabled       │ // Stage: delivered to the original recipients.              │ BEFORE: contradicted the code │
│ ENVIRONMENT_STAGE │ enabled       │ // Stage: rerouted, then delivered to the rerouting address. │ AFTER: matches Dev            │
├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┼───────────────────────────────┤
│ ENVIRONMENT_PROD  │ disabled      │ // Prod: delivered to the original recipients.               │ unchanged                     │
└───────────────────┴───────────────┴──────────────────────────────────────────────────────────────┴───────────────────────────────┘

Changes

  • Updated the ENVIRONMENT_STAGE comment in dataProviderMailCollector() in tests/phpunit/Drupal/SwitchableSettingsTest.php to describe the rerouted behavior instead of the pre-rerouting behavior it described before stage rerouting was enabled.
  • Mirrored the same one-line comment fix into the installer snapshot fixture at .vortex/installer/tests/Fixtures/handler_process/_baseline/tests/phpunit/Drupal/SwitchableSettingsTest.php by regenerating the installer's baseline snapshot.

Screenshots

N/A

Summary by CodeRabbit

  • Tests
    • Updated test wording to clarify that staged mail is rerouted and delivered to the configured rerouting address instead of the original recipients.

@github-project-automation github-project-automation Bot moved this to BACKLOG in Vortex 1.x Sep 8, 2026
@AlexSkrypnyk AlexSkrypnyk added the A2 Working clone index A2 label Sep 8, 2026
@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 96cc9951-ab27-4ba9-b856-244913754919

📥 Commits

Reviewing files that changed from the base of the PR and between 1447fe5 and c2544c8.

⛔ Files ignored due to path filters (1)
  • .vortex/installer/tests/Fixtures/handler_process/_baseline/tests/phpunit/Drupal/SwitchableSettingsTest.php is excluded by !.vortex/installer/tests/Fixtures/**
📒 Files selected for processing (1)
  • tests/phpunit/Drupal/SwitchableSettingsTest.php

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


Walkthrough

The Stage mail collector test comment now matches the configured behavior. It states that messages are rerouted and delivered to the rerouting address.

Changes

Stage mail routing

Layer / File(s) Summary
Update Stage routing comment
tests/phpunit/Drupal/SwitchableSettingsTest.php
The Stage test-case comment now describes rerouting messages to the rerouting address.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to c2544

Stage email-routing documentation now correctly describes rerouting to the configured rerouting address. Runtime behavior and test assertions are unchanged, with no current merge-readiness risk identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the correction to the stale stage mail comment in dataProviderMailCollector().
Linked Issues check ✅ Passed The change updates the ENVIRONMENT_STAGE comment from delivery to original recipients to rerouting and delivery to the rerouting address. This matches issue #3103 and leaves the stage assertion unchan…
Out of Scope Changes check ✅ Passed The reviewable change is limited to the comment correction described in issue #3103. No unrelated behavior, assertions, production comments, or configuration changes are reported.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/3103-stage-mail-comment

A rabbit reads each line,
The patch grows clear beneath the moon,
Small changes hop in place,
Tests guard the garden path,
Reviews bloom before the dawn.

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

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   98.68% (224/227)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@AlexSkrypnyk

This comment has been minimized.

2 similar comments
@AlexSkrypnyk

Copy link
Copy Markdown
Member Author

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   98.68% (224/227)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@AlexSkrypnyk

Copy link
Copy Markdown
Member Author

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   98.68% (224/227)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown

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

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

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

@codecov

codecov Bot commented Sep 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.74%. Comparing base (1447fe5) to head (c2544c8).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3104      +/-   ##
==========================================
- Coverage   87.10%   86.74%   -0.36%     
==========================================
  Files         108      101       -7     
  Lines        5179     5016     -163     
  Branches       49        3      -46     
==========================================
- Hits         4511     4351     -160     
+ Misses        668      665       -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.

@AlexSkrypnyk AlexSkrypnyk added the Needs review Pull request needs a review from assigned developers label Sep 8, 2026
@AlexSkrypnyk
AlexSkrypnyk merged commit db498d6 into main Sep 8, 2026
35 checks passed
@github-project-automation github-project-automation Bot moved this from BACKLOG to Release queue in Vortex 1.x Sep 8, 2026
@AlexSkrypnyk
AlexSkrypnyk deleted the feature/3103-stage-mail-comment branch September 8, 2026 11:20
@AlexSkrypnyk AlexSkrypnyk added this to the 1.42.0 milestone Sep 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A2 Working clone index A2 Needs review Pull request needs a review from assigned developers

Projects

Status: Release queue

Development

Successfully merging this pull request may close these issues.

Update stale stage mail comment in dataProviderMailCollector after enabling stage rerouting

1 participant