feature symfony#363 Switched project id to be opt-in (fabpot)

fabpot · fabpot · commit 729aee08d62b · 2018-05-02T21:08:56.000+02:00
This PR was squashed before being merged into the 1.0-dev branch (closes symfony#363). Discussion ---------- Switched project id to be opt-in Right now, we generate a unique id for each new project (or if a project does not have one already). But as we are only using it server side for restricting private recipes, let's move to an opt-in way. I didn't do that at first as it means having one more command in the composer command + one thing to do. Commits ------- 255f155 fixed command descriptions a06b229 switched project id to be opt-in
diff --git a/src/Command/FixRecipesCommand.php b/src/Command/FixRecipesCommand.php
@@ -32,8 +32,9 @@ public function __construct(/* cannot be type-hinted */ $flex)
 
     protected function configure()
     {
-        $this->setName('fix-recipes')
-            ->setDescription('Install missing recipes.')
+        $this->setName('symfony:fix-recipes')
+            ->setAliases(['fix-recipes'])
+            ->setDescription('Installs missing recipes.')
         ;
     }
 
diff --git a/src/Command/GenerateIdCommand.php b/src/Command/GenerateIdCommand.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Flex\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class GenerateIdCommand extends Command
+{
+    private $flex;
+
+    public function __construct(/* cannot be type-hinted */ $flex)
+    {
+        $this->flex = $flex;
+
+        parent::__construct();
+    }
+
+    protected function configure()
+    {
+        $this->setName('symfony:generate-id')
+            ->setDescription('Generates a unique ID for this project.')
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $this->flex->generateFlexId();
+    }
+}
diff --git a/src/Command/UnpackCommand.php b/src/Command/UnpackCommand.php
@@ -37,8 +37,9 @@ public function __construct(PackageResolver $resolver)
 
     protected function configure()
     {
-        $this->setName('unpack')
-            ->setDescription('Unpack a Symfony pack.')
+        $this->setName('symfony:unpack')
+            ->setAliases(['unpack'])
+            ->setDescription('Unpacks a Symfony pack.')
             ->setDefinition([
                 new InputArgument('packages', InputArgument::IS_ARRAY | InputArgument::REQUIRED, 'Installed packages to unpack.'),
                 new InputOption('sort-packages', null, InputOption::VALUE_NONE, 'Sorts packages'),
diff --git a/src/Flex.php b/src/Flex.php
@@ -190,6 +190,7 @@ public function activate(Composer $composer, IOInterface $io)
             $app->add(new Command\RemoveCommand($resolver));
             $app->add(new Command\UnpackCommand($resolver));
             $app->add(new Command\FixRecipesCommand($this));
+            $app->add(new Command\GenerateIdCommand($this));
 
             break;
         }
@@ -500,6 +501,20 @@ public function onFileDownload(PreFileDownloadEvent $event)
         }
     }
 
+    public function generateFlexId()
+    {
+        if ($this->getFlexId()) {
+            return;
+        }
+
+        $json = new JsonFile(Factory::getComposerFile());
+        $manipulator = new JsonManipulator(file_get_contents($json->getPath()));
+        $manipulator->addSubNode('extra', 'symfony.id', $this->downloader->get('/ulid')->getBody()['ulid']);
+        file_put_contents($json->getPath(), $manipulator->getContents());
+
+        $this->updateComposerLock();
+    }
+
     private function fetchRecipes(): array
     {
         $devPackages = null;
@@ -568,27 +583,7 @@ private function getFlexId()
     {
         $extra = $this->composer->getPackage()->getExtra();
 
-        // don't want to be registered
-        if (getenv('SYMFONY_SKIP_REGISTRATION') || !isset($extra['symfony']['id'])) {
-            return null;
-        }
-
-        // already registered
-        if ($extra['symfony']['id']) {
-            return $extra['symfony']['id'];
-        }
-
-        // get a new ID
-        $id = $this->downloader->get('/ulid')->getBody()['ulid'];
-
-        // update composer.json
-        $json = new JsonFile(Factory::getComposerFile());
-        $manipulator = new JsonManipulator(file_get_contents($json->getPath()));
-        $manipulator->addSubNode('extra', 'symfony.id', $id);
-        file_put_contents($json->getPath(), $manipulator->getContents());
-        $this->shouldUpdateComposerLock = true;
-
-        return $id;
+        return $extra['symfony']['id'] ?? null;
     }
 
     private function formatOrigin(string $origin): string

Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,9 @@ public function __construct(/* cannot be type-hinted */ $flex)`
`32`	`32`
`33`	`33`	`protected function configure()`
`34`	`34`	`{`
`35`		`- $this->setName('fix-recipes')`
`36`		`- ->setDescription('Install missing recipes.')`
	`35`	`+ $this->setName('symfony:fix-recipes')`
	`36`	`+ ->setAliases(['fix-recipes'])`
	`37`	`+ ->setDescription('Installs missing recipes.')`
`37`	`38`	`;`
`38`	`39`	`}`
`39`	`40`