Feature/update manager by Sebbeben · Pull Request #1217 · Part-DB/Part-DB-server

Sebbeben · 2026-01-30T22:41:47Z

Summary

This PR adds a comprehensive Update Manager similar to Mainsail's update system, allowing administrators to update Part-DB directly from the web interface.

Key Features

Web UI at /admin/update-manager showing current and available versions
Support for Git-based installations with automatic update execution
Maintenance mode during updates to prevent user access
Automatic database backup before updates with restore capability
Git rollback points for recovery (tags created before each update)
Progress tracking with real-time status updates
Update history and log viewing
Downgrade support with appropriate UI warnings
CLI command php bin/console partdb:update for server-side updates
Backup restore feature with confirmation dialogs

New Components

UpdateManagerController: Handles all web UI routes
UpdateCommand: CLI command for running updates
UpdateExecutor: Core update execution logic with safety mechanisms
UpdateChecker: GitHub API integration for version checking
InstallationTypeDetector: Detects installation type (Git/Docker/ZIP)
UpdateExtension: Twig functions for update notifications
Stimulus controllers for CSP-compliant confirmation dialogs

UI Improvements

Update notification in navbar for admins when update is available
Confirmation dialogs for update/downgrade actions
Downgrade-specific messaging when reverting to older versions
Warning when downgrading to versions without Update Manager
Progress page with auto-refresh during updates
Backup management with restore functionality

Permissions

New permission: @system.manage_updates (automatically granted to users with show_updates and server_infos)
Permission schema bumped to version 4

Safety Features

Exclusive lock prevents concurrent updates
Maintenance mode prevents user access during updates
Automatic backup before every update
Git tags created as rollback points
Comprehensive error handling and logging
Update precondition validation

Installation Type Support

Git installations: Full auto-update support ✅
ZIP installations: Update detection only (manual update instructions provided)
Docker installations: Detected but shows manual instructions

Test Plan

Test update from older version to newer version
Test downgrade from newer version to older version
Test confirmation dialogs (update and downgrade)
Test backup creation during updates
Test backup restore functionality
Verify maintenance mode blocks users during updates
Verify permissions work correctly
Test on Git-based installation

Screenshots

The interface shows available updates, current version, update history, and backup management with restore functionality.

This feature adds a comprehensive Update Manager similar to Mainsail's update system, allowing administrators to update Part-DB directly from the web interface. Features: - Web UI at /admin/update-manager showing current and available versions - Support for Git-based installations with automatic update execution - Maintenance mode during updates to prevent user access - Automatic database backup before updates - Git rollback points for recovery (tags created before each update) - Progress tracking with real-time status updates - Update history and log viewing - Downgrade support with appropriate UI messaging - CLI command `php bin/console partdb:update` for server-side updates New files: - UpdateManagerController: Handles all web UI routes - UpdateCommand: CLI command for running updates - UpdateExecutor: Core update execution logic with safety mechanisms - UpdateChecker: GitHub API integration for version checking - InstallationTypeDetector: Detects installation type (Git/Docker/ZIP) - MaintenanceModeSubscriber: Blocks user access during maintenance - UpdateExtension: Twig functions for update notifications UI improvements: - Update notification in navbar for admins when update available - Confirmation dialogs for update/downgrade actions - Downgrade-specific text throughout the interface - Progress page with auto-refresh

- Bump permission schema to version 4 - Add upgradeSchemaToVersion4 for manage_updates permission - Grants manage_updates to users who have both show_updates and server_infos - Fix ZIP_RELEASE installation type: set supportsAutoUpdate to false (ZIP update not yet implemented) - Improve update instructions for ZIP installations

When downgrading to versions before v2.6.0, show a warning that the Update Manager will not be available in older versions and that future updates will need to be done manually via command line.

The previous implementation used inline onsubmit handlers with return confirmVersionChange(...), which could fail silently if any JavaScript error occurred on the page, causing the form to submit without confirmation. Fixes: - Use event.preventDefault() FIRST to ensure form never submits by default - Use DOMContentLoaded event listeners instead of inline handlers - Properly escape translation strings using json_encode filter - Wrap in IIFE with 'use strict' for better error handling - Use data-attributes to identify forms and pass isDowngrade state Fix DOMContentLoaded race condition in update form handlers The event listener was not attaching if DOMContentLoaded had already fired by the time the script executed. Now checks document.readyState and attaches handlers immediately if DOM is already ready. Added console.log statements to help debug form handler attachment. Use Stimulus controller for update confirmation dialogs The inline script was blocked by Content Security Policy (CSP). Stimulus controllers are bundled with webpack and properly allowed by CSP. - Create update_confirm_controller.js Stimulus controller - Remove inline script from template - Pass translation strings via data-* attributes

