Skip to content

feat: [#546] artisan command up and down to set website Maintenance mode#1198

Merged
hwbrzzl merged 35 commits intogoravel:masterfrom
praem90:feat-546-artisan-command-up-and-down
Mar 3, 2026
Merged

feat: [#546] artisan command up and down to set website Maintenance mode#1198
hwbrzzl merged 35 commits intogoravel:masterfrom
praem90:feat-546-artisan-command-up-and-down

Conversation

@praem90
Copy link
Contributor

@praem90 praem90 commented Sep 14, 2025

📑 Description

This PR adds two Artisan commands

  1. Up
  2. Down
go run . artisan down
go run . artisan up

The down commands creates a temporary file in the framework storage folder
The up commands removes that file if exists

There is an another middleware CheckForMaintenance, that checks for the file.
It returns the request with 503 status code if the file exists else allow the request to passthrough.

Closes goravel/goravel#546

✅ Checks

  • [ x ] Added test cases for my code

@praem90 praem90 requested a review from a team as a code owner September 14, 2025 15:52
@codecov
Copy link

codecov bot commented Sep 14, 2025

Codecov Report

❌ Patch coverage is 75.38462% with 32 lines in your changes missing coverage. Please review.
✅ Project coverage is 68.84%. Comparing base (f028efa) to head (619619e).

Files with missing lines Patch % Lines
foundation/console/down_command.go 77.02% 10 Missing and 7 partials ⚠️
http/middleware/check_for_maintenance_mode.go 70.27% 7 Missing and 4 partials ⚠️
foundation/application.go 0.00% 2 Missing ⚠️
foundation/console/up_command.go 88.23% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1198      +/-   ##
==========================================
+ Coverage   68.80%   68.84%   +0.03%     
==========================================
  Files         287      290       +3     
  Lines       18118    18248     +130     
==========================================
+ Hits        12466    12562      +96     
- Misses       5115     5136      +21     
- Partials      537      550      +13     

☔ View full report in Codecov by Sentry.
📢 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.

@almas-x
Copy link
Contributor

almas-x commented Sep 14, 2025

This is a fantastic PR with a very useful addition to the framework! 🎉

I have a suggestion: how about allowing an optional reason flag for the down command? This could record the reason or announcement for the maintenance, and store it in the framework/down file. The middleware could then read this reason and return it, making it available for APIsor views to display. This would enhance the user experience by providing more context during maintenance mode.

@hwbrzzl
Copy link
Contributor

hwbrzzl commented Sep 15, 2025

Please fix the windows CI.

@hwbrzzl
Copy link
Contributor

hwbrzzl commented Sep 15, 2025

Thanks, great job 👍 Could add some related screenshots in the PR description?

@praem90 praem90 force-pushed the feat-546-artisan-command-up-and-down branch from 3479a4b to b70c346 Compare September 18, 2025 08:16
@praem90 praem90 force-pushed the feat-546-artisan-command-up-and-down branch from e635bf5 to 07bc616 Compare January 4, 2026 15:58
@hwbrzzl hwbrzzl force-pushed the feat-546-artisan-command-up-and-down branch from a224b58 to 63f223a Compare January 11, 2026 13:42
@hwbrzzl
Copy link
Contributor

hwbrzzl commented Jan 13, 2026

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces up and down artisan commands to manage maintenance mode, along with a middleware to enforce it. The implementation is a good start, but there are several areas for improvement. My review focuses on enhancing error handling within the new commands to provide clearer feedback for scripting and automation, and on improving the test coverage for the new maintenance middleware to ensure all its features are working as expected. I've also identified a few issues in a test helper function that could lead to flaky tests.

Copy link
Contributor

@hwbrzzl hwbrzzl left a comment

Choose a reason for hiding this comment

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

Thanks, great PR! Just left a few questions.

@praem90 praem90 force-pushed the feat-546-artisan-command-up-and-down branch from 80004df to 2be2fa0 Compare February 28, 2026 16:22
@praem90 praem90 force-pushed the feat-546-artisan-command-up-and-down branch from dbadd5e to 619619e Compare February 28, 2026 17:35
@praem90 praem90 requested review from almas-x and hwbrzzl February 28, 2026 17:40
@hwbrzzl
Copy link
Contributor

hwbrzzl commented Mar 1, 2026

@praem90 Thanks, checking

hwbrzzl

This comment was marked as duplicate.

hwbrzzl

This comment was marked as duplicate.

Copy link
Contributor

@hwbrzzl hwbrzzl left a comment

Choose a reason for hiding this comment

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

Thanks, great job! I tested this feature locally, pretty good.

@hwbrzzl hwbrzzl merged commit f1e4fc4 into goravel:master Mar 3, 2026
23 of 25 checks passed
hwbrzzl added a commit that referenced this pull request Mar 11, 2026
* chore: Update upgrade DB packages (#1374)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Internalize file rotation logic from goravel/file-rotatelogs (#1375)

* Initial plan

* Implement internal file rotation to replace goravel/file-rotatelogs

Co-authored-by: hwbrzzl <[email protected]>

* Improve cleanup logic with glob pattern matching and add comprehensive tests

Co-authored-by: hwbrzzl <[email protected]>

* Address code review feedback: fix trailing whitespace, add cleanup wait, and make tests deterministic

Co-authored-by: hwbrzzl <[email protected]>

* optimize

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: hwbrzzl <[email protected]>
Co-authored-by: Bowen <[email protected]>

* chore: Update non-major dependencies (#1373)

* chore: Update non-major dependencies

* optimize

* optimize

* renovate/non-major-dependencies

* optimize

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Bowen <[email protected]>

* feat: [#726] Add HTTP server and client telemetry instrumentation [5] (#1326)

* add http middleware

* add http transport

* optimise http telemetry package

* add test cases for Telemetry middleware

* add auto instrumentation configs

* add config to enable Telemetry for http clients

* add docs for config facade

* add ConfigFacade nil warning

* disable default telemetry

* optimise transport

* add kill switch for instrumentation

* update the stubs

* remove unnecessary handler

* optimise log instrumentation

* move route registration in the end

* lazily initialize middleware and transport to work with new application_builder

* optimise channel test

* optimise channel test

* accept telemetry facade as an input instead of using global instance

* use a callback to resolve the telemetry facade instance

* optimise grpc handler to remove usage of telemetry and config facade

* optimise the grpc handler

* use telemetry transport if enabled

* optimise http auto instrumentation

* optimize log test cases

* optimise

* optimise

* optimise

* optimise

* revert PR#1357

* fix log test cases

* revert GRPC changes

* optimise middleware

* remove zipkin trace driver

* correct GRPC enable condition

* correct http transport enable condition

* correct log channel enable condition

* update go mod

* fix test cases

* fix test cases

* fix test cases

* fix tests

---------

Co-authored-by: Bowen <[email protected]>

* chore: optimize runner tests for Windows (#1377)

Co-authored-by: Bowen <[email protected]>

* chore: Update non-major dependencies (#1378)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix: runner stuck (#1381)

* fix: runner stuck

* optimize

* optimize

* optimize

* optimize

* optimize

* chore: Update non-major dependencies (#1382)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* feat: [#849] Add table support to the console context (#1380)

* add table function in cli

* add test cases for new method Table

* update mocks

* add column level styles

* fix lint error

* move style vars to new file

* add GlobalHuhTheme

* update go mod tidy

* feat: [#546] artisan command up and down to set website Maintenance mode (#1198)

* Add up and down command

* Use file helper to create files and add unit tests

* Fix the foundation.App dependency

* Use support/path instead of foundation.App

* Add unit test case

* Add some missing checks

* Add more missing checks

* One more

* Fix tmpfile path

* Use T.TempDir instead of os.TempDir in tests

* Add reason to the down command

* Add option to the tests

* Change the maintenance file name

* close created file handles

* Defer abort

* Fix the linter issue

* Add more options to the down command

* Use options

* Check for maintenance mode respond

* Fix down_command_test

* Add more unit test cases

* Fix more lint issues

* Fix lint issue

* fix tests

* fix tests

* fix tests

* fix tests

* Address PR comments

* Fix check_for_maintenance_test

* Check Aborts in check_for_maintenance

* Rename check_for_maintenance_mode

* Fix and Write more unit tests for check_for_maintenance_mode middleware

* fix down command

* Fix down_command_test

* Fix up_command

---------

Co-authored-by: Bowen <[email protected]>

* feat: Laravel-style Collection library (#1134)

Merges comprehensive Collection library with 100+ methods for data manipulation.

Implements both eager (Collection) and lazy (LazyCollection) evaluation strategies.
Closes goravel/goravel#566

Follow-up improvements tracked in: goravel/goravel#883

* Increase route module coverage for factory, provider, and runner wiring paths (#1384)

* Initial plan

* test(route): cover route factory and service provider paths

Co-authored-by: hwbrzzl <[email protected]>

* optimize

* optimize

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: hwbrzzl <[email protected]>
Co-authored-by: Bowen <[email protected]>

* chore: optimize interface (#1389)

* Increase crypt module coverage by exercising AES key validation and failure paths (#1385)

* Initial plan

* test: add crypt AES edge-case coverage

Co-authored-by: hwbrzzl <[email protected]>

* test: improve readability of crypt key-length cases

Co-authored-by: hwbrzzl <[email protected]>

* test: address crypt PR feedback and simplify test structure

Co-authored-by: hwbrzzl <[email protected]>

* test: use configmock EXPECT style in TestNewAES

Co-authored-by: hwbrzzl <[email protected]>

* test: standardize config mock setup across aes tests

Co-authored-by: hwbrzzl <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: hwbrzzl <[email protected]>

* Increase filesystem module test coverage for storage, service provider, and file facade paths (#1387)

* Initial plan

* Add filesystem application and provider coverage tests

Co-authored-by: hwbrzzl <[email protected]>

* Polish filesystem coverage tests after review feedback

Co-authored-by: hwbrzzl <[email protected]>

* Refine filesystem tests based on review feedback

Co-authored-by: hwbrzzl <[email protected]>

* Apply review style suggestions in filesystem tests

Co-authored-by: hwbrzzl <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: hwbrzzl <[email protected]>

* Increase mail module test coverage to 70%+ with focused unit tests (#1386)

* Initial plan

* test(mail): add focused unit coverage for application, options, and service provider

Co-authored-by: hwbrzzl <[email protected]>

* test(mail): address review feedback on test specificity and readability

Co-authored-by: hwbrzzl <[email protected]>

* test(mail): merge application unit tests and remove untyped mock matchers

Co-authored-by: hwbrzzl <[email protected]>

* test(mail): deduplicate matchers and tighten queue job assertion

Co-authored-by: hwbrzzl <[email protected]>

* test(mail): use AnythingOfType and any in application tests

Co-authored-by: hwbrzzl <[email protected]>

* test(mail): derive bind callback type string from any signature

Co-authored-by: hwbrzzl <[email protected]>

* test(mail): simplify bind callback type matcher

Co-authored-by: hwbrzzl <[email protected]>

* test(mail): use AnythingOfType for template render expectations

Co-authored-by: hwbrzzl <[email protected]>

* test(mail): restore specific MatchedBy assertions per review clarification

Co-authored-by: hwbrzzl <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: hwbrzzl <[email protected]>

* Increase hash module coverage with targeted tests for driver selection and service provider paths (#1388)

* Initial plan

* test: increase hash module coverage for driver and provider paths

Co-authored-by: hwbrzzl <[email protected]>

* test: cover hash provider and driver selection paths

Co-authored-by: hwbrzzl <[email protected]>

* test: address hash module review feedback

Co-authored-by: hwbrzzl <[email protected]>

* test: merge hash module tests into application_test

Co-authored-by: hwbrzzl <[email protected]>

* test: use EXPECT API in hash service provider test

Co-authored-by: hwbrzzl <[email protected]>

* test: use any alias in hash singleton callback test

Co-authored-by: hwbrzzl <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: hwbrzzl <[email protected]>

* chore: add AI instructions file (#1393)

* Increase core framework coverage via targeted service provider and builder-path tests (#1391)

* Initial plan

* Add service provider coverage tests for core modules

Co-authored-by: hwbrzzl <[email protected]>

* Expand core module coverage tests and validate suite

Co-authored-by: hwbrzzl <[email protected]>

* Revert unintended test module dependency drift

Co-authored-by: hwbrzzl <[email protected]>

* Address actionable PR review suggestions in coverage tests

Co-authored-by: hwbrzzl <[email protected]>

* Finalize review feedback handling

Co-authored-by: hwbrzzl <[email protected]>

* Revert unintended tests module dependency updates

Co-authored-by: hwbrzzl <[email protected]>

* Tighten provider test matchers per review feedback

Co-authored-by: hwbrzzl <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: hwbrzzl <[email protected]>

* Increase infrastructure module coverage by adding Process/Packages/Log/Schedule tests and fixing errors.As target forwarding (#1392)

* Initial plan

* test(errors): cover As/Unwrap/Ignore/Join edge cases

Co-authored-by: hwbrzzl <[email protected]>

* test(errors): use wrapped error in As coverage test

Co-authored-by: hwbrzzl <[email protected]>

* chore: revert unintended tests module file changes

Co-authored-by: hwbrzzl <[email protected]>

* test: add coverage for process packages log schedule modules

Co-authored-by: hwbrzzl <[email protected]>

* test: refine schedule coverage tests per review

Co-authored-by: hwbrzzl <[email protected]>

* chore: revert unintended tests module dependency updates

Co-authored-by: hwbrzzl <[email protected]>

* test: assert boot no-panic in log and process providers

Co-authored-by: hwbrzzl <[email protected]>

* chore: finalize review feedback responses for boot test assertions

Co-authored-by: hwbrzzl <[email protected]>

* chore: revert unintended tests module file changes

Co-authored-by: hwbrzzl <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: hwbrzzl <[email protected]>

* test: expand service-layer coverage across Event, Queue, gRPC, Cache, and Console (#1390)

* Initial plan

* test(event): cover service provider and queued listener dispatch paths

Co-authored-by: hwbrzzl <[email protected]>

* chore: finalize event coverage validation

Co-authored-by: hwbrzzl <[email protected]>

* chore: revert unintended tests module dependency updates

Co-authored-by: hwbrzzl <[email protected]>

* test(event): address review suggestions for robust command matching and queue error path

Co-authored-by: hwbrzzl <[email protected]>

* chore: finalize PR feedback follow-up

Co-authored-by: hwbrzzl <[email protected]>

* chore: revert unintended tests module file updates

Co-authored-by: hwbrzzl <[email protected]>

* test: add focused coverage cases for queue grpc cache console

Co-authored-by: hwbrzzl <[email protected]>

* test: clarify queue nil args in empty chain test

Co-authored-by: hwbrzzl <[email protected]>

* chore: revert unintended tests module dependency updates

Co-authored-by: hwbrzzl <[email protected]>

* test: avoid nil context in console usage-error test

Co-authored-by: hwbrzzl <[email protected]>

* chore: finalize lint ci fix validation

Co-authored-by: hwbrzzl <[email protected]>

* chore: revert unintended tests module dependency drift

Co-authored-by: hwbrzzl <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: hwbrzzl <[email protected]>

* chore: Update non-major dependencies (#1399)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore: add generate flag to artisan build command (#1402)

* feat: [#911] add query context accessor (#1401)

* chore: optimize agents (#1396)

* chore: optimize agents

* optimize

* address comments

* Initial plan

* fix: backport migrate rollback default handling to v1.17.x

Co-authored-by: hwbrzzl <[email protected]>

* chore: align branch tree with v1.17.x before backporting rollback fix

Co-authored-by: hwbrzzl <[email protected]>

* optimize

* optimize

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Bowen <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: hwbrzzl <[email protected]>
Co-authored-by: krishan kumar <[email protected]>
Co-authored-by: Bowen <[email protected]>
Co-authored-by: Mohan Raj <[email protected]>
Co-authored-by: Ahmed M. Ammar <[email protected]>
Co-authored-by: 耗子 <[email protected]>
Co-authored-by: ALMAS <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ [Feature] artisan command up and down to set website Maintenance mode

3 participants