feat(archive): Add is_archived to /projects/{project_pk}/features/

api/features/migrations/0033_auto_20210918_1048.py

@@ -0,0 +1,23 @@
+# Generated by Django 2.2.24 on 2021-09-18 10:48
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("features", "0032_update_feature_type"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="feature",
+            name="is_archived",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="historicalfeature",
+            name="is_archived",
+            field=models.BooleanField(default=False),
+        ),
+    ]

api/features/models.py

@@ -74,10 +74,12 @@ class Feature(CustomLifecycleModelMixin, models.Model):
     type = models.CharField(max_length=50, null=True, blank=True)
     history = HistoricalRecords()
     tags = models.ManyToManyField(Tag, blank=True)
+    is_archived = models.BooleanField(default=False)
 
     class Meta:
         # Note: uniqueness is changed to reference lowercase name in explicit SQL in the migrations
         unique_together = ("name", "project")
+        ordering = ("id",)  # explicit ordering to prevent pagination warnings
 
     @hook(AFTER_CREATE)
     def create_feature_states(self):

api/features/serializers.py

@@ -35,6 +35,7 @@ class Meta:
             "description",
             "tags",
             "multivariate_options",
+            "is_archived",
         )
         read_only_fields = ("feature_segments", "created_date")
 

api/features/tests/test_views.py

@@ -24,7 +24,7 @@
     FeatureStateValue,
 )
 from features.multivariate.models import MultivariateFeatureOption
-from features.value_types import STRING, INTEGER, BOOLEAN
+from features.value_types import BOOLEAN, INTEGER, STRING
 from organisations.models import Organisation, OrganisationRole
 from projects.models import Project
 from projects.tags.models import Tag
@@ -83,6 +83,36 @@ def setUp(self):
             project=self.project2,
         )
 
+    def test_default_is_archived_is_false(self):
+        # Given - set up data
+        data = {
+            "name": "test feature",
+        }
+        url = reverse("api-v1:projects:project-features-list", args=[self.project.id])
+
+        # When
+        response = self.client.post(
+            url, data=json.dumps(data), content_type="application/json"
+        ).json()
+
+        # Then
+        assert response["is_archived"] is False
+
+    def test_update_is_archived_works(self):
+        # Given
+        feature = Feature.objects.create(name="test feature", project=self.project)
+        url = reverse(
+            "api-v1:projects:project-features-detail",
+            args=[self.project.id, feature.id],
+        )
+        data = {"name": "test feature", "is_archived": True}
+
+        # When
+        response = self.client.put(url, data=data).json()
+
+        # Then
+        assert response["is_archived"] is True
+
     def test_should_create_feature_states_when_feature_created(self):
         # Given - set up data
         default_value = "This is a value"
@@ -494,6 +524,27 @@ def test_list_features_return_tags(self):
         feature = response_json["results"][0]
         assert "tags" in feature
 
+    def test_list_features_is_archived_filter(self):
+        # Firstly, let's setup the initial data
+        feature = Feature.objects.create(name="test_feature", project=self.project)
+        archived_feature = Feature.objects.create(
+            name="archived_feature", project=self.project, is_archived=True
+        )
+        base_url = reverse(
+            "api-v1:projects:project-features-list", args=[self.project.id]
+        )
+        # Next, let's test true filter
+        url = f"{base_url}?is_archived=true"
+        response = self.client.get(url)
+        assert len(response.json()["results"]) == 1
+        assert response.json()["results"][0]["id"] == archived_feature.id
+
+        # Finally, let's test false filter
+        url = f"{base_url}?is_archived=false"
+        response = self.client.get(url)
+        assert len(response.json()["results"]) == 1
+        assert response.json()["results"][0]["id"] == feature.id
+
     def test_put_feature_does_not_update_feature_states(self):
         # Given
         feature = Feature.objects.create(

api/features/views.py

@@ -52,6 +52,7 @@
 
 class FeatureViewSet(viewsets.ModelViewSet):
     permission_classes = [IsAuthenticated, FeaturePermissions]
+    filterset_fields = ["is_archived"]
 
     def get_serializer_class(self):
         return {