🚸(backend) add onboarding docs for new users
Adds two methods to allow new users to start with some docs. User._handle_onboarding_documents_access() gives READER access to each document listed in settings.USER_ONBOARDING_DOCUMENTS. User._duplicate_onboarding_sandbox_document() creates a local copy of the sandbox document specified in settings.USER_ONBOARDING_SANDBOX_DOCUMENT.
This commit is contained in:
Sylvain Boissel
@@ -209,14 +209,76 @@ class User(AbstractBaseUser, BaseModel, auth_models.PermissionsMixin):
|
||||
|
||||
def save(self, *args, **kwargs):
|
||||
"""
|
||||
If it's a new user, give its user access to the documents to which s.he was invited.
|
||||
If it's a new user, give its user access to the documents they were invited to.
|
||||
"""
|
||||
is_adding = self._state.adding
|
||||
super().save(*args, **kwargs)
|
||||
|
||||
if is_adding:
|
||||
self._handle_onboarding_documents_access()
|
||||
self._duplicate_onboarding_sandbox_document()
|
||||
self._convert_valid_invitations()
|
||||
|
||||
def _handle_onboarding_documents_access(self):
|
||||
"""
|
||||
If the user is new and there are documents configured to be given to new users,
|
||||
give access to these documents and pin them as favorites for the user.
|
||||
"""
|
||||
if settings.USER_ONBOARDING_DOCUMENTS:
|
||||
onboarding_document_ids = set(settings.USER_ONBOARDING_DOCUMENTS)
|
||||
onboarding_accesses = []
|
||||
favorite_documents = []
|
||||
for document_id in onboarding_document_ids:
|
||||
try:
|
||||
document = Document.objects.get(id=document_id)
|
||||
except Document.DoesNotExist:
|
||||
logger.warning(
|
||||
"Onboarding document with id %s does not exist. Skipping.",
|
||||
document_id,
|
||||
)
|
||||
continue
|
||||
|
||||
onboarding_accesses.append(
|
||||
DocumentAccess(
|
||||
user=self, document=document, role=RoleChoices.READER
|
||||
)
|
||||
)
|
||||
favorite_documents.append(
|
||||
DocumentFavorite(user=self, document_id=document_id)
|
||||
)
|
||||
|
||||
DocumentAccess.objects.bulk_create(onboarding_accesses)
|
||||
DocumentFavorite.objects.bulk_create(favorite_documents)
|
||||
|
||||
def _duplicate_onboarding_sandbox_document(self):
|
||||
"""
|
||||
If the user is new and there is a sandbox document configured,
|
||||
duplicate the sandbox document for the user
|
||||
"""
|
||||
if settings.USER_ONBOARDING_SANDBOX_DOCUMENT:
|
||||
sandbox_id = settings.USER_ONBOARDING_SANDBOX_DOCUMENT
|
||||
try:
|
||||
template_document = Document.objects.get(id=sandbox_id)
|
||||
|
||||
sandbox_document = template_document.add_sibling(
|
||||
"right",
|
||||
title=template_document.title,
|
||||
content=template_document.content,
|
||||
attachments=template_document.attachments,
|
||||
duplicated_from=template_document,
|
||||
creator=self,
|
||||
)
|
||||
|
||||
DocumentAccess.objects.create(
|
||||
user=self, document=sandbox_document, role=RoleChoices.OWNER
|
||||
)
|
||||
|
||||
except Document.DoesNotExist:
|
||||
logger.warning(
|
||||
"Onboarding sandbox document with id %s does not exist. Skipping.",
|
||||
sandbox_id,
|
||||
)
|
||||
|
||||
def _convert_valid_invitations(self):
|
||||
"""
|
||||
Convert valid invitations to document accesses.
|
||||
|
||||
@@ -2,7 +2,11 @@
|
||||
Unit tests for the User model
|
||||
"""
|
||||
|
||||
import uuid
|
||||
from unittest.mock import patch
|
||||
|
||||
from django.core.exceptions import ValidationError
|
||||
from django.test.utils import override_settings
|
||||
|
||||
import pytest
|
||||
|
||||
@@ -74,3 +78,217 @@ def test_modes_users_convert_valid_invitations():
|
||||
id=invitation_other_document.id
|
||||
).exists()
|
||||
assert models.Invitation.objects.filter(id=other_email_invitation.id).exists()
|
||||
|
||||
|
||||
@override_settings(USER_ONBOARDING_DOCUMENTS=[])
|
||||
def test_models_users_handle_onboarding_documents_access_empty_setting():
|
||||
"""
|
||||
When USER_ONBOARDING_DOCUMENTS is empty, no accesses should be created.
|
||||
"""
|
||||
user = factories.UserFactory()
|
||||
assert models.DocumentAccess.objects.filter(user=user).count() == 0
|
||||
|
||||
|
||||
def test_models_users_handle_onboarding_documents_access_with_single_document():
|
||||
"""
|
||||
When USER_ONBOARDING_DOCUMENTS has a valid document ID,
|
||||
an access should be created for the new user with the READER role.
|
||||
|
||||
The document should be pinned as a favorite for the user.
|
||||
"""
|
||||
document = factories.DocumentFactory()
|
||||
|
||||
with override_settings(USER_ONBOARDING_DOCUMENTS=[str(document.id)]):
|
||||
user = factories.UserFactory()
|
||||
|
||||
assert (
|
||||
models.DocumentAccess.objects.filter(user=user, document=document).count() == 1
|
||||
)
|
||||
|
||||
access = models.DocumentAccess.objects.get(user=user, document=document)
|
||||
assert access.role == models.RoleChoices.READER
|
||||
|
||||
user_favorites = models.DocumentFavorite.objects.filter(user=user)
|
||||
assert user_favorites.count() == 1
|
||||
assert user_favorites.filter(document=document).exists()
|
||||
|
||||
|
||||
def test_models_users_handle_onboarding_documents_access_with_multiple_documents():
|
||||
"""
|
||||
When USER_ONBOARDING_DOCUMENTS has multiple valid document IDs,
|
||||
accesses should be created for all documents.
|
||||
|
||||
All accesses should have the READER role.
|
||||
All documents should be pinned as favorites for the user.
|
||||
"""
|
||||
document1 = factories.DocumentFactory(title="Document 1")
|
||||
document2 = factories.DocumentFactory(title="Document 2")
|
||||
document3 = factories.DocumentFactory(title="Document 3")
|
||||
|
||||
with override_settings(
|
||||
USER_ONBOARDING_DOCUMENTS=[
|
||||
str(document1.id),
|
||||
str(document2.id),
|
||||
str(document3.id),
|
||||
]
|
||||
):
|
||||
user = factories.UserFactory()
|
||||
|
||||
user_accesses = models.DocumentAccess.objects.filter(user=user)
|
||||
assert user_accesses.count() == 3
|
||||
|
||||
assert models.DocumentAccess.objects.filter(user=user, document=document1).exists()
|
||||
assert models.DocumentAccess.objects.filter(user=user, document=document2).exists()
|
||||
assert models.DocumentAccess.objects.filter(user=user, document=document3).exists()
|
||||
|
||||
for access in user_accesses:
|
||||
assert access.role == models.RoleChoices.READER
|
||||
|
||||
user_favorites = models.DocumentFavorite.objects.filter(user=user)
|
||||
assert user_favorites.count() == 3
|
||||
assert user_favorites.filter(document=document1).exists()
|
||||
assert user_favorites.filter(document=document2).exists()
|
||||
assert user_favorites.filter(document=document3).exists()
|
||||
|
||||
|
||||
def test_models_users_handle_onboarding_documents_access_with_invalid_document_id():
|
||||
"""
|
||||
When USER_ONBOARDING_DOCUMENTS has an invalid document ID,
|
||||
it should be skipped and logged, but not raise an exception.
|
||||
"""
|
||||
invalid_id = uuid.uuid4()
|
||||
|
||||
with override_settings(USER_ONBOARDING_DOCUMENTS=[str(invalid_id)]):
|
||||
with patch("core.models.logger") as mock_logger:
|
||||
user = factories.UserFactory()
|
||||
|
||||
mock_logger.warning.assert_called_once()
|
||||
call_args = mock_logger.warning.call_args
|
||||
assert "Onboarding document with id" in call_args[0][0]
|
||||
|
||||
assert models.DocumentAccess.objects.filter(user=user).count() == 0
|
||||
|
||||
|
||||
def test_models_users_handle_onboarding_documents_access_duplicate_prevention():
|
||||
"""
|
||||
If the same document is listed multiple times in USER_ONBOARDING_DOCUMENTS,
|
||||
it should only create one access (or handle duplicates gracefully).
|
||||
"""
|
||||
document = factories.DocumentFactory()
|
||||
|
||||
with override_settings(
|
||||
USER_ONBOARDING_DOCUMENTS=[str(document.id), str(document.id)]
|
||||
):
|
||||
user = factories.UserFactory()
|
||||
|
||||
user_accesses = models.DocumentAccess.objects.filter(user=user, document=document)
|
||||
|
||||
assert user_accesses.count() >= 1
|
||||
|
||||
|
||||
@override_settings(USER_ONBOARDING_SANDBOX_DOCUMENT=None)
|
||||
def test_models_users_duplicate_onboarding_sandbox_document_no_setting():
|
||||
"""
|
||||
When USER_ONBOARDING_SANDBOX_DOCUMENT is not set, no sandbox document should be created.
|
||||
"""
|
||||
user = factories.UserFactory()
|
||||
|
||||
assert (
|
||||
models.Document.objects.filter(creator=user, title__icontains="Sandbox").count()
|
||||
== 0
|
||||
)
|
||||
|
||||
initial_accesses = models.DocumentAccess.objects.filter(user=user).count()
|
||||
assert initial_accesses == 0
|
||||
|
||||
|
||||
def test_models_users_duplicate_onboarding_sandbox_document_creates_sandbox():
|
||||
"""
|
||||
When USER_ONBOARDING_SANDBOX_DOCUMENT is set with a valid template document,
|
||||
a new sandbox document should be created for the user with OWNER access.
|
||||
"""
|
||||
template_document = factories.DocumentFactory(title="Getting started with Docs")
|
||||
|
||||
with override_settings(USER_ONBOARDING_SANDBOX_DOCUMENT=str(template_document.id)):
|
||||
user = factories.UserFactory()
|
||||
|
||||
sandbox_docs = models.Document.objects.filter(
|
||||
creator=user, title="Getting started with Docs"
|
||||
)
|
||||
assert sandbox_docs.count() == 1
|
||||
|
||||
sandbox_doc = sandbox_docs.first()
|
||||
assert sandbox_doc.creator == user
|
||||
assert sandbox_doc.duplicated_from == template_document
|
||||
|
||||
access = models.DocumentAccess.objects.get(user=user, document=sandbox_doc)
|
||||
assert access.role == models.RoleChoices.OWNER
|
||||
|
||||
|
||||
def test_models_users_duplicate_onboarding_sandbox_document_with_invalid_template_id():
|
||||
"""
|
||||
When USER_ONBOARDING_SANDBOX_DOCUMENT has an invalid document ID,
|
||||
it should be skipped and logged, but not raise an exception.
|
||||
"""
|
||||
invalid_id = uuid.uuid4()
|
||||
|
||||
with override_settings(USER_ONBOARDING_SANDBOX_DOCUMENT=str(invalid_id)):
|
||||
with patch("core.models.logger") as mock_logger:
|
||||
user = factories.UserFactory()
|
||||
|
||||
mock_logger.warning.assert_called_once()
|
||||
call_args = mock_logger.warning.call_args
|
||||
assert "Onboarding sandbox document with id" in call_args[0][0]
|
||||
|
||||
sandbox_docs = models.Document.objects.filter(creator=user)
|
||||
assert sandbox_docs.count() == 0
|
||||
|
||||
|
||||
def test_models_users_duplicate_onboarding_sandbox_document_creates_unique_sandbox_per_user():
|
||||
"""
|
||||
Each new user should get their own independent sandbox document.
|
||||
"""
|
||||
template_document = factories.DocumentFactory(title="Getting started with Docs")
|
||||
|
||||
with override_settings(USER_ONBOARDING_SANDBOX_DOCUMENT=str(template_document.id)):
|
||||
user1 = factories.UserFactory()
|
||||
user2 = factories.UserFactory()
|
||||
|
||||
sandbox_docs_user1 = models.Document.objects.filter(
|
||||
creator=user1, title="Getting started with Docs"
|
||||
)
|
||||
sandbox_docs_user2 = models.Document.objects.filter(
|
||||
creator=user2, title="Getting started with Docs"
|
||||
)
|
||||
|
||||
assert sandbox_docs_user1.count() == 1
|
||||
assert sandbox_docs_user2.count() == 1
|
||||
|
||||
assert sandbox_docs_user1.first().id != sandbox_docs_user2.first().id
|
||||
|
||||
|
||||
def test_models_users_duplicate_onboarding_sandbox_document_integration_with_other_methods():
|
||||
"""
|
||||
Verify that sandbox creation works alongside other onboarding methods.
|
||||
"""
|
||||
template_document = factories.DocumentFactory(title="Getting started with Docs")
|
||||
onboarding_doc = factories.DocumentFactory(title="Onboarding Document")
|
||||
|
||||
with override_settings(
|
||||
USER_ONBOARDING_SANDBOX_DOCUMENT=str(template_document.id),
|
||||
USER_ONBOARDING_DOCUMENTS=[str(onboarding_doc.id)],
|
||||
):
|
||||
user = factories.UserFactory()
|
||||
|
||||
sandbox_doc = models.Document.objects.filter(
|
||||
creator=user, title="Getting started with Docs"
|
||||
).first()
|
||||
|
||||
user_accesses = models.DocumentAccess.objects.filter(user=user)
|
||||
assert user_accesses.count() == 2
|
||||
|
||||
sandbox_access = user_accesses.get(document=sandbox_doc)
|
||||
onboarding_access = user_accesses.get(document=onboarding_doc)
|
||||
|
||||
assert sandbox_access.role == models.RoleChoices.OWNER
|
||||
assert onboarding_access.role == models.RoleChoices.READER
|
||||
|
||||
@@ -884,7 +884,12 @@ class Base(Configuration):
|
||||
USER_RECONCILIATION_FORM_URL = values.Value(
|
||||
None, environ_name="USER_RECONCILIATION_FORM_URL", environ_prefix=None
|
||||
)
|
||||
|
||||
USER_ONBOARDING_DOCUMENTS = values.ListValue(
|
||||
[], environ_name="USER_ONBOARDING_DOCUMENTS", environ_prefix=None
|
||||
)
|
||||
USER_ONBOARDING_SANDBOX_DOCUMENT = values.Value(
|
||||
None, environ_name="USER_ONBOARDING_SANDBOX_DOCUMENT", environ_prefix=None
|
||||
)
|
||||
# Marketing and communication settings
|
||||
SIGNUP_NEW_USER_TO_MARKETING_EMAIL = values.BooleanValue(
|
||||
False,
|
||||
|
||||
Reference in New Issue
Block a user