Skip to content

Better bootstrap refactor #3820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 10, 2018
Merged

Better bootstrap refactor #3820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89a8bc4
Move state out of BootstrapManager and into boot object. Remove refer…
greg-1-anderson Dec 5, 2018
d171634
Failed experiment to attempt to separate the bootstrap state from the…
greg-1-anderson Dec 5, 2018
67aabae
Describe continuation strategy
greg-1-anderson Dec 5, 2018
e2687db
Re-inject logger and add Drupal commandfiles as needed in integration…
greg-1-anderson Dec 10, 2018
f2eae27
[ci skip] Fix up comments
greg-1-anderson Dec 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/Application.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,8 @@ public function selectUri($cwd)
if ($uri) {
return $uri;
}
return $this->bootstrapManager()->selectUri($cwd);
$uri = $this->bootstrapManager()->selectUri($cwd);
return $uri;
}

/**
Expand Down
63 changes: 24 additions & 39 deletions src/Boot/BaseBoot.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@

use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use League\Container\ContainerAwareInterface;
use League\Container\ContainerAwareTrait;

abstract class BaseBoot implements Boot, LoggerAwareInterface, ContainerAwareInterface
abstract class BaseBoot implements Boot, LoggerAwareInterface
{
use LoggerAwareTrait;
use ContainerAwareTrait;

protected $uri;
protected $uri = false;
protected $phase = false;

public function __construct()
{
Expand All @@ -24,11 +22,32 @@ public function findUri($root, $uri)
return 'default';
}

public function getUri()
{
return $this->uri;
}

public function setUri($uri)
{
$this->uri = $uri;
}

/**
* @return int
*/
public function getPhase()
{
return $this->phase;
}

/**
* @param int $phase
*/
public function setPhase($phase)
{
$this->phase = $phase;
}

public function validRoot($path)
{
}
Expand Down Expand Up @@ -94,40 +113,6 @@ protected function hasRegisteredSymfonyCommand($application, $name)
}
}

protected function inflect($object)
{
// See \Drush\Runtime\DependencyInjection::addDrushServices and
// \Robo\Robo\addInflectors
$container = $this->getContainer();
if ($object instanceof \Robo\Contract\ConfigAwareInterface) {
$object->setConfig($container->get('config'));
}
if ($object instanceof \Psr\Log\LoggerAwareInterface) {
$object->setLogger($container->get('logger'));
}
if ($object instanceof \League\Container\ContainerAwareInterface) {
$object->setContainer($container->get('container'));
}
if ($object instanceof \Symfony\Component\Console\Input\InputAwareInterface) {
$object->setInput($container->get('input'));
}
if ($object instanceof \Robo\Contract\OutputAwareInterface) {
$object->setOutput($container->get('output'));
}
if ($object instanceof \Robo\Contract\ProgressIndicatorAwareInterface) {
$object->setProgressIndicator($container->get('progressIndicator'));
}
if ($object instanceof \Consolidation\AnnotatedCommand\Events\CustomEventAwareInterface) {
$object->setHookManager($container->get('hookManager'));
}
if ($object instanceof \Robo\Contract\VerbosityThresholdInterface) {
$object->setOutputAdapter($container->get('outputAdapter'));
}
if ($object instanceof \Consolidation\SiteAlias\SiteAliasManagerAwareInterface) {
$object->setSiteAliasManager($container->get('site.alias.manager'));
}
}

/**
* {@inheritdoc}
*/
Expand Down
146 changes: 88 additions & 58 deletions src/Boot/BootstrapManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,21 @@
namespace Drush\Boot;

use Consolidation\AnnotatedCommand\AnnotationData;
use Robo\Common\ConfigAwareTrait;
use DrupalFinder\DrupalFinder;
use Drush\Log\LogLevel;
use League\Container\ContainerAwareInterface;
use League\Container\ContainerAwareTrait;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Robo\Common\ConfigAwareTrait;
use Robo\Contract\ConfigAwareInterface;

