hotfix var name

Author: xin.xu1

app.py

@@ -6,7 +6,7 @@
 app = Flask(__name__)
 app.config['debug'] = True
 
-# 路由组
+# router group
 app.register_blueprint(git, url_prefix='/git')
 
 @app.errorhandler(400)

app/gitlab_utils.py

@@ -12,18 +12,16 @@ def get_merge_request_id(branch_name, project_id):
     :param project_id: 项目id
     :return: 如果分支存在 mr 则返回mrid / 如果不存在mr 则返回 ""
     """
-    # 构建API请求URL
     url = f"{gitlab_server_url}/api/v4/projects/{project_id}/merge_requests"
 
-    # 发送API请求，检查是否有与分支相关的Merge Request
     params = {
         "source_branch": branch_name,
         "state": "opened"  # 可以根据需求选择合适的状态（opened、closed、merged等）
     }
+    
     headers = {"Private-Token": gitlab_private_token}
     response = requests.get(url, params=params, headers=headers)
 
-    # 解析JSON响应并检查是否有相关的Merge Request
     if response.status_code == 200:
         merge_requests = response.json()
         if len(merge_requests) > 0:
@@ -38,27 +36,19 @@ def get_merge_request_id(branch_name, project_id):
 
 @retry(stop_max_attempt_number=3, wait_fixed=2000)
 def get_commit_list(merge_request_iid, project_id):
-    # Create API URL for the merge request commits
     api_url = f"{gitlab_server_url}/api/v4/projects/{project_id}/merge_requests/{merge_request_iid}/commits"
-    # Set the private token in the header
+    
     headers = {"PRIVATE-TOKEN": gitlab_private_token}
-
-    # Make a GET request to the API URL
     response = requests.get(api_url, headers=headers)
+
     commit_list = []
-    # If the response code is 200, the API call was successful
     if response.status_code == 200:
-        # Get the commits from the response
         commits = response.json()
-        # Iterate through the commits and print the commit ID and message
         for commit in commits:
             print(f"Commit ID: {commit['id']}, Message: {commit['message']}")
-            # Append the commit ID to the list
             commit_list.append(commit['id'])
     else:
-        # Log an error if the API call was unsuccessful
         log.error(f"Failed to fetch commits. Status code: {response.status_code}")
-    # Return the list of commit IDs
     return commit_list
 
 
@@ -117,40 +107,38 @@ def add_comment_to_mr(project_id, merge_request_id, comment):
 
 
 @retry(stop_max_attempt_number=3, wait_fixed=2000)
-def get_mr_comment_info(project_id, mr_iid, ):
-    url = f"{gitlab_server_url}/api/v4/projects/{project_id}/merge_requests/{mr_iid}/notes"
+def get_merge_request_comments(project_id, merge_request_iid):
+    url = f"{gitlab_server_url}/api/v4/projects/{project_id}/merge_requests/{merge_request_iid}/notes"
 
-    # 发送API请求
     headers = {"Private-Token": gitlab_private_token}
     response = requests.get(url, headers=headers)
 
-    comments_info = ""
-    # 解析JSON响应
+    comments_content = ""
     if response.status_code == 200:
         comments = response.json()
         for comment in comments:
-            author = comment['author']['username']
-            comment_text = comment['body']
-            print(f"Author: {author}")
-            print(f"Comment: {comment_text}")
-            comments_info += comment_text
+            author_username = comment['author']['username']
+            comment_body = comment['body']
+            print(f"Author: {author_username}")
+            print(f"Comment: {comment_body}")
+            comments_content += comment_body
 
     else:
         print(f" 获取mr comment 失败， Status code: {response.status_code}")
-    return comments_info
+    return comments_content
 
 
 @retry(stop_max_attempt_number=3, wait_fixed=2000)
 def get_commit_change_file(push_info):
     # 获取提交列表
-    commits = push_info['commits']
-    add_file = []
-    modify_file = []
+    commit_list = push_info['commits']
+    added_files_list = []
+    modified_files_list = []
     # 遍历提交
-    for commit in commits:
+    for commit in commit_list:
         added_files = commit.get('added', [])
         modified_files = commit.get('modified', [])
-        add_file += added_files
-        modify_file += modified_files
+        added_files_list += added_files
+        modified_files_list += modified_files
 
-    return add_file + modify_file
+    return added_files_list + modified_files_list

app/gitlab_webhook.py

@@ -20,10 +20,10 @@ def question():
 def webhook():
     if request.method == 'GET':
         # 获取gitlab的webhook的token
-        verify_token = request.headers.get('X-Gitlab-Token')
+        webhook_token = request.headers.get('X-Gitlab-Token')
 
         # gitlab的webhook的token验证
-        if verify_token == WEBHOOK_VERIFY_TOKEN:
+        if webhook_token == WEBHOOK_VERIFY_TOKEN:
             return jsonify({'status': 'success'}), 200
         else:
             return jsonify({'status': 'bad token'}), 401
@@ -33,41 +33,41 @@ def webhook():
         webhook的主要逻辑,获取gitlab的推送信息
         """
         # 获取gitlab的推送信息
