Merge branch 'master' into feature/docs

Author: VeryBigSad

.github/workflows/release-ci.yml

@@ -98,6 +98,8 @@ jobs:
             password: ${{ secrets.SERVER_PASSWORD }}
             command: |
               cd /home/app/procollab-backend &&
+              docker container prune -f &&
+              docker image prune -a -f &&
               docker-compose -f docker-compose.prod-ci.yml -p prod pull &&
               
               rm -f .env &&

chats/consumers.py

@@ -48,6 +48,7 @@ async def connect(self):
         """User connected to websocket"""
 
         if self.scope["user"].is_anonymous:
+            # not authenticated
             return await self.close(403)
 
         self.user = self.scope["user"]

chats/middleware.py

@@ -1,3 +1,5 @@
+from urllib.parse import parse_qs
+
 import jwt
 from channels.db import database_sync_to_async
 from django.conf import settings
@@ -103,24 +105,23 @@ def __init__(self, app):
         self.app = app
 
     async def __call__(self, scope, receive, send):
-        # Look up user from query string (you should also do things like
-        # checking if it is a valid user ID, or if scope["user"] is already
-        # populated).
-        headers = scope["headers"]
-        try:
-            token = None
-            for name, value in headers:
-                if name == b"authorization":
-                    token = value.decode()
-                    break
+        # Look up user from query string
 
+        # TODO: (you should also do things like
+        #  checking if it is a valid user ID, or if scope["user" ] is already
+        #  populated).
+
+        query_string = scope["query_string"].decode()
+        query_dict = parse_qs(query_string)
+        try:
+            token = query_dict["token"][0]
             if token is None:
                 raise ValueError("Token is missing from headers")
 
             scope["token"] = token
             scope["user"] = await get_user(scope)
-        except ValueError:
-            # Token is missing from headers
+        except (ValueError, KeyError, IndexError):
+            # Token is missing from query string
             from django.contrib.auth.models import AnonymousUser
 
             scope["user"] = AnonymousUser()

chats/websockets_settings.py

@@ -1,6 +1,5 @@
 from dataclasses import dataclass
 from enum import Enum
-from typing import Optional, Union
 
 
 class ChatType(str, Enum):
@@ -25,15 +24,7 @@ class EventGroupType(str, Enum):
     GENERAL_EVENTS = "GENERAL_EVENTS"
 
 
-@dataclass(slots=True, frozen=True)
-class NewMessageEventContent:
-    chat_id: Optional[str]
-    chat_type: Optional[Union[ChatType.DIRECT, ChatType.PROJECT]]
-    message: Optional[str]
-    reply_to: Optional[int]
-
-
-@dataclass(slots=True, frozen=True)
+@dataclass(frozen=True)
 class Event:
     type: EventType
     content: dict

docs/chats.md

@@ -3,10 +3,9 @@
 ## Общая инфа
 URL для всего вебсокет-релейтед - `/ws/`
 
-В данный момент есть только 1 Consumer (т.е. View, но для вебсокетов). Это ChatsConsumer, живет на `/ws/chats/`.
+В данный момент есть только 1 Consumer (т.е. View, но для вебсокетов). Это ChatConsumer, живет на `/ws/chat/`.
 
-## ChatsConsumer
-`/ws/chats/`
+`/ws/chat/`
 
 ### Подключение
 Чтобы законнектиться, укажите в хедерах авторизацию по Bearer токену (как и для всех других запросов в REST API).
@@ -20,12 +19,12 @@ class Event:
     type: EventType
     content: dict
 ```
-И соответсвенно EventType вот такой:
+И соответственно EventType вот такой:
 ```py
 # эти строки указывать в {"type": event_type}
 
 class EventType(str, Enum):
-    # CHATS RELATED EVENTS
+    # CHAT RELATED EVENTS
     NEW_MESSAGE = "new_message"
     DELETE_MESSAGE = "delete_message"
     READ_MESSAGE = "message_read"
