coze-coding-utils 0.2.7__tar.gz → 0.2.8a1__tar.gz

{coze_coding_utils-0.2.7 → coze_coding_utils-0.2.8a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: coze-coding-utils
-Version: 0.2.7
+Version: 0.2.8a1
 Summary: Utilities for Coze coding client runtime context and helpers.
 Project-URL: Homepage, https://code.byted.org/stone/coze-coding-client
 Author: Bytedance Stone Team

{coze_coding_utils-0.2.7 → coze_coding_utils-0.2.8a1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "coze-coding-utils"
-version = "0.2.7"
+version = "0.2.8a1"
 description = "Utilities for Coze coding client runtime context and helpers."
 readme = "README.md"
 requires-python = ">=3.10"

{coze_coding_utils-0.2.7 → coze_coding_utils-0.2.8a1}/src/coze_coding_utils/log/node_log.py

@@ -99,7 +99,7 @@ def create_log_entry(level="info", message="", timestamp=None, log_id=None, late
                      input_data="", output_data="", node_id="", project_id="", commit_id="",
                      execute_mode="run", caller="", node_type="", node_title="",
                      token="", cost="", error_code="", error_message="", event_type="", execution_id="", node_name="",
-                     method=""):
+                     method="", worktree_name="", user_id=""):
     """
     创建符合要求的日志条目
     :param level: 日志级别
@@ -124,6 +124,8 @@ def create_log_entry(level="info", message="", timestamp=None, log_id=None, late
     :param execution_id: 执行唯一ID（可选）
     :param node_name: 节点名称
     :param method: 方法名称
+    :param worktree_name: 当前 worktree 名（主仓为空字符串），便于多 worktree 并发排查
+    :param user_id: 当前用户 ID（沙箱 owner / 调用方），便于多用户并发排查
     :return: 格式化的日志字典
     """
     if timestamp is None:
@@ -156,10 +158,12 @@ def create_log_entry(level="info", message="", timestamp=None, log_id=None, late
         "execute_id": execution_id,
         "node_name": node_name,
         "method": method,
+        "worktree_name": worktree_name,
+        "user_id": user_id,
     }
 
 
-def log_workflow_start(project_id, commit_id, log_id=None, execute_id="", input_data="", method=""):
+def log_workflow_start(project_id, commit_id, log_id=None, execute_id="", input_data="", method="", worktree_name="", user_id=""):
     """
     记录流程开始日志
     :param project_id: 项目ID
@@ -167,6 +171,8 @@ def log_workflow_start(project_id, commit_id, log_id=None, execute_id="", input_
     :param is_test_run: 是否试运行
     :param log_id: 日志ID（可选）
     :param execute_id: 执行唯一ID（可选）
+    :param worktree_name: 当前 worktree 名
+    :param user_id: 当前用户 ID
     """
     event_type = "test_run_start" if not is_prod() else "run_start"
     execute_mode = "test_run" if not is_prod() else "run"
@@ -184,13 +190,15 @@ def log_workflow_start(project_id, commit_id, log_id=None, execute_id="", input_
         execution_id=execute_id,
         input_data=input_data,
         method=method,
+        worktree_name=worktree_name,
+        user_id=user_id,
     )
 
     write_log(log_entry)
 
 
 def log_workflow_end(execution_id, output=None, total_time=None, status="success", token_consumed=None,
-                     error_reason=None, error_code=None, is_test_run=False, log_id="", method=""):
+                     error_reason=None, error_code=None, is_test_run=False, log_id="", method="", worktree_name="", user_id=""):
     """
     记录流程结束日志
     :param execution_id: 执行唯一ID
@@ -201,6 +209,8 @@ def log_workflow_end(execution_id, output=None, total_time=None, status="success
     :param error_reason: 错误原因
     :param error_code: 错误码
     :param is_test_run: 是否试运行
+    :param worktree_name: 当前 worktree 名
+    :param user_id: 当前用户 ID
     """
     level = "error" if status == "error" else "info"
     execute_mode = "test_run" if is_test_run else "run"