-        gitlab_message = request.data.decode('utf-8')
+        gitlab_payload = request.data.decode('utf-8')
         # 将gitlab的推送信息转换为字典
-        gitlab_message = json.loads(gitlab_message)
-        log.info(f"🌈 ：{gitlab_message}")
+        gitlab_payload = json.loads(gitlab_payload)
+        log.info(f"🌈 ：{gitlab_payload}")
         # 获取项目的类型
-        object_kind = gitlab_message.get('object_kind')
+        event_type = gitlab_payload.get('object_kind')
 
         # 首次发起mr时候触发
-        if object_kind == 'merge_request' and gitlab_message.get("object_attributes").get(
-            "state") == "opened" and gitlab_message.get("object_attributes").get("merge_status") == "preparing":
+        if event_type == 'merge_request' and gitlab_payload.get("object_attributes").get(
+            "state") == "opened" and gitlab_payload.get("object_attributes").get("merge_status") == "preparing":
             # 验证通过，获取commit的信息
-            log.info("首次merge_request ", gitlab_message)
+            log.info("首次merge_request ", gitlab_payload)
             # 获取项目id
-            project_id = gitlab_message.get('project')['id']
+            project_id = gitlab_payload.get('project')['id']
             # 获取merge request ID
-            merge_id = gitlab_message.get("object_attributes")["iid"]
+            merge_request_id = gitlab_payload.get("object_attributes")["iid"]
 
-            thread = threading.Thread(target=review_code_for_mr, args=(project_id, merge_id, gitlab_message))
+            thread = threading.Thread(target=review_code_for_mr, args=(project_id, merge_request_id, gitlab_payload))
             thread.start()
 
             return jsonify({'status': 'success'}), 200
-        elif object_kind == 'push':
+        elif event_type == 'push':
             # 获取merge request ID
-            merge_id = get_merge_request_id(gitlab_message.get('ref').split("/")[-1], gitlab_message.get("project_id"))
+            merge_request_id = get_merge_request_id(gitlab_payload.get('ref').split("/")[-1], gitlab_payload.get("project_id"))
             # 获取项目id
-            project_id = gitlab_message.get('project')['id']
-            if not merge_id:
+            project_id = gitlab_payload.get('project')['id']
+            if not merge_request_id:
                 send_dingtalk_message_by_sign(
-                    f"Project_Name:{gitlab_message['project']['name']}\n备注：分支 {gitlab_message.get('ref')} 没有处于open状态的 Merge Request 不进行 Code Review。")
-                return jsonify({'status': f'非存在MR分支,{gitlab_message}'}), 200
+                    f"Project_Name:{gitlab_payload['project']['name']}\n备注：分支 {gitlab_payload.get('ref')} 没有处于open状态的 Merge Request 不进行 Code Review。")
+                return jsonify({'status': f'非存在MR分支,{gitlab_payload}'}), 200
 
-            change_files = get_commit_change_file(gitlab_message)
+            changed_files = get_commit_change_file(gitlab_payload)
 
             thread = threading.Thread(target=review_code_for_add_commit,
-                                      args=(project_id, merge_id, change_files, gitlab_message))
+                                      args=(project_id, merge_request_id, changed_files, gitlab_payload))
             thread.start()
 
             return jsonify({'status': 'success'}), 200
@@ -76,7 +76,7 @@ def webhook():
             log.error("不是merge")
             return jsonify({'status': '操作不为push'}), 200
 
-        return jsonify({'status': f'未匹配到规则,{gitlab_message}'}), 200
+        return jsonify({'status': f'未匹配到规则,{gitlab_payload}'}), 200
 
     else:
         abort(400)

service/chat_review.py

@@ -161,36 +161,36 @@ def review_code_for_mr(project_id, merge_id, gitlab_message):
 
 
 @retry(stop_max_attempt_number=3, wait_fixed=2000)
