Merge pull request #25 from mapswipe/feature/tutorial-mutations

Feature/tutorial mutations and also includes validate project

Author: tnagorra

.dockerignore

@@ -155,3 +155,5 @@ deploy/eb/
 # Generated by docker on up (only for mypy)
 .mypy-dep/
 .mypy_cache/
+
+rest-media-temp/

.github/workflows/ci.yml

@@ -33,6 +33,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@main
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: '.python-version'
+
       - uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true

.pre-commit-config.yaml

@@ -46,6 +46,11 @@ repos:
       - id: ruff-format
         types_or: [python, pyi, jupyter, toml]
 
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.24.2
+    hooks:
+      - id: gitleaks
+
   - repo: https://github.com/RobertCraigie/pyright-python
     rev: v1.1.398
     hooks:

TODO.md

@@ -0,0 +1,26 @@
+# TODO
+
+## Project and Tutorial
+
+- [ ] Add field validations when attaching tutorial to project
+- [ ] Define relationship between project and tutorial (do we avoid graphs)
+    - Can tutorial.reference_project be equal to project.tutorial
+
+## Base Tutorial
+
+- [ ] Implement validation for state transition
+- [ ] Update Tutorial
+    - [ ] What fields can be updated depending on the state and referenced project?
+- [ ] Archive Tutorial
+    - [ ] Add validation when attaching tutorial that it's published
+    - [ ] Add validation for state transitions
+- [ ] Publish Tutorial
+
+# Base Project
+- [ ] Implement validation for state transition
+- [ ] Update Project
+    - [ ] What fields can be updated depending on the state and attached project?
+
+## Project Types
+- [ ] Implement Validate
+- [ ] Update Completeness to support vector tiles and rendering

apps/common/graphql/dataloaders.py

@@ -1,12 +1,8 @@
-import typing
-
 from django.db import models
 
-DjangoModel = typing.TypeVar("DjangoModel", bound=models.Model)
-
 
 # -- Helper
-def load_model_objects(
+def load_model_objects[DjangoModel: models.Model](
     Model: type[DjangoModel],
     keys: list[int],
 ) -> list[DjangoModel]:

apps/common/graphql/inputs.py

@@ -0,0 +1,17 @@
+import strawberry
+
+
+@strawberry.input
+class UserResourceCreateInputMixin:
+    client_id: str
+
+
+@strawberry.input
+class UserResourceUpdateInputMixin:
+    id: strawberry.ID
+    client_id: str
+
+
+@strawberry.input
+class UserResourceTopLevelUpdateInputMixin:
+    client_id: str

apps/common/graphql/types.py

@@ -8,6 +8,7 @@
 # -- Interfaces
 @strawberry.interface
 class UserResourceTypeMixin:
+    client_id: str
     created_at: datetime.datetime
     modified_at: datetime.datetime
 

apps/common/models.py

@@ -1,15 +1,39 @@
 # pyright: reportUninitializedInstanceVariable=false
 import typing
 
+from django.core.exceptions import ValidationError
 from django.db import models
+from django.utils.translation import gettext
 from django_stubs_ext.db.models import TypedModelMeta
+from ulid import ULID
 
 from apps.user.models import User
 from main.db import Model
 
 
+def validate_ulid(val: str):
+    if val == "":
+        raise ValidationError(
+            gettext("Empty string is not a valid ULID value"),
+        )
+    try:
+        ULID.from_str(val)
+    except (ValueError, TypeError) as e:
+        raise ValidationError(
+            gettext("Not a valid ULID value '%s'") % (val),
+        ) from e
+
+
 # -- Abstracts
 class UserResource(Model):
+    # FIXME(tnagorra): Should users be able to edit this?
+    client_id = models.CharField(
+        null=False,
+        blank=False,
+        unique=True,
+        max_length=26,
+        validators=[validate_ulid],
+    )
     created_at = models.DateTimeField(auto_now_add=True)
     modified_at = models.DateTimeField(auto_now=True)
     created_by = models.ForeignKey(

apps/common/serializers.py

@@ -1,18 +1,46 @@
 import typing
 
+from django.http.request import HttpRequest
+from django.utils.translation import gettext
 from rest_framework import serializers
+from ulid import ULID
 
 from apps.common.models import UserResource
 
-ModelType = typing.TypeVar("ModelType", bound=UserResource)
 
+class DrfContextType(typing.TypedDict):
+    request: HttpRequest
 
-class UserResourceSerializer(serializers.ModelSerializer[ModelType]):
+
+# FIXME(tnagorra): Add support for DrfContextType in __init__
+# Reference: https://github.com/locustio/locust/blob/master/locust/clients.py#L144
+class UserResourceSerializer[ModelType: UserResource, ContextType: DrfContextType = DrfContextType](
+    serializers.ModelSerializer[ModelType],
+):
     modified_at = serializers.DateTimeField(read_only=True)
     modified_by = serializers.PrimaryKeyRelatedField(read_only=True)
+    client_id = serializers.CharField()
 
     instance: ModelType | None  # type: ignore[override]
 
+    def validate_client_id(self, new_client_id: str | None):
+        if new_client_id is None:
+            return None
+
+        try:
+            ULID.from_str(new_client_id)
+            return new_client_id
+        except (ValueError, TypeError) as err:
+            raise serializers.ValidationError(
+                gettext("Not a valid ULID value '%s'") % (new_client_id),
+            ) from err
+
+    @property
+    def context(self) -> ContextType:  # type: ignore[override]
+        context = super().context
+        assert context is not None, f"Always pass context when using {type(self)}"
+        return typing.cast("ContextType", context)
+
     @typing.override
     def create(self, validated_data: dict[str, typing.Any]) -> ModelType:
         if "created_by" in self.Meta.model._meta._forward_fields_map:  # type: ignore[reportAttributeAccessIssue]

apps/common/tasks.py

@@ -14,4 +14,4 @@ def clear_expired_django_sessions():
         if not acquired:
             logger.warning("Clear expired django sessions")
             return
-    management.call_command("clearsessions", verbosity=0, interactive=False)
+    management.call_command("clearsessions", verbosity=0)