[Feature] - Adding Stickies reordering feature (Issue #8488)

apps/admin/react-router.config.ts

@@ -1,7 +1,12 @@
 import type { Config } from "@react-router/dev/config";
-import { joinUrlPath } from "@plane/utils";
 
-const basePath = joinUrlPath(process.env.VITE_ADMIN_BASE_PATH ?? "", "/") ?? "/";
+const normalizeBasePath = (value: string): string => {
+  const trimmed = value.trim();
+  if (!trimmed || trimmed === "/") return "/";
+  return `/${trimmed.replace(/^\/+|\/+$/g, "")}/`;
+};
+
+const basePath = normalizeBasePath(process.env.VITE_ADMIN_BASE_PATH ?? "");
 
 export default {
   appDirectory: "app",

apps/admin/vite.config.ts

@@ -3,7 +3,12 @@ import * as dotenv from "@dotenvx/dotenvx";
 import { reactRouter } from "@react-router/dev/vite";
 import { defineConfig } from "vite";
 import tsconfigPaths from "vite-tsconfig-paths";
-import { joinUrlPath } from "@plane/utils";
+
+const normalizeBasePath = (value: string): string => {
+  const trimmed = value.trim();
+  if (!trimmed || trimmed === "/") return "/";
+  return `/${trimmed.replace(/^\/+|\/+$/g, "")}/`;
+};
 
 dotenv.config({ path: path.resolve(__dirname, ".env") });
 
@@ -15,7 +20,7 @@ const viteEnv = Object.keys(process.env)
     return a;
   }, {});
 