-def review_code_for_add_commit(project_id, merge_id, commit_change_files, gitlab_message):
+def review_code_for_add_commit(project_id, merge_request_id, changed_files, gitlab_payload):
     """
     code review for gitlab commit
     :param project_id:
-    :param merge_id:
-    :param commit_change_files:
-    :param gitlab_message:
+    :param merge_request_id:
+    :param changed_files:
+    :param gitlab_payload:
     :return: 
     """
-    if len(commit_change_files) > 50:
+    if len(changed_files) > 50:
         send_dingtalk_message_by_sign(
-            f"project_name:{gitlab_message['project']['name']}\n备注：(增量commit)修改文件{len(commit_change_files)}个 > 50个 不进行codereview ⚠️ \n分支名：{gitlab_message.get('ref')}")
+            f"project_name:{gitlab_payload['project']['name']}\n备注：(增量commit)修改文件{len(changed_files)}个 > 50个 不进行codereview ⚠️ \n分支名：{gitlab_payload.get('ref')}")
 
     # 获取diff分支的修改文件列表
-    merge_change_files = get_merge_request_changes(project_id, merge_id)
+    merge_request_files = get_merge_request_changes(project_id, merge_request_id)
 
     # 根据增量commit 修改文件列表过滤merge request二次修改的文件
-    change_files = [file_content for file_content in merge_change_files if
-                    file_content["new_path"] in commit_change_files]
+    filtered_files = [file_content for file_content in merge_request_files if
+                      file_content["new_path"] in changed_files]
 
-    print("😊增量commit 修改文件列表", change_files)
-    if len(change_files) <= 50:
-        review_info = chat_review("", project_id, "", change_files, "", "")
+    print("😊增量commit 修改文件列表", filtered_files)
+    if len(filtered_files) <= 50:
+        review_info = chat_review("", project_id, "", filtered_files, "", "")
         if review_info:
-            add_comment_to_mr(project_id, merge_id, review_info)
+            add_comment_to_mr(project_id, merge_request_id, review_info)
             send_dingtalk_message_by_sign(
-                f"project_name:{gitlab_message['project']['name']}\n增量修改文件个数：{len(change_files)}\ncodereview状态：✅")
+                f"project_name:{gitlab_payload['project']['name']}\n增量修改文件个数：{len(filtered_files)}\ncodereview状态：✅")
 
     else:
         send_dingtalk_message_by_sign(
-            f"project_name:{gitlab_message['project']['name']}\n备注：增量commit 修改{len(change_files)} > 50个文件不进行codereview ⚠️ \n")
+            f"project_name:{gitlab_payload['project']['name']}\n备注：增量commit 修改{len(filtered_files)} > 50个文件不进行codereview ⚠️ \n")
 
 

utils/logger.py

@@ -15,13 +15,9 @@
 NOTSET = 0
 # Set the current directory
 current_dir = os.path.abspath(os.path.dirname(__file__))
-# Set the parent directory
 parent_dir = os.path.abspath(os.path.join(current_dir, ".."))
-# Set the current path
 CURRENT_PATH = os.path.dirname(os.path.abspath(__file__))
-# Set the root path
 ROOT_PATH = os.path.join(CURRENT_PATH, os.pardir)
-# Set the log path
 LOG_PATH = os.path.join(parent_dir, 'logs')
 
 
@@ -64,29 +60,21 @@ def __setFileHandler__(self, level=None):
 
     def __setStreamHandler__(self, level=None):
 
-        # Create a stream handler
         stream_handler = logging.StreamHandler()
-        # Set the format of the handler
         formatter = logging.Formatter(
             '%(asctime)s.%(msecs)03d %(levelname)s | [%(threadName)s] %(name)s [%(lineno)d] | %(filename)s %(funcName)s | %(message)s',
             datefmt='%Y-%m-%d %H:%M:%S')
         stream_handler.setFormatter(formatter)
-        # If no level is specified, set the level to the level of the handler
+
         if not level:
             stream_handler.setLevel(self.level)
-        # Otherwise, set the level to the specified level
         else:
             stream_handler.setLevel(level)
-        # Add the handler to the logger
         self.addHandler(stream_handler)
 
     def resetName(self, name):
-
-        # Set the name of the logger
         self.name = name
-        # Remove the existing file handler
         self.removeHandler(self.file_handler)
-        # Set a new file handler
         self.__setFileHandler__()
 
 project_name = 'chat'