Problem

  1. install_begin_request() contains arbitrary bootstrap and state checking logic.
  2. install_tasks() contains arbitrary bootstrap and state checking logic.
  3. Every install task needs to check on its own whether it is available.
  4. Every install task needs to check on its own whether it is required.
  5. Every install task needs to check on its own whether it can run.
  6. Every install task needs to account separately for the non-interactive vs. interactive installer.
  7. Various install tasks have inter-dependencies to/from other install tasks.
  8. Less than a handful of people understand how the installer works.

Proposed solution

  1. Introduce a Graph-based install task/step manager:

    install.php
∟ DrupalKernel
  ∟ InstallerServiceProvider
    ∟ InstallerTaskManager ← Graph
      ∟ InstallTask (already installed?)
      ∟ InstallTask (distribution profile)
      ∟ InstallTask (language)
      ∟ InstallTask (translation download)
      ∟ InstallTask (profile)
      ∟ InstallTask (database settings)
      ∟ InstallTask (filesystem settings)
      ∟ InstallTask (core base system installation)
      ∟ InstallTask (kernel reboot/rebuild into production environment)
      ∟ InstallTask (module installation)
      ∟ InstallTask (theme installation)
      ∟ InstallTask (extension translation download + import)
      ∟ InstallTask (profile task X)
      ∟ InstallTask (final installer cleanup)

  2. All available install tasks are instantiated immediately, in order to

    1. Resolve dependencies
    2. Check (task) availability
    3. Check requirements
    4. Auto-resolve task parameters from current Request and/or current State
    5. Resolve the next task to be executed

    Install tasks no longer have a hard-coded order. Dependencies define execution order.

    Plugins?

  3. global $install_state → \Drupal::state()->get('installer')

    As soon as available, the current installer state is loaded from persistent state storage instead of being rebuilt from scratch on every request.

Notes

  1. This probably can and should be abstracted for re-use (e.g., update.php, same drama), but intentionally ignoring that topic for now.

Comments

sun’s picture

sun
Primary language German
Location Karlsruhe
commented
Related issues: +#1757536: Move settings.php to /settings directory, fold sites.php into settings.php
larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented

Yes, love this design.
There is a similar proposal for update tasks at #2222593: Implement better hook_update_N()s for concurrent development

sun’s picture

sun
Primary language German
Location Karlsruhe
commented
Related issues: +#1887606: Possible DOS vulnerability due to anonymous users being able to trigger database installation tasks at install.php
andypost’s picture

andypost
he/him
Primary language Russian
commented
Version: 8.0.x-dev » 8.1.x-dev
Assigned: sun » Unassigned

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.0-beta1 was released on March 2, 2016, which means new developments and disruptive changes should now be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

andypost’s picture

andypost
he/him
Primary language Russian
commented
Related issues: +#3136855: Refactor install_* database helpers into an install helper class

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.