WIP: Runtime feature flags

Author: zkayyali812

ansible_base/feature_flags/apps.py

@@ -1,8 +1,27 @@
 from django.apps import AppConfig
+from django.db.models.signals import post_migrate
+from django.db.utils import OperationalError, ProgrammingError
+
+from .utils import create_initial_data
 
 
 class FeatureFlagsConfig(AppConfig):
     default_auto_field = 'django.db.models.BigAutoField'
     name = 'ansible_base.feature_flags'
     label = 'dab_feature_flags'
     verbose_name = 'Feature Flags'
+
+    def ready(self):
+        from django.conf import settings
+
+        if 'ansible_base.feature_flags' in settings.INSTALLED_APPS:
+            # TODO: Is there a better way to handle this logic?
+
+            # If migrations are complete, attempt to load in feature flags again.
+            # This can help capture any updates to the platform flags loaded in to ensure that new values
+            # are added and updated.
+            # Otherwise wait for migrations to be complete before loading in feature flags.
+            try:
+                create_initial_data()
+            except (ProgrammingError, OperationalError):
+                post_migrate.connect(create_initial_data)

ansible_base/feature_flags/migrations/0001_initial.py

@@ -0,0 +1,41 @@
+# Generated by Django 4.2.17 on 2025-03-21 13:04
+
+import ansible_base.feature_flags.models.aap_flag
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='AAPFlag',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('modified', models.DateTimeField(auto_now=True, help_text='The date/time this resource was created.')),
+                ('created', models.DateTimeField(auto_now_add=True, help_text='The date/time this resource was created.')),
+                ('name', models.CharField(help_text='The name of the feature flag. Must follow the format of FEATURE_<flag-name>_ENABLED.', max_length=64, validators=[ansible_base.feature_flags.models.aap_flag.validate_feature_flag_name])),
+                ('condition', models.CharField(default='boolean', help_text='Used to specify a condition, which if met, will enable the feature flag.', max_length=64)),
+                ('value', models.CharField(default='True', help_text='The value used to evaluate the conditional specified.', max_length=127)),
+                ('required', models.BooleanField(default=False, help_text="If multiple conditions are required to be met to enable a feature flag, 'required' can be used to specify the necessary conditionals.")),
+                ('support_level', models.CharField(choices=[('NOT_FOR_USE', 'Not for use'), ('NOT_FOR_PRODUCTION', 'Not for production'), ('READY_FOR_PRODUCTION', 'Ready for production')], help_text='The support criteria for the feature flag. Must be one of (NOT_FOR_USE, NOT_FOR_PRODUCTION, READY_FOR_PRODUCTION).', max_length=25)),
+                ('visibility', models.CharField(choices=[('public', 'public'), ('private', 'private')], help_text='The visibility level of the feature flag. If private, flag is hidden.', max_length=20)),
+                ('toggle_type', models.CharField(choices=[('install-time', 'install-time'), ('run-time', 'run-time')], default='run-time', help_text="Details whether a flag is toggle-able at run-time or install-time. (Default: 'run-time').", max_length=20)),
+                ('description', models.CharField(default='', help_text='A detailed description giving an overview of the feature flag.', max_length=300)),
+                ('version_added', models.CharField(help_text='The Ansible Automation Platform version the feature flag was added in.', max_length=30)),
+                ('labels', models.JSONField(blank=True, default=list, help_text='A list of labels for the feature flag.', null=True)),
+                ('created_by', models.ForeignKey(default=None, editable=False, help_text='The user who created this resource.', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='%(app_label)s_%(class)s_created+', to=settings.AUTH_USER_MODEL)),
+                ('modified_by', models.ForeignKey(default=None, editable=False, help_text='The user who last modified this resource.', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='%(app_label)s_%(class)s_modified+', to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'unique_together': {('name', 'condition', 'value')},
+            },
+        ),
+    ]

ansible_base/feature_flags/models/__init__.py

@@ -0,0 +1,3 @@
+from .aap_flag import AAPFlag
+
+__all__ = ('AAPFlag',)

ansible_base/feature_flags/models/aap_flag.py

