[WEB-4100] Unique custom properties UI validation (#3240)

* chore: raise error for adding custom properties with specific keywords

* chore: remove print statement

* fix: duplicate custom properties

* fix: duplicate issue types

* fix: error message

* chore: added ui validation for restricted keywords in issue types

* fix: updated the variable names and refactor

---------

Co-authored-by: sangeethailango <[email protected]>

Author: JayashTripathy

apiserver/plane/ee/serializers/app/issue_property.py

@@ -6,6 +6,10 @@
 from plane.db.models import IssueType
 from plane.ee.models import IssueProperty, IssuePropertyOption, IssuePropertyActivity
 from plane.app.serializers import UserLiteSerializer
+from plane.utils.constants import (
+    RESTRICTED_ISSUE_PROPERTY_DISPLAY_NAMES,
+    RESTRICTED_ISSUE_TYPES,
+)
 
 
 class IssueTypeSerializer(BaseSerializer):
@@ -17,13 +21,23 @@ class Meta:
         fields = "__all__"
         read_only_fields = ["workspace", "project", "is_default", "deleted_at"]
 
+    def validate_name(self, value):
+        if value in RESTRICTED_ISSUE_TYPES:
+            raise serializers.ValidationError(f"Issue type cannot be the {value}")
+        return value
+
 
 class IssuePropertySerializer(BaseSerializer):
     class Meta:
         model = IssueProperty
         fields = "__all__"
         read_only_fields = ["name", "issue_type", "workspace", "deleted_at"]
 
+    def validate_display_name(self, value):
+        if value in RESTRICTED_ISSUE_PROPERTY_DISPLAY_NAMES:
+            raise serializers.ValidationError(f"Display name cannot be the {value}")
+        return value
+
 
 class IssuePropertyOptionSerializer(BaseSerializer):
     class Meta:
@@ -33,8 +47,8 @@ class Meta:
 
 
 class IssuePropertyActivitySerializer(BaseSerializer):
-    actor_detail = UserLiteSerializer(read_only=True, source='actor')
-    
+    actor_detail = UserLiteSerializer(read_only=True, source="actor")
+
     class Meta:
         model = IssuePropertyActivity
         fields = "__all__"

apiserver/plane/ee/views/app/issue_property/base.py

@@ -179,6 +179,19 @@ def post(self, request, slug, project_id, issue_type_id):
             # Get the options
             options = request.data.pop("options", [])
 
+            issue_properties = IssueProperty.objects.filter(
+                workspace__slug=slug,
+                project_id=project_id,
+                issue_type_id=issue_type_id,
+                issue_type__is_epic=False,
+            ).values_list("display_name", flat=True)
+
+            if request.data.get("display_name") in issue_properties:
+                return Response(
+                    {"error": "Custom property with this name already exists"},
+                    status=status.HTTP_400_BAD_REQUEST,
+                )
+
             # Check is_active
             if not request.data.get("is_active"):
                 request.data["is_active"] = False

apiserver/plane/ee/views/app/issue_property/type.py

@@ -102,6 +102,18 @@ def get(self, request, slug, project_id, pk=None):
 
     @check_feature_flag(FeatureFlag.ISSUE_TYPES)
     def post(self, request, slug, project_id):
+        issue_types = IssueType.objects.filter(
+            workspace__slug=slug,
+            project_issue_types__project_id=project_id,
+            is_epic=False,
+        ).values_list("name", flat=True)
+
+        if request.data.get("name") in issue_types:
+            return Response(
+                {"error": "Issue type with this name already exists"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
         # Fetch the project
         project = Project.objects.get(pk=project_id)
         # Create a new issue type
@@ -261,7 +273,9 @@ def post(self, request, slug, project_id):
                 )
                 .annotate(
                     issue_exists=Exists(
-                        Issue.objects.filter(project_id=project_id, type_id=OuterRef("pk"))
+                        Issue.objects.filter(
+                            project_id=project_id, type_id=OuterRef("pk")
+                        )
                     )
                 )
                 .annotate(
@@ -289,9 +303,7 @@ def post(self, request, slug, project_id):
                 "is_epic": work_item_type.is_epic,
             }
             WorkitemTemplate.objects.filter(
-                project_id=project_id,
-                workspace__slug=slug,
-                type__exact={},
+                project_id=project_id, workspace__slug=slug, type__exact={}
             ).update(type=work_item_type_template_schema)
 
             # Serialize the data
@@ -371,9 +383,7 @@ def post(self, request, slug, project_id):
             "is_epic": work_item_type.is_epic,
         }
         WorkitemTemplate.objects.filter(
-            project_id=project_id,
-            workspace__slug=slug,
-            type__exact={},
+            project_id=project_id, workspace__slug=slug, type__exact={}
         ).update(type=work_item_type_template_schema)
 
         # Serialize the data

apiserver/plane/utils/constants.py

@@ -67,3 +67,6 @@
     "oauth",
     "applications",
 ]
