@lark-apaas/client-toolkit 1.2.17-alpha.13 → 1.2.17-alpha.14

package/lib/components/AppContainer/RoutePatternTracker.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 监听路由变化，更新当前匹配的参数化路由模式
+ * 供观测 SDK 获取 referer_path 字段
+ */
+export default function RoutePatternTracker(): any;

package/lib/components/AppContainer/RoutePatternTracker.js

@@ -0,0 +1,13 @@
+import { useEffect } from "react";
+import { useLocation } from "react-router-dom";
+import { updateRoutePattern } from "../../utils/routePattern.js";
+function RoutePatternTracker() {
+    const location = useLocation();
+    useEffect(()=>{
+        updateRoutePattern(location.pathname);
+    }, [
+        location.pathname
+    ]);
+    return null;
+}
+export { RoutePatternTracker as default };

package/lib/components/AppContainer/index.js

@@ -4,6 +4,7 @@ import { ConfigProvider } from "antd";
 import { MiaodaInspector } from "@lark-apaas/miaoda-inspector";
 import zh_CN from "antd/locale/zh_CN";
 import IframeBridge from "./IframeBridge.js";
+import RoutePatternTracker from "./RoutePatternTracker.js";
 import { Toaster } from "./sonner.js";
 import { PageHoc } from "./PageHoc.js";
 import { reportTeaEvent } from "./utils/tea.js";
