Allow for no currently selected project

django_project_base/account/middleware.py

@@ -1,49 +1,9 @@
-import json
-
-import swapper
-
 from django.conf import settings
 from django.contrib.sessions.middleware import SessionMiddleware as SessionMiddlewareBase
-from django.utils.functional import SimpleLazyObject
 from rest_framework.authentication import get_authorization_header
 
 
-class ProjectNotSelectedError(NotImplementedError):
-    def __init__(self, message: str, *args: object) -> None:
-        super().__init__(message, *args)
-        self.message = message
-
-
-def selected_project_not_setup():
-    raise ProjectNotSelectedError(
-        """The functionality called requires settings variables that establish currently selected project.
-        Check docs for DJANGO_PROJECT_BASE_BASE_REQUEST_URL_VARIABLES and its "project" setting.
-        The setting needs to be declared and currently selected project passed at least once from the front-end
-        """
-    )
-
-
-def load_selected_project(slug: str):
-    def load():
-        ProjectModel = swapper.load_model("django_project_base", "Project")
-        try:
-            return ProjectModel.objects.prefetch_related("owner").get(slug=slug)
-        except ProjectModel.DoesNotExist:
-            selected_project_not_setup()
-
-    return load
-
-
 class SessionMiddleware(SessionMiddlewareBase):
-    def get_request_params(self, request):
-        if request.method in ["POST", "PUT", "PATCH", "DELETE"]:
-            body_data = json.loads(request.body.decode("utf-8"))
-            if isinstance(body_data, list):
-                return body_data[0]
-            return body_data
-        else:
-            return getattr(request, request.method)
-
     def process_request(self, request):
         auth = get_authorization_header(request).split()
         if auth and auth[0].lower() == b"sessionid":
@@ -54,27 +14,6 @@ def process_request(self, request):
 
         request.session = self.SessionStore(session_key)
 
-        # determine if currently selected project has been passed with the request and set it to session if so
-        # this requires UrlVarsMiddleware to have been installed before this middleware
-        current_project_attr = (
-            getattr(settings, "DJANGO_PROJECT_BASE_BASE_REQUEST_URL_VARIABLES", {})
-            .get("project", {})
-            .get("value_name", None)
-        )
-
-        # also set request.selected_project variables or throw errors on access if conditions not satisfied
-        if current_project_attr:
-            if curr_project_slug := getattr(request, current_project_attr, None):
-                request.session[current_project_attr] = curr_project_slug
-            else:
-                curr_project_slug = request.session.get(current_project_attr, None)
-
-            request.selected_project_slug = curr_project_slug
-            request.selected_project = SimpleLazyObject(load_selected_project(curr_project_slug))
-        else:
-            request.selected_project_slug = SimpleLazyObject(selected_project_not_setup)
-            request.selected_project = SimpleLazyObject(selected_project_not_setup)
-
     def process_response(self, request, response):
         if getattr(response, "returntype", None) == "json":
             process_response = super().process_response(request, response)

django_project_base/account/rest/invite.py

@@ -16,6 +16,8 @@
 
 from django_project_base.base.event import UserInviteFoundEvent
 from django_project_base.base.exceptions import InviteActionNotImplementedException
+from django_project_base.base.fields import ProjectField
+from django_project_base.base.mixins import ProjectMixin
 from django_project_base.base.viewsets import ProjectFilteringViewSet
 from django_project_base.constants import INVITE_NOTIFICATION_TEXT
 from django_project_base.notifications.email_notification import EMailNotificationWithListOfEmails
@@ -45,7 +47,7 @@ def __init__(self, *args, **kw):
         self.allow_blank = True
 
 