@@ -0,0 +1,64 @@
+from django.core.exceptions import ValidationError
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from ansible_base.lib.abstract_models.common import NamedCommonModel
+
+
+def validate_feature_flag_name(value: str):
+    if not value.startswith('FEATURE_') or not value.endswith('_ENABLED'):
+        raise ValidationError(_("Feature flag names must follow the format of `FEATURE_<flag-name>_ENABLED`"))
+
+
+class AAPFlag(NamedCommonModel):
+    class Meta:
+        app_label = "dab_feature_flags"
+        unique_together = ("name", "condition", "value")
+
+    def __str__(self):
+        return "{name} is enabled when {condition} is " "{value}{required}".format(
+            name=self.name,
+            condition=self.condition,
+            value=self.value,
+            required=" (required)" if self.required else "",
+        )
+
+    name = models.CharField(
+        max_length=64,
+        null=False,
+        help_text=_("The name of the feature flag. Must follow the format of FEATURE_<flag-name>_ENABLED."),
+        validators=[validate_feature_flag_name],
+        blank=False,
+    )
+    condition = models.CharField(max_length=64, default="boolean", help_text=_("Used to specify a condition, which if met, will enable the feature flag."))
+    value = models.CharField(max_length=127, default="True", help_text=_("The value used to evaluate the conditional specified."))
+    required = models.BooleanField(
+        default=False,
+        help_text=_("If multiple conditions are required to be met to enable a feature flag, 'required' can be used to specify the necessary conditionals."),
+    )
+    support_level = models.CharField(
+        max_length=25,
+        null=False,
+        help_text=_("The support criteria for the feature flag. Must be one of (NOT_FOR_USE, NOT_FOR_PRODUCTION, READY_FOR_PRODUCTION)."),
+        choices=(('NOT_FOR_USE', 'Not for use'), ('NOT_FOR_PRODUCTION', 'Not for production'), ('READY_FOR_PRODUCTION', 'Ready for production')),
+        blank=False,
+    )
+    visibility = models.CharField(
+        max_length=20,
+        null=False,
+        choices=[('public', 'public'), ('private', 'private')],
+        help_text=_("The visibility level of the feature flag. If private, flag is hidden."),
+        blank=False,
+    )
+    toggle_type = models.CharField(
+        max_length=20,
+        null=False,
+        choices=[('install-time', 'install-time'), ('run-time', 'run-time')],
+        default='run-time',
+        help_text=_("Details whether a flag is toggle-able at run-time or install-time. (Default: 'run-time')."),
+    )
+    description = models.CharField(max_length=300, null=False, default="", help_text=_("A detailed description giving an overview of the feature flag."))
+    version_added = models.CharField(
+        max_length=30, null=False, help_text=_("The Ansible Automation Platform version the feature flag was added in."), blank=False
+    )
+    labels = models.JSONField(null=True, default=list, help_text=_("A list of labels for the feature flag."), blank=True)

ansible_base/feature_flags/serializers.py

@@ -1,16 +1,36 @@
 from flags.state import flag_state
-from rest_framework import serializers
+
+from ansible_base.feature_flags.models import AAPFlag
+from ansible_base.lib.serializers.common import NamedCommonModelSerializer
 
 from .utils import get_django_flags
 
 
-class FeatureFlagSerializer(serializers.Serializer):
+class FeatureFlagSerializer(NamedCommonModelSerializer):
+    """Serialize list of feature flags"""
+
+    class Meta:
+        model = AAPFlag
+        fields = NamedCommonModelSerializer.Meta.fields + [x.name for x in AAPFlag._meta.concrete_fields]
+        read_only_fields = ["name", "condition", "required", "support_level", "visibility", "toggle_type", "description", "version_added", "labels"]
+
+    def to_representation(self, instance):
+        ret = super().to_representation(instance)
+        return ret
+
+
+# TODO: Remove once all components are migrated to the new endpont.
+class OldFeatureFlagSerializer(NamedCommonModelSerializer):
     """Serialize list of feature flags"""
 
+    class Meta:
+        model = AAPFlag
+        fields = NamedCommonModelSerializer.Meta.fields + [x.name for x in AAPFlag._meta.concrete_fields]
+        read_only_fields = ["name", "condition", "required", "support_level", "visibility", "toggle_type", "description", "version_added", "labels"]
+
     def to_representation(self) -> dict:
         return_data = {}
         feature_flags = get_django_flags()
         for feature_flag in feature_flags:
             return_data[feature_flag] = flag_state(feature_flag)
