Integration feedbacks changes

.codeclimate.yml

@@ -0,0 +1,57 @@
+version: "2"
+checks:
+  complex-logic:
+    enabled: true
+    config:
+        threshold: 10
+  file-lines:
+    enabled: true
+    config:
+        threshold: 999
+  method-complexity:
+    enabled: true
+    config:
+        threshold: 12
+  method-count:
+    enabled: true
+    config:
+        threshold: 20
+  method-lines:
+    enabled: true
+    config:
+        threshold: 100
+  nested-control-flow:
+    enabled: true
+    config:
+        threshold: 4
+  return-statements:
+    enabled: true
+    config:
+        threshold: 5
+  argument-count:
+    enabled: false
+  similar-code:
+    enabled: false
+  identical-code:
+    enabled: false
+
+plugins:
+  pep8:
+    enabled: true
+    checks:
+      complexity:
+        enabled: false
+plugins:
+  fixme:
+    enabled: true
+    config:
+      strings:
+      - FIXME
+      - XXX
+
+exclude_patterns:
+- "**/migrations/*"
+- "**/snapshots/*"
+- "**/tests/*"
+- "**/wsgi.py"
+- "manage.py"

.coveragerc

@@ -0,0 +1,25 @@
+[run]
+branch = true
+source = .
+parallel = true
+concurrency = multiprocessing
+omit = */migrations/*
+        */management/*
+        */snaphosts/*
+        sitecustomize.py
+        __init.py__
+        */wsgi.py
+        manage.py
+        .tox/*
+        **/apps.py
+        **/urls.py
+        **/tests.py
+        **/test_*.py
+        export/*
+
+[report]
+show_missing = true
+exclude_lines =
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:

.flake8

@@ -1,5 +1,5 @@
 [flake8]
-extend-ignore = C901, W504
+extend-ignore = C901, W504, E701, E203, W503
 max-line-length = 125
 # NOTE: Update in .pre-commit-config.yaml as well
 extend-exclude = .git,__pycache__,old,build,dist,*/migrations/*.py,legacy/,.venv

.github/workflows/ci.yml

@@ -51,7 +51,7 @@ jobs:
         env:
           DOCKER_IMAGE_BACKEND: ${{ steps.prep.outputs.tagged_image }}
         run: |
-          docker-compose -f ./gh-docker-compose.yml run --rm web bash -c 'wait-for-it db:5432 && ./manage.py graphql_schema --out /ci-share/schema-latest.graphql' &&
+          docker compose -f ./gh-docker-compose.yml run --rm web bash -c 'wait-for-it db:5432 && ./manage.py graphql_schema --out /ci-share/schema-latest.graphql' &&
           cmp --silent schema.graphql ./ci-share/schema-latest.graphql || {
             echo 'The schema.graphql is not up to date with the latest changes. Please update and push latest';
             diff schema.graphql ./ci-share/schema-latest.graphql;
@@ -62,16 +62,16 @@ jobs:
         env:
           DOCKER_IMAGE_BACKEND: ${{ steps.prep.outputs.tagged_image }}
         run: |
-          docker-compose -f ./gh-docker-compose.yml run --rm web bash -c 'wait-for-it db:5432 && ./manage.py makemigrations --check --dry-run' || {
+          docker compose -f ./gh-docker-compose.yml run --rm web bash -c 'wait-for-it db:5432 && ./manage.py makemigrations --check --dry-run' || {
             echo 'There are some changes to be reflected in the migration. Make sure to run makemigrations';
             exit 1;
           }
 
-      # TODO: Run this for CI
-      # - name: 🤞 Run Test 🧪 & Publish coverage to code climate
-      #   env:
-      #     DOCKER_IMAGE_BACKEND: ${{ steps.prep.outputs.tagged_image }}
-      #   run: docker-compose -f gh-docker-compose.yml run --rm web /code/scripts/run_tests.sh
+      - name: 🤞 Run Test 🧪 & Publish coverage to code climate
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CODE_CLIMATE_ID }}
+          DOCKER_IMAGE_BACKEND: ${{ steps.prep.outputs.tagged_image }}
+        run: docker compose -f gh-docker-compose.yml run --rm web /code/scripts/run_tests.sh
 
         # Temp fix
         # https://github.com/docker/build-push-action/blob/master/docs/advanced/cache.md#github-cache

.gitignore

@@ -129,3 +129,5 @@ dmypy.json
 
 # editors
 .idea/
+
+assets/

.pre-commit-config.yaml

@@ -7,7 +7,6 @@ exclude: |
       \.git|
       __pycache__|
       .*snap_test_.*\.py|
-      .+\/.+\/migrations\/.*|
       \.venv
     )
 
@@ -30,6 +29,6 @@ repos:
       - id: flake8
 
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.367
+    rev: v1.1.378
     hooks:
       - id: pyright

Dockerfile

@@ -1,8 +1,8 @@
-FROM python:3.12-slim-bullseye as base
+FROM python:3.12-slim-bullseye
 
 LABEL maintainer="Togglecorp Dev"
 
-ENV PYTHONUNBUFFERED 1
+ENV PYTHONUNBUFFERED=1
 
 WORKDIR /code
 

TODO.md

@@ -0,0 +1 @@
+- MFA: https://django-mfa.readthedocs.io/en/latest/

apps/common/admin.py

@@ -1,14 +1,36 @@
+import typing
+
 from django.contrib import admin
+from django.db import models
+from django.http import HttpRequest
 from reversion.admin import VersionAdmin as OgVersionAdmin
 
-from .models import UserResource
+from .models import Event, UserResource
+
+DjangoModel = typing.TypeVar("DjangoModel", bound=models.Model)
 
 
+# -- Abstracts
 class VersionAdmin(OgVersionAdmin):
     history_latest_first = True
 
 
+class PreventDeleteAdminMixin:
+    def has_delete_permission(self, request, obj=None):
+        return False
+
+
 class UserResourceAdmin(admin.ModelAdmin):
+    def get_list_display(self, request):
+        list_display = super().get_list_display(request)
+        for field in ["created_by", "modified_by"]:
+            if field not in list_display:
+                list_display = [
+                    *list_display,
+                    field,
+                ]
+        return list_display
+
     def get_readonly_fields(self, *args, **kwargs):
         readonly_fields = super().get_readonly_fields(*args, **kwargs)  # type: ignore[reportAttributeAccessIssue]
         return [
@@ -28,7 +50,7 @@ def save_model(self, request, obj, form, change):
         if not change:
             obj.created_by = request.user
         obj.modified_by = request.user
-        return super().save_model(request, obj, form, change)  # type: ignore[reportAttributeAccessIssue]
+        super().save_model(request, obj, form, change)  # type: ignore[reportAttributeAccessIssue]
 
     def save_formset(self, request, form, formset, change):
         if not issubclass(formset.model, UserResource):
@@ -44,6 +66,9 @@ def save_formset(self, request, form, formset, change):
             instance.modified_by = request.user
             instance.save()
 
+    def get_queryset(self, request: HttpRequest) -> models.QuerySet[DjangoModel]:
+        return super().get_queryset(request).select_related("created_by", "modified_by")
+
 
 class UserResourceTabularInline(admin.TabularInline):
     def get_readonly_fields(self, *args, **kwargs):
@@ -60,3 +85,12 @@ def get_readonly_fields(self, *args, **kwargs):
                 ]
             )
         ]
+
+
+# -- Common Models
+@admin.register(Event)
+class EventAdmin(VersionAdmin, UserResourceAdmin):
+    search_fields = ("name",)
+    list_display = ("name", "type", "start_date", "end_date")
+    list_filter = ("type",)
+    ordering = ("start_date",)

apps/common/dataloaders.py

@@ -1,14 +1,70 @@
 import typing
 
+# from asgiref.sync import sync_to_async
 from django.db import models
 
+# import datetime
+
+
+# from apps.common.models import Event
+# from apps.journal.models import Journal
+# from django.utils.functional import cached_property
+# from strawberry.dataloader import DataLoader
+
 DjangoModel = typing.TypeVar("DjangoModel", bound=models.Model)
 
 
+# -- Helper
 def load_model_objects(
     Model: typing.Type[DjangoModel],
     keys: list[int],
 ) -> list[DjangoModel]:
     qs = Model.objects.filter(id__in=keys)
     _map = {obj.pk: obj for obj in qs}
     return [_map[key] for key in keys]
+
+
+# -- Common models dataloaders
+
+# def load_user_last_working_date(keys: list[int]) -> list[datetime.date]:
+#     """
+#     WITH recursive_days AS (
+#         SELECT
+#             DATE_SUB(:input_date, INTERVAL 1 DAY) AS prev_day
+#         UNION ALL
+#         SELECT
+#             DATE_SUB(prev_day, INTERVAL 1 DAY)
+#         FROM recursive_days
+#         WHERE
+#             prev_day NOT IN (
+#                 SELECT
+#                     {Event.date.db_column}
+#                 FROM {Event._meta.db_table}
+#                 WHERE {Event.type.db_column} IN (
+#                     {Event.Type.HOLIDAY.value},
+#                     {Event.Type.RETREAT.value}
+#                 )
+#             )
+#             AND DAYOFWEEK(prev_day) NOT IN (1, 7)  -- 1 = Sunday, 7 = Saturday
+#             AND (
+#                 SELECT COUNT(*) FROM recursive_days
+#             ) < %(NUMBER_OF_WORKING_DAYS_TO_SKIP + 1)s  -- Stop after finding N working days
+#     )
+#     SELECT MIN(prev_day) AS date_before_n_working_days
+#     FROM recursive_days;
+#     """
+
+#     recent_user_leave_dates_qs = (
+#         Journal.as_leave_qs(recent_only=True)
+#         .filter(user__in=keys)
+#         .values_list('user', 'date')
+#     )
+#     print(recent_user_leave_dates_qs)
+#     return load_model_objects(User, keys)
+
+
+class CommonLoader:
+    # @cached_property
+    # def load_user_last_working_date(self):
+    #     return DataLoader(load_fn=sync_to_async(load_user_last_working_date))
+    ...

apps/common/enums.py

@@ -0,0 +1,10 @@
+import strawberry
+
+from utils.strawberry.enums import get_enum_name_from_django_field
+
+from .models import Event
+
+EventTypeEnum = strawberry.enum(Event.Type, name="EventTypeEnum")
+
+
+enum_map = {get_enum_name_from_django_field(field): enum for field, enum in ((Event.type, EventTypeEnum),)}

apps/common/filters.py

@@ -0,0 +1,13 @@
+import strawberry
+import strawberry_django
+
+from .enums import EventTypeEnum
+from .models import Event
+
+
+@strawberry_django.filters.filter(Event, lookups=True)
+class EventFilter:
+    id: strawberry.auto
+    start_date: strawberry.auto
+    end_date: strawberry.auto
+    types: list[EventTypeEnum]  # type: ignore[reportInvalidTypeForm]

apps/common/management/commands/init_development.py

@@ -148,7 +148,7 @@ def get_or_create_contractor(self, creator: User, name: str) -> Contractor:
     def get_or_create_project(self, creator: User, name: str, client: Client, contractor: Contractor) -> Project:
         project, created = Project.objects.get_or_create(
             name=name,
-            client=client,
+            project_client=client,
             contractor=contractor,
             defaults=self.get_user_resource_kwargs(creator),
         )

apps/common/migrations/0001_initial.py

@@ -0,0 +1,49 @@
+# Generated by Django 4.2.15 on 2024-08-23 04:46
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Event",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("modified_at", models.DateTimeField(auto_now=True)),
+                ("name", models.CharField(max_length=225)),
+                ("type", models.PositiveSmallIntegerField(choices=[(1, "Holiday"), (2, "Retreat"), (3, "Misc")], default=1)),
+                ("start_date", models.DateField()),
+                ("end_date", models.DateField()),
+                (
+                    "created_by",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="%(class)s_created",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                (
+                    "modified_by",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="%(class)s_modified",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["-id"],
+                "abstract": False,
+            },
+        ),
+    ]