@@ -35,6 +34,40 @@ class EventType(str, Enum):
     SET_ONLINE = "set_online"
     SET_OFFLINE = "set_offline"
 ```
+Пример того, как выглядит Event на новое сообщение
+```json
+{
+  "type": "new_message",
+  "content": {
+    "chat_type": "direct",
+    "chat_id": "12_23",
+    "message": "hello world",
+    "reply_to": 54
+  }
+}
+```
+
+## Методы e.g. Ивенты
+
+### SET_ONLINE/SET_OFFLINE
+Без параметров.
+
+### NEW_MESSAGE
+- `chat_type: str`\
+`"direct"` или `"project"`, зависит от типа чата
+- `chat_id: int/str`\
+Если тип `"project"`, то тип будет `int` и это айди проекта, которому принадлежит чат. Если тип `"direct"`, то это `str`. Выглядит как `{user1_id}_{user2_id}`, **где первое число всегда меньше второго**.
+- `message: str` текст сообщения
+- `reply_to: Optional[int]` айди сообщения, на которое кидается ответ. Если его нет, то обязательно кидать `None`
+
+### TYPING
+- `chat_type` см выше
+- `chat_id` см выше
+
+### READ_MESSAGE
+- `chat_type` см выше
+- `chat_id` см выше
+- `message_id: int` айди сообщение, которое прочитали
 
 #### General events
 

procollab/asgi.py

@@ -2,7 +2,6 @@
 import chats.routing
 
 from channels.routing import ProtocolTypeRouter, URLRouter
-from channels.security.websocket import AllowedHostsOriginValidator
 from django.core.asgi import get_asgi_application
 
 from chats.middleware import TokenAuthMiddleware
@@ -12,8 +11,6 @@
 application = ProtocolTypeRouter(
     {
         "http": get_asgi_application(),
-        "websocket": AllowedHostsOriginValidator(
-            TokenAuthMiddleware(URLRouter(chats.routing.websocket_urlpatterns))
-        ),
+        "websocket": TokenAuthMiddleware(URLRouter(chats.routing.websocket_urlpatterns)),
     }
 )

procollab/settings.py

@@ -27,11 +27,13 @@
 ]
 
 ALLOWED_HOSTS = [
+    "127.0.0.1:8000",
     "127.0.0.1",
     "localhost",
     "0.0.0.0",
     "api.procollab.ru",
-    "127.0.0.1:8000",
+    "app.procollab.ru",
+    "procollab.ru",
 ]
 
 PASSWORD_HASHERS = [
@@ -80,7 +82,7 @@
     "rest_framework_simplejwt",
     "rest_framework_simplejwt.token_blacklist",
     "django_cleanup.apps.CleanupConfig",
-    "rest_framework.authtoken",
+    # "rest_framework.authtoken",
     # Plugins
     "corsheaders",
     "django_filters",
@@ -169,23 +171,31 @@
 
     CHANNEL_LAYERS = {"default": {"BACKEND": "channels.layers.InMemoryChannelLayer"}}
 else:
-    CHANNEL_LAYERS = {
-        "default": {
-            "BACKEND": "channels_redis.core.RedisChannelLayer",
-            "CONFIG": {
-                "hosts": [("127.0.0.1", 6379)],
-            },
-        },
-    }
-
-    REDIS_HOST = config("REDIS_HOST", cast=str, default="127.0.0.1")
+    # fixme
     CACHES = {
         "default": {
-            "BACKEND": "django.core.cache.backends.redis.RedisCache",
-            "LOCATION": f"redis://{REDIS_HOST}:6379",
+            "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
         }
     }
 
+    CHANNEL_LAYERS = {"default": {"BACKEND": "channels.layers.InMemoryChannelLayer"}}
+    # CHANNEL_LAYERS = {
+    #     "default": {
+    #         "BACKEND": "channels_redis.core.RedisChannelLayer",
+    #         "CONFIG": {
+    #             "hosts": [("127.0.0.1", 6379)],
+    #         },
+    #     },
+    # }
+    #
+    # REDIS_HOST = config("REDIS_HOST", cast=str, default="127.0.0.1")
+    # CACHES = {
+    #     "default": {
+    #         "BACKEND": "django.core.cache.backends.redis.RedisCache",
+    #         "LOCATION": f"redis://{REDIS_HOST}:6379",
+    #     }
+    # }
+
     REST_FRAMEWORK["DEFAULT_RENDERER_CLASSES"] = [
         "rest_framework.renderers.JSONRenderer",
     ]
@@ -252,7 +262,7 @@
     "UPDATE_LAST_LOGIN": False,
     "ALGORITHM": "HS256",
     "SIGNING_KEY": SECRET_KEY,
-    "VERIFYING_KEY": None,
+    "VERIFYING_KEY": True,
     "AUDIENCE": None,
     "ISSUER": None,
     "JWK_URL": None,
@@ -273,8 +283,7 @@
 }
 
 if DEBUG:
-    SIMPLE_JWT["ACCESS_TOKEN_LIFETIME"] = timedelta(weeks=1)
-
+    SIMPLE_JWT["ACCESS_TOKEN_LIFETIME"] = timedelta(seconds=30)
 
 SESSION_COOKIE_SECURE = False
 

projects/constants.py

@@ -0,0 +1,9 @@
+VERBOSE_STEPS = (
+    (0, "Идея"),
+    (1, "Прототип"),
+    (2, "MVP(Минимально жизнеспособный продукт)"),
+    (3, "Первые продажи"),
+    (4, "Масштабирование"),
+)
+
+RECOMMENDATIONS_COUNT = 5

projects/helpers.py

@@ -1,7 +1,35 @@
-VERBOSE_STEPS = (
-    (0, "Идея"),
-    (1, "Прототип"),
-    (2, "MVP(Минимально жизнеспособный продукт)"),
-    (3, "Первые продажи"),
-    (4, "Масштабирование"),
-)
+from random import sample
+
+from django.contrib.auth import get_user_model
+
+from projects.constants import RECOMMENDATIONS_COUNT
+from projects.models import Project
+
+User = get_user_model()
+
+
+def get_recommended_users(project: Project) -> list[User]:
+    """
+    Searches for users by matching their key_skills and vacancies required_skills
+    """
+
+    # fixme: store key_skills and required_skills more convenient, not just as a string
+    all_needed_skills = set()
+    for vacancy in project.vacancies.all():
+        all_needed_skills.update(set(vacancy.required_skills.lower().split(",")))
+
+    recommended_users = []
+    for user in User.objects.get_members():
+        if user == project.leader or not user.key_skills:
+            continue
+
+        skills = set(user.key_skills.lower().split(","))
+        if skills.intersection(all_needed_skills):
+            recommended_users.append(user)
+
+    # get some random users
+    sampled_recommended_users = sample(
+        recommended_users, min(RECOMMENDATIONS_COUNT, len(recommended_users))
+    )
+
+    return sampled_recommended_users

projects/managers.py

@@ -70,6 +70,9 @@ def check_if_owns_any_projects(self, user) -> bool:
         # I don't think this should work but the function has no usages, so I'll let it be
         return user.leader_projects.exists()
 
+    def get_projects_from_list_of_ids(self, ids):
+        return self.get_queryset().filter(id__in=ids)
+
 
 class AchievementManager(Manager):
     def get_achievements_for_list_view(self):