feat(review, reply, gitlab integration): refactor code to achieve modularization, add review handle functionality, and modify reply functionality

Author: Robbings

app/gitlab_webhook.py

@@ -1,5 +1,5 @@
 from flask import Blueprint, request, jsonify
-from webhook_processor.webhook_listener import webhook_listener
+from gitlab_integration.webhook_listener import webhook_listener
 
 git = Blueprint('git', __name__)
 

webhook_processor/__init__.py renamed to gitlab_integration/__init__.py

@@ -0,0 +1,51 @@
+import requests
+from retrying import retry
+from config.config import *
+from utils.logger import log
+
+class GitlabMergeRequestFetcher:
+    def __init__(self, project_id, merge_request_iid):
+        self.project_id = project_id
+        self.iid = merge_request_iid
+
+    @retry(stop_max_attempt_number=3, wait_fixed=2000)
+    def get_changes(self):
+        """
+        Get the changes of the merge request
+        :return: changes
+        """
+        # URL for the GitLab API endpoint
+        url = f"{gitlab_server_url}/api/v4/projects/{self.project_id}/merge_requests/{self.iid}/changes"
+
+        # Headers for the request
+        headers = {
+            "PRIVATE-TOKEN": gitlab_private_token
+        }
+
+        # Make the GET request
+        response = requests.get(url, headers=headers)
+
+        # Check if the request was successful
+        if response.status_code == 200:
+            return response.json()["changes"]
+        else:
+            return None
+
+    @retry(stop_max_attempt_number=3, wait_fixed=2000)
+    def get_info(self):
+        # URL for the GitLab API endpoint
+        url = f"{gitlab_server_url}/api/v4/projects/{self.project_id}/merge_requests/{self.iid}"
+
+        # Headers for the request
+        headers = {
+            "PRIVATE-TOKEN": gitlab_private_token
+        }
+
+        # Make the GET request
+        response = requests.get(url, headers=headers)
+
+        # Check if the request was successful
+        if response.status_code == 200:
+            return response.json()
+        else:
+            return None

gitlab_integration/gitlab_fetcher.py

@@ -3,7 +3,10 @@
 
 from flask import request, jsonify
 
-from app.gitlab_utils import get_merge_request_id, get_commit_change_file
+from app.gitlab_utils import get_merge_request_id, get_commit_change_file, get_merge_request_changes
+from gitlab_integration.gitlab_fetcher import GitlabMergeRequestFetcher
+from reply_module.reply import Reply
+from review_engine.review_engine import ReviewEngine
 from service.chat_review import review_code_for_mr, review_code_for_add_commit
 from utils.dingding import send_dingtalk_message_by_sign
 from utils.logger import log
@@ -22,35 +25,44 @@ def handle_webhook(self):
         gitlab_payload = json.loads(gitlab_payload)
         log.info(f"🌈 ：{gitlab_payload}")
         event_type = gitlab_payload.get('object_kind')
+        return self.call_handle(gitlab_payload, event_type)
 
+    def call_handle(self, gitlab_payload, event_type):
+        reply = Reply(gitlab_payload.get('project')['id'], gitlab_payload.get("object_attributes")["iid"])
         if event_type == 'merge_request':
-            self.handle_merge_request(gitlab_payload)
+            return self.handle_merge_request(gitlab_payload, reply)
         elif event_type == 'push':
-            self.handle_push(gitlab_payload)
+            return self.handle_push(gitlab_payload, reply)
         else:
-            self.handle_other(gitlab_payload)
+            return self.handle_other(gitlab_payload, reply)
 
-    def handle_merge_request(self, gitlab_payload):
+    def handle_merge_request(self, gitlab_payload, reply):
         """
         处理合并请求事件
         """
         if gitlab_payload.get("object_attributes").get("state") == "opened" and gitlab_payload.get("object_attributes").get("merge_status") == "preparing":
             log.info("首次merge_request ", gitlab_payload)
             project_id = gitlab_payload.get('project')['id']
-            merge_request_id = gitlab_payload.get("object_attributes")["iid"]
+            merge_request_iid = gitlab_payload.get("object_attributes")["iid"]
+            review_engine = ReviewEngine(reply)
+            fetcher = GitlabMergeRequestFetcher(project_id, merge_request_iid)
 
-            thread = threading.Thread(target=review_code_for_mr, args=(project_id, merge_request_id, gitlab_payload))
+            changes = fetcher.get_changes()
+            info = fetcher.get_info()
+            thread = threading.Thread(target=review_engine.handle_merge, args=(changes, info, gitlab_payload))
             thread.start()
 
             return jsonify({'status': 'success'}), 200
+        return jsonify({'status': 'do not need check'}), 200
 
-    def handle_push(self, gitlab_payload):
+    def handle_push(self, gitlab_payload, reply):
         """
         处理推送事件
         """
         project_id = gitlab_payload.get('project')['id']
         merge_request_id = get_merge_request_id(gitlab_payload.get('ref').split("/")[-1], gitlab_payload.get("project_id"))
 
