feat: Import / export of features across environments and orgs

api/features/constants.py

@@ -6,3 +6,14 @@
 # Feature state statuses
 COMMITTED = "COMMITTED"
 DRAFT = "DRAFT"
+
+# Feature import strategies
+SKIP = "SKIP"
+OVERWRITE = "OVERWRITE"
+FEATURE_IMPORT_STRATEGIES = (
+    (SKIP, "Skip"),
+    (OVERWRITE, "Overwrite"),
+)
+
+MAX_FEATURE_EXPORT_SIZE = 1000_000
+MAX_FEATURE_IMPORT_SIZE = MAX_FEATURE_EXPORT_SIZE

api/features/migrations/0061_featureexport.py

@@ -0,0 +1,24 @@
+# Generated by Django 3.2.23 on 2023-11-21 20:01
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('environments', '0032_rename_use_mv_v2_evaluation_to_use_in_percentage_split_evaluation'),
+        ('features', '0060_feature_group_owners'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='FeatureExport',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('data', models.CharField(max_length=1000000)),
+                ('created_date', models.DateTimeField(auto_now_add=True, verbose_name='DateCreated')),
+                ('environment', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='feature_exports', to='environments.environment')),
+            ],
+        ),
+    ]

api/features/migrations/0062_auto_20231121_2028.py

@@ -0,0 +1,30 @@
+# Generated by Django 3.2.23 on 2023-11-21 20:28
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('environments', '0032_rename_use_mv_v2_evaluation_to_use_in_percentage_split_evaluation'),
+        ('features', '0061_featureexport'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='featureexport',
+            name='environment',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='feature_imports', to='environments.environment'),
+        ),
+        migrations.CreateModel(
+            name='FeatureImport',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('strategy', models.CharField(choices=[('SKIP', 'Skip'), ('OVERWRITE', 'Overwrite')], max_length=50)),
+                ('data', models.CharField(max_length=1000000)),
+                ('created_date', models.DateTimeField(auto_now_add=True, verbose_name='DateCreated')),
+                ('environment', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='feature_exports', to='environments.environment')),
+            ],
+        ),
+    ]

api/features/models.py

@@ -48,7 +48,14 @@
 from environments.identities.helpers import (
     get_hashed_percentage_for_object_ids,
 )
-from features.constants import ENVIRONMENT, FEATURE_SEGMENT, IDENTITY
+from features.constants import (
+    ENVIRONMENT,
+    FEATURE_IMPORT_STRATEGIES,
+    FEATURE_SEGMENT,
+    IDENTITY,
+    MAX_FEATURE_EXPORT_SIZE,
+    MAX_FEATURE_IMPORT_SIZE,
+)
 from features.custom_lifecycle import CustomLifecycleModelMixin
 from features.feature_states.models import AbstractBaseFeatureValueModel
 from features.feature_types import MULTIVARIATE, STANDARD
@@ -933,6 +940,8 @@ class FeatureStateValue(
     related_object_type = RelatedObjectType.FEATURE_STATE
     history_record_class_path = "features.models.HistoricalFeatureStateValue"
 
+    # After a FeatureState is created, a FeatureStateValue is
+    # automatically created in a post create hook.
     feature_state = models.OneToOneField(
         FeatureState, related_name="feature_state_value", on_delete=models.CASCADE
     )
@@ -984,3 +993,52 @@ def get_update_log_message(self, history_instance) -> typing.Optional[str]:
 
     def _get_environment(self) -> typing.Optional["Environment"]:
         return self.feature_state.environment
+
+
+class FeatureExport(models.Model):
+    """
+    Stores the representation of an environment's export of
+    features between the request for the export and the
+    ultimate download. Records are deleted automatically after
+    a waiting period.
+    """
+
+    # The environment the export came from.
+    environment = models.ForeignKey(
+        "environments.Environment",
+        related_name="feature_imports",
+        on_delete=models.CASCADE,
+        swappable=True,
+    )
+
+    # This is a JSON string of data used for file download
+    # once the task has completed assembly.
+    data = models.CharField(max_length=MAX_FEATURE_EXPORT_SIZE)
+    created_date = models.DateTimeField("DateCreated", auto_now_add=True)
+
+
+class FeatureImport(models.Model):
+    """
+    Stores the representation of an environment's import of
+    features between upload of a previously exported featureset
+    and the processing of the import. Records are deleted
+    automatically after a waiting period.
+    """
+
+    # The environment the features are being imported to.
+    environment = models.ForeignKey(
+        "environments.Environment",
+        related_name="feature_exports",
+        on_delete=models.CASCADE,
+        swappable=True,
+    )
+    strategy = models.CharField(
+        choices=FEATURE_IMPORT_STRATEGIES,
+        max_length=50,
+        blank=False,
+        null=False,
+    )
+
+    # This is a JSON string of data generated by the export.
+    data = models.CharField(max_length=MAX_FEATURE_IMPORT_SIZE)
+    created_date = models.DateTimeField("DateCreated", auto_now_add=True)

api/features/multivariate/models.py

@@ -31,6 +31,13 @@ class MultivariateFeatureOption(
     AbstractBaseExportableModel,
     abstract_base_auditable_model_factory(["uuid"]),
 ):
+    """
+    This class holds the *value* for a given multivariate feature
+    option. This value is the same for every environment, but the
+    percent allocation is set in MultivariateFeatureStateValue
+    which varies per-environment.
+    """
+
     history_record_class_path = (
         "features.multivariate.models.HistoricalMultivariateFeatureOption"
     )

api/features/permissions.py

@@ -1,6 +1,7 @@
 from contextlib import suppress
 
 from django.shortcuts import get_object_or_404
+from rest_framework.generics import ListAPIView
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.request import Request
 from rest_framework.viewsets import GenericViewSet
@@ -14,7 +15,7 @@
     UPDATE_FEATURE_STATE,
     VIEW_ENVIRONMENT,
 )