-
         return return_data

ansible_base/feature_flags/urls.py

@@ -1,12 +1,18 @@
-from django.urls import path
+from django.urls import include, path
 
 from ansible_base.feature_flags import views
 from ansible_base.feature_flags.apps import FeatureFlagsConfig
+from ansible_base.lib.routers import AssociationResourceRouter
 
 app_name = FeatureFlagsConfig.label
 
-api_version_urls = [
-    path('feature_flags_state/', views.FeatureFlagsStateListView.as_view(), name='feature-flags-state-list'),
-]
+router = AssociationResourceRouter()
+
+router.register(r'feature_flags/states', views.FeatureFlagsStatesView, basename='aap_flags_states')
+
+router.register(r'feature_flags', views.FeatureFlagsView, basename='aap_flags')
+
+# TODO: Remove once all components are migrated to new endpoints.
+api_version_urls = [path('feature_flags_state/', views.OldFeatureFlagsStateListView.as_view(), name='feature-flags-state-list'), path('', include(router.urls))]
 api_urls = []
 root_urls = []

ansible_base/feature_flags/utils.py

@@ -1,5 +1,80 @@
-from django.conf import settings
+from django.apps import apps
+from django.core.exceptions import ValidationError
+from flags.sources import get_flags
+
+from ansible_base.lib.dynamic_config.feature_flags.platform_flags import AAP_FEATURE_FLAGS
 
 
 def get_django_flags():
-    return getattr(settings, 'FLAGS', {})
+    return get_flags()
+
+
+def is_boolean_str(val):
+    return val.lower() in {'true', 'false'}
+
+
+def create_initial_data(**kwargs):
+    """
+    Loads in platform feature flags when the server starts
+    """
+
+    from ansible_base.feature_flags.models.aap_flag import AAPFlag
+
+    def update_feature_flag(existing: AAPFlag, new):
+        """
+        Update only the required fields of the feature flag model.
+        This is used to ensure that flags can be loaded in when the server starts, with any applicable updates.
+        """
+
+        existing.support_level = new['support_level']
+        existing.visibility = new['visibility']
+        existing.version_added = new['version_added']
+        if 'required' in new:
+            existing.required = new['required']
+        if 'toggle_type' in new:
+            existing.toggle_type = new['toggle_type']
+        if 'labels' in new:
+            existing.labels = new['labels']
+        if 'description' in new:
+            existing.description = new['description']
+        existing.save()
+
+    def load_feature_flags():
+        """
+        Loads in all feature flags into the database. Updates them if necessary.
+        """
+        FeatureFlags = apps.get_model('dab_feature_flags', 'AAPFlag')
+        for flag in AAP_FEATURE_FLAGS:
+            try:
+                existing_flag = FeatureFlags.objects.filter(name=flag['name'], condition=flag['condition'])
+                if existing_flag:
+                    update_feature_flag(existing_flag.first(), flag)
+                else:
+                    FeatureFlags.objects.create(**flag)
+                AAPFlag(**flag).full_clean()
+            except ValidationError as e:
+                # Ignore this error unless better way to bypass this
+                if e.messages[0] == 'Aap flag with this Name, Condition and Value already exists.':
+                    pass
+                else:
+                    # Raise row validation errors
+                    raise e
+
+    def delete_feature_flags():
+        """
+        If a feature flag has been removed from the platform flags list, delete it from the database.
+        """
+        all_flags = apps.get_model('dab_feature_flags', 'AAPFlag').objects.all()
+        for flag in all_flags:
+            found = False
+            for _flag in AAP_FEATURE_FLAGS:
+                if flag.name == _flag['name'] and flag.condition == _flag['condition']:
+                    found = True
+                    continue
+            if found:
+                continue
+            if not found:
+                flag.delete()
+
+    delete_feature_flags()
+    load_feature_flags()

ansible_base/feature_flags/views.py

@@ -1,25 +1,84 @@
 from django.conf import settings