+
         if not merge_request_id:
             send_dingtalk_message_by_sign(
                 f"Project_Name:{gitlab_payload['project']['name']}\n备注：分支 {gitlab_payload.get('ref')} 没有处于open状态的 Merge Request 不进行 Code Review。")
@@ -64,7 +76,7 @@ def handle_push(self, gitlab_payload):
 
         return jsonify({'status': 'success'}), 200
 
-    def handle_other(self, gitlab_payload):
+    def handle_other(self, gitlab_payload, reply):
         """
         处理其他事件
         """

webhook_processor/webhook_listener.py renamed to gitlab_integration/webhook_listener.py

@@ -10,32 +10,34 @@ def __init__(self, project_id, merge_request_iid):
         self.project_id = project_id
         self.merge_request_iid = merge_request_iid
 
-    def add_reply(self, reply):
+    def add_reply(self, reply_msg):
         # reply 格式检查：title, content 必选
-        if 'title' not in reply or 'content' not in reply:
+        if 'content' not in reply_msg:
             raise Exception('Reply format error, title and content are required.')
-        if 'priority' in reply:
-            if not isinstance(reply['priority'], int):
+        if 'priority' in reply_msg:
+            if not isinstance(reply_msg['priority'], int):
                 raise Exception('Reply format error, priority should be an integer.')
-            elif reply['priority'] == 0:
-                self.send_single_message(reply)
+            elif reply_msg['priority'] == 0:
+                self.send_single_message(reply_msg)
                 return
 
         with self.lock:  # 加锁
-            self.replies.append(reply)
+            self.replies.append(reply_msg)
 
     def send(self):
         msg_list = {}
+        main_msg = None
         with self.lock:  # 加锁
             # 发送所有消息的逻辑
-            for reply in self.replies:
-                targets = [t.strip() for t in reply['target'].split(',')]
-                if 'all' in targets:
-                    targets = ReplyFactory.get_all_targets()
-                for target in targets:
-                    msg_list[target] = msg_list.get(target, '')
-                    msg_list[target] += f"## {reply['title']}\n\n{reply['content']}\n\n"
+            for msg in self.replies:
+                if msg['title'] == '__MAIN_REVIEW__':
+                    main_msg = msg
+                    continue
+                self.__parse_msg(msg, msg_list)
+
             self.replies = []  # 清空已发送的消息
+        if main_msg:
+            self.__parse_msg(main_msg, msg_list)
         ret = True
         for target, msg in msg_list.items():
             reply_target = ReplyFactory.get_reply_instance(target, self.project_id, self.merge_request_iid)
@@ -52,17 +54,34 @@ def send_single_message(self, reply):
         ret = True
         for target in targets:
             reply_target = ReplyFactory.get_reply_instance(target, self.project_id, self.merge_request_iid)
-            ret &= reply_target.send(f"## {reply['title']}\n\n{reply['content']}\n\n")
+            # 如果title不为__IGNORE__ or __MAIN_REVIEW__, 则发送带有标题的消息
+            if 'title' not in reply or reply['title'] not in ['__IGNORE__', '__MAIN_REVIEW__']:
+                ret &= reply_target.send(f"## {reply['title']}\n\n{reply['content']}\n\n")
+            else:
+                ret &= reply_target.send(reply['content'])
         return ret
 
+    def __parse_msg(self, msg, msg_list):
+        targets = [t.strip() for t in msg['target'].split(',')]
+        if 'all' in targets:
+            targets = ReplyFactory.get_all_targets()
+        for target in targets:
+            msg_list[target] = msg_list.get(target, '')
+            # 如果msg['title']不存在
+            if 'title' not in msg or msg['title'] in ['__IGNORE__', '__MAIN_REVIEW__']:
+                msg_list[target] = f"{msg['content']}\n\n" + msg_list[target]
+            else:
+                msg_list[target] += f"## {msg['title']}\n\n{msg['content']}\n\n"
+
 
 if __name__ == '__main__':
     reply = Reply(9885, 18)
     threads = []
     for i in range(10):
         threads.append(threading.Thread(target=reply.add_reply, args=(
             {'title': f'title{i}', 'content': f'content{i}', 'target': 'gitlab, dingtalk', 'priority': i % 3},)))
-
+    threads.append(threading.Thread(target=reply.add_reply, args=(
+            {'title': '__IGNORE__', 'content': f'content{i}', 'target': 'gitlab, dingtalk', 'priority': i % 3},)))
     for thread in threads:
         thread.start()
     for thread in threads:

reply_module/reply.py

@@ -0,0 +1,11 @@
+import importlib
+import pkgutil
+
+
+
+class ReviewHandle(object):
+    def __init__(self):
+        pass
+
+    def merge_handle(self, changes, merge_info, hook_info, reply):
+        pass