AAP-45875 Runtime Feature Flags #736

zkayyali812 · 2025-06-04T12:30:28Z

Description

https://issues.redhat.com/browse/AAP-45875

What is being changed?
This change is the foundation for enabling runtime platform feature flags for AAP. This updates the django-ansible-base to be the central location where all platform flags are defined. Components can inherit the ansible_base.feature_flags application to inherit all platform feature flag definitions.
Why is this change needed?
To enable runtime platform feature flags in AAP.
How does this change address the issue?
This change addresses the issue by defining a database flag source, which contains all the feature flags along with their associated metadata.
These feature flags are installed into each components database at install-time and kept in sync via resource sync (Gateway is the provider)

Before this can be merged, the following should be done -

Confirm expected flag support levels
Confirm each feature flags metadata

Type of Change

New feature (non-breaking change which adds functionality)
Documentation update
Test update

Self-Review Checklist

I have performed a self-review of my code
I have added relevant comments to complex code sections
I have updated documentation where needed
I have considered the security impact of these changes
I have considered performance implications
I have thought about error handling and edge cases
I have tested the changes in my local environment

Testing Instructions

Prerequisites

Steps to Test

Recommend testing this through AAP Dev, but it can be tested directly via the test app as well.

Clone aap-dev
enter aap-dev directory and run make configure-sources
Use this PR for the DAB source
Use this PR for the Gateway source - https://github.com/ansible/aap-gateway/pull/795

Expected Results

AAP Deploys as expected with database feature flags.

Notes

This PR is the prerequisite for the following component PRs -
Gateway - https://github.com/ansible/aap-gateway/pull/795
EDA - ansible/eda-server#1346
Galaxy - ansible/galaxy_ng#2615
AWX - ansible/awx#16030

zkayyali812 · 2025-06-17T13:27:15Z

This PR was reviewed in the DAB PR review meeting, before it can be merged, the remaining tasks are outstanding -
Confirm expected flag support levels
Confirm each feature flags metadata

github-actions · 2025-06-23T21:49:30Z

DVCS PR Check Results:

PR appears valid (JIRA key(s) found)

sonarqubecloud · 2025-06-23T21:58:28Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
96.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

AlanCoding · 2025-06-24T03:44:16Z

Downstream failures, starting to hit the database for references like this in AWX:

  File "/awx_devel/awx/main/tasks/jobs.py", line 976, in build_env
    if flag_enabled("FEATURE_INDIRECT_NODE_COUNTING_ENABLED"):
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

These are probably expected. This is in the job execution path, so that's not too big of a deal.

AlanCoding · 2025-06-24T03:47:27Z

docs/apps/feature_flags.md

@@ -5,55 +5,32 @@ Additional library documentation can be found at https://cfpb.github.io/django-f

 ## Settings

-Add `ansible_base.feature_flags` to your installed apps:
+Add `ansible_base.feature_flags` to your installed apps and ensure `ansible_base.resource_registry` as added to enable flag state to sync across the platform:


Don't you also need to register the flag model in the resource registry config?

Just trying to complete the circle for ability for someone to understand. That should be mentioned here if I understand. Or mention briefly how you're doing that automatically, if that's the case.

AlanCoding · 2025-06-24T03:48:40Z

ansible_base/resource_registry/shared_types.py

+
+
+class FeatureFlagType(SharedResourceTypeSerializer):
+    """Serialize list of feature flags"""


Not really for a list.

AlanCoding · 2025-06-24T03:58:33Z

ansible_base/feature_flags/urls.py

-]
+router = AssociationResourceRouter()
+
+router.register(r'feature_flags/states', views.FeatureFlagsStatesView, basename='aap_flags_states')


The serializer for this has an awfully small number of fields. The model has many more fields. Even the management command gives more information.

Were you intending to add some other endpoint which would give the UI the information necessary to render choices and stuff?

AlanCoding · 2025-06-24T04:00:01Z

ansible_base/feature_flags/utils.py

+
+def delete_feature_flags():
+    """
+    If a feature flag has been removed from the platform flags list, delete it from the database.


Strange between docstring & method name. Maybe it would flow more smoothly if named purge_feature_flags. "delete" makes me expect a flag name as argument.

AlanCoding · 2025-06-24T04:03:06Z

ansible_base/feature_flags/views.py

-class FeatureFlagsStateListView(AnsibleBaseView):
+class FeatureFlagsStatesView(AnsibleBaseDjangoAppApiView, ModelViewSet):
+    """
+    A view class for displaying feature flags states


