Merge branch '1.x' into 2.x

* 1.x:
  Fix checking for "flex-require-dev" in composer.json
  Fix reading recipe version from lock file
  Hit raw.githubusercontent.com to work around rate limiting
  Shorten Symfony Recipe URL Cache Keys
  Interactively asking if the user wants Docker support from Flex

Author: nicolas-grekas

src/Command/RecipesCommand.php

@@ -156,6 +156,7 @@ private function displayPackageInformation(Recipe $recipe)
         $lockRepo = $recipeLock['recipe']['repo'] ?? null;
         $lockFiles = $recipeLock['files'] ?? null;
         $lockBranch = $recipeLock['recipe']['branch'] ?? null;
+        $lockVersion = $recipeLock['recipe']['version'] ?? $recipeLock['version'] ?? null;
 
         $status = '<comment>up to date</comment>';
         if ($recipe->isAuto()) {
@@ -174,7 +175,7 @@ private function displayPackageInformation(Recipe $recipe)
                     $recipe->getName(),
                     $lockRepo,
                     $lockBranch ?? '',
-                    $recipeLock['version'],
+                    $lockVersion,
                     $lockRef
                 );
             } catch (TransportException $exception) {
@@ -183,16 +184,16 @@ private function displayPackageInformation(Recipe $recipe)
         }
 
         $io->write('<info>name</info>             : '.$recipe->getName());
-        $io->write('<info>version</info>          : '.($recipeLock['version'] ?? 'n/a'));
+        $io->write('<info>version</info>          : '.($lockVersion ?? 'n/a'));
         $io->write('<info>status</info>           : '.$status);
