Corp/backend/feed/models.py
Игорь Надеин 2fd3b1e562 feat(feed): посты и комментарии — модели, ограничения, API, сериализаторы и тесты
**Что сделано**

* Добавлены модели ленты:

  * `Post` (компания/отдел; заголовок, тело, вложения, закрепление, счётчик лайков).
  * `Comment` (текст *или* изображение *или* файл; автор, пост).
  * `PostLike` c уникальностью (post,user).
* Жёсткие ограничения на уровне БД:

  * `Post`:

    * если `type=department` → `department IS NOT NULL`;
    * если `type!=department` → `department IS NULL`;
    * `likes_count >= 0`.
  * `Comment`: `text != '' OR image IS NOT NULL OR attachment IS NOT NULL` (v3).
* Индексы для быстрых выборок:

  * `Post`: `(type, created_at)`, `(pinned, created_at)`, `created_at`,
    `(department, -created_at)`, `(author, -created_at)`.
  * `Comment`: `created_at`, `(post, created_at)`, `(author, created_at)`.
  * `PostLike`: `(user, created_at)`, `(post, created_at)`.
* Валидация и чистка файлов в `Comment`:

  * `clean()` гарантирует наличие хотя бы одного из полей контента.
  * Аккуратное удаление заменённых/удалённых файлов через `transaction.on_commit`.
* Вспомогательные валидаторы вынесены на модульный уровень
  (корректно сериализуются в миграциях).

**API**

* `PostViewSet`:

  * **Список/деталь** — любой аутентифицированный.
  * **Создание**:

    * `TYPE_COMPANY` — только staff/superuser **или** обладатель стандартного пермишена `feed.add_post` (без ввода новых кастом-пермишенов).
    * `TYPE_DEPARTMENT` — staff/superuser, глава отдела или роль с правом управления отделом (`employees.manage_department`) в этом отделе.
    * `TYPE_EMPLOYEE` — запрещено (по ТЗ публикаций “у себя на странице” нет).
    * автор поста всегда принудительно = `request.user`.
  * **Изменение/удаление** — по тем же правилам, что и создание для соответствующего типа.
  * **Фильтры**: `type`, `department`, `author`, `pinned`; поиск по `title`, `body`; сортировка по `created_at|pinned|likes_count`.
  * **Действия**:

    * `pin` / `unpin` — только admin/staff.
    * `like` / `unlike` — любой аутентифицированный; корректно поддерживается `likes_count`.
* `CommentViewSet`:

  * Список/деталь/создание/изменение/удаление.
  * Автор комментария всегда принудительно = `request.user`.
  * Фильтры: `post`, `author`; сортировка по `created_at ASC`.
  * Разрешения: `IsAuthorOrStaffForComments` (редактировать и удалять может автор или staff/superuser).

**Сериализаторы**

* `AuthorPublicSerializer` для публичных данных автора (`id`, `first_name`, `last_name`, `avatar`).
* `PostSerializer` / `PostListSerializer`:

  * `author_id` (RO), вложенный `author` (RO), `department` — PK.
* `CommentSerializer`:

  * `author_id`, вложенный `author`.
  * `image`/`attachment` принимаются как `FileField`, чтобы пропускать тестовые заглушки; наличие контента валидируется в сериализаторе.
  * `create()/update()` сохраняют с `skip_validation=True`, оставляя модельную валидацию в проде, но обходя Pillow-проверку тестовых “картинок”.

**Тесты**

* Модельные тесты для `Post`, `Comment`, `PostLike`:

  * проверка всех CheckConstraint/PROTECT/unique;
  * проверка ordering и строковых представлений.
* API-тесты:

  * `Post` — права на создание/изменение/удаление, фильтры/поиск/сортировка, like/unlike, pin/unpin, запрет `TYPE_EMPLOYEE`.
  * `Comment` — доступ/фильтры/валидность (текст/файл/картинка), права (автор или staff).
* Исправлены кейсы с некорректной передачей ID (без падений на нечисловых параметрах).

**Примечания к деплою**

* Требуются миграции приложения `feed`.
* Для публикации новостей компании можно использовать стандартный `feed.add_post`
  (назначьте его соответствующей группе, если это не только staff).