class BootstrapManager implements LoggerAwareInterface, AutoloaderAwareInterface, ConfigAwareInterface
class BootstrapManager implements LoggerAwareInterface, AutoloaderAwareInterface, ConfigAwareInterface, ContainerAwareInterface
{
use LoggerAwareTrait;
use AutoloaderAwareTrait;
use ConfigAwareTrait;
use ContainerAwareTrait;

/**
* @var DrupalFinder
Expand All @@ -26,63 +29,37 @@ class BootstrapManager implements LoggerAwareInterface, AutoloaderAwareInterface
*/
protected $bootstrapCandidates = [];

/**
* @var \Drush\Boot\Boot
*/
protected $defaultBootstrapObject;

/**
* @var \Drush\Boot\Boot
*/
protected $bootstrap;

/**
* @var string
*/
protected $root;

/**
* @var string
*/
protected $uri;

/**
* @var int
*/
protected $phase;

/**
* Constructor.
*
* @param \Drush\Boot\Boot
* The default bootstrap object to use when there are
* no viable candidates to use (e.g. no selected site)
*/
public function __construct(Boot $default)
{
$this->defaultBootstrapObject = $default;

// Reset our bootstrap phase to the beginning
$this->setPhase(DRUSH_BOOTSTRAP_NONE);
}

/**
* @return int
*/
public function getPhase()
{
return $this->phase;
if (!$this->hasBootstrap()) {
return DRUSH_BOOTSTRAP_NONE;
}
return $this->bootstrap()->getPhase();
}

/**
* @param int $phase
*/
public function setPhase($phase)
protected function setPhase($phase)
{
$this->phase = $phase;
if ($this->bootstrap) {
$this->bootstrap()->setPhase($phase);
}
}


/**
* Add a bootstrap object to the list of candidates.
*
Expand Down Expand Up @@ -140,7 +117,10 @@ public function locateRoot($root, $start_path = null)
*/
public function getUri()
{
return $this->uri;
if (!$this->hasBootstrap()) {
return false;
}
return $this->bootstrap()->getUri();
}

/**
Expand All @@ -158,10 +138,7 @@ public function setUri($uri)
{
// TODO: Throw if we already bootstrapped a framework?
// n.b. site-install needs to set the uri.
$this->uri = $uri;
if ($this->bootstrap) {
$this->bootstrap->setUri($this->getUri());
}
$this->bootstrap()->setUri($uri);
}

/**
Expand All @@ -174,10 +151,23 @@ public function setUri($uri)
*/
public function bootstrap()
{
if ($this->bootstrap) {
return $this->bootstrap;
if (!$this->bootstrap) {
$this->bootstrap = $this->selectBootstrapClass();
}
return $this->selectBootstrapClass();
return $this->bootstrap;
}

/**
* For use in testing
*/
public function injectBootstrap($bootstrap)
{
$this->inflect($bootstrap);
$this->bootstrap = $bootstrap;

// Our bootstrap object is always a DrupalBoot8.
// TODO: make an API in the Boot interface to call.
$bootstrap->addDrupalModuleDrushCommands($this);
}

/**
Expand All @@ -195,7 +185,6 @@ public function bootstrapObjectForRoot($path)
if ($candidate instanceof AutoloaderAwareInterface) {
$candidate->setAutoloader($this->autoloader());
}
$candidate->setUri($this->getUri());
return $candidate;
}
}
Expand All @@ -214,16 +203,7 @@ protected function selectBootstrapClass()
{
// Once we have selected a Drupal root, we will reduce our bootstrap
// candidates down to just the one used to select this site root.
$bootstrap = $this->bootstrapObjectForRoot($this->getRoot());
// If we have not found a bootstrap class by this point,
// then return our default bootstrap object. The default bootstrap object
// should pass through all calls without doing anything that
// changes state in a CMS-specific way.
if ($bootstrap == null) {
$bootstrap = $this->defaultBootstrapObject;
}

return $bootstrap;
return $this->bootstrapObjectForRoot($this->getRoot());
}

/**
Expand Down Expand Up @@ -310,15 +290,23 @@ public function doBootstrap($phase, $phase_max = false, AnnotationData $annotati
if ($result = $this->bootstrapValidate($phase_index)) {
if (method_exists($bootstrap, $current_phase)) {
$this->logger->log(LogLevel::BOOTSTRAP, 'Drush bootstrap phase: {function}()', ['function' => $current_phase]);
$bootstrap->{$current_phase}($annotationData);
$bootstrap->{$current_phase}($this, $annotationData);
}
$this->setPhase($phase_index);
$bootstrap->setPhase($phase_index);
}
}
}
return true;
}

/**
* hasBootstrap determines whether the manager has a bootstrap object yet.
*/
public function hasBootstrap()
{
return $this->bootstrap != null;
}

/**
* Determine whether a given bootstrap phase has been completed.
*
Expand Down Expand Up @@ -367,7 +355,7 @@ public function bootstrapValidate($phase)
if ($phase_index > $validated_phase) {
$current_phase .= 'Validate';
if (method_exists($bootstrap, $current_phase)) {
$result_cache[$phase_index] = $bootstrap->{$current_phase}();
$result_cache[$phase_index] = $bootstrap->{$current_phase}($this);
} else {
$result_cache[$phase_index] = true;
}
Expand Down Expand Up @@ -515,4 +503,46 @@ public function bootstrapMax($max_phase_index = false, AnnotationData $annotatio

return $this->getPhase();
}

/**
* Allow those with an instance to us to the BootstrapManager to use its logger
*/
public function logger()
{
return $this->logger;
}

public function inflect($object)
{
// See \Drush\Runtime\DependencyInjection::addDrushServices and
// \Robo\Robo\addInflectors
$container = $this->getContainer();
if ($object instanceof \Robo\Contract\ConfigAwareInterface) {
$object->setConfig($container->get('config'));
}
if ($object instanceof \Psr\Log\LoggerAwareInterface) {
$object->setLogger($container->get('logger'));
}
if ($object instanceof \League\Container\ContainerAwareInterface) {
$object->setContainer($container->get('container'));
}
if ($object instanceof \Symfony\Component\Console\Input\InputAwareInterface) {
$object->setInput($container->get('input'));
}
if ($object instanceof \Robo\Contract\OutputAwareInterface) {
$object->setOutput($container->get('output'));
}
if ($object instanceof \Robo\Contract\ProgressIndicatorAwareInterface) {
$object->setProgressIndicator($container->get('progressIndicator'));
}
if ($object instanceof \Consolidation\AnnotatedCommand\Events\CustomEventAwareInterface) {
$object->setHookManager($container->get('hookManager'));
}
if ($object instanceof \Robo\Contract\VerbosityThresholdInterface) {
$object->setOutputAdapter($container->get('outputAdapter'));
}
if ($object instanceof \Consolidation\SiteAlias\SiteAliasManagerAwareInterface) {
$object->setSiteAliasManager($container->get('site.alias.manager'));
}
}
}
Loading