feat: Import / export of features across environments and orgs

api/app/settings/common.py

@@ -119,6 +119,7 @@
     "environments.identities",
     "environments.identities.traits",
     "features",
+    "features.import_export",
     "features.multivariate",
     "features.versioning",
     "features.workflows.core",

api/features/import_export/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class FeaturesImportExport(AppConfig):
+    name = "features.import_export"
+    label = "features_import_export"

api/features/import_export/constants.py

@@ -0,0 +1,20 @@
+SKIP = "SKIP"
+OVERWRITE_DESTRUCTIVE = "OVERWRITE_DESTRUCTIVE"
+FEATURE_IMPORT_STRATEGIES = (
+    (SKIP, "Skip"),
+    (OVERWRITE_DESTRUCTIVE, "Overwrite Destructive"),
+)
+
+MAX_FEATURE_EXPORT_SIZE = 1000_000
+MAX_FEATURE_IMPORT_SIZE = MAX_FEATURE_EXPORT_SIZE
+
+
+SUCCESS = "SUCCESS"
+PROCESSING = "PROCESSING"
+FAILED = "FAILED"
+
+FEATURE_IMPORT_STATUSES = (
+    (SUCCESS, "Success"),
+    (PROCESSING, "Processing"),
+    (FAILED, "Failed"),
+)

api/features/import_export/migrations/0001_initial.py

@@ -0,0 +1,36 @@
+# Generated by Django 3.2.23 on 2023-11-29 18:44
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('environments', '0033_add_environment_feature_state_version_logic'),
+    ]
+
+    operations = [
+        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_DESTRUCTIVE', 'Overwrite Destructive')], max_length=50)),
+                ('status', models.CharField(choices=[('SUCCESS', 'Success'), ('PROCESSING', 'Processing'), ('FAILED', 'Failed')], default='PROCESSING', max_length=50)),
+                ('data', models.CharField(max_length=1000000)),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('environment', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='feature_exports', to='environments.environment')),
+            ],
+        ),
+        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_at', models.DateTimeField(auto_now_add=True)),
+                ('environment', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='feature_imports', to='environments.environment')),
+            ],
+        ),
+    ]

api/features/import_export/models.py

@@ -0,0 +1,65 @@
+from django.db import models
+
+from features.import_export.constants import (
+    FEATURE_IMPORT_STATUSES,
+    FEATURE_IMPORT_STRATEGIES,
+    MAX_FEATURE_EXPORT_SIZE,
+    MAX_FEATURE_IMPORT_SIZE,
+    PROCESSING,
+)
+
+
+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_at = models.DateTimeField(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,
+    )
+    status = models.CharField(
+        choices=FEATURE_IMPORT_STATUSES,
+        max_length=50,
+        blank=False,
+        null=False,
+        default=PROCESSING,
+    )
+
+    # This is a JSON string of data generated by the export.
+    data = models.CharField(max_length=MAX_FEATURE_IMPORT_SIZE)
+    created_at = models.DateTimeField(auto_now_add=True)

api/features/import_export/permissions.py

@@ -0,0 +1,53 @@
+from rest_framework.generics import ListAPIView
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.request import Request
+
+from environments.models import Environment
+from features.import_export.models import FeatureExport
+from projects.models import Project
+from projects.permissions import VIEW_PROJECT
+
+
+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"])
+        # The user will only see environment feature exports
+        # that the user is an environment admin.
+        return request.user.has_project_permission(VIEW_PROJECT, project)

api/features/import_export/serializers.py

@@ -0,0 +1,61 @@
+from django.core.files.uploadedfile import InMemoryUploadedFile
+from rest_framework import serializers
+from rest_framework.exceptions import ValidationError
+
+from .constants import MAX_FEATURE_IMPORT_SIZE, OVERWRITE_DESTRUCTIVE, SKIP
+from .models import FeatureExport, FeatureImport
+from .tasks import export_features_for_environment
+
+
+class CreateFeatureExportSerializer(serializers.Serializer):
+    environment_id = serializers.IntegerField(required=True)
+    tag_ids = serializers.ListField(child=serializers.IntegerField())
+
+    def save(self) -> None:
+        export_features_for_environment.delay(
+            kwargs={
+                "environment_id": self.validated_data["environment_id"],
+                "tag_ids": self.validated_data["tag_ids"],
+            }
+        )
+
+
+class FeatureExportSerializer(serializers.ModelSerializer):
+    name = serializers.SerializerMethodField()
+
+    class Meta:
+        model = FeatureExport
+        fields = (
+            "id",
+            "name",
+            "environment_id",
+            "created_at",
+        )
+
+    def get_name(self, obj: FeatureExport) -> str:
+        return (
+            f"{obj.environment.name} | {obj.created_at.strftime('%Y-%m-%d %H:%M')} UTC"
+        )
+
+
+def validate_feature_import_file_size(upload_file: InMemoryUploadedFile) -> None:
+    if upload_file.size > MAX_FEATURE_IMPORT_SIZE:
+        raise ValidationError("File size is too large.")
+
+
+class FeatureImportUploadSerializer(serializers.Serializer):
+    file = serializers.FileField(
+        validators=[validate_feature_import_file_size],
+    )
+    strategy = serializers.ChoiceField(choices=[SKIP, OVERWRITE_DESTRUCTIVE])
+
+
+class FeatureImportSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = FeatureImport
+        fields = (
+            "id",
+            "environment_id",
+            "status",
+            "created_at",
+        )