@@ -60,6 +61,7 @@ const App = (props)=>{
             !disableToaster && true !== appFlags.customToaster && /*#__PURE__*/ jsx(Toaster, {}),
             'production' !== process.env.NODE_ENV && /*#__PURE__*/ jsx(MiaodaInspector, {}),
             'production' !== process.env.NODE_ENV && /*#__PURE__*/ jsx(IframeBridge, {}),
+            /*#__PURE__*/ jsx(RoutePatternTracker, {}),
             /*#__PURE__*/ jsx(PageHoc, {
                 children: props.children
             })

package/lib/components/AppContainer/utils/childApi.js

@@ -1,20 +1,6 @@
 import { normalizeBasePath } from "../../../utils/utils.js";
 import { api_delete, api_get, api_head, api_options, api_patch, api_post, api_put } from "./api-panel.js";
-async function getRoutes() {
-    let routes = [
-        {
-            path: '/'
-        }
-    ];
-    try {
-        const basePath = normalizeBasePath(process.env.CLIENT_BASE_PATH);
-        const res = await fetch(`${basePath}/routes.json`);
-        routes = await res.json();
-    } catch (error) {
-        console.warn('get routes.json error', error);
-    }
-    return routes;
-}
+import { getRouteDefinitions } from "../../../utils/routePattern.js";
 async function getSourceMap() {
     if ('vite' === process.env.BUILD_TOOL) return '';
     let sourceMapContent = '';
@@ -28,7 +14,7 @@ async function getSourceMap() {
     return sourceMapContent;
 }
 const childApi = {
-    getRoutes,
+    getRoutes: getRouteDefinitions,
     updateAppInfo: (appInfo)=>{
         dispatchEvent(new CustomEvent('MiaoDaMetaInfoChanged', {
             detail: appInfo

package/lib/utils/axiosConfig.js

@@ -4,6 +4,26 @@ import { logger } from "../apis/logger.js";
 import { getStacktrace } from "../logger/selected-logs.js";
 import { safeStringify } from "./safeStringify.js";
 import { slardar } from "@lark-apaas/internal-slardar";
+import { getCurrentRoutePattern } from "./routePattern.js";
+import { normalizeBasePath } from "./utils.js";
+const APP_CLIENT_API_LOG_TYPE = 'app_client_api_log';
+function getRefererPath() {
+    try {
+        return getCurrentRoutePattern();
+    } catch  {
+        return '/';
+    }
+}
+function getApiField(method, response, errorResponse, fallbackPath) {
+    const matchRoute = response?.headers?.['x-match-route'] || errorResponse?.headers?.['x-match-route'] || '';
+    const routePath = matchRoute || fallbackPath;
+    return `${method} ${routePath}`;
+}
+function stripBasePath(path) {
+    const base = normalizeBasePath(process.env.CLIENT_BASE_PATH);
+    if (base && path.startsWith(base)) return path.slice(base.length) || '/';
+    return path;
+}
 const isValidResponse = (resp)=>null != resp && 'object' == typeof resp && 'config' in resp && null !== resp.config && void 0 !== resp.config && 'object' == typeof resp.config && 'status' in resp && 'number' == typeof resp.status && 'data' in resp;
 async function logResponse(ok, responseOrError) {
     if (isValidResponse(responseOrError)) {
@@ -139,13 +159,20 @@ function handleSpanEnd(cfg, response, error) {
         const errorMessage = error?.message || '未知错误';
         const url = response?.request?.responseURL || errorResponse?.request?.responseURL || cfg.url || "";
         const method = (cfg.method || 'GET').toUpperCase();
-        const path = url.split('?')[0].replace(/^https?:\/\/[^/]+/, '') || '/';
+        const rawPath = url.split('?')[0].replace(/^https?:\/\/[^/]+/, '') || '/';
+        const path = stripBasePath(rawPath);
+        const durationMs = startTime ? Date.now() - startTime : void 0;
+        const referer_path = getRefererPath();
+        const api = getApiField(method, response, errorResponse, path);
+        const type = APP_CLIENT_API_LOG_TYPE;
         const logData = {
             method,
             path,
             url,
-            duration_ms: startTime ? Date.now() - startTime : void 0,
-            status: response ? response.status : errorResponse.status || 0
+            duration_ms: durationMs,
+            status: response ? response.status : errorResponse.status || 0,
+            referer_path,
+            type
         };
         if (error) logData.error_message = errorMessage;
         if ('undefined' != typeof navigator) logData.user_agent = navigator.userAgent;
@@ -158,7 +185,12 @@ function handleSpanEnd(cfg, response, error) {
         const responseData = response?.data || errorResponse?.data;
         if (responseData) logData.response = responseData;
         const level = error ? 'ERROR' : 'INFO';
-        observable.log(level, safeStringify(logData), {}, currentSpan);
+        observable.log(level, safeStringify(logData), {
+            referer_path,
+            api,
+            type,
+            duration_ms: durationMs
+        }, currentSpan);
         'function' == typeof currentSpan.end && currentSpan.end();
     } catch (e) {
         console.error('[AxiosTrace] Log span failed:', e);

package/lib/utils/routePattern.d.ts

@@ -0,0 +1,13 @@
+export declare function getRouteDefinitions(): Promise<{
+    path: string;
+}[]>;
+/**
+ * 根据当前 pathname 匹配路由模式并更新存储
+ * 使用 react-router 的 matchPath 确保匹配逻辑与路由一致
+ */
+export declare function updateRoutePattern(pathname: string): Promise<void>;
+/**
+ * 获取当前匹配的参数化路由模式
+ * 供 axiosConfig 等非 React 上下文使用
+ */
+export declare function getCurrentRoutePattern(): string;

package/lib/utils/routePattern.js

@@ -0,0 +1,63 @@
+import { matchPath } from "react-router-dom";
+import { normalizeBasePath } from "./utils.js";
+let currentRoutePattern = '/';
+let routeDefinitions = null;
+function getInjectedRouteDefinitions() {
+    try {
+        const raw = process.env.__ROUTE_DEFINITIONS__;
+        if (raw) {
+            const parsed = JSON.parse(raw);
+            if (Array.isArray(parsed) && parsed.length > 0) return parsed;
+        }
+    } catch  {}
+    return null;
+}
+async function loadRouteDefinitions() {
+    if (routeDefinitions) return routeDefinitions;
+    const injected = getInjectedRouteDefinitions();
+    if (injected) {
+        routeDefinitions = injected;
+        return routeDefinitions;
+    }
+    try {
+        const basePath = normalizeBasePath(process.env.CLIENT_BASE_PATH);
+        const res = await fetch(`${basePath}/routes.json`);
+        routeDefinitions = await res.json();
+    } catch  {
+        routeDefinitions = [
+            {
+                path: '/'
+            }
+        ];
+    }
+    return routeDefinitions;
+}
+async function getRouteDefinitions() {
+    return loadRouteDefinitions();
+}
+async function updateRoutePattern(pathname) {
+    const routes = await loadRouteDefinitions();
+    const basePath = normalizeBasePath(process.env.CLIENT_BASE_PATH);
+    let relativePath = pathname;
+    if (basePath && pathname.startsWith(basePath)) relativePath = pathname.slice(basePath.length) || '/';
+    const sortedRoutes = [
+        ...routes
+    ].sort((a, b)=>b.path.length - a.path.length);
+    for (const route of sortedRoutes){
+        let routePath = route.path;
+        if (basePath && routePath.startsWith(basePath)) routePath = routePath.slice(basePath.length) || '/';
+        const match = matchPath({
+            path: routePath,
+            end: true
+        }, relativePath);
+        if (match) {
+            currentRoutePattern = routePath;
+            return;
+        }
+    }
+    currentRoutePattern = relativePath;
+}
+function getCurrentRoutePattern() {
+    return currentRoutePattern;
+}
+export { getCurrentRoutePattern, getRouteDefinitions, updateRoutePattern };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/client-toolkit",
-  "version": "1.2.17-alpha.13",
+  "version": "1.2.17-alpha.14",
   "types": "./lib/index.d.ts",
   "main": "./lib/index.js",
   "files": [
@@ -99,7 +99,7 @@
     "@ant-design/colors": "^7.2.1",
     "@ant-design/cssinjs": "^1.24.0",
     "@data-loom/js": "0.4.9",
-    "@lark-apaas/aily-web-sdk": "0.0.2-alpha.15",
+    "@lark-apaas/aily-web-sdk": "^0.0.6",
     "@lark-apaas/auth-sdk": "^0.1.1",
     "@lark-apaas/client-capability": "^0.1.5",
     "@lark-apaas/internal-slardar": ">=0.0.1",