nextcloud / nextcloud/updater

Improve user experience of the Updater by changing order of operations (WIP/RFC)

Open
#525 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement overview Performance 🚀 UX🙂
Dominant language
PHP
Stars
51
Forks
40
Avg merge
2d 19h
Merged PRs (30d)
3

Description

  • Some steps are more likely to take longer than others
  • Some steps make others unnecessary if they fail (e.g. if the update can't be downloaded or extracted)

e.g.

  1. checkForExpectedFilesAndFolders()
  2. checkWritePermissions()
  3. downloadUpdate()
  4. verifyIntegrity()
  5. extractDownload()
  6. createBackup() <---- moves here from step 3
  7. setMaintenanceMode()
  8. replaceEntryPoints()
  9. deleteOldFiles()
  10. moveNewVersionInPlace()
  11. setMaintenanceMode
  12. finalize

The current order is as follows:

https://github.com/nextcloud/updater/blob/4d660d83db17a6cc6ce8c28f4ce38fa19932d054/index.php#L1335-L1372

Other considerations:

  • maintenance mode / end-users hitting the server
  • entrypoint replacement timing

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at index.php lines 1335-1372 and compare the current operation order with the proposed sequence in the issue. Trace how backup creation, maintenance mode, entrypoint replacement, and the other listed steps interact; done means agreeing on and implementing an order that addresses the stated failure, end-user, and timing considerations.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.