[FeatureToggle] Import component from private sources

symfony · Neirda24 · Jul 28, 2023 · Jul 30, 2023 · Sep 7, 2023 · Sep 7, 2023
commit 129043f4e2fb97506ba21a1353d16daf4e4d785c
diff --git a/composer.json b/composer.json
@@ -73,6 +73,7 @@
         "symfony/error-handler": "self.version",
         "symfony/event-dispatcher": "self.version",
         "symfony/expression-language": "self.version",
+        "symfony/feature-toggle": "self.version",
-        "symfony/feature-toggle": "self.version",
+        "symfony/feature-flags": "self.version",
-        "symfony/feature-toggle": "self.version",
+        "symfony/feature-flags": "self.version",
         "symfony/filesystem": "self.version",
         "symfony/finder": "self.version",
         "symfony/form": "self.version",

diff --git a/src/Symfony/Bundle/FeatureToggleBundle/DataCollector/FeatureCheckerDataCollector.php b/src/Symfony/Bundle/FeatureToggleBundle/DataCollector/FeatureCheckerDataCollector.php
@@ -0,0 +1,157 @@
+<?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\Bundle\FeatureToggleBundle\DataCollector;
+
+use Closure;
+use Symfony\Component\FeatureToggle\Feature;
+use Symfony\Component\FeatureToggle\FeatureCollection;
+use Symfony\Component\FeatureToggle\Strategy\StrategyInterface;
+use Symfony\Component\FeatureToggle\StrategyResult;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\DataCollector\DataCollector;
+use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
+use Symfony\Component\VarDumper\Caster\ClassStub;
+use Symfony\Component\VarDumper\Cloner\Data;
+
+/**
+ * @phpstan-type FeatureType array{
+ *     default: bool,
+ *     description: string,
+ *     strategy: StrategyInterface,
+ * }
+ * @phpstan-type ToggleType array{
+ *     feature: string,
+ *     result: bool|null,
+ *     computes: array<string, ComputeType>,
+ * }
+ * @phpstan-type ComputeType array{
+ *     strategyId: string,
+ *     strategyClass: string,
+ *     level: int,
+ *     result: StrategyResult|null,
+ * }
+ *
+ * @property Data|array{
+ *     features: array<string, FeatureType>,
+ *     toggles: array<string, ToggleType>,
+ * } $data
+ */
+final class FeatureCheckerDataCollector extends DataCollector implements LateDataCollectorInterface
+{
+    /** @var \SplStack<string> */
+    private \SplStack $currentToggle;
+
+    /** @var \SplStack<string> */
+    private \SplStack $currentCompute;
+
+    public function __construct(
+        private readonly FeatureCollection $featureCollection,
+    ) {
+        $this->data = ['features' => [], 'toggles' => []];
+        $this->currentToggle = new \SplStack();
+        $this->currentCompute = new \SplStack();
+    }
+
+    public function collect(Request $request, Response $response, \Throwable $exception = null): void
+    {
+        foreach ($this->featureCollection as $feature) {
+            $strategy = (Closure::bind(fn(): StrategyInterface => $this->strategy, $feature, Feature::class))();
+            $default = (Closure::bind(fn(): bool => $this->default, $feature, Feature::class))();
+
+            $this->data['features'][$feature->getName()] = [
+                'default' => $default,
+                'description' => $feature->getDescription(),
+                'strategy' => $strategy,
+            ];
+        }
+    }
+
+    public function collectIsEnabledStart(string $featureName): void
+    {
+        $toggleId = uniqid();
+
+        $this->data['toggles'][$toggleId] = [
+            'feature' => $featureName,
+            'computes' => [],
+            'result' => null,
+        ];
+        $this->currentToggle->push($toggleId);
+    }
+
+    /**
+     * @param class-string $strategyClass
+     */
+    public function collectComputeStart(string $strategyId, string $strategyClass): void
+    {
+        $toggleId = $this->currentToggle->top();
+        $computeId = uniqid();
+        $level = $this->currentCompute->count();
+
+        $this->data['toggles'][$toggleId]['computes'][$computeId] = [
+            'strategyId' => $strategyId,
+            'strategyClass' => new ClassStub($strategyClass),
+            'level' => $level,
+            'result' => null,
+        ];
+        $this->currentCompute->push($computeId);
+    }
+
+    public function collectComputeStop(StrategyResult $result): void
+    {
+        $toggleId = $this->currentToggle->top();
+        $computeId = $this->currentCompute->pop();
+
+        $this->data['toggles'][$toggleId]['computes'][$computeId]['result'] = $result;
+    }
+
+    public function collectIsEnabledStop(bool $result): void
+    {
+        $toggleId = $this->currentToggle->pop();
+
+        $this->data['toggles'][$toggleId]['result'] = $result;
+    }
+
+    public function getName(): string
+    {
+        return 'feature_toggle';
+    }
+
+    public function reset(): void
+    {
+        $this->data = [
+            'features' => [],
+            'toggles' => [],
+        ];
+    }
+
+    public function lateCollect(): void
+    {
+        $this->data = $this->cloneVar($this->data);
+    }
+
+    /**
+     * @return list<FeatureType>|Data
+     */
+    public function getFeatures(): array|Data
+    {
+        return $this->data['features'];
+    }
+
+    /**
+     * @return list<ToggleType>|Data
+     */
+    public function getToggles(): array|Data
+    {
+        return $this->data['toggles'];
+    }
+}
diff --git a/src/Symfony/Bundle/FeatureToggleBundle/DependencyInjection/CompilerPass/DebugPass.php b/src/Symfony/Bundle/FeatureToggleBundle/DependencyInjection/CompilerPass/DebugPass.php
@@ -0,0 +1,47 @@
+<?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\Bundle\FeatureToggleBundle\DependencyInjection\CompilerPass;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\FeatureToggle\Debug\TraceableFeatureChecker;
+use Symfony\Component\FeatureToggle\Debug\TraceableStrategy;
+
+final class DebugPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        if (!$container->has('feature_toggle.data_collector')) {
+            return;
+        }
+
+        $container->register('debug.toggle_feature.feature_checker', TraceableFeatureChecker::class)
+            ->setDecoratedService('toggle_feature.feature_checker')
+            ->setArguments([
+                '$featureChecker' => new Reference('.inner'),
+                '$dataCollector' => new Reference('feature_toggle.data_collector'),
+            ])
+        ;
+
+        foreach ($container->findTaggedServiceIds('feature_toggle.feature_strategy') as $serviceId => $tags) {
+            $container->register('debug.'.$serviceId, TraceableStrategy::class)
+                ->setDecoratedService($serviceId)
+                ->setArguments([
+                    '$strategy' => new Reference('.inner'),
+                    '$strategyId' => $serviceId,
+                    '$dataCollector' => new Reference('feature_toggle.data_collector'),
+                ])
+            ;
+        }
+    }
+}
diff --git a/...ony/Bundle/FeatureToggleBundle/DependencyInjection/CompilerPass/FeatureCollectionPass.php b/...ony/Bundle/FeatureToggleBundle/DependencyInjection/CompilerPass/FeatureCollectionPass.php
@@ -0,0 +1,42 @@
+<?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\Bundle\FeatureToggleBundle\DependencyInjection\CompilerPass;
+
+use Closure;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\FeatureToggle\Provider\ProviderInterface;
+
+final class FeatureCollectionPass implements CompilerPassInterface
+{
+    use PriorityTaggedServiceTrait;
+
+    public function process(ContainerBuilder $container): void
+    {
+        $container->registerForAutoconfiguration(ProviderInterface::class)->addTag('feature_toggle.feature_provider');
+
+        $collection = $container->getDefinition('toggle_feature.feature_collection');
+
+        foreach ($this->findAndSortTaggedServices('feature_toggle.feature_provider', $container) as $provider) {
+            $collectionDefinition = (new Definition(Closure::class))
+                ->setFactory([Closure::class, 'fromCallable'])
+                ->setArguments([[$provider, 'provide']])
+            ;
+
+            $collection
+                ->addMethodCall('withFeatures', [$collectionDefinition])
+            ;
+        }
+    }
+}