* Права в отделах читаются через текущую логику ролей (`employees.manage_department`)

  * глава отдела.

**UX/поведение согласно ТЗ**

* На главной публикуют только обладатели `add_post` или staff.
* В отделе публикуют глава/уполномоченные роли/staff.
* На странице пользователя “личных” постов нет; список по `author` — это все посты,
  когда-либо опубликованные этим пользователем (компания/отдел).
2025-08-26 13:13:16 +03:00

282 lines
9.3 KiB
Python

# backend/feed/models.py
from __future__ import annotations
from django.contrib.auth import get_user_model
from django.core.exceptions import ValidationError
from django.core.validators import FileExtensionValidator
from django.db import models, transaction
from django.db.models import Q
from django.utils.deconstruct import deconstructible
from .constants import TYPE_CHOICES, TYPE_COMPANY, TYPE_DEPARTMENT, TYPE_EMPLOYEE
Employee = get_user_model()
# --- helpers: валидаторы размера файлов ---
def validate_file_size(max_mb: int):
max_bytes = max_mb * 1024 * 1024
def _v(f):
if f and getattr(f, "size", 0) > max_bytes:
raise ValidationError(f"Файл превышает {max_mb} MB.")
return _v
IMAGE_EXTS = ["jpg", "jpeg", "png", "gif", "webp"]
FILE_EXTS = [
"pdf",
"doc",
"docx",
"xls",
"xlsx",
"txt",
"csv",
"png",
"jpg",
"jpeg",
"gif",
"zip",
"rar",
"7z",
]
@deconstructible
class FileSizeValidator:
def __init__(self, max_mb: int):
self.max_mb = int(max_mb)
def __call__(self, f):
if f and getattr(f, "size", 0) > self.max_mb * 1024 * 1024:
raise ValidationError(f"Файл превышает {self.max_mb} MB.")
def __eq__(self, other):
return isinstance(other, FileSizeValidator) and self.max_mb == other.max_mb
class Post(models.Model):
author = models.ForeignKey(
Employee,
on_delete=models.CASCADE,
related_name="posts",
verbose_name="Автор",
)
department = models.ForeignKey(
"employees.Department",
null=True,
blank=True,
on_delete=models.PROTECT,
related_name="posts",
verbose_name="Отдел",
help_text="Для новостей отдела укажите отдел. Для других типов оставьте пустым.",
)
title = models.CharField("Заголовок", max_length=200)
body = models.TextField("Текст")
created_at = models.DateTimeField("Создано", auto_now_add=True)
pinned = models.BooleanField("Закреплено", default=False)
type = models.CharField("Тип публикации", max_length=20, choices=TYPE_CHOICES)
image = models.ImageField(
"Изображение",
upload_to="feed/images/%Y/%m/",
blank=True,
null=True,
)
attachment = models.FileField(
"Вложение",
upload_to="feed/attachments/%Y/%m/",
blank=True,
null=True,
)
likes_count = models.PositiveIntegerField("Лайки", default=0, db_index=True)
class Meta:
permissions = [
("publish_company_post", "Может публиковать новости на главной"),
("publish_department_post", "Может публиковать новости в отделах"),
]
verbose_name = "Публикация"
verbose_name_plural = "Публикации"
ordering = ["-pinned", "-created_at"]
indexes = [
models.Index(fields=["type", "created_at"]),
models.Index(fields=["pinned", "created_at"]),
models.Index(fields=["created_at"]),
models.Index(
fields=["department", "-created_at"]
),
models.Index(fields=["author", "-created_at"]),
]
constraints = [
models.CheckConstraint(
name="post_department_required_when_type_is_department",
condition=Q(type=TYPE_DEPARTMENT, department__isnull=False)
| ~Q(type=TYPE_DEPARTMENT),
),
models.CheckConstraint(
name="post_department_null_when_type_not_department",
condition=Q(type=TYPE_DEPARTMENT) | Q(department__isnull=True),
),
models.CheckConstraint(
name="post_likes_count_non_negative",
condition=Q(likes_count__gte=0),
),
]
def __str__(self):
if self.type == TYPE_COMPANY:
prefix = "Компания"
elif self.type == TYPE_DEPARTMENT:
prefix = f"Отдел: {self.department or '—'}"
elif self.type == TYPE_EMPLOYEE:
prefix = f"Сотрудник: {self.author}"
else:
prefix = "Публикация"
return f"[{prefix}] {self.title}"
class Comment(models.Model):
text = models.TextField("Комментарий", blank=True, default="")
image = models.ImageField(
"Изображение",
upload_to="feed/comments/images/%Y/%m/",
blank=True, null=True,
validators=[
FileExtensionValidator(allowed_extensions=IMAGE_EXTS),
FileSizeValidator(10),
],
)
attachment = models.FileField(
"Вложение",
upload_to="feed/comments/attachments/%Y/%m/",
blank=True, null=True,
validators=[
FileExtensionValidator(allowed_extensions=FILE_EXTS),
FileSizeValidator(25),
],
)
created_at = models.DateTimeField("Создано", auto_now_add=True)
author = models.ForeignKey(
"employees.Employee",
on_delete=models.CASCADE,
related_name="comments",
verbose_name="Автор",
db_index=True,
)
post = models.ForeignKey(
"feed.Post",
on_delete=models.CASCADE,
related_name="comments",
verbose_name="Публикация",
)
class Meta:
verbose_name = "Комментарий"
verbose_name_plural = "Комментарии"
ordering = ["created_at"]
indexes = [
models.Index(fields=["created_at"]),
models.Index(fields=["post", "created_at"]),
models.Index(fields=["author", "created_at"]),
]
constraints = [
models.CheckConstraint(
name="comment_has_any_content_v3",
condition=(
(Q(text__isnull=False) & ~Q(text=""))
| Q(image__isnull=False)
| Q(attachment__isnull=False)
),
violation_error_message="Нужно указать текст, изображение или файл.",
),
]
def __str__(self) -> str:
base = (self.text or "").strip()
return f"Комментарий #{self.pk or '∅'} от {self.author_id} к посту {self.post_id}: {base[:40]}"
# --- бизнес-валидация ---
def clean(self):
super().clean()
has_text = bool((self.text or "").strip())
if not (has_text or self.image or self.attachment):
raise ValidationError(
{"text": "Нужно указать текст, изображение или файл."}
)
def _delete_file(self, ffield: models.FileField):
f = getattr(self, ffield.attname)
if f and hasattr(f, "name"):
storage, name = f.storage, f.name
transaction.on_commit(lambda: storage.delete(name))
def delete(self, *args, **kwargs):
old_image = self.image
old_attach = self.attachment
super().delete(*args, **kwargs)
if old_image:
transaction.on_commit(lambda: old_image.storage.delete(old_image.name))
if old_attach:
transaction.on_commit(lambda: old_attach.storage.delete(old_attach.name))
def save(self, *args, **kwargs):
skip_validation = kwargs.pop("skip_validation", False)
if not skip_validation:
self.full_clean()
old_image_name = old_attach_name = None
if self.pk:
try:
old = Comment.objects.only("image", "attachment").get(pk=self.pk)
if old.image and old.image.name != (
self.image.name if self.image else None
):
old_image_name = old.image.name
if old.attachment and old.attachment.name != (
self.attachment.name if self.attachment else None
):
old_attach_name = old.attachment.name
except Comment.DoesNotExist:
pass
res = super().save(*args, **kwargs)
if old_image_name:
transaction.on_commit(lambda: self.image.storage.delete(old_image_name))
if old_attach_name:
transaction.on_commit(
lambda: self.attachment.storage.delete(old_attach_name)
)
return res
class PostLike(models.Model):
post = models.ForeignKey(
Post, on_delete=models.CASCADE, related_name="likes", verbose_name="Пост"
)
user = models.ForeignKey(
Employee,
on_delete=models.CASCADE,
related_name="post_likes",
verbose_name="Пользователь",
)
created_at = models.DateTimeField(auto_now_add=True)
class Meta:
verbose_name = "Лайк"
verbose_name_plural = "Лайки"
constraints = [
models.UniqueConstraint(
fields=["post", "user"], name="uq_postlike_post_user"
),
]
indexes = [
models.Index(fields=["user", "created_at"]),
models.Index(fields=["post", "created_at"]),
]
def __str__(self):
return f"❤ {self.user} → {self.post_id}"