- Add restoreBackup() method to UpdateExecutor with full restore workflow - Add getBackupDetails() to retrieve backup metadata and contents info - Add restore controller routes (backup details API, restore action) - Add restore button to backups table in UI - Create backup_restore_controller.js Stimulus controller for confirmation - Add translation strings for restore feature The restore process: 1. Acquires lock and enables maintenance mode 2. Extracts backup to temp directory 3. Restores database (MySQL/PostgreSQL SQL or SQLite file) 4. Optionally restores config files and attachments 5. Clears and warms cache 6. Disables maintenance mode Fix backup restore database import The restore feature was using a non-existent doctrine:database:import command. Now properly uses mysql/psql commands directly to import database dumps. Changes: - Add EntityManagerInterface dependency to UpdateExecutor - Use mysql command with shell input redirection for MySQL restore - Use psql -f command for PostgreSQL restore - Properly handle database connection parameters - Add error handling for failed imports

codecov · 2026-01-31T21:36:06Z

Codecov Report

❌ Patch coverage is 2.55616% with 1258 lines in your changes missing coverage. Please review.
✅ Project coverage is 55.33%. Comparing base (ae4c078) to head (fa4ae63).
⚠️ Report is 17 commits behind head on master.

Files with missing lines	Patch %	Lines
src/Services/System/UpdateExecutor.php	0.51%	584 Missing ⚠️
src/Command/UpdateCommand.php	0.00%	248 Missing ⚠️
src/Services/System/UpdateChecker.php	0.00%	156 Missing ⚠️
src/Controller/UpdateManagerController.php	0.00%	146 Missing ⚠️
src/Services/System/InstallationTypeDetector.php	1.13%	87 Missing ⚠️
src/EventSubscriber/MaintenanceModeSubscriber.php	15.38%	33 Missing ⚠️
src/Twig/UpdateExtension.php	73.33%	4 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #1217      +/-   ##
============================================
- Coverage     58.23%   55.33%   -2.90%     
- Complexity     7435     7752     +317     
============================================
  Files           582      589       +7     
  Lines         23656    24947    +1291     
============================================
+ Hits          13775    13805      +30     
- Misses         9881    11142    +1261

☔ 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.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Otherwise we run into an error message that web profiler does not exist

jbtronics · 2026-01-31T23:40:51Z

Hey, thanks for the PR, it looks very cool and amazing.
I took a rough look through the code, and added some comments in github.

Some general remarks:

As far as I see the updater does not update the frontend dependencies and does not compile it. So there should be steps added to run yarn install and yarn build
There should be an env var option to completley disable the update process from the web, no matter the user permissions. So that server admins can disable that for security reasons or if that interferes with some other deployment process.
I think the whole logic to do the actual backup/restores should be moved to its own service (that can then maybe be utilized by the backup command). Also the backup management logic should maybe be extracted to its own BackupManager service, so that it could be utilized for other things later
Maybe there should be some additional permission or at least some env var option to enable/disable backup restoring. That is quite an powerful and potentially destructive command, which could allow users to destroy months of work.
That are quite complex (and critical) new logics, it would be good to have that at least somehow testable automatically. Even though i see that this maybe difficult to test with classical phpunit tests. I will think about it, maybe some github actions workflow that tries to run the update commands, would be be good to ensure at least a bit of reliability.

Merged new Conrad info provider and generic web provider translations from upstream while keeping Update Manager translations.

