Custom Columns using JSONFields

backend/api/migrations/0005_remove_customfield_custom_fiel_id_b33a4d_idx_and_more.py

@@ -0,0 +1,100 @@
+# Generated by Django 4.2.6 on 2023-10-31 03:06
+
+from django.db import migrations, models
+import api.models.custom_field
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0004_customfield_historicalcustomfield_customfieldvalue_and_more'),
+    ]
+
+    operations = [
+        migrations.RemoveIndex(
+            model_name='customfield',
+            name='custom_fiel_id_b33a4d_idx',
+        ),
+        migrations.RemoveField(
+            model_name='customfield',
+            name='label',
+        ),
+        migrations.RemoveField(
+            model_name='customfield',
+            name='style',
+        ),
+        migrations.RemoveField(
+            model_name='customfield',
+            name='validation',
+        ),
+        migrations.RemoveField(
+            model_name='customfieldvalue',
+            name='value',
+        ),
+        migrations.RemoveField(
+            model_name='historicalcustomfield',
+            name='label',
+        ),
+        migrations.RemoveField(
+            model_name='historicalcustomfield',
+            name='style',
+        ),
+        migrations.RemoveField(
+            model_name='historicalcustomfield',
+            name='validation',
+        ),
+        migrations.AddField(
+            model_name='historicalitem',
+            name='custom_fields',
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='historicaljob',
+            name='custom_fields',
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='historicaltask',
+            name='custom_fields',
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='item',
+            name='custom_fields',
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='job',
+            name='custom_fields',
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='task',
+            name='custom_fields',
+            field=models.JSONField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='customfield',
+            name='field_type',
+            field=models.CharField(choices=[('text', 'Text'), ('number', 'Number'), ('date', 'Date'), ('boolean', 'Boolean'), ('datetime', 'DateTime'), ('time', 'Time')], max_length=50),
+        ),
+        migrations.AlterField(
+            model_name='historicalcustomfield',
+            name='field_type',
+            field=models.CharField(choices=[('text', 'Text'), ('number', 'Number'), ('date', 'Date'), ('boolean', 'Boolean'), ('datetime', 'DateTime'), ('time', 'Time')], max_length=50),
+        ),
+        migrations.AddIndex(
+            model_name='customfield',
+            index=models.Index(fields=['id', 'field_name', 'related_model'], name='custom_fiel_id_0ed23a_idx'),
+        ),
+        migrations.AlterField(
+            model_name='customfield',
+            name='related_model',
+            field=models.CharField(max_length=255, validators=[api.models.custom_field.validate_related_model]),
+        ),
+        migrations.AlterField(
+            model_name='historicalcustomfield',
+            name='related_model',
+            field=models.CharField(max_length=255, validators=[api.models.custom_field.validate_related_model]),
+        ),
+    ]

backend/api/models/custom_field.py

@@ -2,21 +2,28 @@
 from django.db import models
 from django.utils import timezone
 from simple_history.models import HistoricalRecords
+from django.apps import apps
+from django.core.exceptions import ValidationError
+
+def validate_related_model(value):
+    try:
+        apps.get_model('api', value)
+    except LookupError:
+        raise ValidationError(f"'{value}' is not a valid model in the app.") 
 
 class CustomField(models.Model):
     FIELD_TYPES = [
         ("text", "Text"),
         ("number", "Number"),
         ("date", "Date"),
         ("boolean", "Boolean"),
+        ("datetime", "DateTime"),
+        ("time", "Time"),
     ]
 
     field_name = models.CharField(max_length=255)
     field_type = models.CharField(max_length=50, choices=FIELD_TYPES)
-    related_model = models.CharField(max_length=255)
-    label = models.CharField(max_length=255, null=True, blank=True)
-    validation = models.JSONField(null=True, blank=True)
-    style = models.JSONField(null=True, blank=True)
+    related_model = models.CharField(max_length=255, validators= [validate_related_model])
 
      # Metadata
     created_at = models.DateTimeField(default=timezone.now)
@@ -42,4 +49,4 @@ def __str__(self):
 
     class Meta:
         db_table = "custom_fields"
-        indexes = [models.Index(fields=["id", "field_name"])]
+        indexes = [models.Index(fields=["id", "field_name", "related_model"])]

backend/api/models/item.py

@@ -9,6 +9,7 @@
 class Item(models.Model):
     name = models.CharField(max_length=100)
     description = models.TextField(blank=True, null=True)
+    custom_fields = models.JSONField(blank=True, null=True)
 
     # Metadata
     created_at = models.DateTimeField(default=timezone.now)

backend/api/models/job.py

@@ -23,6 +23,7 @@ class Job(OrderedModelBase):
     job_status = models.ForeignKey(JobStatus, on_delete=models.DO_NOTHING)
     job_type = models.ForeignKey(JobType, on_delete=models.DO_NOTHING)
     dependencies = models.ManyToManyField("Dependency", related_name="jobs")
+    custom_fields = models.JSONField(blank=True, null=True)
 
     # Metadata
     created_at = models.DateTimeField(default=timezone.now)

backend/api/models/task.py

@@ -37,6 +37,7 @@ class Task(models.Model):
     planned_start_datetime = models.DateTimeField(blank=True, null=True)
     planned_end_datetime = models.DateTimeField(blank=True, null=True)
     dependencies = models.ManyToManyField("Dependency", related_name="tasks")
+    custom_fields = models.JSONField(blank=True, null=True)
 
     # Metadata
     created_at = models.DateTimeField(default=timezone.now)

backend/api/schemas/base.py

@@ -1,9 +1,10 @@
 # schemas.py
 
-from typing import List
+from typing import List, Optional
 
 from ninja import ModelSchema
 from pydantic.fields import Field