Might be help to explain where they should go to change them?

Makes sense that this is read-only. But it would be really really helpful to direct users to where they need to be.

AlanCoding

I'm good with the decisions made here, totally ready to 👍 this

Almost all my comments are to improve documentation, very simple things.

I'm just unclear if the API endpoints (views, serializers) are finished. I'm confused about that, in terms of what the UI needs to be delivered with this, what the response looks like, and if that's planned for later or anything.

zkayyali812 force-pushed the phase2/feature-flags/poc branch 3 times, most recently from 3822dfe to 6b72afd Compare June 4, 2025 19:31

zkayyali812 changed the title ~~WIP: Runtime Feature Flags~~ WIP: AAP-45875 Runtime Feature Flags Jun 4, 2025

zkayyali812 force-pushed the phase2/feature-flags/poc branch 21 times, most recently from 081fdcc to f492546 Compare June 11, 2025 19:58

This was referenced Jun 11, 2025

Move to Runtime Platform Flags ansible/eda-server#1346

Open

Move to Runtime Platform Flags ansible/galaxy_ng#2615

Open

Move to Runtime Platform Flags ansible/awx#16030

Open

zkayyali812 force-pushed the phase2/feature-flags/poc branch 2 times, most recently from 3699be8 to 8b6d0bc Compare June 13, 2025 12:21

zkayyali812 requested a review from AlanCoding June 16, 2025 16:02

zkayyali812 added 10 commits June 17, 2025 17:14

WIP: Runtime feature flags

6618c39

attempt moving apis to gw

559a2d6

Update DAB PoC

d5fae1d

Add feature flag management command

0a85f3b

resource-sync

b1d6534

refactor and cleanup code

7057f50

add unit tests

9eb1fcf

Refactor view to gateway

48ad36a

Change flags list to yaml list

25381a6

Add documentation and JSON Schema validation

740140d

zkayyali812 force-pushed the phase2/feature-flags/poc branch 5 times, most recently from fedaa23 to 69f6bbb Compare June 18, 2025 19:58

Adjust feature flag metadata

2ef72a1

zkayyali812 force-pushed the phase2/feature-flags/poc branch from 69f6bbb to 2ef72a1 Compare June 23, 2025 12:48

Fix post-migrate call. Replace with manual migrations

5b7f1f9

zkayyali812 force-pushed the phase2/feature-flags/poc branch from 9860248 to 5b7f1f9 Compare June 23, 2025 21:49

AlanCoding reviewed Jun 24, 2025

View reviewed changes

AlanCoding requested changes Jun 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

AAP-45875 Runtime Feature Flags #736

AAP-45875 Runtime Feature Flags #736

Uh oh!

zkayyali812 commented Jun 4, 2025 •

edited

Loading

Uh oh!

zkayyali812 commented Jun 17, 2025

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

sonarqubecloud bot commented Jun 23, 2025

Uh oh!

AlanCoding commented Jun 24, 2025

Uh oh!

AlanCoding Jun 24, 2025

Uh oh!

AlanCoding Jun 24, 2025

Uh oh!

AlanCoding Jun 24, 2025

Uh oh!

AlanCoding Jun 24, 2025

Uh oh!

AlanCoding Jun 24, 2025

Uh oh!

AlanCoding left a comment

Uh oh!

Uh oh!



		class FeatureFlagType(SharedResourceTypeSerializer):
		"""Serialize list of feature flags"""

AAP-45875 Runtime Feature Flags #736

Are you sure you want to change the base?

AAP-45875 Runtime Feature Flags #736

Uh oh!

Conversation

zkayyali812 commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Self-Review Checklist

Testing Instructions

Prerequisites

Steps to Test

Expected Results

Notes

Uh oh!

zkayyali812 commented Jun 17, 2025

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

sonarqubecloud bot commented Jun 23, 2025

Quality Gate passed

Uh oh!

AlanCoding commented Jun 24, 2025

Uh oh!

AlanCoding Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

AlanCoding Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

AlanCoding Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

AlanCoding Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

AlanCoding Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

AlanCoding left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zkayyali812 commented Jun 4, 2025 •

edited

Loading