♻️(frontend) adapt doc visibility to new api

We updated the way we handle the visibility of a doc
in the backend. Now we use a new api to update
the visibility (documents/{id}/link-configuration/)
of a doc. We adapted the frontend to use this new api.
We changed the types to reflect the new api and
to keep the same logic.

CHANGELOG.md

@@ -11,21 +11,13 @@ and this project adheres to
 
 ## Added
 
-- ✨Add link public/authenticated/restricted access with read/editor roles #234
 - ✨(frontend) add copy link button #235
 - 🛂(frontend) access public docs without being logged #235
 
 ## Changed
 
-- ♻️ Allow null titles on documents for easier creation #234
-- 🛂(backend) stop to list public doc to everyone #234
 - 🚚(frontend) change visibility in share modal #235
 
-## Fixed
-
-- 🐛 Fix forcing ID when creating a document via API endpoint #234
-- 🐛 Rebuild frontend dev container from makefile #248
-
 
 ## [1.3.0] - 2024-09-05
 
@@ -40,6 +32,7 @@ and this project adheres to
 
 - 💄(frontend) code background darkened on editor #214
 - 🔥(frontend) hide markdown button if not text #213
+- 🛂(backend) stop to list public doc to everyone #234
 
 ## Fixed
 
@@ -155,4 +148,4 @@ and this project adheres to
 [1.2.0]: https://github.com/numerique-gouv/impress/releases/v1.2.0
 [1.1.0]: https://github.com/numerique-gouv/impress/releases/v1.1.0
 [1.0.0]: https://github.com/numerique-gouv/impress/releases/v1.0.0
-[0.1.0]: https://github.com/numerique-gouv/impress/releases/v0.1.0
+[0.1.0]: https://github.com/numerique-gouv/impress/releases/v0.1.0

Makefile

@@ -92,7 +92,6 @@ bootstrap: \
 # -- Docker/compose
 build: ## build the app-dev container
 	@$(COMPOSE) build app-dev --no-cache
-	@$(COMPOSE) build frontend-dev --no-cache
 .PHONY: build
 
 down: ## stop and remove containers, networks, images, and volumes

src/backend/core/api/serializers.py

@@ -148,7 +148,6 @@ class DocumentSerializer(BaseResourceSerializer):
             "title",
             "accesses",
             "abilities",
-            "is_e2ee",
             "link_role",
             "link_reach",
             "created_at",

src/backend/core/api/viewsets.py

@@ -7,8 +7,8 @@ from urllib.parse import urlparse
 
 from django.conf import settings
 from django.contrib.postgres.aggregates import ArrayAgg
-from django.core.exceptions import ValidationError
 from django.core.files.storage import default_storage