-const basePath = joinUrlPath(process.env.VITE_ADMIN_BASE_PATH ?? "", "/") ?? "/";
+const basePath = normalizeBasePath(process.env.VITE_ADMIN_BASE_PATH ?? "");
 
 export default defineConfig(() => ({
   base: basePath,

apps/api/plane/api/views/sticky.py

@@ -65,7 +65,7 @@ def create(self, request, slug):
     )
     def list(self, request, slug):
         query = request.query_params.get("query", False)
-        stickies = self.get_queryset().order_by("-created_at")
+        stickies = self.get_queryset().order_by("-sort_order", "-created_at")
         if query:
             stickies = stickies.filter(description_stripped__icontains=query)
 

apps/api/plane/app/serializers/page.py

@@ -55,6 +55,7 @@ class Meta:
             "logo_props",
             "label_ids",
             "project_ids",
+            "sort_order",
         ]
         read_only_fields = ["workspace", "owned_by"]
 

apps/api/plane/app/views/page/base.py

@@ -102,7 +102,7 @@ def get_queryset(self):
             .annotate(is_favorite=Exists(subquery))
             .order_by(self.request.GET.get("order_by", "-created_at"))
             .prefetch_related("labels")
-            .order_by("-is_favorite", "-created_at")
+            .order_by("-is_favorite", "-sort_order", "-created_at")
             .annotate(
                 project=Exists(
                     ProjectPage.objects.filter(page_id=OuterRef("id"), project_id=self.kwargs.get("project_id"))
@@ -160,7 +160,10 @@ def partial_update(self, request, slug, project_id, page_id):
                 project_pages__deleted_at__isnull=True,
             )
 
-            if page.is_locked:
+            updatable_fields_when_locked = {"sort_order"}
+            is_sort_only_update = set(request.data.keys()).issubset(updatable_fields_when_locked)
+
+            if page.is_locked and not is_sort_only_update:
                 return Response({"error": "Page is locked"}, status=status.HTTP_400_BAD_REQUEST)
 
             parent = request.data.get("parent", None)

apps/api/plane/celery.py

@@ -8,7 +8,7 @@
 
 # Third party imports
 from celery import Celery
-from pythonjsonlogger.jsonlogger import JsonFormatter
+from pythonjsonlogger.json import JsonFormatter
 from celery.signals import after_setup_logger, after_setup_task_logger
 from celery.schedules import crontab
 

apps/api/plane/settings/common.py

@@ -224,7 +224,6 @@
 # Internationalization
 LANGUAGE_CODE = "en-us"
 USE_I18N = True
-USE_L10N = True
 
 # Timezones
 USE_TZ = True

apps/api/plane/settings/test.py

@@ -11,6 +11,9 @@
 # Send it in a dummy outbox
 EMAIL_BACKEND = "django.core.mail.backends.locmem.EmailBackend"
 
+# WhiteNoise checks STATIC_ROOT on middleware init; avoid static-dir warnings in tests.
+MIDDLEWARE = [mw for mw in MIDDLEWARE if mw != "whitenoise.middleware.WhiteNoiseMiddleware"]  # noqa
+
 INSTALLED_APPS.append(  # noqa
     "plane.tests"
 )

apps/api/plane/tests/contract/api/test_sticky.py

@@ -0,0 +1,43 @@
+import pytest
+from plane.db.models import Sticky, Workspace
+
+
+@pytest.mark.django_db
+def test_default_sort_order_assignment(workspace, session_client):
+    # Create the first sticky
+    s1 = Sticky.objects.create(
+        workspace=workspace,
+        owner=session_client.user,
+        name="Sticky 1",
+    )
+    assert s1.sort_order == 65535
+
+    # Create the second sticky
+    s2 = Sticky.objects.create(
+        workspace=workspace,
+        owner=session_client.user,
+        name="Sticky 2",
+    )
+    # According to the model logic, sort_order increments by +10000
+    assert s2.sort_order == 65535 + 10000
+
+
+@pytest.mark.django_db
+def test_api_returns_ordered_list(workspace, session_client):
+    Sticky.objects.create(
+        workspace=workspace,
+        owner=session_client.user,
+        name="Last",
+        sort_order=200,
+    )
+    Sticky.objects.create(
+        workspace=workspace,
+        owner=session_client.user,
+        name="First",
+        sort_order=100,
+    )
+
+    res = session_client.get(f"/api/workspaces/{workspace.slug}/stickies/")
+    results = res.data
+    assert results[0]["name"] == "First"
+    assert results[1]["name"] == "Last"

apps/api/plane/tests/contract/app/test_pages_app.py

@@ -0,0 +1,122 @@
+# Copyright (c) 2023-present Plane Software, Inc. and contributors
+# SPDX-License-Identifier: AGPL-3.0-only
+# See the LICENSE file for details.
+
+import pytest
+from rest_framework import status
+
+from plane.db.models import Page, Project, ProjectMember, ProjectPage
+
+
+@pytest.fixture
+def project(db, workspace, create_user):
+    project = Project.objects.create(
+        name="Pages Project",
+        identifier="PGS",
+        workspace=workspace,
+        created_by=create_user,
+    )
+    ProjectMember.objects.create(
+        project=project,
+        member=create_user,
+        role=20,
+        is_active=True,
+    )
+    return project
+
+
+@pytest.fixture
+def project_pages(db, workspace, project, create_user):
+    page_low = Page.objects.create(
+        workspace=workspace,
+        owned_by=create_user,
+        name="Low",
+        access=Page.PUBLIC_ACCESS,
+        sort_order=100,
+    )
+    page_mid = Page.objects.create(
+        workspace=workspace,
+        owned_by=create_user,
+        name="Mid",
+        access=Page.PUBLIC_ACCESS,
+        sort_order=150,
+    )
+    page_high = Page.objects.create(
+        workspace=workspace,
+        owned_by=create_user,
+        name="High",
+        access=Page.PUBLIC_ACCESS,
+        sort_order=200,
+    )
+
+    for page in [page_low, page_mid, page_high]:
+        ProjectPage.objects.create(
+            project=project,
+            page=page,
+            workspace=workspace,
+            created_by=create_user,
+        )
+
+    return {"low": page_low, "mid": page_mid, "high": page_high}
+
+
+@pytest.mark.contract
+class TestProjectPagesAPI:
+    def get_pages_url(self, workspace_slug: str, project_id: str) -> str:
+        return f"/api/workspaces/{workspace_slug}/projects/{project_id}/pages/"
+
+    def get_page_url(self, workspace_slug: str, project_id: str, page_id: str) -> str:
+        return f"/api/workspaces/{workspace_slug}/projects/{project_id}/pages/{page_id}/"
+
+    @pytest.mark.django_db
+    def test_list_pages_sorted_by_sort_order_desc(self, session_client, workspace, project, project_pages):
+        url = self.get_pages_url(workspace.slug, project.id)
+        response = session_client.get(url)
+
+        assert response.status_code == status.HTTP_200_OK
+        data = response.json()
+        assert [row["id"] for row in data] == [
+            str(project_pages["high"].id),
+            str(project_pages["mid"].id),
+            str(project_pages["low"].id),
+        ]
+        assert all("sort_order" in row for row in data)
+
+    @pytest.mark.django_db
+    def test_patch_sort_order_updates_page(self, session_client, workspace, project, project_pages):
+        page = project_pages["mid"]
+        url = self.get_page_url(workspace.slug, project.id, page.id)
+        response = session_client.patch(url, {"sort_order": 250}, format="json")
+
+        assert response.status_code == status.HTTP_200_OK
+        page.refresh_from_db()
+        assert page.sort_order == 250
+        assert response.json()["sort_order"] == 250
+
+    @pytest.mark.django_db
+    def test_patch_sort_order_allowed_when_page_is_locked(self, session_client, workspace, project, project_pages):
+        page = project_pages["low"]
+        page.is_locked = True
+        page.save()
+
+        url = self.get_page_url(workspace.slug, project.id, page.id)
+        response = session_client.patch(url, {"sort_order": 175}, format="json")
+
+        assert response.status_code == status.HTTP_200_OK
+        page.refresh_from_db()
+        assert page.sort_order == 175
+
+    @pytest.mark.django_db
+    def test_patch_non_sort_field_blocked_when_page_is_locked(self, session_client, workspace, project, project_pages):
+        page = project_pages["high"]
+        page.is_locked = True
+        page.save()
+
+        url = self.get_page_url(workspace.slug, project.id, page.id)
+        response = session_client.patch(url, {"name": "Renamed while locked"}, format="json")
+
+        assert response.status_code == status.HTTP_400_BAD_REQUEST
+        assert response.json()["error"] == "Page is locked"
+
+        page.refresh_from_db()
+        assert page.name == "High"

apps/space/react-router.config.ts

@@ -1,7 +1,12 @@
 import type { Config } from "@react-router/dev/config";
-import { joinUrlPath } from "@plane/utils";
 
-const basePath = joinUrlPath(process.env.VITE_SPACE_BASE_PATH ?? "", "/") ?? "/";
+const normalizeBasePath = (value: string): string => {
+  const trimmed = value.trim();
+  if (!trimmed || trimmed === "/") return "/";
+  return `/${trimmed.replace(/^\/+|\/+$/g, "")}/`;
+};
+
+const basePath = normalizeBasePath(process.env.VITE_SPACE_BASE_PATH ?? "");
 
 export default {
   appDirectory: "app",

apps/space/vite.config.ts

@@ -3,7 +3,12 @@ import * as dotenv from "@dotenvx/dotenvx";
 import { reactRouter } from "@react-router/dev/vite";
 import { defineConfig } from "vite";
 import tsconfigPaths from "vite-tsconfig-paths";
-import { joinUrlPath } from "@plane/utils";
+
+const normalizeBasePath = (value: string): string => {
+  const trimmed = value.trim();
+  if (!trimmed || trimmed === "/") return "/";
+  return `/${trimmed.replace(/^\/+|\/+$/g, "")}/`;
+};
 
 dotenv.config({ path: path.resolve(__dirname, ".env") });
 
@@ -15,7 +20,7 @@ const viteEnv = Object.keys(process.env)
     return a;
   }, {});
 
-const basePath = joinUrlPath(process.env.VITE_SPACE_BASE_PATH ?? "", "/") ?? "/";
+const basePath = normalizeBasePath(process.env.VITE_SPACE_BASE_PATH ?? "");
 
 export default defineConfig(() => ({
   base: basePath,