-from features.models import Feature, FeatureState
+from features.models import Feature, FeatureExport, FeatureState
 from projects.models import Project
 from projects.permissions import CREATE_FEATURE, DELETE_FEATURE
 from projects.permissions import (
@@ -185,3 +186,46 @@ def has_permission(self, request, view):
             permission=MANAGE_SEGMENT_OVERRIDES,
             environment=environment,
         )
+
+
+class FeatureImportPermissions(IsAuthenticated):
+    def has_permission(
+        self, request: Request, view: "WrappedAPIView"  # noqa: F821
+    ) -> bool:
+        if not super().has_permission(request, view):
+            return False
+
+        environment = Environment.objects.get(id=view.kwargs["environment_id"])
+        return request.user.is_environment_admin(environment)
+
+
+class CreateFeatureExportPermissions(IsAuthenticated):
+    def has_permission(
+        self, request: Request, view: "WrappedAPIView"  # noqa: F821
+    ) -> bool:
+        if not super().has_permission(request, view):
+            return False
+
+        environment = Environment.objects.get(id=request.data["environment_id"])
+        return request.user.is_environment_admin(environment)
+
+
+class DownloadFeatureExportPermissions(IsAuthenticated):
+    def has_permission(
+        self, request: Request, view: "WrappedAPIView"  # noqa: F821
+    ) -> bool:
+        if not super().has_permission(request, view):
+            return False
+
+        feature_export = FeatureExport.objects.get(id=view.kwargs["feature_export_id"])
+
+        return request.user.is_environment_admin(feature_export.environment)
+
+
+class FeatureExportListPermissions(IsAuthenticated):
+    def has_permission(self, request: Request, view: ListAPIView) -> bool:
+        if not super().has_permission(request, view):
+            return False
+
+        project = Project.objects.get(id=view.kwargs["project_id"])
+        return request.user.has_project_permission(VIEW_PROJECT, project)

api/features/serializers.py

@@ -23,7 +23,13 @@
 from .feature_segments.serializers import (
     CreateSegmentOverrideFeatureSegmentSerializer,
 )
-from .models import Feature, FeatureState, FeatureStateValue
+from .models import (
+    Feature,
+    FeatureExport,
+    FeatureImport,
+    FeatureState,
+    FeatureStateValue,
+)
 from .multivariate.serializers import (
     MultivariateFeatureStateValueSerializer,
     NestedMultivariateFeatureOptionSerializer,
@@ -495,3 +501,30 @@ def validate_environment_segment_override_limit(
                     "environment": "The environment has reached the maximum allowed segments overrides limit."
                 }
             )
+
+
+class CreateFeatureExportSerializer(serializers.Serializer):
+    environment_id = serializers.IntegerField(required=True)
+    tag_ids = serializers.ListField(child=serializers.IntegerField())
+
+
+class FeatureExportSerializer(serializers.ModelSerializer):
+    name = serializers.SerializerMethodField()
+
+    class Meta:
+        model = FeatureExport
+        fields = (
+            "id",
+            "name",
+            "environment_id",
+            "created_date",
+        )
+
+    def get_name(self, obj: FeatureExport) -> str:
+        return f"{obj.environment.name} | {obj.created_date.strftime('%Y-%m-%d %H:%M')} UTC"
+
+
+class FeatureImportSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = FeatureImport
+        fields = ("id", "environment_id", "created_date")