Changes based on maintainer feedback from PR Part-DB#1217: 1. Add yarn install/build steps to update process - Added yarn availability check in validateUpdatePreconditions - Added yarn install and yarn build steps after composer install - Added yarn rebuild to rollback process - Updated total steps count from 12 to 14 2. Add environment variables to disable web features - DISABLE_WEB_UPDATES: Completely disable web-based updates - DISABLE_BACKUP_RESTORE: Disable backup restore from web UI - Added checks in controller and template 3. Extract BackupManager service - New service handles backup creation, listing, details, and restoration - UpdateExecutor now delegates backup operations to BackupManager - Cleaner separation of concerns for future reuse 4. Merge upstream/master and resolve translation conflicts - Added Conrad info provider and generic web provider translations - Kept Update Manager translations

Combined jbtronics' debug mode handling for composer install with our yarn install/build steps and BackupManager refactoring.

Tests cover: - BackupManager: backup directory, listing, details parsing - UpdateExecutor: lock/unlock, maintenance mode, validation, progress

Sebbeben · 2026-02-01T18:40:08Z

Thanks, glad you like it! I've addressed all the points:

1. Yarn install/build steps

Added yarn validation check in validateUpdatePreconditions()
Added Step 8 (yarn install) and Step 9 (yarn build) to the update process
Also added yarn reinstall/rebuild during rollback

2. Environment variable to disable web updates

Added DISABLE_WEB_UPDATES env var (default: 0)
When enabled, shows warning message and hides update buttons
API endpoints return 403 Access Denied

3. Extracted BackupManager service

Created src/Services/System/BackupManager.php with backup/restore logic
UpdateExecutor now delegates to BackupManager (with deprecated wrapper methods for BC)
This allows the backup functionality to be reused elsewhere (e.g., dedicated backup command)

4. Backup restore permission/control

Added DISABLE_BACKUP_RESTORE env var (default: 0)
Separate from web updates since restore is a destructive operation
Shows warning and hides restore buttons when disabled

5. Automated tests

Added BackupManagerTest.php (6 tests)
Added UpdateExecutorTest.php (12 tests)
All 18 tests passing

… but include that for new databases

… in GitVersionInfoProvider service

…service

This can become default, when there is more experience with the web updated

…ake it more consistent with other hyphen command tools

jbtronics · 2026-02-02T22:29:13Z

So i did some optimizations of the code during the more detailed review.
You should take a look again and test out if everything is working fine.
I removed quite some translation messages, which seemed unused.

If everythings works, i can merge the PR.

It would be good, if there is some documentation to the update features. For now i would keep it under an experimental status, I have disabled by default for now. If there was some experienced gathered how reliable everything works for the end user, we can make it enabled by default.

- Add comprehensive update_manager.md with feature overview - Document CLI commands (partdb:update, partdb:maintenance-mode) - Document web interface and permissions - Add security considerations and troubleshooting - Update console_commands.md with new commands

Sebbeben · 2026-02-03T10:59:01Z

Thanks for the review and optimizations! I've tested everything and all 17 tests pass.

I've also added documentation:

New docs/usage/update_manager.md with comprehensive feature documentation
Updated docs/usage/console_commands.md with the new commands

The documentation notes the experimental status and that web updates are disabled by default.

Also improved the .env comments for DISABLE_WEB_UPDATES and DISABLE_BACKUP_RESTORE to clarify that 0=enabled and 1=disabled, since the original wording wasn't clear about this.

Clarify that 0=enabled and 1=disabled for DISABLE_WEB_UPDATES and DISABLE_BACKUP_RESTORE environment variables.

…eature/update-manager

…t it is properly cleared on cache clear

jbtronics · 2026-02-03T20:42:03Z

I merged the PR.

Thanks again for your PR.

Sebbeben · 2026-02-05T21:30:49Z

I merged the PR.

Thanks again for your PR.

It is me that should thank you for making Part DB possible, thank you very much for that! You are making a fantastic job!

Sebbeben added 6 commits January 30, 2026 21:36

Add downgrade warning for versions without Update Manager

97e3b0a

When downgrading to versions before v2.6.0, show a warning that the Update Manager will not be available in older versions and that future updates will need to be done manually via command line.

Add Update Manager screenshot for PR

fa4ae63

jbtronics added 3 commits January 31, 2026 23:33

Require ext-zip in composer.json

6ac7a42

Install dev dependencies when updating a debug mode instance

a78ca67

Otherwise we run into an error message that web profiler does not exist

Fixed composer.json formatting

0eba473

Sebbeben added 4 commits February 1, 2026 19:07

Merge upstream/master and resolve translation conflict