+
+RESTRICTED_ISSUE_PROPERTY_DISPLAY_NAMES = ["state", "due date", "cycle", "modules"]
+RESTRICTED_ISSUE_TYPES = ["Task"]

packages/constants/src/work-item-properties.ts

@@ -172,8 +172,7 @@ export const DROPDOWN_ATTRIBUTES: Partial<{
   ],
 };
 
-export const ISSUE_PROPERTY_SETTINGS_CONFIGURATIONS: Partial<TIssuePropertySettingsConfigurationsDetails> =
-{
+export const ISSUE_PROPERTY_SETTINGS_CONFIGURATIONS: Partial<TIssuePropertySettingsConfigurationsDetails> = {
   TEXT: [
     {
       keyToUpdate: ["display_format"],
@@ -227,3 +226,5 @@ export const ISSUE_PROPERTY_SETTINGS_CONFIGURATIONS: Partial<TIssuePropertySetti
     },
   ],
 };
+
+export const RESTRICTED_WORK_ITEM_PROPERTY_DISPLAY_NAMES = ["state", "due date", "cycle", "modules"];

packages/constants/src/work-item-types.ts

@@ -14,3 +14,5 @@ export const DEFAULT_BACKGROUND_COLORS = [
   "#5D407A",
   "#999AA0",
 ];
+
+export const RESTRICTED_WORK_ITEM_TYPES = ["task"];

packages/i18n/src/locales/cs/translations.json

@@ -502,7 +502,6 @@
   "export": "Exportovat",
   "member": "{count, plural, one{# člen} few{# členové} other{# členů}}",
   "new_password_must_be_different_from_old_password": "Nové heslo musí být odlišné od starého hesla",
-
   "project_view": {
     "sort_by": {
       "created_at": "Vytvořeno dne",
@@ -2463,4 +2462,4 @@
     "previously_edited_by": "Dříve upraveno uživatelem",
     "edited_by": "Upraveno uživatelem"
   }
-}
+}

packages/i18n/src/locales/de/translations.json

@@ -504,7 +504,6 @@
   "new_password_must_be_different_from_old_password": "Das neue Passwort muss von dem alten Passwort abweichen",
   "edited": "Bearbeitet",
   "bot": "Bot",
-
   "project_view": {
     "sort_by": {
       "created_at": "Erstellt am",

packages/i18n/src/locales/en/translations.json

@@ -336,8 +336,6 @@
   "new_password_must_be_different_from_old_password": "New password must be different from old password",
   "edited": "edited",
   "bot": "Bot",
-
-
   "project_view": {
     "sort_by": {
       "created_at": "Created at",
@@ -2309,7 +2307,6 @@
     "previously_edited_by": "Previously edited by",
     "edited_by": "Edited by"
   },
-
   "intake_forms": {
     "create": {
       "title": "Create a work item",

packages/i18n/src/locales/id/translations.json

@@ -502,7 +502,6 @@
   "export": "Ekspor",
   "member": "{count, plural, one{# anggota} other{# anggota}}",
   "new_password_must_be_different_from_old_password": "Kata sandi baru harus berbeda dari kata sandi lama",
-
   "project_view": {
     "sort_by": {
       "created_at": "Dibuat pada",
@@ -2457,4 +2456,4 @@
     "previously_edited_by": "Sebelumnya disunting oleh",
     "edited_by": "Disunting oleh"
   }
-}
+}