Update DAB PoC

Author: zkayyali812

ansible_base/feature_flags/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.17 on 2025-03-26 17:52
+# Generated by Django 4.2.17 on 2025-04-08 14:36
 
 import ansible_base.feature_flags.models.aap_flag
 from django.conf import settings
@@ -22,13 +22,15 @@ class Migration(migrations.Migration):
                 ('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])),
+                ('ui_name', models.CharField(help_text='The pretty name to display in the application User Interface', max_length=64)),
                 ('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)),
+                ('description', models.CharField(default='', help_text='A detailed description giving an overview of the feature flag.', max_length=500)),
+                ('support_url', models.CharField(blank=True, default='', help_text='A link to the documentation support URL for the feature', max_length=250)),
                 ('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)),

ansible_base/feature_flags/models/aap_flag.py

@@ -25,7 +25,7 @@ def __str__(self):
             required=" (required)" if self.required else "",
         )
 
-    resource = AnsibleResourceField(primary_key_field="id")
+    # resource = AnsibleResourceField(primary_key_field="id")
 
     name = models.CharField(
         max_length=64,
@@ -34,6 +34,12 @@ def __str__(self):
         validators=[validate_feature_flag_name],
         blank=False,
     )
+    ui_name = models.CharField(
+        max_length=64,
+        null=False,
+        blank=False,
+        help_text=_("The pretty name to display in the application User Interface")
+    )
     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(
@@ -61,5 +67,6 @@ def __str__(self):
         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."))
+    description = models.CharField(max_length=500, null=False, default="", help_text=_("A detailed description giving an overview of the feature flag."))
+    support_url = models.CharField(max_length=250, null=False, default="", blank=True, help_text="A link to the documentation support URL for the feature")
     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,17 +1,43 @@
 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
 
 
-# TODO: This view and its serializer can be removed after functionality is migrated over to new class
-class FeatureFlagSerializer(serializers.Serializer):
+class FeatureFlagSerializer(NamedCommonModelSerializer):
+    """Serialize list of feature flags"""
+
+    state = serializers.SerializerMethodField()
+
+    class Meta:
+        model = AAPFlag
+        fields = NamedCommonModelSerializer.Meta.fields + [x.name for x in AAPFlag._meta.concrete_fields] + ['state']
+        read_only_fields = ["name", "condition", "required", "support_level", "visibility", "toggle_type", "description", "labels"]
+
+    def get_state(self, instance):
+        return flag_state(instance.name)
+
+    def to_representation(self, instance):
+        instance.state = True
+        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", "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,17 @@
-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='featureflags-list'),
-]
+router = AssociationResourceRouter()
+
+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='featureflags-list'), path('', include(router.urls))]
+
 api_urls = []
 root_urls = []

ansible_base/feature_flags/utils.py

@@ -28,6 +28,8 @@ def update_feature_flag(existing: AAPFlag, new):
 
         existing.support_level = new['support_level']
         existing.visibility = new['visibility']
+        existing.ui_name = new['ui_name']
+        existing.support_url = new['support_url']
         if 'required' in new:
             existing.required = new['required']
         if 'toggle_type' in new:

ansible_base/feature_flags/views.py

@@ -1,25 +1,64 @@
+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
 
 
-# TODO: This view and its serializer can be removed after functionality is migrated over to new class
-class FeatureFlagsStateListView(AnsibleBaseView):
+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",
 ]

ansible_base/lib/dynamic_config/dynaconf_helpers.py

@@ -15,6 +15,8 @@
 from dynaconf.loaders.yaml_loader import yaml
 from dynaconf.utils.files import glob
 from dynaconf.utils.functional import empty
+from flags.sources import get_flags
+from flags.state import disable_flag, enable_flag
 
 from ansible_base.lib.dynamic_config.settings_logic import get_mergeable_dab_settings
 
@@ -315,3 +317,17 @@ def toggle_feature_flags(settings: Dynaconf) -> dict[str, Any]:
             feature_content[0]["value"] = installer_value
             data[f"FLAGS__{feature_name}"] = feature_content
     return data
+
+
+def toggle_database_feature_flags(settings: Dynaconf) -> dict[str, Any]:
+    """Toggle FLAGS based on installer settings.
+    FLAGS is a django-flags formatted dictionary.
+    Installers will place `FEATURE_SOME_PLATFORM_FLAG_ENABLED=True/False` in the settings file.
+    This function will update the value in the database with the expected boolean value
+    """
+    for feature_name in get_flags():
+        if (installer_value := settings.get(feature_name, empty)) is not empty:
+            if installer_value:
+                enable_flag(feature_name)
+            else:
+                disable_flag(feature_name)

ansible_base/lib/dynamic_config/feature_flags/platform_flags.py

@@ -3,52 +3,63 @@
 
 class AAPFlagNameSchema(TypedDict):
     name: str
+    ui_name: str
     condition: str
     value: str
-    visibility: str
+    required: str
     support_level: str
+    visibility: str
+    toggle_type: str
     description: str
+    support_url: str
     labels: list
-    toggle_type: str
 
 
 AAP_FEATURE_FLAGS: list[AAPFlagNameSchema] = [
     AAPFlagNameSchema(
         name="FEATURE_FEATURE_FLAGS_ENABLED",
+        ui_name="Feature Flags",
         condition="boolean",
         value="True",
-        visibility="public",
         support_level='READY_FOR_PRODUCTION',
+        visibility="public",
+        toggle_type='install-time',
         description='If enabled, feature flags can be toggled on/off at runtime via UI or API. '
         'If disabled, feature flags can only be toggled on/off at install-time.',
+        support_url="",
         labels=['platform'],
-        toggle_type='install-time',
     ),
     AAPFlagNameSchema(
         name="FEATURE_INDIRECT_NODE_COUNTING_ENABLED",
+        ui_name="Indirect Node Counting",
         visibility="public",
         condition="boolean",
         value="False",
         support_level="NOT_FOR_PRODUCTION",
         description="TBD",
+        support_url="https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/",
         labels=['controller'],
     ),
     AAPFlagNameSchema(
         name="FEATURE_POLICY_AS_CODE_ENABLED",
+        ui_name="Policy as Code",
         visibility="public",
         condition="boolean",
         value="False",
         support_level="NOT_FOR_PRODUCTION",
         description="TBD",
+        support_url="https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/",
         labels=['controller'],
     ),
     AAPFlagNameSchema(
         name="FEATURE_EDA_ANALYTICS_ENABLED",
+        ui_name="Event-Driven Ansible Analytics",
         condition="boolean",
         value="False",
         visibility="public",
         support_level="NOT_FOR_PRODUCTION",
         description="TBD",
+        support_url="https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/",
         labels=['eda'],
     ),
 ]