@qiu_jun/monitors 0.0.3 → 0.0.5

package/README.md

@@ -88,3 +88,5 @@ npm publish
 - 性能类（paint/timing/longTask）→ `exc_perf_event`
 - reporter 源码位于 `src/exception/`，与 exception-sdk 逻辑等价，便于独立发版
 - **后台对接与展示**：[backend-integration.md](./backend-integration.md)（与 exception 模块 `/api/exception/*` 接口一一对照）
+
+# npm login --registry=https://registry.npmjs.org/

package/dist/miniprogram.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 小程序监控入口（按需引入）
+ * 与 H5 入口相互独立：transport 基于 wx.request，错误采集基于 wx.onError / wx.onUnhandledRejection
+ */
+import { SDK_VERSION, createReporter } from './exception/reporter';
+import type { ExcReporter } from './exception/reporter';
+import type { ExcEventPayload, ExcSdkOptions, ExcTransport } from './exception/types';
+export type { ExcEventPayload, ExcSdkOptions, ExcReporter, ExcTransport };
+export { SDK_VERSION, createReporter };
+/** 最小 wx 类型声明（避免强制依赖 miniprogram-api-typings） */
+interface WxLike {
+    request(options: {
+        url: string;
+        method?: string;
+        header?: Record<string, string>;
+        data?: string;
+        success?: (res: {
+            statusCode: number;
+        }) => void;
+        fail?: (err: {
+            errMsg?: string;
+        }) => void;
+    }): void;
+    onError(callback: (message: string) => void): void;
+    offError?(callback: (message: string) => void): void;
+    onUnhandledRejection(callback: (res: {
+        reason?: unknown;
+    }) => void): void;
+    offUnhandledRejection?(callback: (res: {
+        reason?: unknown;
+    }) => void): void;
+    onAppHide?(callback: () => void): void;
+    offAppHide?(callback: () => void): void;
+    getAccountInfoSync?(): {
+        miniProgram?: {
+            envVersion?: string;
+            version?: string;
+        };
+    };
+    getSystemInfoSync?(): Record<string, any>;
+}
+/** 小程序 transport：wx.request POST JSON */
+export declare function makeMiniProgramTransport(endpoint: string, wxApi?: WxLike): ExcTransport;
+export interface MiniProgramMonitorOptions extends ExcSdkOptions {
+    /** 用户标识（对齐 H5 侧 IMonitorOptions.userId） */
+    userId?: string;
+    /** 默认取全局 wx；支付宝/百度等可显式传入适配后的 API */
+    wxApi?: WxLike;
+    /** 拦截 App/Page/Component 生命周期（默认 true，须在调用 App()/Page() 之前初始化） */
+    interceptLifecycle?: boolean;
+    /** 拦截 wx.request 上报失败请求（默认 true，上报自身 URL 除外，防递归） */
+    interceptRequest?: boolean;
+}
+export interface MiniProgramMonitor {
+    reporter: ExcReporter;
+    /** 上报自定义事件 */
+    capture: (event: ExcEventPayload) => void;
+    /** 立即上报缓冲中的事件，并还原 App/Page/Component 与 wx.request 的包装 */
+    destroy: () => void;
+}
+/** 小程序监控：创建 reporter + 挂载错误采集（wx.onError / wx.onUnhandledRejection）+ 切后台 flush */
+export declare function createMiniProgramMonitor(options: MiniProgramMonitorOptions): MiniProgramMonitor;

package/dist/miniprogram.js