+from django.shortcuts import get_object_or_404
 from django.utils.translation import gettext_lazy as _
+from flags.state import flag_enabled, flag_state, get_flags
+from rest_framework import status
 from rest_framework.response import Response
+from rest_framework.viewsets import ModelViewSet
 
-from ansible_base.feature_flags.serializers import FeatureFlagSerializer
+from ansible_base.feature_flags.models import AAPFlag
+from ansible_base.feature_flags.serializers import FeatureFlagSerializer, OldFeatureFlagSerializer
 from ansible_base.lib.utils.views.ansible_base import AnsibleBaseView
+from ansible_base.lib.utils.views.django_app_api import AnsibleBaseDjangoAppApiView
+from ansible_base.lib.utils.views.permissions import IsSuperuserOrAuditor
+from ansible_base.rest_pagination import DefaultPaginator
 
-from .utils import get_django_flags
+from .utils import get_django_flags, is_boolean_str
 
 
-class FeatureFlagsStateListView(AnsibleBaseView):
+class FeatureFlagsStatesView(AnsibleBaseDjangoAppApiView, ModelViewSet):
+    """
+    A view class for displaying feature flags states
+    """
+
+    queryset = AAPFlag.objects.order_by('id')
+    permission_classes = [IsSuperuserOrAuditor]
+    http_method_names = ['get', 'head', 'options']
+
+    def list(self, request):
+        paginator = DefaultPaginator()
+        flags = get_flags()
+        ret = []
+        for flag in flags:
+            ret.append({"flag_name": flag, "flag_state": flag_state(flag)})
+        result_page = paginator.paginate_queryset(ret, request)
+        return paginator.get_paginated_response(result_page)
+
+
+class FeatureFlagsView(AnsibleBaseDjangoAppApiView, ModelViewSet):
     """
     A view class for displaying feature flags
     """
 
+    queryset = AAPFlag.objects.order_by('id')
     serializer_class = FeatureFlagSerializer
+    permission_classes = [IsSuperuserOrAuditor]
+    http_method_names = ['get', 'put', 'head', 'options']
+
+    def update(self, request, **kwargs):
+        _feature_flag = self.get_object()
+        value = request.data.get('value')
+        if not value:
+            return Response(status=status.HTTP_400_BAD_REQUEST, data={"details": "Invalid request object."})
+
+        # Disable runtime toggle if the feature flag feature is not enabled
+        if not flag_enabled('FEATURE_FEATURE_FLAGS_ENABLED'):
+            return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED, data={"details": "Runtime feature flags toggle is not enabled."})
+
+        feature_flag = get_object_or_404(AAPFlag, pk=_feature_flag.id)
+        if feature_flag.toggle_type == 'install-time':
+            return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED, data={"details": "Install-time feature flags cannot be toggled at run-time."})
+        if feature_flag.condition == "boolean" and not is_boolean_str(value):
+            return Response(status=status.HTTP_400_BAD_REQUEST, data={"details": "Feature flag boolean conditional requires using boolean value."})
+        feature_flag.value = value
+        feature_flag.save()
+
+        return Response(self.get_serializer().to_representation(feature_flag))
+
+
+# TODO: This can be removed after functionality is migrated over to new class
+class OldFeatureFlagsStateListView(AnsibleBaseView):
+    """
+    A view class for displaying feature flags
+    """
+
+    serializer_class = OldFeatureFlagSerializer
     filter_backends = []
     name = _('Feature Flags')
     http_method_names = ['get', 'head']
 
     def _get(self, request, format=None):
-        self.serializer = FeatureFlagSerializer()
+        self.serializer = OldFeatureFlagSerializer()
         return Response(self.serializer.to_representation())
 
     def get_queryset(self):

ansible_base/lib/dynamic_config/__init__.py

@@ -5,6 +5,7 @@
     load_envvars,
     load_python_file_with_injected_context,
     load_standard_settings_files,
+    toggle_database_feature_flags,
     toggle_feature_flags,
     validate,
 )
@@ -17,5 +18,6 @@
     "load_python_file_with_injected_context",
     "load_standard_settings_files",
     "toggle_feature_flags",
+    "toggle_database_feature_flags",
     "validate",
 ]