6b27f3a

Merged new Conrad info provider and generic web provider translations from upstream while keeping Update Manager translations.

Merge remote changes with PR feedback

f369e14

Combined jbtronics' debug mode handling for composer install with our yarn install/build steps and BackupManager refactoring.

Add unit tests for BackupManager and UpdateExecutor

47295bd

Tests cover: - BackupManager: backup directory, listing, details parsing - UpdateExecutor: lock/unlock, maintenance mode, validation, progress

jbtronics added 14 commits February 2, 2026 16:43

Merge branch 'master' into feature/update-manager

5991458

Added missing phpdoc structure definitions

7e486a9

Do not automatically give existing users the right to manage updates,…

1bfd36c

… but include that for new databases

Remove Content-Security-Policy for maintenance mode

7ff07a7

Centralized git logic from InstallationTypeDetector and UpdateChecker…

6dbead6

… in GitVersionInfoProvider service

Merged functionality from UpdateAvailableManager and UpdateChecker

68ff072

Extracted logic used by both BackupManager and UpdateExecutor to new …

1ccc3ad

…service

Improved UpdateExecutor

720c1e5

Try to emulate nohup behavior on windows

7a856bf

Use different symbol for update manager

2b94ff9

Use version info from updateChecker to be consistent

29a08d1

Fixed git commit hash logic

883e3b2

Disable the web updater and web backup restore for now

d06df44

This can become default, when there is more experience with the web updated

Add nonce to inline script in progress bar

0e5a73b

jbtronics added 10 commits February 2, 2026 21:29

Put update manager under /system route instead of admin

f327688

We are in development of 2.6.0

9b08410

Moved "Cant auto update panel higher" to make it more visible

427778e

Added missing translations

903716a

Added an console command to turn maintenance mode on or off

1adfec1

Only use the simple maintenance page, and made this a bit more generic

58d574a

Removed custom yes and no translations

1a06432

Removed unused translations

9ca1834

Make maintenance command available under partdb:maintenance-mode to m…

a755287

…ake it more consistent with other hyphen command tools

Fixed phpstan issues

cad5261

Sebbeben and others added 5 commits February 3, 2026 20:16

Improve .env comments for Update Manager settings

e83e739

Clarify that 0=enabled and 1=disabled for DISABLE_WEB_UPDATES and DISABLE_BACKUP_RESTORE environment variables.

Allow to view progress view while update is running

c34acfe

Merge remote-tracking branch 'Sebbeben/feature/update-manager' into f…

36e105a

…eature/update-manager

Use a special settings cache that lives in cache.system to ensure tha…

5ceadc8

…t it is properly cleared on cache clear

Added translation for downgrading in progress title

1601382

jbtronics merged commit 7eafa7d into Part-DB:master Feb 3, 2026

This was referenced Feb 3, 2026

Updater in the WebUI #244

Closed

Little shell script for update #720

Closed

Create partdb-release-script.sh #941

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feature/update manager#1217

Feature/update manager#1217
jbtronics merged 43 commits intoPart-DB:masterfrom
Sebbeben:feature/update-manager

Sebbeben commented Jan 30, 2026

Uh oh!

codecov bot commented Jan 31, 2026

Uh oh!

jbtronics commented Jan 31, 2026

Uh oh!

Sebbeben commented Feb 1, 2026 •

edited

Loading

Uh oh!

jbtronics commented Feb 2, 2026

Uh oh!

Sebbeben commented Feb 3, 2026 •

edited

Loading

Uh oh!

jbtronics commented Feb 3, 2026

Uh oh!

Sebbeben commented Feb 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

Sebbeben commented Jan 30, 2026

Summary

Key Features

New Components

UI Improvements

Permissions

Safety Features

Installation Type Support

Test Plan

Screenshots

Uh oh!

codecov bot commented Jan 31, 2026

Codecov Report

Uh oh!

jbtronics commented Jan 31, 2026

Uh oh!

Sebbeben commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jbtronics commented Feb 2, 2026

Uh oh!

Sebbeben commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jbtronics commented Feb 3, 2026

Uh oh!

Sebbeben commented Feb 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Sebbeben commented Feb 1, 2026 •

edited

Loading

Sebbeben commented Feb 3, 2026 •

edited

Loading