-class ProjectUserInviteSerializer(ModelSerializer):
+class ProjectUserInviteSerializer(ProjectMixin, ModelSerializer):
     template_context = dict(url_reverse="project-user-invite")
     form_titles = {
         "table": _("Project invites"),
@@ -62,9 +64,9 @@ class ProjectUserInviteSerializer(ModelSerializer):
 
     id = fields.AutoGeneratedField(display=DisplayMode.HIDDEN)
     invited_by = fields.AutoGeneratedField(display=DisplayMode.HIDDEN)
-    project = fields.PrimaryKeyRelatedField(
-        display=DisplayMode.SUPPRESS,
-        queryset=swapper.load_model("django_project_base", "Project").objects.all(),
+    # Project field is hidden... Because when you invite member to project, project id is always known.
+    project = ProjectField(
+        display=DisplayMode.HIDDEN, queryset=swapper.load_model("django_project_base", "Project").objects.none()
     )
     role = fields.PrimaryKeyRelatedField(
         queryset=swapper.load_model("django_project_base", "Role").objects.all(),

django_project_base/account/rest/profile.py

@@ -37,7 +37,6 @@
 from rest_registration.exceptions import UserNotFound
 
 from django_project_base.account.constants import MERGE_USERS_QS_CK
-from django_project_base.account.middleware import ProjectNotSelectedError
 from django_project_base.account.rest.project_profiles_utils import get_project_members
 from django_project_base.base.event import UserRegisteredEvent
 from django_project_base.base.permissions import IsProjectOwner
@@ -48,7 +47,12 @@
 )
 from django_project_base.notifications.models import DjangoProjectBaseMessage
 from django_project_base.permissions import BasePermissions
-from django_project_base.rest.project import ProjectSerializer, ProjectViewSet
+from django_project_base.project_selection import (
+    get_project_slug_from_session,
+    get_user_projects,
+    ProjectNotSelectedError,
+)
+from django_project_base.rest.project import ProjectSerializer
 from django_project_base.settings import DELETE_PROFILE_TIMEDELTA, USER_CACHE_KEY
 from django_project_base.utils import get_pk_name
 
@@ -460,7 +464,7 @@ def get_current_profile(self, request: Request, **kwargs) -> Response:
             response_data["default_project"] = ProjectSerializer(request.selected_project).data
             cache.set(cache_key, request.selected_project.pk, timeout=None)
         except ProjectNotSelectedError:
-            q = ProjectViewSet._get_queryset_for_request(request)
+            q = get_user_projects(self.request.user)
             # todo this might be a problem if the cache is cleared. then selected project might change for some users as
             #   previously selected project would be forgotten. might have to move this to a table?
             previously_selected_project_pk = cache.get(cache_key)
@@ -638,7 +642,7 @@ def reset_user_data(self, request: Request, **kwargs) -> Response:
     def create(self, request, *args, **kwargs):
         response = super().create(request, *args, **kwargs)
         project = swapper.load_model("django_project_base", "Project").objects.get(
-            slug=getattr(self.request, settings.DJANGO_PROJECT_BASE_BASE_REQUEST_URL_VARIABLES["project"]["value_name"])
+            slug=get_project_slug_from_session(self.request)
         )
         if (
             sett := swapper.load_model("django_project_base", "ProjectSettings")

django_project_base/account/rest/project_profiles.py

@@ -21,9 +21,9 @@
 from rest_framework.utils import model_meta
 
 from django_project_base.account.rest.profile import ProfileSerializer, ProfileViewSet
+from django_project_base.project_selection import ProjectNotSelectedError
 
 from ...base.permissions import is_project_owner, is_superuser, IsProjectOwnerOrMemberReadOnly, project_is_selected
-from ..middleware import ProjectNotSelectedError
 from .project_profiles_utils import filter_project_members_fields, get_project_members
 
 

django_project_base/account/rest/project_profiles_utils.py

@@ -20,7 +20,7 @@
 from dynamicforms import fields
 from rest_framework.request import Request
 
-from django_project_base.account.middleware import ProjectNotSelectedError
+from django_project_base.project_selection import ProjectNotSelectedError
 
 
 def get_project_members(request: Request, project=None) -> QuerySet:

django_project_base/base/event.py

@@ -13,6 +13,7 @@
 from django_project_base.constants import EMAIL_SENDER_ID_SETTING_NAME, SMS_SENDER_ID_SETTING_NAME
 from django_project_base.notifications.email_notification import SystemEMailNotificationWithListOfEmails
 from django_project_base.notifications.models import DjangoProjectBaseMessage
+from django_project_base.project_selection import get_current_project_attr
 
 
 class UserModel:
@@ -105,11 +106,7 @@ def trigger(self, payload=None, **kwargs):
         payload.accepted = datetime.datetime.now()
         payload.save(update_fields=["accepted"])
 
-        if current_project_attr := (
-            getattr(settings, "DJANGO_PROJECT_BASE_BASE_REQUEST_URL_VARIABLES", {})
-            .get("project", {})
-            .get("value_name", None)
-        ):
+        if current_project_attr := get_current_project_attr():
             kwargs["request"].session[current_project_attr] = payload.project.slug
         kwargs["request"].session.pop("invite-pk", None)
 

django_project_base/base/fields.py

@@ -64,3 +64,31 @@ def display_value(self, instance):
             return ""
 
         return str(instance)
+
+
+class ProjectField(df_fields.PrimaryKeyRelatedField):
+    # This class is used for fields that represents project fields.
+    # There is serializer mixin ProjectMixin that shows or hides this field on form/table based on setting
+    # DJANGO_PROJECT_BASE_SELECTED_PROJECT_MODE
+
+    _attr_display_default = False
+    _attr_queryset_default = False
+
+    def __init__(self, **kw):
+        from dynamicforms.mixins import DisplayMode
+
+        from django_project_base.base.models import get_project_model
+
+        if "display" not in kw:
+            kw["display"] = DisplayMode.HIDDEN
+            self._attr_display_default = True
+        if "queryset" not in kw:
+            kw["queryset"] = get_project_model().objects.none()
+            self._attr_queryset_default = True
+
+        super().__init__(**kw)
+
+    def set_field_attrs(self, **kw):
+        for k, v in kw.items():
+            if getattr(self, f"_attr_{k}_default", True):
+                setattr(self, k, v)

django_project_base/base/filter_to_model.py

@@ -29,8 +29,8 @@
 def filter_queryset_to_project(
     queryset: QuerySet, project_field: str = "project", project: "BaseProject" = None
 ) -> QuerySet:
-    from django_project_base.account.middleware import ProjectNotSelectedError
     from django_project_base.base.middleware import get_current_request, has_current_request
+    from django_project_base.project_selection import ProjectNotSelectedError
 
     if not project and has_current_request():
         project = getattr(get_current_request(), "selected_project", None)

django_project_base/base/middleware.py

@@ -21,18 +21,23 @@ def get_parameter(request, value_name: str, url_part: str) -> Optional[object]:
     if value_from_header is not None and value_from_header not in ("", "null"):
         return value_from_header
 
-    path_parts = request.path_info.split("/")
-    if isinstance(url_part, (list, tuple)) and isinstance(url_part[0], int) and isinstance(url_part[1], (list, tuple)):
-        parm = path_parts[url_part[0]] if len(path_parts) > url_part[0] else None
-        return parm if parm not in url_part[1] else None
-
-    try:
-        project_info = next(iter(filter(lambda f: f and url_part in f, path_parts)))
-    except StopIteration:
-        project_info = None
-    if project_info:
-        url_part_len = len(url_part)
-        return project_info[url_part_len:]
+    if url_part:
+        path_parts = request.path_info.split("/")
+        if (
+            isinstance(url_part, (list, tuple))
+            and isinstance(url_part[0], int)
+            and isinstance(url_part[1], (list, tuple))
+        ):
+            parm = path_parts[url_part[0]] if len(path_parts) > url_part[0] else None
+            return parm if parm not in url_part[1] else None
+
+        try:
+            project_info = next(iter(filter(lambda f: f and url_part in f, path_parts)))
+        except StopIteration:
+            project_info = None
+        if project_info:
+            url_part_len = len(url_part)
+            return project_info[url_part_len:]
 
     return None
 
@@ -42,8 +47,12 @@ def __init__(self, get_response):
         self.get_response = get_response
 
     def __call__(self, request):
+        from django_project_base.constants import BASE_REQUEST_URL_VARIABLES_PROJECT_KEY
+
         for value, config in settings.DJANGO_PROJECT_BASE_BASE_REQUEST_URL_VARIABLES.items():
-            if param := get_parameter(request, value, config["url_part"]):
+            if value == BASE_REQUEST_URL_VARIABLES_PROJECT_KEY:
+                continue
+            if param := get_parameter(request, value, config.get("url_part", "")):
                 setattr(request, config["value_name"], param)
 
         _threadmap[threading.get_ident()] = request