Merge branch 'fix/missing-signal' into 'master'

Ensure the event listeners are registered

See merge request pyshare/backend!120

Author: Bogay

mongo/comment.py

@@ -6,7 +6,11 @@
 from .course import Course
 from .user import User
 from .notif import Notif
-from .utils import doc_required, get_redis_client
+from .utils import (
+    doc_required,
+    get_redis_client,
+    logger,
+)
 from .submission import *
 from .event import (
     submission_completed,
@@ -52,11 +56,6 @@ def __new__(cls, pk, *args, **kwargs):
             cls.__initialized = True
         return super().__new__(cls, pk, *args, **kwargs)
 
-    def __init__(self, _id):
-        if isinstance(_id, self.engine):
-            _id = _id.id
-        self.id = _id
-
     @classmethod
     def on_submission_completed(cls, submission):
         if submission.comment is None:
@@ -131,7 +130,7 @@ def delete(self):
         return self
 
     @doc_required('user', 'user', User)
-    def like(self, user):
+    def like(self, user: User):
         '''
         Like/Unlike a comment
         '''
@@ -155,6 +154,8 @@ def like(self, user):
         self.reload()
         user.reload()
         event.send(self, user=user)
+        logger().info(
+            f'User like/unlike comment [user={user.id}, comment={self.id}]')
 
     def submit(self, code=None):
         '''
@@ -187,6 +188,7 @@ def on_submission_completed_ins(self):
             self.update(inc__success=1)
         # Process OJ problem
         if self.problem.is_OJ:
+            # FIXME: There might exists unfinished submissions, their `result` will be `None`
             is_ac = lambda s: s.result.judge_result == Submission.engine.JudgeResult.AC
             self.update(acceptance=self.Acceptance.ACCEPTED if any(
                 map(is_ac, self.submissions)) else self.Acceptance.REJECTED)
@@ -240,6 +242,7 @@ def add_to_problem(
             notif = Notif.new(info)
             target.author.update(push__notifs=notif.pk)
         comment_created.send(comment.reload())
+        logger().info(f'Comment created [comment={comment.id}]')
         return comment
 
     def new_submission(self, code: str):
@@ -271,27 +274,28 @@ def add_to_comment(
         if not target:
             raise engine.DoesNotExist
         # create new comment
-        comment = cls.add(
+        reply = cls.add(
             floor=target.floor,
             depth=1,
             problem=target.problem,
             **ks,
         )
-        target.update(push__replies=comment.obj)
+        target.update(push__replies=reply.obj)
         # notify relevant users
         info = Notif.types.NewReply(
             comment=target.pk,
             problem=target.problem,
         )
         authors = {target.author, target.problem.author} - {
-            comment.author,
+            reply.author,
         }
         if authors:
             notif = Notif.new(info)
         for author in authors:
             author.update(push__notifs=notif.pk)
-        reply_created.send(comment.reload())
-        return comment
+        reply_created.send(reply.reload())
+        logger().info(f'Reply created [comment={target.id}, reply={reply.id}]')
+        return reply
 
     @classmethod
     @doc_required('author', User)

mongo/requirement/leave_comment.py

@@ -18,19 +18,26 @@
     get_redis_client,
     doc_required,
     drop_none,
+    logger,
 )
 from .base import default_on_task_time_changed
 
 
 class LeaveComment(MongoBase, engine=engine.LeaveComment):
     __initialized = False
 
-    def __new__(cls, pk, *args, **kwargs):
-        if not cls.__initialized:
-            comment_created.connect(cls.on_comment_created)
-            task_time_changed.connect(cls.on_task_time_changed)
-            cls.__initialized = True
-        return super().__new__(cls, pk, *args, **kwargs)
+    def __new__(cls, *args, **kwargs):
+        cls.register_event_listener()
+        return super().__new__(cls, *args, **kwargs)
+
+    @classmethod
+    def register_event_listener(cls):
+        if cls.__initialized:
+            return
+        cls.__initialized = True
+        comment_created.connect(cls.on_comment_created)
+        task_time_changed.connect(cls.on_task_time_changed)
+        logger().info(f'Event listener registered [class={cls.__name__}]')
 
     # Declare again because blinker cannot accept `partial` as a reciever
     @classmethod
@@ -92,6 +99,7 @@ def add(
         params = {k: v for k, v in params.items() if v is not None}
         req = cls.engine(**params).save()
         requirement_added.send(req)
+        logger().info(f'Requirement created [requirement={req.id}]')
         return cls(req)
 
     def sync(
@@ -112,3 +120,6 @@ def sync(
         }))
         for comment in comments:
             self.add_comment(comment)
+
+
+LeaveComment.register_event_listener()

mongo/requirement/like_others_comment.py

@@ -16,19 +16,26 @@
 from mongo.utils import (
     get_redis_client,
     doc_required,
+    logger,
 )
 from .base import default_on_task_time_changed
 
 
 class LikeOthersComment(MongoBase, engine=engine.LikeOthersComment):
     __initialized = False
 
-    def __new__(cls, pk, *args, **kwargs):
-        if not cls.__initialized:
-            comment_liked.connect(cls.on_liked)
-            task_time_changed.connect(cls.on_task_time_changed)
-            cls.__initialized = True
-        return super().__new__(cls, pk, *args, **kwargs)
+    def __new__(cls, *args, **kwargs):
+        cls.register_event_listener()
+        return super().__new__(cls, *args, **kwargs)
+
+    @classmethod
+    def register_event_listener(cls):
+        if cls.__initialized:
+            return
+        cls.__initialized = True
+        comment_liked.connect(cls.on_liked)
+        task_time_changed.connect(cls.on_task_time_changed)
+        logger().info(f'Event listener registered [class={cls.__name__}]')
 
     # Declare again because blinker cannot accept `partial` as a reciever
     @classmethod
@@ -75,6 +82,7 @@ def add(
             required_number=required_number,
         ).save()
         requirement_added.send(req)
+        logger().info(f'Requirement created [requirement={req.id}]')
         return cls(req)
 
     def sync(
@@ -93,3 +101,6 @@ def sync(
                 #   instead of when the comment was created
                 if starts_at < comment.created < ends_at:
                     self.add_like(comment, user)
+
+
+LikeOthersComment.register_event_listener()

mongo/requirement/reply_to_comment.py

@@ -17,19 +17,26 @@
     get_redis_client,
     doc_required,
     drop_none,
+    logger,
 )
 from .base import default_on_task_time_changed
 
 
 class ReplyToComment(MongoBase, engine=engine.ReplyToComment):
     __initialized = False
 
-    def __new__(cls, pk, *args, **kwargs):
-        if not cls.__initialized:
-            reply_created.connect(cls.on_reply_created)
-            task_time_changed.connect(cls.on_task_time_changed)
-            cls.__initialized = True
-        return super().__new__(cls, pk, *args, **kwargs)
+    def __new__(cls, *args, **kwargs):
+        cls.register_event_listener()
+        return super().__new__(cls, *args, **kwargs)
+
+    @classmethod
+    def register_event_listener(cls):
+        if cls.__initialized:
+            return
+        cls.__initialized = True
+        reply_created.connect(cls.on_reply_created)
+        task_time_changed.connect(cls.on_task_time_changed)
+        logger().info(f'Event listener registered [class={cls.__name__}]')
 
     # Declare again because blinker cannot accept `partial` as a reciever
     @classmethod
@@ -77,6 +84,7 @@ def add(
         params = {k: v for k, v in params.items() if v is not None}
         req = cls.engine(**params).save()
         requirement_added.send(req)
+        logger().info(f'Requirement created [requirement={req.id}]')
         return cls(req)
 
     def sync(
@@ -97,3 +105,6 @@ def sync(
         }))
         for reply in replies:
             self.add_reply(reply)
+
+
+ReplyToComment.register_event_listener()

mongo/requirement/solve_oj_problem.py

@@ -19,20 +19,27 @@
     get_redis_client,
     doc_required,
     drop_none,
+    logger,
 )
 from .base import default_on_task_time_changed
 
 
 class SolveOJProblem(MongoBase, engine=engine.SolveOJProblem):
     __initialized = False
 
-    def __new__(cls, pk, *args, **kwargs):
+    def __new__(cls, *args, **kwargs):
+        cls.register_event_listener()
+        return super().__new__(cls, *args, **kwargs)
+
+    @classmethod
+    def register_event_listener(cls):
+        if cls.__initialized:
+            return
+        cls.__initialized = True
         # TODO: handle rejudge, which might convert a AC submission into WA
-        if not cls.__initialized:
-            submission_completed.connect(cls.on_submission_completed)
-            task_time_changed.connect(cls.on_task_time_changed)
-            cls.__initialized = True
-        return super().__new__(cls, pk, *args, **kwargs)
+        submission_completed.connect(cls.on_submission_completed)
+        task_time_changed.connect(cls.on_task_time_changed)
+        logger().info(f'Event listener registered [class={cls.__name__}]')
 
     # Declare again because blinker cannot accept `partial` as a reciever
     @classmethod
@@ -60,6 +67,9 @@ def on_submission_completed(cls, submission):
             cls(req).add_submission(submission)
 
     def add_submission(self, submission):
+        logger().debug(
+            f'New submission added to requirement [type=SolveOJProblem, id={self.id}]'
+        )
         if not self.is_valid_submission(submission):
             return
         if submission.problem not in self.problems:
@@ -75,8 +85,15 @@ def add_submission(self, submission):
             if problem in completes:
                 return
             completes.append(problem.id)
+            logger().info(
+                'User solved a new OJ problem '
+                f'[user={user.id}, problem={problem.id}, requirement={self.id}]'
+            )
             if len(completes) >= len(self.problems):
                 record.completed_at = datetime.now()
+                logger().info(
+                    f'User complete requirement [user={user.id}, requirement={self.id}]'
+                )
             self.set_record(user, record)
 
     @classmethod
@@ -97,6 +114,7 @@ def add(
             problems=[p.id for p in problems],
         ).save()
         requirement_added.send(req)
+        logger().info(f'Requirement created [requirement={req.id}]')
         return cls(req)
 
     def sync(
@@ -118,3 +136,6 @@ def sync(
             }))
         for submission in submissions:
             self.add_submission(submission)
+
+
+SolveOJProblem.register_event_listener()

mongo/submission.py

@@ -1,12 +1,15 @@
 from typing import List, Optional
 import base64
-from blinker import signal
 from . import engine
 from .base import MongoBase
 from .user import User
 from .problem import Problem
 from .comment import Comment
-from .utils import doc_required, get_redis_client
+from .utils import (
+    doc_required,
+    get_redis_client,
+    logger,
+)
 from .token import TokenExistError
 from .event import submission_completed
 
@@ -117,6 +120,7 @@ def complete(
             self.result.files = files
             self.save()
             submission_completed.send(self.reload())
+            logger().info(f'Submission judge complete [submission={self.id}]')
         return True
 
     def get_file(self, filename):

mongo/task.py

@@ -8,8 +8,8 @@
 from .base import MongoBase
 from .utils import (
     doc_required,
-    get_redis_client,
     drop_none,
+    logger,
 )
 from .event import (requirement_added, task_time_changed)
 
@@ -111,3 +111,4 @@ def update(self, **ks):
                 old_ends_at=old_ends_at,
             )
             self.reload('requirements')
+            logger().info(f'Task interval updated [task={self.id}]')

pytest.ini

@@ -1,15 +1,2 @@
 [pytest]
-testpaths = 
-    tests/unittest
-    tests/api_test/test_attachment.py
-    tests/api_test/test_problem.py
-    tests/api_test/test_course.py
-    tests/api_test/test_auth.py
-    tests/api_test/test_school.py
-    tests/api_test/test_submission.py
-    tests/api_test/test_user.py
-    tests/api_test/test_tag.py
-    tests/api_test/test_dummy.py
-    tests/api_test/test_sandbox.py
-    tests/api_test/test_task.py
-; python_files = test_problem.py
+testpaths = tests/

requirements.txt

@@ -1,16 +1,14 @@
-# TODO: move test dependencies to tests/requirements.txt
-flask==2.0.1
+flask~=2.1
 gunicorn==20.1.0
 mongoengine==0.23.1
 PyJWT==2.1.0
 requests==2.26.0
 pre-commit==2.8.2
 yapf==0.31.0
 redis==3.5.3
+# TODO: move test dependencies to tests/requirements.txt
 fakeredis==1.6.0
-flask-socketio<5
-python-socketio<5
-python-engineio<4
+flask-socketio~=5.1
 eventlet==0.29.1
 dynaconf==3.1.5
 blinker==1.4