-        if (!$recipe->isAuto() && isset($recipeLock['version'])) {
+        if (!$recipe->isAuto() && null !== $lockVersion) {
             $recipeUrl = sprintf(
                 'https://%s/tree/%s/%s/%s',
                 $lockRepo,
                 // if something fails, default to the branch as the closest "sha"
                 $gitSha ?? $lockBranch,
                 $recipe->getName(),
-                $recipeLock['version']
+                $lockVersion
             );
 
             $io->write('<info>installed recipe</info> : '.$recipeUrl);
@@ -202,7 +203,7 @@ private function displayPackageInformation(Recipe $recipe)
             $io->write('<info>latest recipe</info>    : '.$recipe->getURL());
         }
 
-        if ($lockRef !== $recipe->getRef() && isset($recipeLock['version'])) {
+        if ($lockRef !== $recipe->getRef() && null !== $lockVersion) {
             $historyUrl = sprintf(
                 'https://%s/commits/%s/%s',
                 $lockRepo,

src/Configurator/DockerComposeConfigurator.php

@@ -12,7 +12,10 @@
 namespace Symfony\Flex\Configurator;
 
 use Composer\Composer;
+use Composer\Factory;
 use Composer\IO\IOInterface;
+use Composer\Json\JsonFile;
+use Composer\Json\JsonManipulator;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Flex\Lock;
 use Symfony\Flex\Options;
@@ -27,6 +30,8 @@ class DockerComposeConfigurator extends AbstractConfigurator
 {
     private $filesystem;
 
+    public static $configureDockerRecipes = null;
+
     public function __construct(Composer $composer, IOInterface $io, Options $options)
     {
         parent::__construct($composer, $io, $options);
@@ -36,8 +41,7 @@ public function __construct(Composer $composer, IOInterface $io, Options $option
 
     public function configure(Recipe $recipe, $config, Lock $lock, array $options = [])
     {
-        $installDocker = $this->composer->getPackage()->getExtra()['symfony']['docker'] ?? true;
-        if (!$installDocker) {
+        if (!self::shouldConfigureDockerRecipe($this->composer, $this->io, $recipe)) {
             return;
         }
 
@@ -128,6 +132,72 @@ public function unconfigure(Recipe $recipe, $config, Lock $lock)
         $this->write('Docker Compose definitions have been modified. Please run "docker-compose up" again to apply the changes.');
     }
 
+    public static function shouldConfigureDockerRecipe(Composer $composer, IOInterface $io, Recipe $recipe): bool
+    {
+        if (null !== self::$configureDockerRecipes) {
+            return self::$configureDockerRecipes;
+        }
+
+        if (null !== $dockerPreference = $composer->getPackage()->getExtra()['symfony']['docker'] ?? null) {
+            self::$configureDockerRecipes = $dockerPreference;
+
+            return self::$configureDockerRecipes;
+        }
+
+        if ('install' !== $recipe->getJob()) {
+            // default to not configuring
+            return false;
+        }
+
+        $warning = $io->isInteractive() ? 'WARNING' : 'IGNORING';
+        $io->writeError(sprintf('  - <warning> %s </> %s', $warning, $recipe->getFormattedOrigin()));
+        $question = '    The recipe for this package contains some Docker configuration.
+
+    This may create/update <comment>docker-compose.yml</comment> or update <comment>Dockerfile</comment> (if it exists).
+
+    Do you want to include Docker configuration from recipes?
+    [<comment>y</>] Yes
+    [<comment>n</>] No
+    [<comment>p</>] Yes permanently, never ask again for this project
+    [<comment>x</>] No permanently, never ask again for this project
+    (defaults to <comment>y</>): ';
+        $answer = $io->askAndValidate(
+            $question,
+            function ($value) {
+                if (null === $value) {
+                    return 'y';
+                }
+                $value = strtolower($value[0]);
+                if (!\in_array($value, ['y', 'n', 'p', 'x'], true)) {
+                    throw new \InvalidArgumentException('Invalid choice.');
+                }
+
+                return $value;
+            },
+            null,
+            'y'
+        );
+        if ('n' === $answer) {
+            self::$configureDockerRecipes = false;
+
+            return self::$configureDockerRecipes;
+        }
+        if ('y' === $answer) {
+            self::$configureDockerRecipes = true;
+
+            return self::$configureDockerRecipes;
+        }
+
+        // yes or no permanently
+        self::$configureDockerRecipes = 'p' === $answer;
+        $json = new JsonFile(Factory::getComposerFile());
+        $manipulator = new JsonManipulator(file_get_contents($json->getPath()));
+        $manipulator->addSubNode('extra', 'symfony.docker', self::$configureDockerRecipes);
+        file_put_contents($json->getPath(), $manipulator->getContents());
+
+        return self::$configureDockerRecipes;
+    }
+
     /**
      * Normalizes the config and return the name of the main Docker Compose file if applicable.
      */

src/Configurator/DockerfileConfigurator.php

@@ -23,8 +23,7 @@ class DockerfileConfigurator extends AbstractConfigurator
 {
     public function configure(Recipe $recipe, $config, Lock $lock, array $options = [])
     {
-        $installDocker = $this->composer->getPackage()->getExtra()['symfony']['docker'] ?? true;
-        if (!$installDocker) {
+        if (!DockerComposeConfigurator::shouldConfigureDockerRecipe($this->composer, $this->io, $recipe)) {
             return;
         }
 

src/Downloader.php

@@ -29,8 +29,8 @@
 class Downloader
 {
     private const DEFAULT_ENDPOINTS = [
-        'https://api.github.com/repos/symfony/recipes/contents/index.json?ref=flex/main',
-        'https://api.github.com/repos/symfony/recipes-contrib/contents/index.json?ref=flex/main',
+        'https://raw.githubusercontent.com/symfony/recipes/flex/main/index.json',
+        'https://raw.githubusercontent.com/symfony/recipes-contrib/flex/main/index.json',
     ];
     private const MAX_LENGTH = 1000;
 
@@ -271,7 +271,7 @@ private function get(array $urls, bool $isRecipe = false, int $try = 3): array
         $options = [];
 
         foreach ($urls as $url) {
-            $cacheKey = preg_replace('{[^a-z0-9.]}i', '-', $url);
+            $cacheKey = self::generateCacheKey($url);
             $headers = [];
 
             if (preg_match('{^https?://api\.github\.com/}', $url)) {
@@ -300,7 +300,7 @@ private function get(array $urls, bool $isRecipe = false, int $try = 3): array
             foreach ($urls as $url) {
                 $jobs[] = $this->rfs->add($url, $options[$url])->then(function (ComposerResponse $response) use ($url, &$responses) {
                     if (200 === $response->getStatusCode()) {
-                        $cacheKey = preg_replace('{[^a-z0-9.]}i', '-', $url);
+                        $cacheKey = self::generateCacheKey($url);
                         $responses[$url] = $this->parseJson($response->getBody(), $url, $cacheKey, $response->getHeaders())->getBody();
                     }
                 }, function (\Exception $e) use ($url, &$retries) {
@@ -314,7 +314,7 @@ private function get(array $urls, bool $isRecipe = false, int $try = 3): array
             }
             $this->rfs->download($urls, function ($url) use ($options, &$responses, &$retries, &$error) {
                 try {
-                    $cacheKey = preg_replace('{[^a-z0-9.]}i', '-', $url);
+                    $cacheKey = self::generateCacheKey($url);
                     $origin = method_exists($this->rfs, 'getOrigin') ? $this->rfs::getOrigin($url) : parse_url($url, \PHP_URL_HOST);
                     $json = $this->rfs->getContents($origin, $url, false, $options[$url]);
                     if (200 === $this->rfs->findStatusCode($this->rfs->getLastHeaders())) {
@@ -412,4 +412,12 @@ private function initialize()
             $this->endpoints[$endpoint] = $config;
         }
     }
+
+    private static function generateCacheKey(string $url): string
+    {
+        $url = preg_replace('{^https://api.github.com/repos/([^/]++/[^/]++)/contents/}', '$1/', $url);
+        $url = preg_replace('{^https://raw.githubusercontent.com/([^/]++/[^/]++)/}', '$1/', $url);
+
+        return preg_replace('{[^a-z0-9.]}i', '-', $url);
+    }
 }

src/Flex.php

@@ -97,7 +97,6 @@ class Flex implements PluginInterface, EventSubscriberInterface
         'remove' => false,
         'unpack' => true,
     ];
-    private $shouldUpdateComposerLock = false;
     private $filter;
 
     public function activate(Composer $composer, IOInterface $io)
@@ -357,7 +356,7 @@ public function update(Event $event, $operations = [])
         $contents = file_get_contents($file);
         $json = JsonFile::parseJson($contents);
 
-        if (!isset($json['flex-require']) && !isset($json['flex-require'])) {
+        if (!isset($json['flex-require']) && !isset($json['flex-require-dev'])) {
             $this->unpack($event);
 
             return;
@@ -427,10 +426,11 @@ public function install(Event $event)
         $this->io->writeError(sprintf('<info>Symfony operations: %d recipe%s (%s)</>', \count($recipes), \count($recipes) > 1 ? 's' : '', $this->downloader->getSessionId()));
         $installContribs = $this->composer->getPackage()->getExtra()['symfony']['allow-contrib'] ?? false;
         $manifest = null;
+        $originalComposerJsonHash = $this->getComposerJsonHash();
         foreach ($recipes as $recipe) {
             if ('install' === $recipe->getJob() && !$installContribs && $recipe->isContrib()) {
                 $warning = $this->io->isInteractive() ? 'WARNING' : 'IGNORING';
-                $this->io->writeError(sprintf('  - <warning> %s </> %s', $warning, $this->formatOrigin($recipe->getOrigin())));
+                $this->io->writeError(sprintf('  - <warning> %s </> %s', $warning, $recipe->getFormattedOrigin()));
                 $question = sprintf('    The recipe for this package comes from the "contrib" repository, which is open to community contributions.
     Review the recipe at %s
 
@@ -468,13 +468,12 @@ function ($value) {
                     $manipulator = new JsonManipulator(file_get_contents($json->getPath()));
                     $manipulator->addSubNode('extra', 'symfony.allow-contrib', true);
                     file_put_contents($json->getPath(), $manipulator->getContents());
-                    $this->shouldUpdateComposerLock = true;
                 }
             }
 
             switch ($recipe->getJob()) {
                 case 'install':
-                    $this->io->writeError(sprintf('  - Configuring %s', $this->formatOrigin($recipe->getOrigin())));
+                    $this->io->writeError(sprintf('  - Configuring %s', $recipe->getFormattedOrigin()));
                     $this->configurator->install($recipe, $this->lock, [
                         'force' => $event instanceof UpdateEvent && $event->force(),
                     ]);
@@ -491,7 +490,7 @@ function ($value) {
                 case 'update':
                     break;
                 case 'uninstall':
-                    $this->io->writeError(sprintf('  - Unconfiguring %s', $this->formatOrigin($recipe->getOrigin())));
+                    $this->io->writeError(sprintf('  - Unconfiguring %s', $recipe->getFormattedOrigin()));
                     $this->configurator->unconfigure($recipe, $this->lock);
                     break;
             }
@@ -512,7 +511,7 @@ function ($value) {
         $this->synchronizePackageJson($rootDir);
         $this->lock->write();
 
-        if ($this->shouldUpdateComposerLock) {
+        if ($this->getComposerJsonHash() !== $originalComposerJsonHash) {
             $this->updateComposerLock();
         }
     }
@@ -808,16 +807,6 @@ private function initOptions(): Options
         return new Options($options, $this->io);
     }
 
-    private function formatOrigin(string $origin): string
-    {
-        // symfony/translation:3.3@github.com/symfony/recipes:branch
-        if (!preg_match('/^([^:]++):([^@]++)@(.+)$/', $origin, $matches)) {
-            return $origin;
-        }
-
-        return sprintf('<info>%s</> (<comment>>=%s</>): From %s', $matches[1], $matches[2], 'auto-generated recipe' === $matches[3] ? '<comment>'.$matches[3].'</>' : $matches[3]);
-    }
-
     private function shouldRecordOperation(PackageEvent $event): bool
     {
         $operation = $event->getOperation();
@@ -981,4 +970,9 @@ public static function getSubscribedEvents(): array
 
         return $events;
     }
+
+    private function getComposerJsonHash(): string
+    {
+        return md5_file(Factory::getComposerFile());
+    }
 }

src/Options.php

@@ -68,7 +68,7 @@ public function shouldWriteFile(string $file, bool $overwrite): bool
         exec('git status --short --ignored --untracked-files=all -- '.ProcessExecutor::escape($file).' 2>&1', $output, $status);
 
         if (0 !== $status) {
-            return (bool) $this->io && $this->io->askConfirmation(sprintf('Cannot determine the state of the "%s" file, overwrite anyway? [y/N] ', $file), false);
+            return $this->io && $this->io->askConfirmation(sprintf('Cannot determine the state of the "%s" file, overwrite anyway? [y/N] ', $file), false);
         }
 
         if (empty($output[0]) || preg_match('/^[ AMDRCU][ D][ \t]/', $output[0])) {
@@ -78,7 +78,7 @@ public function shouldWriteFile(string $file, bool $overwrite): bool
         $name = basename($file);
         $name = \strlen($output[0]) - \strlen($name) === strrpos($output[0], $name) ? substr($output[0], 3) : $name;
 
-        return (bool) $this->io && $this->io->askConfirmation(sprintf('File "%s" has uncommitted changes, overwrite? [y/N] ', $name), false);
+        return $this->io && $this->io->askConfirmation(sprintf('File "%s" has uncommitted changes, overwrite? [y/N] ', $name), false);
     }
 
     public function toArray(): array

src/Recipe.php

@@ -67,6 +67,20 @@ public function getOrigin(): string
         return $this->data['origin'] ?? '';
     }
 
+    public function getFormattedOrigin(): string
+    {
+        if (!$this->getOrigin()) {
+            return '';
+        }
+
+        // symfony/translation:3.3@github.com/symfony/recipes:branch
+        if (!preg_match('/^([^:]++):([^@]++)@(.+)$/', $this->getOrigin(), $matches)) {
+            return $this->getOrigin();
+        }
+
+        return sprintf('<info>%s</> (<comment>>=%s</>): From %s', $matches[1], $matches[2], 'auto-generated recipe' === $matches[3] ? '<comment>'.$matches[3].'</>' : $matches[3]);
+    }
+
     public function getURL(): string
     {
         if (!$this->data['origin']) {
@@ -99,6 +113,6 @@ public function isAuto(): bool
 
     public function getVersion(): string
     {
-        return $this->lock['version'];
+        return $this->lock['recipe']['version'] ?? $this->lock['version'];
     }
 }