Merge pull request #27 from mimo-x/optimize_info

fix some issue

Author: mimo-x

.gitignore

@@ -4,6 +4,9 @@ app/mrmax.py
 db/*
 !db/.gitkeep
 /venv/
+.config.py
+__pycache__/
+.DS_Store
 
 /config/config_local.py
 

README.md

@@ -176,9 +176,12 @@
 
 ```bash
 git clone git@github.com:mimo-x/Code-Review-GPT-Gitlab.git
+
 cd Code-Review-GPT-Gitlab
+
 vim ./config/config.py
-docker run -d -v ./config:/workspace/config -p 8080:80 --name codereview xuxin1/llmcodereview:latest
+
+docker run -d --network bridge --add-host=host.docker.internal:host-gateway -v ./config:/workspace/config -p 8080:80 --name codereview xuxin1/llmcodereview:latest
 ```
 
 #### 源代码运行 💻

config/config.py

@@ -1,36 +1,43 @@
 # api 接口封装类
+
 llm_api_impl = "large_model.api.default_api.DefaultApi"
 
 # DeepSeek配置示例
 # api 配置方式参考 docs/config.md
 # 默认使用认UnionLLM，参考：https://github.com/EvalsOne/UnionLLM/tree/main/docs
 # UnionLLM兼容LiteLLM，参考LiteLLM文档：https://docs.litellm.ai/docs
+
 api_config = {
     "api_key": "your deepseek key",
     "model": 'deepseek-chat',
     "provider": "deepseek",
 }
-# # GPT API 配置示例
-# # model list
-# model_gpt_35_turbo = "gpt-3.5-turbo"
-# model_gpt_4o = "gpt-4o"
-#
+
+# demo-proxy-gpt
 # api_config = {
 #     "api_key": "your openai key",
 #     "api_base": "https://api.openai.com/v1",
-#     "model": model_gpt_4o,
+#     "model": "gpt_4o",
 #     "provider": "openai",
 # }
 
-# ollama 配置示例
+# demo-ollama 
 # api_config = {
 #     "api_base": "http://localhost:11434",
 #     "model": "llama3.2",
 #     "provider": "ollama",
 # }
 
+# demo-azure
+# api_config = {
+#     "AZURE_API_KEY": "*",
+#     "AZURE_API_BASE": "https://*.openai.azure.com",
+#     "AZURE_API_VERSION": "2024-10-21",
+#     "model": "azure/o1-mini",
+# }
+
 # Prompt
-gpt_message = """
+GPT_MESSAGE = """
          你是一位资深编程专家，gitlab的分支代码变更将以git diff 字符串的形式提供，请你帮忙review本段代码。然后你review内容的返回内容必须严格遵守下面的格式，包括标题内容。模板中的变量内容解释：
          变量5为: 代码中的优点。变量1:给review打分，分数区间为0~100分。变量2：code review发现的问题点。变量3：具体的修改建议。变量4：是你给出的修改后的代码。 
          必须要求：1. 以精炼的语言、严厉的语气指出存在的问题。2. 你的反馈内容必须使用严谨的markdown格式 3. 不要携带变量内容解释信息。4. 有清晰的标题结构。有清晰的标题结构。有清晰的标题结构。
@@ -57,16 +64,24 @@
 
 # ------------------Gitlab info--------------------------
 # Gitlab url
-gitlab_server_url = "https://gitlab.com"
+GITLAB_SERVER_URL = "https://gitlab.com"
 
 # Gitlab private token
-gitlab_private_token = "gitlab private token"
+GITLAB_PRIVATE_TOKEN = "gitlab private token"
 
 # Gitlab modifies the maximum number of files
-maximum_files = 50
+MAX_FILES = 50
 
 
 # ------------- Message notification --------------------
 # dingding notification （un necessary）
-dingding_bot_webhook = "https://oapi.dingtalk.com/robot/send?access_token=*****************************************"
-dingding_secret = "S********************************950f"
+DINGDING_BOT_WEBHOOK = "https://oapi.dingtalk.com/robot/send?access_token=*****************************************"
+DINGDING_SECRET = "S********************************950f"
+
+
+# ------------- code review settings --------------------
+# expect file types
+EXCLUDE_FILE_TYPES = ['.py', '.java', '.class', '.vue', ".go",".c",".cpp"]
+
+# ignore file types
+IGNORE_FILE_TYPES = ["mod.go"]

doc/config.md

@@ -75,8 +75,8 @@ api_config = {
 
 
 ## Gitlab配置
-- `gitlab_server_url`: Gitlab服务器地址
-- `gitlab_private_token`: Gitlab私有令牌
+- `GITLAB_SERVER_URL`: Gitlab服务器地址
+- `GITLAB_PRIVATE_TOKEN`: Gitlab私有令牌
 - `maximum_files`: Gitlab Merge Request最大文件数
 
 ## 消息通知配置

doc/review.md

@@ -349,7 +349,7 @@ class CustomReviewHandle(ReviewHandle):
       content = filter_diff_content(change['diff'])
       messages = [
           {"role": "system",
-           "content": gpt_message
+           "content": GPT_MESSAGE
            },
           {"role": "user",
            "content": f"请review这部分代码变更{content}",

gitlab_integration/gitlab_fetcher.py

@@ -28,11 +28,11 @@ def get_changes(self, force=False):
         if self._changes_cache and not force:
             return self._changes_cache
         # URL for the GitLab API endpoint
-        url = f"{gitlab_server_url}/api/v4/projects/{self.project_id}/merge_requests/{self.iid}/changes"
+        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
+            "PRIVATE-TOKEN": GITLAB_PRIVATE_TOKEN
         }
 
         # Make the GET request
@@ -58,11 +58,11 @@ def get_file_content(self, file_path, branch_name='main', force=False):
         if file_path in self._file_content_cache and not force:
             return self._file_content_cache[file_path]
         # URL for the GitLab API endpoint
-        url = f"{gitlab_server_url}/api/v4/projects/{self.project_id}/repository/files/{file_path}/raw?ref={branch_name}"
+        url = f"{GITLAB_SERVER_URL}/api/v4/projects/{self.project_id}/repository/files/{file_path}/raw?ref={branch_name}"
 
         # Headers for the request
         headers = {
-            "PRIVATE-TOKEN": gitlab_private_token
+            "PRIVATE-TOKEN": GITLAB_PRIVATE_TOKEN
         }
 
         # Make the GET request
@@ -84,11 +84,11 @@ def get_info(self, force=False):
         if self._info_cache and not force:
             return self._info_cache
         # URL for the GitLab API endpoint
-        url = f"{gitlab_server_url}/api/v4/projects/{self.project_id}/merge_requests/{self.iid}"
+        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
+            "PRIVATE-TOKEN": GITLAB_PRIVATE_TOKEN
         }
 
         # Make the GET request
@@ -115,11 +115,11 @@ def get_info(self):
         :return: Project information
         """
         # URL for the GitLab API endpoint
-        url = f"{gitlab_server_url}/api/v4/projects/{self.project_id}"
+        url = f"{GITLAB_SERVER_URL}/api/v4/projects/{self.project_id}"
 
         # Headers for the request
         headers = {
-            "PRIVATE-TOKEN": gitlab_private_token
+            "PRIVATE-TOKEN": GITLAB_PRIVATE_TOKEN
         }
 
         # Make the GET request
@@ -195,7 +195,7 @@ def find_files_by_keyword(self, keyword, branch_name="main"):
     # 构建带有身份验证信息的 URL
     def _build_authenticated_url(self, repo_url):
         # 如果 URL 使用 https
-        token = gitlab_private_token
+        token = GITLAB_PRIVATE_TOKEN
         if repo_url.startswith("https://"):
             return f"https://oauth2:{token}@{repo_url[8:]}"
         # 如果 URL 使用 http

large_model/api/default_api.py

@@ -16,10 +16,12 @@ def set_config(self, api_config: dict) -> bool:
         if api_config is None:
             raise ValueError("api_config is None")
         for key in api_config:
-            self.params[key] = api_config[key]
             # 如果为大写，则写入环境变量
             if key.isupper():
                 os.environ[key] = api_config[key]
+                continue
+            self.params[key] = api_config[key]
+            
         return True
 
     def generate_text(self, messages: list) -> bool:

response_module/response_target/msg_response/dingtalk_response.py

@@ -36,7 +36,7 @@ def send_dingtalk_message_by_sign(self, message_text):
         """
         timestamp = str(round(time.time() * 1000))
         sign = self.__get_sign(timestamp)
-        webhookurl = f"{dingding_bot_webhook}&timestamp={timestamp}&sign={sign}"
+        webhookurl = f"{DINGDING_BOT_WEBHOOK}&timestamp={timestamp}&sign={sign}"
         # 构建请求头
         headers = {
             "Content-Type": "application/json",
@@ -75,7 +75,7 @@ def send_dingtalk_message_by_key_word(self, project_url):
 
         """
         # 设置钉钉机器人的 Webhook URL
-        webhook_url = dingding_bot_webhook
+        webhook_url = DINGDING_BOT_WEBHOOK
 
         # 要发送的消息内容
         message = f"新工程接入\nurl：{project_url}"
@@ -97,7 +97,7 @@ def __get_sign(self, timestamp):
         :return: 签名
         '''
 
-        secret = dingding_secret
+        secret = DINGDING_SECRET
         secret_enc = secret.encode('utf-8')
         string_to_sign = '{}\n{}'.format(timestamp, secret)
         string_to_sign_enc = string_to_sign.encode('utf-8')

response_module/response_target/msg_response/gitlab_response.py

@@ -22,12 +22,12 @@ def send(self, message):
     @retry(stop_max_attempt_number=3, wait_fixed=2000)
     def send_merge(self, message):
         headers = {
-            "Private-Token": gitlab_private_token,
+            "Private-Token": GITLAB_PRIVATE_TOKEN,
             "Content-Type": "application/json"
         }
         project_id = self.project_id
         merge_request_id = self.merge_request_id
-        url = f"{gitlab_server_url}/api/v4/projects/{project_id}/merge_requests/{merge_request_id}/notes"
+        url = f"{GITLAB_SERVER_URL}/api/v4/projects/{project_id}/merge_requests/{merge_request_id}/notes"
         data = {
             "body": message
         }

review_engine/handler/default_handler.py

@@ -2,8 +2,7 @@
 import threading
 
 from retrying import retry
-
-from config.config import gpt_message
+from config.config import GPT_MESSAGE, EXCLUDE_FILE_TYPES, IGNORE_FILE_TYPES, MAX_FILES
 from review_engine.abstract_handler import ReviewHandle
 from utils.gitlab_parser import filter_diff_content
 from utils.logger import log
@@ -22,8 +21,8 @@ def process_change(change):
 
         futures = []
         for change in changes:
-            if any(change["new_path"].endswith(ext) for ext in ['.py', '.java', '.class', '.vue', ".go"]) and not any(
-                change["new_path"].endswith(ext) for ext in ["mod.go"]):
+            if any(change["new_path"].endswith(ext) for ext in EXCLUDE_FILE_TYPES) and not any(
+                change["new_path"].endswith(ext) for ext in IGNORE_FILE_TYPES):
                 futures.append(executor.submit(process_change, change))
             else:
                 log.info(f"{change['new_path']} 非目标检测文件！")
@@ -38,7 +37,7 @@ def generate_review_note(change, model):
         content = filter_diff_content(change['diff'])
         messages = [
             {"role": "system",
-             "content": gpt_message
+             "content": GPT_MESSAGE
              },
             {"role": "user",
              "content": f"请review这部分代码变更{content}",
@@ -66,8 +65,7 @@ def merge_handle(self, gitlabMergeRequestFetcher, gitlabRepoManager, hook_info,
         self.default_handle(changes, merge_info, hook_info, reply, model)
 
     def default_handle(self, changes, merge_info, hook_info, reply, model):
-        maximum_files = 50
-        if changes and len(changes) <= maximum_files:
+        if changes and len(changes) <= MAX_FILES:
             # Code Review 信息
             review_info = chat_review(changes, generate_review_note, model)
             if review_info:
@@ -110,7 +108,7 @@ def default_handle(self, changes, merge_info, hook_info, reply, model):
                 })
 
 
-        elif changes and len(changes) > maximum_files:
+        elif changes and len(changes) > MAX_FILES:
             reply.add_reply({
                 'title': '__MAIN_REVIEW__',
                 'content': (