@@ -222,6 +232,8 @@ def log_workflow_end(execution_id, output=None, total_time=None, status="success
         execution_id=execution_id,
         log_id=log_id,
         method=method,
+        worktree_name=worktree_name,
+        user_id=user_id,
     )
 
     write_log(log_entry)
@@ -271,7 +283,9 @@ class Logger(BaseCallbackHandler):
                     event_type="node_start",
                     log_id=self.runtime_ctx.logid,
                     method=self.runtime_ctx.method,
-                    node_type="condition"
+                    node_type="condition",
+                    worktree_name=self.runtime_ctx.worktree_name,
+                    user_id=self.runtime_ctx.user_id,
                 )
                 write_log(log_entry)
                 return
@@ -290,6 +304,8 @@ class Logger(BaseCallbackHandler):
             log_id=self.runtime_ctx.logid,
             node_name=node_info.name,
             method=self.runtime_ctx.method,
+            worktree_name=self.runtime_ctx.worktree_name,
+            user_id=self.runtime_ctx.user_id,
         )
         write_log(log_entry)
 
@@ -321,7 +337,9 @@ class Logger(BaseCallbackHandler):
                         event_type="node_end",
                         log_id=self.runtime_ctx.logid,
                         method=self.runtime_ctx.method,
-                        node_type="condition"
+                        node_type="condition",
+                        worktree_name=self.runtime_ctx.worktree_name,
+                        user_id=self.runtime_ctx.user_id,
                     )
                     write_log(log_entry)
                     return
@@ -340,6 +358,8 @@ class Logger(BaseCallbackHandler):
                 log_id=self.runtime_ctx.logid,
                 node_name=node_info.name,
                 method=self.runtime_ctx.method,
+                worktree_name=self.runtime_ctx.worktree_name,
+                user_id=self.runtime_ctx.user_id,
             )
             write_log(log_entry)
 
@@ -354,6 +374,8 @@ class Logger(BaseCallbackHandler):
             execute_id=self.runtime_ctx.run_id,
             input_data=_serialize_data(inputs),
             method=self.runtime_ctx.method,
+            worktree_name=self.runtime_ctx.worktree_name,
+            user_id=self.runtime_ctx.user_id,
         )
 
     def _on_graph_end(self, outputs: Dict[str, Any]):
@@ -367,6 +389,8 @@ class Logger(BaseCallbackHandler):
             log_id=self.runtime_ctx.logid,
             is_test_run=not is_prod(),
             method=self.runtime_ctx.method,
+            worktree_name=self.runtime_ctx.worktree_name,
+            user_id=self.runtime_ctx.user_id,
         )
 
     def on_chain_error(
@@ -409,6 +433,8 @@ class Logger(BaseCallbackHandler):
             error_message=str(error),
             node_name=node_name,
             method=self.runtime_ctx.method,
+            worktree_name=self.runtime_ctx.worktree_name,
+            user_id=self.runtime_ctx.user_id,
         )
         write_log(error_log_entry)
 

{coze_coding_utils-0.2.7 → coze_coding_utils-0.2.8a1}/src/coze_coding_utils/log/write_log.py