+from django.db import IntegrityError
 from django.db.models import (
     OuterRef,
     Q,
@@ -358,11 +358,11 @@ class DocumentViewSet(
             try:
                 # Add a trace that the user visited the document (this is needed to include
                 # the document in the user's list view)
-                models.LinkTrace.objects.create(
+                models.LinkTrace.objects.update_or_create(
                     document=instance,
                     user=self.request.user,
                 )
-            except ValidationError:
+            except IntegrityError:
                 # The trace already exists, so we just pass without doing anything
                 pass
 
@@ -375,7 +375,7 @@ class DocumentViewSet(
         to the document
         """
         if not request.user.is_authenticated:
-            raise exceptions.PermissionDenied("Authentication required.")
+            return drf_response.Response([])
 
         document = self.get_object()
         user = request.user

src/backend/core/migrations/0003_document_link_reach_document_link_role_and_more.py

@@ -16,7 +16,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='document',
             name='link_reach',
-            field=models.CharField(choices=[('restricted', 'Restricted'), ('authenticated', 'Authenticated'), ('public', 'Public')], default='authenticated', max_length=20),
+            field=models.CharField(choices=[('restricted', 'Restricted'), ('authenticated', 'Authenticated'), ('public', 'Public')], default='restricted', max_length=20),
         ),
         migrations.AddField(
             model_name='document',

src/backend/core/migrations/0006_remove_document_is_public_document_is_e2ee_and_more.py

@@ -1,18 +0,0 @@
-# Generated by Django 5.1 on 2024-09-12 13:53
-
-from django.db import migrations, models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('core', '0005_remove_document_is_public_alter_document_link_reach_and_more'),
-    ]
-
-    operations = [
-        migrations.AddField(
-            model_name='document',
-            name='is_e2ee',
-            field=models.BooleanField(default=False),
-        ),
-    ]

src/backend/core/models.py

@@ -324,12 +324,11 @@ class Document(BaseModel):
     link_reach = models.CharField(
         max_length=20,
         choices=LinkReachChoices.choices,
-        default=LinkReachChoices.AUTHENTICATED,
+        default=LinkReachChoices.RESTRICTED,
     )
     link_role = models.CharField(
         max_length=20, choices=LinkRoleChoices.choices, default=LinkRoleChoices.READER
     )
-    is_e2ee = models.BooleanField(default=False)
 
     _content = None
 

src/backend/core/tests/documents/test_api_document_versions.py

@@ -29,8 +29,8 @@ def test_api_document_versions_list_anonymous(role, reach):
 
     response = APIClient().get(f"/api/v1.0/documents/{document.id!s}/versions/")
 
-    assert response.status_code == 403
-    assert response.json() == {"detail": "Authentication required."}
+    assert response.status_code == 200
+    assert response.json() == []
 
 
 @pytest.mark.parametrize("reach", models.LinkReachChoices.values)

src/backend/core/tests/documents/test_api_documents_retrieve.py

@@ -5,7 +5,7 @@ Tests for Documents API endpoint in impress's core app: retrieve
 import pytest
 from rest_framework.test import APIClient
 
-from core import factories, models
+from core import factories
 from core.api import serializers
 
 pytestmark = pytest.mark.django_db
@@ -33,7 +33,6 @@ def test_api_documents_retrieve_anonymous_public():
             "versions_retrieve": False,
         },
         "accesses": [],
-        "is_e2ee": False,
         "link_reach": "public",
         "link_role": document.link_role,
         "title": document.title,
@@ -88,7 +87,6 @@ def test_api_documents_retrieve_authenticated_unrelated_public_or_authenticated(
             "versions_retrieve": False,
         },
         "accesses": [],
-        "is_e2ee": False,
         "link_reach": reach,
         "link_role": document.link_role,
         "title": document.title,
@@ -96,38 +94,6 @@ def test_api_documents_retrieve_authenticated_unrelated_public_or_authenticated(
         "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
         "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
     }
-    assert (
-        models.LinkTrace.objects.filter(document=document, user=user).exists() is True
-    )
-
-
-@pytest.mark.parametrize("reach", ["public", "authenticated"])
-def test_api_documents_retrieve_authenticated_trace_twice(reach):
-    """
-    Accessing a document several times should not raise any error even though the
-    trace already exists for this document and user.
-    """
-    user = factories.UserFactory()
-
-    client = APIClient()
-    client.force_login(user)
-
-    document = factories.DocumentFactory(link_reach=reach)
-    assert (
-        models.LinkTrace.objects.filter(document=document, user=user).exists() is False
-    )
-
-    client.get(
-        f"/api/v1.0/documents/{document.id!s}/",
-    )
-    assert (
-        models.LinkTrace.objects.filter(document=document, user=user).exists() is True
-    )
-
-    # A second visit should not raise any error
-    response = client.get(f"/api/v1.0/documents/{document.id!s}/")
-
-    assert response.status_code == 200
 
 
 def test_api_documents_retrieve_authenticated_unrelated_restricted():
@@ -196,7 +162,6 @@ def test_api_documents_retrieve_authenticated_related_direct():
         "title": document.title,
         "content": document.content,
         "abilities": document.get_abilities(user),
-        "is_e2ee": False,
         "link_reach": document.link_reach,
         "link_role": document.link_role,
         "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
@@ -335,7 +300,6 @@ def test_api_documents_retrieve_authenticated_related_team_members(
         "title": document.title,
         "content": document.content,
         "abilities": document.get_abilities(user),
-        "is_e2ee": False,
         "link_reach": "restricted",
         "link_role": document.link_role,
         "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
@@ -456,7 +420,6 @@ def test_api_documents_retrieve_authenticated_related_team_administrators(
         "title": document.title,
         "content": document.content,
         "abilities": document.get_abilities(user),
-        "is_e2ee": False,
         "link_reach": "restricted",
         "link_role": document.link_role,
         "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
@@ -581,7 +544,6 @@ def test_api_documents_retrieve_authenticated_related_team_owners(
         "title": document.title,
         "content": document.content,
         "abilities": document.get_abilities(user),
-        "is_e2ee": False,
         "link_reach": "restricted",
         "link_role": document.link_role,
         "created_at": document.created_at.isoformat().replace("+00:00", "Z"),

src/frontend/apps/e2e/package.json

@@ -12,7 +12,7 @@
     "test:ui::chromium": "yarn test:ui --project=chromium"
   },
   "devDependencies": {
-    "@playwright/test": "1.47.0",
+    "@playwright/test": "1.46.1",
     "@types/node": "*",
     "@types/pdf-parse": "1.1.4",
     "eslint-config-impress": "*",

src/frontend/apps/impress/next-env.d.ts

@@ -2,4 +2,4 @@
 /// <reference types="next/image-types/global" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
+// see https://nextjs.org/docs/basic-features/typescript for more information.

src/frontend/apps/impress/package.json

@@ -21,12 +21,12 @@
     "@gouvfr-lasuite/integration": "1.0.2",
     "@hocuspocus/provider": "2.13.5",
     "@openfun/cunningham-react": "2.9.4",
-    "@tanstack/react-query": "5.55.4",
-    "i18next": "23.15.1",
+    "@tanstack/react-query": "5.53.2",
+    "i18next": "23.14.0",
     "idb": "8.0.0",
     "lodash": "4.17.21",
     "luxon": "3.5.0",
-    "next": "14.2.9",
+    "next": "14.2.7",
     "react": "*",
     "react-aria-components": "1.3.3",
     "react-dom": "*",
@@ -34,12 +34,11 @@
     "react-select": "5.8.0",
     "styled-components": "6.1.13",
     "yjs": "*",
-    "y-protocols": "1.0.6",
     "zustand": "4.5.5"
   },
   "devDependencies": {
     "@svgr/webpack": "8.1.0",
-    "@tanstack/react-query-devtools": "5.55.4",
+    "@tanstack/react-query-devtools": "5.53.2",
     "@testing-library/dom": "10.4.0",
     "@testing-library/jest-dom": "6.5.0",
     "@testing-library/react": "16.0.1",
@@ -62,7 +61,6 @@
     "stylelint-config-standard": "36.0.1",
     "stylelint-prettier": "5.0.2",
     "typescript": "*",
-    "webpack": "5.94.0",
     "workbox-webpack-plugin": "7.1.0"
   }
 }

src/frontend/package.json

@@ -25,18 +25,15 @@
     "i18n:test": "yarn I18N run test"
   },
   "resolutions": {
-    "@blocknote/core": "0.15.7",
-    "@blocknote/mantine": "0.15.7",
-    "@blocknote/react": "0.15.7",
-    "@types/node": "20.16.5",
+    "@blocknote/core": "0.15.6",
+    "@blocknote/mantine": "0.15.6",
+    "@blocknote/react": "0.15.6",
+    "@types/node": "20.16.3",
     "@types/react-dom": "18.3.0",
-    "@typescript-eslint/eslint-plugin": "8.5.0",
-    "@typescript-eslint/parser": "8.5.0",
     "cross-env": "7.0.3",
-    "eslint": "8.57.0",
     "react": "18.3.1",
     "react-dom": "18.3.1",
-    "typescript": "5.6.2",
-    "yjs": "13.6.19"
+    "typescript": "5.5.4",
+    "yjs": "13.6.18"
   }
 }

src/frontend/packages/eslint-config-impress/package.json

@@ -6,20 +6,19 @@
     "lint": "eslint --ext .js ."
   },
   "dependencies": {
-    "@next/eslint-plugin-next": "14.2.9",
+    "@next/eslint-plugin-next": "14.2.7",
     "@tanstack/eslint-plugin-query": "5.53.0",
-    "@typescript-eslint/eslint-plugin": "*",
-    "@typescript-eslint/parser": "*",
-    "eslint": "*",
-    "eslint-config-next": "14.2.9",
+    "@typescript-eslint/eslint-plugin": "8.3.0",
+    "@typescript-eslint/parser": "8.3.0",
+    "eslint": "8.57.0",
+    "eslint-config-next": "14.2.7",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-import": "2.30.0",
-    "eslint-plugin-jest": "28.8.3",
-    "eslint-plugin-jsx-a11y": "6.10.0",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-jest": "28.8.2",
+    "eslint-plugin-jsx-a11y": "6.9.0",
     "eslint-plugin-playwright": "1.6.2",
     "eslint-plugin-prettier": "5.2.1",
-    "eslint-plugin-react": "7.35.2",
-    "eslint-plugin-testing-library": "6.3.0",
-    "prettier": "3.3.3"
+    "eslint-plugin-react": "7.35.0",
+    "eslint-plugin-testing-library": "6.3.0"
   }
 }

src/frontend/packages/i18n/package.json

@@ -14,7 +14,7 @@
     "@types/jest": "29.5.12",
     "@types/node": "*",
     "eslint-config-impress": "*",
-    "eslint-plugin-import": "2.30.0",
+    "eslint-plugin-import": "2.29.1",
     "i18next-parser": "9.0.2",
     "jest": "29.7.0",
     "ts-jest": "29.2.5",

src/frontend/servers/y-provider/package.json

@@ -15,8 +15,7 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@hocuspocus/server": "2.13.5",
-    "y-protocols": "1.0.6"
+    "@hocuspocus/server": "2.13.5"
   },
   "devDependencies": {
     "@types/node": "*",