Référence de la configuration

Tout ce qui se trouve sous la clé phil_feature_flags, tel que le déclare PhilFeatureFlagsBundle::configure(), et ce que chaque option branche. Lancez bin/console config:dump-reference phil_feature_flags pour voir l'arbre tel que Symfony l'affiche.

Exemple annoté

# config/packages/phil_feature_flags.yaml
phil_feature_flags:
    # Service id of the resolver of the evaluation context of a request.
    # Default: the service id `Phil\FeatureFlagsBundle\Application\Flag\EvaluationContextResolver`.
    # `phil_feature_flags.context_resolver.anonymous` gives every request an empty context.
    context_resolver: App\Flags\RequestContextResolver

    # The database store. Off by default; `doctrine: true` or any map turns it on.
    doctrine:
        connection: default            # DBAL connection name; default "default"

    # Provider service ids, in order of precedence. Default: the configuration provider, then the
    # database store when `doctrine` is enabled.
    providers:
        - phil_feature_flags.provider.configuration
        - phil_feature_flags.provider.doctrine

    # Service id of the store of active states. Default: the database store when enabled, otherwise none.
    state_store: phil_feature_flags.state_store.doctrine

    # Service id of the store the admin creates and edits flags in. Default: the database store when enabled.
    definition_store: phil_feature_flags.provider.doctrine

    # Service id of the recorder of A/B exposures. Default: none.
    exposure_recorder: App\Flags\ExposureCounter

    # The audited toggle and edit. Off by default; any map turns it on.
    toggle:
        authorizer: App\Flags\PermissionAuthorizer   # default: the ToggleAuthorizer interface id
        auditor: App\Flags\AuditTrailAuditor         # default: the ToggleAuditor interface id

    # The admin screens. Off by default; any map turns them on. They need `toggle`.
    admin:
        actor_provider: App\Flags\OperatorProvider   # default: the ActorProvider interface id
        layout: 'admin/layout.html.twig'             # default: '@PhilFeatureFlags/admin/layout.html.twig'

    # Service id of the PSR-20 clock. Default: "clock".
    clock: clock

    # The flags of the configuration provider, by name.
    flags:
        new-checkout:
            active: true
            rules:
                - { attribute: tenant, members: [tenant-a, tenant-b] }
                - { attribute: tenant, percentage: 20 }
            description: The one-page checkout.
            owner: checkout-team
            kind: release
            expires_on: '2027-03-31'
        checkout-layout:
            active: true
            experiment:
                attribute: tenant
                variants: { one-column: 50, two-columns: 50 }
            kind: experiment
        search.v2: false               # short for { active: false }
        maintenance-banner: true       # short for { active: true }: on for everyone

Clés

context_resolver

La valeur par défaut est le nom de l'interface : l'application enregistre donc un service sous cet identifiant (un alias d'autowiring suffit) ou nomme le sien. phil_feature_flags.context_resolver.anonymous (AnonymousContextResolver) est toujours enregistré : chaque contexte est vide, donc un indicateur avec des règles ou une expérience est désactivé pour tout le monde, et seuls les indicateurs sans règles sont activés. Voyez flags-and-evaluation.md.

doctrine

Lorsqu'il est activé, le bundle enregistre :

• phil_feature_flags.provider.doctrine : DoctrineFlagDefinitions, avec l'étiquette kernel.reset, un fournisseur et le magasin de définitions modifiable ;
• phil_feature_flags.state_store.doctrine : DoctrineFlagStore, avec l'étiquette kernel.reset, le magasin modifiable des états actifs ;
• FlagSchemaListener, avec l'étiquette doctrine.event_listener sur postGenerateSchema pour cette connexion.

Il change aussi les valeurs par défaut de providers, state_store et definition_store. Voyez database-store.md.

providers

Le premier fournisseur qui connaît un indicateur donne sa définition entière ; une liste vide signifie la valeur par défaut. Le catalogue indexe les fournisseurs par leur identifiant de service, ce que la liste et l'administration affichent comme Source. Chaque service implémente FlagProvider ; implémentez EnumerableFlagProvider pour apparaître dans la liste. Nommer phil_feature_flags.provider.doctrine sans activer doctrine fait échouer la compilation du conteneur pour service manquant. Si vous omettez phil_feature_flags.provider.configuration, les flags de la configuration ne sont jamais lus (le fournisseur reste enregistré).

state_store

Sans toggle, n'importe quel FlagStateSource convient. Avec toggle, ce doit être un WritableFlagStore.

definition_store

L'administration n'affiche le lien de modification que pour les indicateurs dont la source dans le catalogue est exactement cet identifiant de service : le magasin de définitions devrait donc aussi faire partie des providers.

exposure_recorder

Voyez experiments.md.

toggle

Enregistre FlagToggler (autorisateur, magasin d'états, auditeur, horloge, FlagCatalog) et, lorsque definition_store est défini, FlagEditor (autorisateur, magasin de définitions, magasin d'états, auditeur, horloge, FlagCatalog). Voyez toggles-and-edits.md.

admin

Le contrôleur reçoit aussi les services twig et router. Les routes ne sont pas chargées automatiquement : importez @PhilFeatureFlagsBundle/config/routes/admin.php (installation.md, admin.md).

clock

flags

Une table de nom d'indicateur vers définition, lue par ConfiguredFlagProvider (service phil_feature_flags.provider.configuration). Les clés ne sont pas normalisées : les tirets restent des tirets.

Les noms de variante suivent l'alphabet des noms d'indicateur, au plus 50 octets. Un indicateur nommé circuit-open.<key> n'accepte ni règle ni expérience. Voyez targeting.md, experiments.md et metadata-and-expiry.md.

Pour chaque circuit déclaré à phil/circuit-breaker-bundle, le fournisseur de configuration déclare aussi circuit-open.<key>, inactif, sans règles, de genre ops, avec la description Forces the circuit "<key>" open., sauf si flags déclare lui-même ce nom. Voyez circuit-breakers.md.

Services enregistrés dans toute configuration

Les services conditionnels sont listés avec leur option ci-dessus ; l'inventaire complet se trouve dans extension-points.md. Tous les services sont privés sauf FlagAdminController ; ceux qui portent le nom d'une classe peuvent être injectés automatiquement par type.

Validation à la construction

Chaque indicateur est analysé pendant la construction du conteneur : une entrée mal formée fait donc échouer cache:clear plutôt que la première requête. Les erreurs sont des InvalidConfigurationException :

L'arbre de configuration de Symfony ajoute ses propres erreurs avant celles-ci (un attribute manquant dans une règle, un percentage non entier, une chaîne vide là où cannotBeEmpty() s'applique). Un identifiant de service qui n'existe pas est signalé par le compilateur du conteneur, pas par le bundle.