attempt moving apis to gw

Author: zkayyali812

ansible_base/feature_flags/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.17 on 2025-03-21 13:04
+# Generated by Django 4.2.17 on 2025-03-26 17:52
 
 import ansible_base.feature_flags.models.aap_flag
 from django.conf import settings
@@ -29,7 +29,6 @@ class Migration(migrations.Migration):
                 ('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)),

ansible_base/feature_flags/models/aap_flag.py

@@ -2,15 +2,17 @@
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
+from ansible_base.activitystream.models import AuditableModel
 from ansible_base.lib.abstract_models.common import NamedCommonModel
+from ansible_base.resource_registry.fields import AnsibleResourceField
 
 
 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 AAPFlag(NamedCommonModel, AuditableModel):
     class Meta:
         app_label = "dab_feature_flags"
         unique_together = ("name", "condition", "value")
@@ -23,6 +25,8 @@ def __str__(self):
             required=" (required)" if self.required else "",
         )
 
+    resource = AnsibleResourceField(primary_key_field="id")
+
     name = models.CharField(
         max_length=64,
         null=False,
@@ -58,7 +62,4 @@ def __str__(self):
         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,36 +1,17 @@
 from flags.state import flag_state
-
-from ansible_base.feature_flags.models import AAPFlag
-from ansible_base.lib.serializers.common import NamedCommonModelSerializer
+from rest_framework import serializers
 
 from .utils import get_django_flags
 
 
-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):
+# TODO: This view and its serializer can be removed after functionality is migrated over to new class
+class FeatureFlagSerializer(serializers.Serializer):
     """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/utils.py

@@ -28,7 +28,6 @@ def update_feature_flag(existing: AAPFlag, new):
 
         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:

ansible_base/feature_flags/views.py

@@ -1,84 +1,27 @@
 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.models import AAPFlag
-from ansible_base.feature_flags.serializers import FeatureFlagSerializer, OldFeatureFlagSerializer
+from ansible_base.feature_flags.serializers import FeatureFlagSerializer
 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, is_boolean_str
+from .utils import get_django_flags
 
 
-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):
+# TODO: This view and its serializer can be removed after functionality is migrated over to new class
+class FeatureFlagsStateListView(AnsibleBaseView):
     """
     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 = OldFeatureFlagSerializer()
+        self.serializer = FeatureFlagSerializer()
         return Response(self.serializer.to_representation())
 
     def get_queryset(self):

ansible_base/lib/dynamic_config/__init__.py

@@ -5,7 +5,6 @@
     load_envvars,
     load_python_file_with_injected_context,
     load_standard_settings_files,
-    toggle_database_feature_flags,
     toggle_feature_flags,
     validate,
 )
@@ -18,6 +17,5 @@
     "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,8 +15,6 @@
 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
 
@@ -317,17 +315,3 @@ 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/dynamic_urls.py

@@ -11,9 +11,8 @@
     globals()[url_type] = []
 
 installed_apps = getattr(settings, 'INSTALLED_APPS', [])
-installed_apps_omit_urls = getattr(settings, 'INSTALLED_APPS_OMIT_URLS', [])
 for app in installed_apps:
-    if app.startswith('ansible_base.') and app not in installed_apps_omit_urls:
+    if app.startswith('ansible_base.'):
         if not importlib.util.find_spec(f'{app}.urls'):
             logger.debug(f'Module {app} does not specify urls.py')
             continue

ansible_base/lib/dynamic_config/feature_flags/platform_flags.py

@@ -3,55 +3,52 @@
 
 class AAPFlagNameSchema(TypedDict):
     name: str
-    support_level: str
+    condition: str
+    value: str
     visibility: str
-    toggle_type: str
+    support_level: str
     description: str
-    version_added: str
     labels: list
+    toggle_type: str
 
 
 AAP_FEATURE_FLAGS: list[AAPFlagNameSchema] = [
     AAPFlagNameSchema(
         name="FEATURE_FEATURE_FLAGS_ENABLED",
         condition="boolean",
-        value=True,
+        value="True",
         visibility="public",
         support_level='READY_FOR_PRODUCTION',
         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.',
-        version_added='2.5',
         labels=['platform'],
         toggle_type='install-time',
     ),
     AAPFlagNameSchema(
         name="FEATURE_INDIRECT_NODE_COUNTING_ENABLED",
         visibility="public",
         condition="boolean",
-        value=False,
+        value="False",
         support_level="NOT_FOR_PRODUCTION",
         description="TBD",
-        version_added="2.5",
         labels=['controller'],
     ),
     AAPFlagNameSchema(
         name="FEATURE_POLICY_AS_CODE_ENABLED",
         visibility="public",
         condition="boolean",
-        value=False,
+        value="False",
         support_level="NOT_FOR_PRODUCTION",
         description="TBD",
-        version_added="2.5",
         labels=['controller'],
     ),
     AAPFlagNameSchema(
         name="FEATURE_EDA_ANALYTICS_ENABLED",
         condition="boolean",
-        value=False,
+        value="False",
         visibility="public",
         support_level="NOT_FOR_PRODUCTION",
         description="TBD",
-        version_added="2.5",
         labels=['eda'],
     ),
 ]

ansible_base/resource_registry/shared_types.py

@@ -75,3 +75,24 @@ class TeamType(SharedResourceTypeSerializer):
         default="",
         allow_blank=True,
     )
+
+
+class FeatureFlagType(SharedResourceTypeSerializer):
+    """Serialize list of feature flags"""
+
+    RESOURCE_TYPE = "feature_flag"
+    UNIQUE_FIELDS = (
+        "name",
+        "condition",
+        "value",
+    )
+
+    name = serializers.CharField()
+    condition = serializers.CharField()
+    value = serializers.CharField()
+    required = serializers.BooleanField()
+    support_level = serializers.CharField()
+    visibility = serializers.CharField()
+    toggle_type = serializers.CharField()
+    description = serializers.CharField()
+    labels = serializers.JSONField()