@@ -11,10 +11,10 @@ request_context: ContextVar[Optional[Context]] = ContextVar('request_context', d
 
 
 class ContextFilter(logging.Filter):
-    
+
     def filter(self, record: logging.LogRecord) -> bool:
         ctx = request_context.get()
-        
+
         if ctx:
             record.log_id = ctx.logid or ''
             record.run_id = ctx.run_id or ''
@@ -22,6 +22,8 @@ class ContextFilter(logging.Filter):
             record.project_id = ctx.project_id or ''
             record.method = ctx.method or ''
             record.x_tt_env = ctx.x_tt_env or ''
+            record.worktree_name = ctx.worktree_name or ''
+            record.user_id = ctx.user_id or ''
         else:
             record.log_id = ''
             record.run_id = ''
@@ -29,7 +31,9 @@ class ContextFilter(logging.Filter):
             record.project_id = ''
             record.method = ''
             record.x_tt_env = ''
-        
+            record.worktree_name = ''
+            record.user_id = ''
+
         return True
 
 
@@ -44,7 +48,7 @@ class APSchedulerFilter(logging.Filter):
 
 
 class JsonFormatter(logging.Formatter):
-    
+
     def format(self, record: logging.LogRecord) -> str:
         log_data = {
             'message': record.getMessage(),
@@ -57,29 +61,32 @@ class JsonFormatter(logging.Formatter):
             'project_id': getattr(record, 'project_id', ''),
             'method': getattr(record, 'method', ''),
             'x_tt_env': getattr(record, 'x_tt_env', ''),
+            'worktree_name': getattr(record, 'worktree_name', ''),
+            'user_id': getattr(record, 'user_id', ''),
             'lineno': record.lineno,
             'funcName': record.funcName,
         }
 
         if record.exc_info:
             log_data['exc_info'] = self.formatException(record.exc_info)
-        
+
         for key, value in record.__dict__.items():
-            if key not in ['name', 'msg', 'args', 'created', 'filename', 'funcName', 
-                          'levelname', 'levelno', 'lineno', 'module', 'msecs', 
+            if key not in ['name', 'msg', 'args', 'created', 'filename', 'funcName',
+                          'levelname', 'levelno', 'lineno', 'module', 'msecs',
                           'message', 'pathname', 'process', 'processName', 'relativeCreated',
                           'thread', 'threadName', 'exc_info', 'exc_text', 'stack_info',
                           'log_id', 'run_id', 'space_id', 'project_id', 'method',
-                          'x_tt_env', 'rpc_persist_rec_rec_biz_scene', 
+                          'x_tt_env', 'worktree_name', 'user_id',
+                          'rpc_persist_rec_rec_biz_scene',
                           'rpc_persist_coze_record_root_id', 'rpc_persist_rec_root_entity_type',
                           'rpc_persist_rec_root_entity_id']:
                 log_data[key] = value
-        
+
         return json.dumps(log_data, ensure_ascii=False)
 
 
 class PlainTextFormatter(logging.Formatter):
-    
+
     def format(self, record: logging.LogRecord) -> str:
         log_data = {
             'message': record.getMessage(),
@@ -92,24 +99,27 @@ class PlainTextFormatter(logging.Formatter):
             'project_id': getattr(record, 'project_id', ''),
             'method': getattr(record, 'method', ''),
             'x_tt_env': getattr(record, 'x_tt_env', ''),
+            'worktree_name': getattr(record, 'worktree_name', ''),
+            'user_id': getattr(record, 'user_id', ''),
             'lineno': record.lineno,
             'funcName': record.funcName,
         }
-        
+
         if record.exc_info:
             log_data['exc_info'] = self.formatException(record.exc_info)
-        
+
         for key, value in record.__dict__.items():
-            if key not in ['name', 'msg', 'args', 'created', 'filename', 'funcName', 
-                          'levelname', 'levelno', 'lineno', 'module', 'msecs', 
+            if key not in ['name', 'msg', 'args', 'created', 'filename', 'funcName',
+                          'levelname', 'levelno', 'lineno', 'module', 'msecs',
                           'message', 'pathname', 'process', 'processName', 'relativeCreated',
                           'thread', 'threadName', 'exc_info', 'exc_text', 'stack_info',
                           'log_id', 'run_id', 'space_id', 'project_id', 'method',
-                          'x_tt_env', 'rpc_persist_rec_rec_biz_scene', 
+                          'x_tt_env', 'worktree_name', 'user_id',
+                          'rpc_persist_rec_rec_biz_scene',
                           'rpc_persist_coze_record_root_id', 'rpc_persist_rec_root_entity_type',
                           'rpc_persist_rec_root_entity_id']:
                 log_data[key] = value
-        
+
         return json.dumps(log_data, ensure_ascii=False)
 
 

{coze_coding_utils-0.2.7 → coze_coding_utils-0.2.8a1}/src/coze_coding_utils/runtime_ctx/context.py

@@ -20,10 +20,17 @@ HEADER_RPC_PERSIST_RES_REC_ROOT_ENTITY_ID = (
 HEADER_RPC_PERSIST_RES_REC_EXT_INFO = (
     "rpc-persist-res-rec-ext-info"  # 扩展信息，json字符串格式
 )
+# 多 worktree / 多用户排查诊断用：上游可通过 header 透传这两个字段，让本次 ctx 持有它们，
+# 下游的 LangGraph callback / 业务日志直接 record 出来，多会话并发时按字段过滤排查。
+HEADER_X_COZE_WORKTREE_NAME = "x-coze-worktree-name"
+HEADER_X_COZE_USER_ID = "x-coze-user-id"
 
 # Environment variable keys
 ENV_SPACE_ID = "COZE_PROJECT_SPACE_ID"
 ENV_PROJECT_ID = "COZE_PROJECT_ID"
+# 沙箱拉起产物子进程时注入。worktree_name 主仓为空字符串；user_id 为创建沙箱的用户 ID。
+ENV_WORKTREE_NAME = "COZE_WORKTREE_NAME"
+ENV_USER_ID = "COZE_USER_ID"
 
 
 @dataclass(slots=True)
@@ -36,6 +43,11 @@ class Context:
     logid: str = ""
     method: str = ""
 
+    # 多 worktree / 多用户支持：默认读环境变量（沙箱拉起产物时注入），上游 HTTP 请求 header 可覆盖。
+    # 用 "" 表示主仓 / 未提供，避免 None 在 logging record 里出现 'None' 字面值。
+    worktree_name: str = ""
+    user_id: str = ""
+
     x_run_mode: Optional[str] = None
     x_tt_env: Optional[str] = None
     x_use_ppe: Optional[str] = None
@@ -58,6 +70,8 @@ def new_context(
         space_id=os.getenv(ENV_SPACE_ID, ""),
         project_id=os.getenv(ENV_PROJECT_ID, ""),
         method=method,
+        worktree_name=os.getenv(ENV_WORKTREE_NAME, ""),
+        user_id=os.getenv(ENV_USER_ID, ""),
     )
     if headers:
         norm = {k.casefold(): v for k, v in headers.items()}
@@ -67,6 +81,8 @@ def new_context(
             HEADER_X_USE_PPE: "x_use_ppe",
             HEADER_X_TT_ENV_FE: "x_tt_env_fe",
             HEADER_X_RUN_MODE: "x_run_mode",
+            HEADER_X_COZE_WORKTREE_NAME: "worktree_name",
+            HEADER_X_COZE_USER_ID: "user_id",
             HEADER_RPC_PERSIST_RES_REC_BIZ_SCENE: "rpc_persist_res_rec_biz_scene",
             HEADER_RPC_PERSIST_COZE_RECORD_ROOT_ID: "rpc_persist_coze_record_root_id",
             HEADER_RPC_PERSIST_RES_REC_ROOT_ENTITY_TYPE: "rpc_persist_res_rec_root_entity_type",
@@ -91,6 +107,8 @@ def default_headers(ctx: Context | None) -> Dict[str, str]:
         "x_use_ppe": HEADER_X_USE_PPE,
         "x_tt_env_fe": HEADER_X_TT_ENV_FE,
         "x_run_mode": HEADER_X_RUN_MODE,
+        "worktree_name": HEADER_X_COZE_WORKTREE_NAME,
+        "user_id": HEADER_X_COZE_USER_ID,
         "rpc_persist_res_rec_biz_scene": HEADER_RPC_PERSIST_RES_REC_BIZ_SCENE,
         "rpc_persist_coze_record_root_id": HEADER_RPC_PERSIST_COZE_RECORD_ROOT_ID,
         "rpc_persist_res_rec_root_entity_type": HEADER_RPC_PERSIST_RES_REC_ROOT_ENTITY_TYPE,