@@ -0,0 +1,265 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createReporter = exports.SDK_VERSION = void 0;
+exports.makeMiniProgramTransport = makeMiniProgramTransport;
+exports.createMiniProgramMonitor = createMiniProgramMonitor;
+/**
+ * 小程序监控入口（按需引入）
+ * 与 H5 入口相互独立：transport 基于 wx.request，错误采集基于 wx.onError / wx.onUnhandledRejection
+ */
+const reporter_1 = require("./exception/reporter");
+Object.defineProperty(exports, "SDK_VERSION", { enumerable: true, get: function () { return reporter_1.SDK_VERSION; } });
+Object.defineProperty(exports, "createReporter", { enumerable: true, get: function () { return reporter_1.createReporter; } });
+/** 从全局取 wx（微信 / uni-app 等均已注入），取不到返回 undefined */
+function getWx() {
+    return globalThis.wx;
+}
+/** 小程序 transport：wx.request POST JSON */
+function makeMiniProgramTransport(endpoint, wxApi) {
+    const api = wxApi !== null && wxApi !== void 0 ? wxApi : getWx();
+    if (!api)
+        throw new Error('monitor: 未找到 wx 全局对象，请显式传入 wxApi');
+    return (payload, projectKey) => new Promise((resolve, reject) => {
+        api.request({
+            url: endpoint,
+            method: 'POST',
+            header: { 'content-type': 'application/json', 'X-Project-Key': projectKey },
+            data: JSON.stringify(payload),
+            success: (res) => {
+                if (res.statusCode >= 200 && res.statusCode < 300)
+                    resolve();
+                else
+                    reject(Object.assign(new Error(`monitor: 上报失败 ${res.statusCode}`), { statusCode: res.statusCode }));
+            },
+            fail: err => { var _a; return reject(new Error(`monitor: 上报失败 ${(_a = err === null || err === void 0 ? void 0 : err.errMsg) !== null && _a !== void 0 ? _a : 'network error'}`)); },
+        });
+    });
+}
+/** Page/Component 实例生命周期 */
+const PAGE_LIFECYCLES = ['onLoad', 'onShow', 'onReady', 'onHide', 'onUnload', 'onPullDownRefresh', 'onReachBottom', 'onError'];
+/** App 生命周期 */
+const APP_LIFECYCLES = ['onLaunch', 'onShow', 'onHide', 'onPageNotFound'];
+/** Component 生命周期 */
+const COMPONENT_LIFECYCLES = ['attached', 'ready', 'detached'];
+/**
+ * 包装生命周期：正常执行不打扰；抛错（含 async 生命周期 reject）时上报
+ * 带 lifecycle/页面/组件上下文与耗时，然后原样抛出（wx.onError 兜底，内部去重防双报）
+ */
+function wrapLifecycle(fn, name, getContext) {
+    return function (...args) {
+        const start = Date.now();
+        const handleError = (err) => {
+            const e = err instanceof Error ? err : new Error(String(err));
+            lifecycleErrorHandler === null || lifecycleErrorHandler === void 0 ? void 0 : lifecycleErrorHandler({
+                type: 'error',
+                message: e.message,
+                stack: e.stack,
+                lifecycle: name,
+                duration: Date.now() - start,
+                page: getContext().page,
+                component: getContext().component,
+            });
+        };
+        try {
+            const result = fn.apply(this, args);
+            // async 生命周期（如 async onLoad）的 reject
+            if (result instanceof Promise)
+                return result.catch((err) => { handleError(err); throw err; });
+            return result;
+        }
+        catch (err) {
+            handleError(err);
+            throw err;
+        }
+    };
+}
+/** wrapLifecycle 上报出口（由 createMiniProgramMonitor 注入） */
+let lifecycleErrorHandler = null;
+/** 不上报的消息关键字：小程序提审/平台侧产生的导航失败噪声（如 navigateTo:fail page xxx.html is not found） */
+const IGNORED_MESSAGE_KEYWORDS = ['.html is not found'];
+/** 命中关键字的消息不上报 */
+function isIgnoredMessage(message) {
+    return IGNORED_MESSAGE_KEYWORDS.some(keyword => message.includes(keyword));
+}
+/** 短窗口内同消息去重（生命周期包装抛出 + wx.onError 会收到同一条错误） */
+let lastErrorCache = { message: '', time: 0 };
+function isDuplicate(message) {
+    const now = Date.now();
+    if (message === lastErrorCache.message && now - lastErrorCache.time < 5000)
+        return true;
+    lastErrorCache = { message, time: now };
+    return false;
+}
+/**
+ * 拦截全局 App/Page/Component：包装生命周期与组件 methods（抛错时带上下文上报）
+ * 必须在业务代码调用 App()/Page()/Component() 之前执行
+ */
+function interceptConstructors() {
+    const g = globalThis;
+    function wrapDefinition(original, kind) {
+        return function (options) {
+            const lifecycles = kind === 'App' ? APP_LIFECYCLES : kind === 'Page' ? PAGE_LIFECYCLES : COMPONENT_LIFECYCLES;
+            const getContext = () => ({ page: kind === 'App' ? '' : currentPageRoute(), component: kind === 'Component' ? 'Component' : undefined });
+            for (const name of lifecycles) {
+                const fn = options === null || options === void 0 ? void 0 : options[name];
+                if (typeof fn === 'function')
+                    options[name] = wrapLifecycle(fn, name, getContext);
+            }
+            // Component 的 methods 也包一层（组件方法抛错常见于这里）
+            if (kind === 'Component' && (options === null || options === void 0 ? void 0 : options.methods)) {
+                for (const name of Object.keys(options.methods)) {
+                    const fn = options.methods[name];
+                    if (typeof fn === 'function')
+                        options.methods[name] = wrapLifecycle(fn, name, getContext);
+                }
+            }
+            return original.call(this, options);
+        };
+    }
+    const originals = {};
+    for (const key of ['App', 'Page', 'Component']) {
+        if (typeof g[key] === 'function') {
+            originals[key] = g[key];
+            g[key] = Object.assign(wrapDefinition(g[key], key), { __monitor_original__: g[key] });
+        }
+    }
+    return () => {
+        var _a;
+        for (const [key, fn] of Object.entries(originals)) {
+            if (((_a = g[key]) === null || _a === void 0 ? void 0 : _a.__monitor_original__) === fn)
+                g[key] = fn;
+        }
+    };
+}
+function currentPageRoute() {
+    var _a, _b, _c, _d;
+    try {
+        const pages = (_c = (_b = (_a = globalThis).getCurrentPages) === null || _b === void 0 ? void 0 : _b.call(_a)) !== null && _c !== void 0 ? _c : [];
+        const route = (_d = pages[pages.length - 1]) === null || _d === void 0 ? void 0 : _d.route;
+        return route ? `/${route}` : '';
+    }
+    catch (_e) {
+        return '';
+    }
+}
+/** 拦截 wx.request：失败的请求按 H5 侧 request 事件格式上报（上报自身 URL 除外，防递归） */
+function interceptRequest(wxApi, endpoint, capture) {
+    const original = wxApi.request.bind(wxApi);
+    wxApi.request = (options) => {
+        var _a;
+        const url = String((_a = options === null || options === void 0 ? void 0 : options.url) !== null && _a !== void 0 ? _a : '');
+        if (url === endpoint)
+            return original(options);
+        const start = Date.now();
+        return original({
+            ...options,
+            success: (res) => {
+                var _a, _b;
+                if (res.statusCode >= 400) {
+                    capture({
+                        type: 'request',
+                        message: `Request failed [${res.statusCode}]: ${String((_a = options === null || options === void 0 ? void 0 : options.method) !== null && _a !== void 0 ? _a : 'GET').toUpperCase()} ${url}`,
+                        device: { durationMs: Date.now() - start },
+                    });
+                }
+                (_b = options === null || options === void 0 ? void 0 : options.success) === null || _b === void 0 ? void 0 : _b.call(options, res);
+            },
+            fail: (err) => {
+                var _a, _b;
+                capture({
+                    type: 'request',
+                    message: `Request failed [network]: ${String((_a = options === null || options === void 0 ? void 0 : options.method) !== null && _a !== void 0 ? _a : 'GET').toUpperCase()} ${url}`,
+                    device: { durationMs: Date.now() - start, msg: err === null || err === void 0 ? void 0 : err.errMsg },
+                });
+                (_b = options === null || options === void 0 ? void 0 : options.fail) === null || _b === void 0 ? void 0 : _b.call(options, err);
+            },
+        });
+    };
+    return () => {
+        ;
+        wxApi.request = original;
+    };
+}
+/** 小程序监控：创建 reporter + 挂载错误采集（wx.onError / wx.onUnhandledRejection）+ 切后台 flush */
+function createMiniProgramMonitor(options) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    const wxApi = (_a = options.wxApi) !== null && _a !== void 0 ? _a : getWx();
+    if (!wxApi)
+        throw new Error('monitor: 未找到 wx 全局对象，请显式传入 wxApi');
+    const reporter = (0, reporter_1.createReporter)(options, makeMiniProgramTransport(options.endpoint, wxApi));
+    const sys = (_b = wxApi.getSystemInfoSync) === null || _b === void 0 ? void 0 : _b.call(wxApi);
+    const account = (_c = wxApi.getAccountInfoSync) === null || _c === void 0 ? void 0 : _c.call(wxApi).miniProgram;
+    // device 字段与 H5 侧 toExcEvent.baseDeviceFields 对齐：title/url/browser/os/deviceInfo/userAgent
+    const baseDevice = {
+        browser: `miniProgram ${(_d = account === null || account === void 0 ? void 0 : account.envVersion) !== null && _d !== void 0 ? _d : ''}`.trim(),
+        os: String((_e = sys === null || sys === void 0 ? void 0 : sys.system) !== null && _e !== void 0 ? _e : ''),
+        deviceInfo: `${(_f = sys === null || sys === void 0 ? void 0 : sys.brand) !== null && _f !== void 0 ? _f : ''} ${(_g = sys === null || sys === void 0 ? void 0 : sys.model) !== null && _g !== void 0 ? _g : ''}`.trim(),
+        userAgent: String((_h = sys === null || sys === void 0 ? void 0 : sys.host) !== null && _h !== void 0 ? _h : ''),
+    };
+    /** 当前页面路由（对齐 H5 侧的 page: location.href） */
+    const currentPage = currentPageRoute;
+    const withBase = (event) => {
+        var _a, _b, _c, _d, _e, _f;
+        return ({
+            level: 'ERROR',
+            ...event,
+            page: (_a = event.page) !== null && _a !== void 0 ? _a : currentPage(),
+            userId: (_b = event.userId) !== null && _b !== void 0 ? _b : options.userId,
+            release: (_d = (_c = event.release) !== null && _c !== void 0 ? _c : options.release) !== null && _d !== void 0 ? _d : account === null || account === void 0 ? void 0 : account.version,
+            environment: (_f = (_e = event.environment) !== null && _e !== void 0 ? _e : options.environment) !== null && _f !== void 0 ? _f : ((account === null || account === void 0 ? void 0 : account.envVersion) === 'release' ? 'production' : account === null || account === void 0 ? void 0 : account.envVersion),
+            device: { ...baseDevice, ...event.device },
+        });
+    };
+    const onError = (message) => {
+        // 提审等平台侧噪声（如 navigateTo:fail page xxx.html is not found）不上报
+        if (isIgnoredMessage(message))
+            return;
+        // 生命周期包装已上报过的错误（包装后原样抛出会再进这里），5s 内同消息去重
+        if (isDuplicate(message))
+            return;
+        const [msg, ...stackLines] = message.split('\n');
+        reporter.capture(withBase({ type: 'error', message: msg, stack: stackLines.join('\n') || undefined }));
+    };
+    const onUnhandledRejection = (res) => {
+        var _a;
+        const reason = res.reason;
+        const err = reason instanceof Error ? reason : undefined;
+        const message = (_a = err === null || err === void 0 ? void 0 : err.message) !== null && _a !== void 0 ? _a : (typeof reason === 'string' ? reason : JSON.stringify(reason));
+        // 平台噪声消息同样过滤
+        if (isIgnoredMessage(message))
+            return;
+        reporter.capture(withBase({
+            type: 'unhandledrejection',
+            message,
+            stack: err === null || err === void 0 ? void 0 : err.stack,
+        }));
+    };
+    const onAppHide = () => void reporter.flush();
+    wxApi.onError(onError);
+    wxApi.onUnhandledRejection(onUnhandledRejection);
+    (_j = wxApi.onAppHide) === null || _j === void 0 ? void 0 : _j.call(wxApi, onAppHide);
+    const doCapture = (event) => reporter.capture(withBase(event));
+    // 生命周期拦截：包装内抛错 → 带上下文上报；随后原样抛出由 wx.onError 兜底（已去重）
+    lifecycleErrorHandler = info => doCapture({
+        type: 'error',
+        message: info.message,
+        stack: info.stack,
+        device: { lifecycle: info.lifecycle, duration: info.duration, component: info.component },
+    });
+    const restoreConstructors = options.interceptLifecycle !== false ? interceptConstructors() : null;
+    const restoreRequest = options.interceptRequest !== false ? interceptRequest(wxApi, options.endpoint, doCapture) : null;
+    return {
+        reporter,
+        capture: doCapture,
+        destroy: () => {
+            var _a, _b, _c;
+            lifecycleErrorHandler = null;
+            restoreConstructors === null || restoreConstructors === void 0 ? void 0 : restoreConstructors();
+            restoreRequest === null || restoreRequest === void 0 ? void 0 : restoreRequest();
+            (_a = wxApi.offError) === null || _a === void 0 ? void 0 : _a.call(wxApi, onError);
+            (_b = wxApi.offUnhandledRejection) === null || _b === void 0 ? void 0 : _b.call(wxApi, onUnhandledRejection);
+            (_c = wxApi.offAppHide) === null || _c === void 0 ? void 0 : _c.call(wxApi, onAppHide);
+            reporter.destroy();
+        },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qiu_jun/monitors",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "前端监控，用于捕获，分析，和报告网站或应用程序中的异常，错误和性能问题的方法",
   "sideEffects": false,
   "main": "dist/index.js",
@@ -16,6 +16,10 @@
       "types": "./dist/h5.d.ts",
       "default": "./dist/h5.js"
     },
+    "./miniprogram": {
+      "types": "./dist/miniprogram.d.ts",
+      "default": "./dist/miniprogram.js"
+    },
     "./reporter": {
       "types": "./dist/reporter.d.ts",
       "default": "./dist/reporter.js"
@@ -27,6 +31,7 @@
   "scripts": {
     "preinstall": "npx only-allow pnpm",
     "build": "pnpm run clean && pnpm run compile && pnpm run bundle",
+    "prepublishOnly": "pnpm run build",
     "clean": "rimraf dist",
     "compile": "tsc -p tsconfig.build.json",
     "bundle": "vite build"