File: ConfigFeatureFlagStorage.php

package info (click to toggle)
matomo 5.5.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 73,596 kB
  • sloc: php: 231,041; javascript: 102,286; python: 202; xml: 189; sh: 172; makefile: 20; sql: 10
file content (110 lines) | stat: -rw-r--r-- 2,988 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\FeatureFlags\Storage;

use Exception;
use Piwik\Config;
use Piwik\Plugins\FeatureFlags\FeatureFlagInterface;
use Piwik\Plugins\FeatureFlags\FeatureFlagStorageInterface;

class ConfigFeatureFlagStorage implements FeatureFlagStorageInterface
{
    private const CONFIG_FEATURE_NAME_SUFFIX = '_feature';
    private const CONFIG_FEATURE_ENABLED_VALUE = 'enabled';
    private const CONFIG_FEATURE_DISABLED_VALUE = 'disabled';

    /**
     * @var Config
     */
    private $config;

    /**
     * @internal
     * @param Config $config
     */
    public function __construct(Config $config)
    {
        $this->config = $config;
    }

    /**
     * @internal
     * @param FeatureFlagInterface $feature
     * @return bool|null
     */
    public function isFeatureActive(FeatureFlagInterface $feature): ?bool
    {
        try {
            $featureFlagsConfig = $this->config->FeatureFlags;
        } catch (Exception $e) {
            return false;
        };

        $configNameForFeature = $this->getConfigNameForFeature($feature->getName());

        if (!isset($featureFlagsConfig[$configNameForFeature])) {
            return null;
        }

        $flagValue = $featureFlagsConfig[$configNameForFeature];

        return $flagValue === self::CONFIG_FEATURE_ENABLED_VALUE;
    }

    /**
     * @internal
     * @param FeatureFlagInterface $feature
     * @return void
     */
    public function disableFeatureFlag(FeatureFlagInterface $feature): void
    {
        if (!isset($this->config->FeatureFlags[$this->getConfigNameForFeature($feature->getName())])) {
            return;
        }

        $this->config->FeatureFlags[$this->getConfigNameForFeature($feature->getName())] = self::CONFIG_FEATURE_DISABLED_VALUE;
        $this->config->forceSave();
    }

    /**
     * @internal
     * @param FeatureFlagInterface $feature
     * @return void
     */
    public function enableFeatureFlag(FeatureFlagInterface $feature): void
    {
        if (!isset($this->config->FeatureFlags)) {
            $this->config->FeatureFlags = [];
        }

        $this->config->FeatureFlags[$this->getConfigNameForFeature($feature->getName())] = self::CONFIG_FEATURE_ENABLED_VALUE;
        $this->config->forceSave();
    }

    /**
     * @internal
     * @param string $feature
     * @return void
     */
    public function deleteFeatureFlag(string $featureName): void
    {
        if (!isset($this->config->FeatureFlags[$this->getConfigNameForFeature($featureName)])) {
            return;
        }

        unset($this->config->FeatureFlags[$this->getConfigNameForFeature($featureName)]);
        $this->config->forceSave();
    }

    private function getConfigNameForFeature(string $featureName): string
    {
        return $featureName . self::CONFIG_FEATURE_NAME_SUFFIX;
    }
}