Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(maintenance-mode): keep only HaRP and ExApp survival routes available in maintenance mode#898

Merged
oleksandr-nc merged 1 commit into
mainfrom
fix/maintenance-mode-route-allowlist
Jun 19, 2026
Merged

fix(maintenance-mode): keep only HaRP and ExApp survival routes available in maintenance mode#898
oleksandr-nc merged 1 commit into
mainfrom
fix/maintenance-mode-route-allowlist

Conversation

@oleksandr-nc

@oleksandr-nc oleksandr-nc commented Jun 19, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Companion PR for this PR to the Server repo: nextcloud/server#61294

With that server change AppAPI stays reachable while the instance is in maintenance, so this adds a guard on our side: a new MaintenanceModeMiddleware returns 503 for every AppAPI route during maintenance, except the few flagged with the new #[MaintenanceModeAvailable] attribute .

The allowlist is just the routes that have to keep working: the HaRP exapp-meta lookup, and the ExApp init-status, enabled-state, nextcloud-url and log callbacks.

ExApps intentionally do not serve end-user traffic during maintenance: user-info is not allowlisted, because confirming who a user is (enabled/admin) needs backends from apps that aren't loaded while only AppAPI runs, so for LDAP/OIDC users the answer would be unreliable.

🤖 AI (if applicable)

  • The content of this PR was partly or fully generated using AI: tests were generated with the help of GLM model

@coderabbitai

coderabbitai Bot commented Jun 19, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 06ce0b57-ebe6-41f5-a4d6-b2d2a862c6a1

📥 Commits

Reviewing files that changed from the base of the PR and between b187fc7 and 6769836.

📒 Files selected for processing (7)
  • lib/AppInfo/Application.php
  • lib/Attribute/MaintenanceModeAvailable.php
  • lib/Controller/HarpController.php
  • lib/Controller/OCSApiController.php
  • lib/Exceptions/MaintenanceModeException.php
  • lib/Middleware/MaintenanceModeMiddleware.php
  • tests/php/Middleware/MaintenanceModeMiddlewareTest.php
🚧 Files skipped from review as they are similar to previous changes (5)
  • lib/Controller/HarpController.php
  • lib/Attribute/MaintenanceModeAvailable.php
  • lib/Exceptions/MaintenanceModeException.php
  • lib/AppInfo/Application.php
  • lib/Controller/OCSApiController.php
📝 Walkthrough

Walkthrough

A new MaintenanceModeAvailable PHP attribute class and MaintenanceModeException are added. MaintenanceModeMiddleware uses these in its beforeController method: it reads the maintenance system config flag and, if set, uses reflection to check whether the target controller method carries #[MaintenanceModeAvailable]; if not, it throws MaintenanceModeException. Its afterException override converts that exception into a JSONResponse (HTTP 503) with X-Nextcloud-Maintenance-Mode: 1 and Retry-After: 120 headers. The middleware is registered in Application::register(), and several endpoints across HarpController and OCSApiController are annotated with #[MaintenanceModeAvailable]. A PHPUnit test class covers all middleware behaviors and verifies the attribute presence on each allowlisted and blocked route via reflection.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 24.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and specifically describes the main change: implementing maintenance mode controls to keep only HaRP and ExApp survival routes available.
Description check ✅ Passed The description is directly related to the changeset, explaining the maintenance mode middleware implementation, its purpose, the allowlisted routes, and the rationale for user-facing exclusions.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

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

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

coderabbitai[bot]
coderabbitai Bot reviewed Jun 19, 2026
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
lib/Attribute/MaintenanceModeAvailable.php (1)

19-20: Restrict this attribute to method targets.

#[Attribute] currently allows broad placement; this marker is only consumed on controller methods. Constraining target scope prevents accidental misannotation that the middleware won't evaluate.

Proposed change 
-#[Attribute]
+#[Attribute(Attribute::TARGET_METHOD)]
 class MaintenanceModeAvailable {
 }

All 7 usages in the codebase are already method-level, making this a safe refactor.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: fa668cbd-18fa-40bd-a5fa-8aeccf0cf3d3

📥 Commits

Reviewing files that changed from the base of the PR and between f80f109 and b187fc7.

📒 Files selected for processing (7)
  • lib/AppInfo/Application.php
  • lib/Attribute/MaintenanceModeAvailable.php
  • lib/Controller/HarpController.php
  • lib/Controller/OCSApiController.php
  • lib/Exceptions/MaintenanceModeException.php
  • lib/Middleware/MaintenanceModeMiddleware.php
  • tests/php/Middleware/MaintenanceModeMiddlewareTest.php

@oleksandr-nc oleksandr-nc force-pushed the fix/maintenance-mode-route-allowlist branch from b187fc7 to 6769836 Compare June 19, 2026 13:59
@oleksandr-nc oleksandr-nc merged commit dba8f14 into main Jun 19, 2026
53 checks passed
@oleksandr-nc oleksandr-nc deleted the fix/maintenance-mode-route-allowlist branch June 19, 2026 17:15
@oleksandr-nc

oleksandr-nc commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

/backport to stable34

@backportbot backportbot Bot mentioned this pull request Jun 19, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@blizzz blizzz blizzz approved these changes

@julien-nc julien-nc Awaiting requested review from julien-nc

@kyteinsky kyteinsky Awaiting requested review from kyteinsky

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@oleksandr-nc @blizzz