+from api.utils.generate_custom_schema import generate_custom_field_schema
 
 from api.models import (
     CustomField,
@@ -75,6 +76,7 @@ class JobBaseOut(ModelSchema):
     job_type: JobTypeOut
     task_ids: List[int] = Field([], alias="task_id_list")
     dependency_ids: List[int] = Field([], alias="dependency_id_list")
+    custom_fields: Optional[generate_custom_field_schema(model_name= 'Job', class_suffix= 'Job')]
 
     class Config:
         model = Job
@@ -118,6 +120,7 @@ class TaskBaseOut(ModelSchema):
     predecessor_ids: List[int] = Field([], alias="predecessor_id_list")
     successor_ids: List[int] = Field([], alias="successor_id_list")
     dependency_ids: List[int] = Field([], alias="dependency_id_list")
+    custom_fields: Optional[generate_custom_field_schema(model_name= 'Task', class_suffix= 'Task')]
 
     class Config:
         model = Task

backend/api/schemas/custom_field.py

@@ -10,11 +10,11 @@ class FieldType(str, Enum):
     NUMBER = "number"
     DATE = "date"
     BOOLEAN = "boolean"
+    DATETIME = "datetime"
+    TIME = "time"
 
 class CustomFieldIn(ModelSchema):
     field_type : FieldType
-    label : Optional[str]
-
     class Config:
         model = CustomField
         model_fields = [

backend/api/schemas/item.py

@@ -4,14 +4,17 @@
 from ninja import ModelSchema, Schema
 
 from api.models import Item
+from api.utils.generate_custom_schema  import generate_custom_field_schema
 
 
 class ItemIn(Schema):
     name: str
     description: Optional[str] = None
+    custom_fields: Optional[generate_custom_field_schema(model_name= 'Item', class_suffix= 'Item')]
 
 
 class ItemOut(ModelSchema):
+    custom_fields: Optional[generate_custom_field_schema(model_name= 'Item', class_suffix= 'Item')]
     class Config:
         model = Item
         model_fields = "__all__"

backend/api/schemas/job.py

@@ -1,11 +1,12 @@
 # schemas.py
-from typing import List
+from typing import List, Optional
 
 from ninja import ModelSchema
 from pydantic import Field
 
 from api.models import Job
 from api.schemas.base import DependencyBaseOut, JobBaseOut, TaskBaseOut
+from api.utils.generate_custom_schema import generate_custom_field_schema
 
 
 class JobIn(ModelSchema):
@@ -14,6 +15,7 @@ class JobIn(ModelSchema):
     dependency_ids: List[int] = Field(default=[])
     task_ids: List[int] = Field(default=[])
     order: int = Field(None, alias="priority")
+    custom_fields: Optional[generate_custom_field_schema(model_name= 'Job', class_suffix= 'Job')]
 
     class Config:
         model = Job

backend/api/schemas/task.py

@@ -1,11 +1,12 @@
 # schemas.py
-from typing import List
+from typing import List, Optional
 
 from ninja import ModelSchema
 from pydantic import Field
 
 from api.models import Task
 from api.schemas.base import DependencyBaseOut, TaskBaseOut
+from api.utils.generate_custom_schema import generate_custom_field_schema
 
 
 class TaskIn(ModelSchema):
@@ -17,6 +18,7 @@ class TaskIn(ModelSchema):
     predecessor_ids: List[int] = Field(default=[])
     successor_ids: List[int] = Field(default=[])
     dependency_ids: List[int] = Field(default=[])
+    custom_fields: Optional[generate_custom_field_schema(model_name= 'Task', class_suffix= 'Task')]
 
     class Config:
         model = Task

backend/api/tests/factories.py

@@ -13,6 +13,7 @@ class JobFactory(ModelFactory[JobIn]):
     priority = 1
     dependency_ids = []
     task_ids = []
+    custom_fields = {}
 
 
 class UserFactory(ModelFactory[UserIn]):

backend/api/tests/test_custom_field.py

@@ -0,0 +1,46 @@
+import json
+import pytest
+
+# Test params
+test_params = [
+    ({
+        "field_name": "cust_item_first_part",
+        "related_model": "Item",
+        "field_type": ["text", "number", "date", "boolean", "datetime", "time"]
+    }, 201),
+
+    ({
+        "field_name": "cust_item_first_part",
+        "related_model": "NonExistentModel",
+        "field_type": ["text"]
+    }, 400),
+
+    ({
+        "field_name": "cust_item_first_part",
+        "related_model": "Item",
+        "field_type": ["float"]  # This should fail
+    }, 400),
+]
+
+
+@pytest.mark.django_db
+@pytest.mark.parametrize(
+    'input, expected_status_code',
+    test_params
+)
+def test_create_customfields(api_client, input: dict, expected_status_code):
+    for type in input.get('field_type'):
+        cf_data = input
+        cf_data['field_type'] = type
+
+        response = api_client.post(
+            "/api/custom-fields/",
+            json.dumps(cf_data),
+            content_type="application/json"
+        )
+        assert response.status_code == expected_status_code
+\
+@pytest.mark.django_db
+def test_get_customfields(api_client):
+    response = api_client.get("/api/custom-fields/")
+    assert response.status_code == 200

backend/api/tests/test_user.py

@@ -2,6 +2,7 @@
 
 import pytest
 
+
 from api.tests.factories import UserCreateFactory, UserFactory
 
 
@@ -81,5 +82,4 @@ def test_update_user_password(api_client, test_update_password_data):
 @pytest.mark.django_db
 def test_get_current_user(api_client):
     response = api_client.get("/api/users/me/")
-
     assert response.status_code == 200