@aomex/async-trace 3.5.0 → 3.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,18 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.6.0](https://github.com/aomex/aomex/compare/v3.5.0...v3.6.0) (2024-10-17)
7
+
8
+
9
+ ### Features
10
+
11
+ * **async-trace:** 方法追踪时,默认标签优先使用displayName属性 ([4458c39](https://github.com/aomex/aomex/commit/4458c397da7498a51323f45e874e1689fb6ac81b))
12
+ * **async-trace:** 记录报错信息 ([4861ee0](https://github.com/aomex/aomex/commit/4861ee03b09869b395f26b2aa3e3aa70dc27fe1f))
13
+
14
+
15
+
16
+
17
+
6
18
  # [3.5.0](https://github.com/aomex/aomex/compare/v3.4.2...v3.5.0) (2024-10-16)
7
19
 
8
20
  **Note:** Version bump only for package @aomex/async-trace
package/dist/index.d.ts CHANGED
@@ -2,6 +2,9 @@ import { AsyncLocalStorage } from 'node:async_hooks';
2
2
  import * as _aomex_core from '@aomex/core';
3
3
 
4
4
  interface AsyncTraceRecord {
5
+ /**
6
+ * 唯一编号,用于识别子链路
7
+ */
5
8
  id: string;
6
9
  /**
7
10
  * 标签
@@ -27,6 +30,10 @@ interface AsyncTraceRecord {
27
30
  * 子链路
28
31
  */
29
32
  children: AsyncTraceRecord[];
33
+ /**
34
+ * 报错内容
35
+ */
36
+ error?: Error | null;
30
37
  }
31
38
  declare class AsyncTrace {
32
39
  records: AsyncTraceRecord[];
package/dist/index.js CHANGED
@@ -13,7 +13,7 @@ var AsyncTrace = class {
13
13
  const start = Date.now();
14
14
  const id = start + "." + this.idSequence;
15
15
  this.storage.run(id, async () => {
16
- const done = () => {
16
+ const done = (err) => {
17
17
  const end = Date.now();
18
18
  this.records.push({
19
19
  id,
@@ -22,16 +22,17 @@ var AsyncTrace = class {
22
22
  delta: end - start,
23
23
  label,
24
24
  parent,
25
- children: this.records.filter((item) => item.parent === id)
25
+ children: this.records.filter((item) => item.parent === id),
26
+ error: err
26
27
  });
27
28
  this.records = this.records.filter((item) => item.parent !== id);
28
29
  };
29
30
  try {
30
31
  const result = await callback(id);
31
- done();
32
+ done(null);
32
33
  resolve(result);
33
34
  } catch (e) {
34
- done();
35
+ done(e instanceof Error ? e : Error(String(e)));
35
36
  reject(e);
36
37
  }
37
38
  });
@@ -73,7 +74,7 @@ var traceMethod = (label, callback) => {
73
74
  let traceId;
74
75
  try {
75
76
  return await asyncTrace.run(
76
- label === void 0 ? `${this.constructor.name}.${String(context.name)}()` : typeof label === "string" ? label : label(...args),
77
+ label === void 0 ? `${"displayName" in this && typeof this.displayName === "string" ? this.displayName : this.constructor.name}.${String(context.name)}()` : typeof label === "string" ? label : label(...args),
77
78
  (id) => {
78
79
  traceId = id;
79
80
  return originalMethod.apply(this, args);
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/async-trace.ts","../src/trace-middleware.ts","../src/trace-method.ts","../src/trace-block.ts"],"sourcesContent":["import { AsyncLocalStorage } from 'node:async_hooks';\n\nexport interface AsyncTraceRecord {\n id: string;\n /**\n * 标签\n */\n label: string;\n /**\n * 开始时间,毫秒时间戳\n */\n start: number;\n /**\n * 结束时间,毫秒时间戳\n */\n end: number;\n /**\n * 时间周期,毫秒\n */\n delta: number;\n /**\n * 父链路\n */\n parent?: string;\n /**\n * 子链路\n */\n children: AsyncTraceRecord[];\n}\n\nclass AsyncTrace {\n public records: AsyncTraceRecord[] = [];\n\n protected readonly storage = new AsyncLocalStorage<string>();\n protected idSequence = 0;\n\n run<T>(label: string, callback: (id: string) => Promise<T>): Promise<T> {\n const parent = this.storage.getStore();\n\n if (++this.idSequence >= Number.MAX_SAFE_INTEGER) {\n this.idSequence = 0;\n }\n\n return new Promise<T>((resolve, reject) => {\n const start = Date.now();\n const id = start + '.' + this.idSequence;\n\n this.storage.run(id, async () => {\n const done = () => {\n const end = Date.now();\n this.records.push({\n id,\n start,\n end,\n delta: end - start,\n label,\n parent,\n children: this.records.filter((item) => item.parent === id),\n });\n this.records = this.records.filter((item) => item.parent !== id);\n };\n\n try {\n const result = await callback(id);\n done();\n resolve(result);\n } catch (e) {\n done();\n reject(e);\n }\n });\n });\n }\n\n getRecord(id: string) {\n const index = this.records.findIndex((item) => item.id === id);\n const record = this.records[index];\n if (record && !record.parent) {\n this.records.splice(index, 1);\n }\n return record!;\n }\n}\n\nexport const asyncTrace = new AsyncTrace();\n","import { middleware } from '@aomex/core';\nimport { asyncTrace, type AsyncTraceRecord } from './async-trace';\n\nexport interface AsyncTraceMiddlewareProps {\n /**\n * 链路追踪记录,仅在中间件后面的任务结束后才会生成\n */\n readonly asyncTrace?: { record: AsyncTraceRecord };\n}\n\n/**\n * 追踪中间件从开始到结束的总链路\n */\nexport const traceMiddleware = (\n label: string,\n callback?: (record: AsyncTraceRecord, ctx: any) => any,\n) => {\n return middleware.mixin<AsyncTraceMiddlewareProps>(async (ctx, next) => {\n let traceId!: string;\n try {\n await asyncTrace.run(label, async (id) => {\n traceId = id;\n await next();\n });\n } finally {\n const record = asyncTrace.getRecord(traceId);\n ctx.asyncTrace = { record };\n await callback?.(record, ctx);\n }\n });\n};\n","import { asyncTrace, type AsyncTraceRecord } from './async-trace';\n\n/**\n * 追踪类的方法或静态方法的链路\n * ```typescript\n * class MyService {\n * .@traceMethod('label')\n * async getData() {\n * return [];\n * }\n * }\n * ```\n */\nexport const traceMethod = <T, P extends (...args: any[]) => Promise<T>>(\n label?: string | ((...args: Parameters<P>) => string),\n callback?: (record: AsyncTraceRecord) => any,\n) => {\n return (originalMethod: P, context: ClassMethodDecoratorContext) => {\n return async function (this: object, ...args: Parameters<P>): Promise<any> {\n let traceId!: string;\n try {\n return await asyncTrace.run<T>(\n label === undefined\n ? `${this.constructor.name}.${String(context.name)}()`\n : typeof label === 'string'\n ? label\n : label(...args),\n (id) => {\n traceId = id;\n return originalMethod.apply(this, args);\n },\n );\n } finally {\n await callback?.(asyncTrace.getRecord(traceId));\n }\n };\n };\n};\n","import { asyncTrace, type AsyncTraceRecord } from './async-trace';\n\n/**\n * 追踪代码段的链路\n * ```typescript\n * const result = await traceBlock('foo', async () => {\n * await ...\n * return 'bar';\n * }, (record)=> {\n * console.log(record); // { label: 'foo', delta: 123, ... }\n * });\n *\n * console.log(result); // 'bar'\n * ```\n */\nexport const traceBlock = async <T>(\n label: string,\n logic: () => Promise<T>,\n callback?: (record: AsyncTraceRecord) => any,\n): Promise<T> => {\n let traceId!: string;\n try {\n return await asyncTrace.run<T>(label, (id) => {\n traceId = id;\n return logic();\n });\n } finally {\n await callback?.(asyncTrace.getRecord(traceId));\n }\n};\n"],"mappings":";AAAA,SAAS,yBAAyB;AA8BlC,IAAM,aAAN,MAAiB;AAAA,EACR,UAA8B,CAAC;AAAA,EAEnB,UAAU,IAAI,kBAA0B;AAAA,EACjD,aAAa;AAAA,EAEvB,IAAO,OAAe,UAAkD;AACtE,UAAM,SAAS,KAAK,QAAQ,SAAS;AAErC,QAAI,EAAE,KAAK,cAAc,OAAO,kBAAkB;AAChD,WAAK,aAAa;AAAA,IACpB;AAEA,WAAO,IAAI,QAAW,CAAC,SAAS,WAAW;AACzC,YAAM,QAAQ,KAAK,IAAI;AACvB,YAAM,KAAK,QAAQ,MAAM,KAAK;AAE9B,WAAK,QAAQ,IAAI,IAAI,YAAY;AAC/B,cAAM,OAAO,MAAM;AACjB,gBAAM,MAAM,KAAK,IAAI;AACrB,eAAK,QAAQ,KAAK;AAAA,YAChB;AAAA,YACA;AAAA,YACA;AAAA,YACA,OAAO,MAAM;AAAA,YACb;AAAA,YACA;AAAA,YACA,UAAU,KAAK,QAAQ,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE;AAAA,UAC5D,CAAC;AACD,eAAK,UAAU,KAAK,QAAQ,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE;AAAA,QACjE;AAEA,YAAI;AACF,gBAAM,SAAS,MAAM,SAAS,EAAE;AAChC,eAAK;AACL,kBAAQ,MAAM;AAAA,QAChB,SAAS,GAAG;AACV,eAAK;AACL,iBAAO,CAAC;AAAA,QACV;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEA,UAAU,IAAY;AACpB,UAAM,QAAQ,KAAK,QAAQ,UAAU,CAAC,SAAS,KAAK,OAAO,EAAE;AAC7D,UAAM,SAAS,KAAK,QAAQ,KAAK;AACjC,QAAI,UAAU,CAAC,OAAO,QAAQ;AAC5B,WAAK,QAAQ,OAAO,OAAO,CAAC;AAAA,IAC9B;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,aAAa,IAAI,WAAW;;;ACpFzC,SAAS,kBAAkB;AAapB,IAAM,kBAAkB,CAC7B,OACA,aACG;AACH,SAAO,WAAW,MAAiC,OAAO,KAAK,SAAS;AACtE,QAAI;AACJ,QAAI;AACF,YAAM,WAAW,IAAI,OAAO,OAAO,OAAO;AACxC,kBAAU;AACV,cAAM,KAAK;AAAA,MACb,CAAC;AAAA,IACH,UAAE;AACA,YAAM,SAAS,WAAW,UAAU,OAAO;AAC3C,UAAI,aAAa,EAAE,OAAO;AAC1B,YAAM,WAAW,QAAQ,GAAG;AAAA,IAC9B;AAAA,EACF,CAAC;AACH;;;ACjBO,IAAM,cAAc,CACzB,OACA,aACG;AACH,SAAO,CAAC,gBAAmB,YAAyC;AAClE,WAAO,kBAAiC,MAAmC;AACzE,UAAI;AACJ,UAAI;AACF,eAAO,MAAM,WAAW;AAAA,UACtB,UAAU,SACN,GAAG,KAAK,YAAY,IAAI,IAAI,OAAO,QAAQ,IAAI,CAAC,OAChD,OAAO,UAAU,WACf,QACA,MAAM,GAAG,IAAI;AAAA,UACnB,CAAC,OAAO;AACN,sBAAU;AACV,mBAAO,eAAe,MAAM,MAAM,IAAI;AAAA,UACxC;AAAA,QACF;AAAA,MACF,UAAE;AACA,cAAM,WAAW,WAAW,UAAU,OAAO,CAAC;AAAA,MAChD;AAAA,IACF;AAAA,EACF;AACF;;;ACtBO,IAAM,aAAa,OACxB,OACA,OACA,aACe;AACf,MAAI;AACJ,MAAI;AACF,WAAO,MAAM,WAAW,IAAO,OAAO,CAAC,OAAO;AAC5C,gBAAU;AACV,aAAO,MAAM;AAAA,IACf,CAAC;AAAA,EACH,UAAE;AACA,UAAM,WAAW,WAAW,UAAU,OAAO,CAAC;AAAA,EAChD;AACF;","names":[]}
1
+ {"version":3,"sources":["../src/async-trace.ts","../src/trace-middleware.ts","../src/trace-method.ts","../src/trace-block.ts"],"sourcesContent":["import { AsyncLocalStorage } from 'node:async_hooks';\n\nexport interface AsyncTraceRecord {\n /**\n * 唯一编号,用于识别子链路\n */\n id: string;\n /**\n * 标签\n */\n label: string;\n /**\n * 开始时间,毫秒时间戳\n */\n start: number;\n /**\n * 结束时间,毫秒时间戳\n */\n end: number;\n /**\n * 时间周期,毫秒\n */\n delta: number;\n /**\n * 父链路\n */\n parent?: string;\n /**\n * 子链路\n */\n children: AsyncTraceRecord[];\n /**\n * 报错内容\n */\n error?: Error | null;\n}\n\nclass AsyncTrace {\n public records: AsyncTraceRecord[] = [];\n\n protected readonly storage = new AsyncLocalStorage<string>();\n protected idSequence = 0;\n\n run<T>(label: string, callback: (id: string) => Promise<T>): Promise<T> {\n const parent = this.storage.getStore();\n\n if (++this.idSequence >= Number.MAX_SAFE_INTEGER) {\n this.idSequence = 0;\n }\n\n return new Promise<T>((resolve, reject) => {\n const start = Date.now();\n const id = start + '.' + this.idSequence;\n\n this.storage.run(id, async () => {\n const done = (err: Error | null) => {\n const end = Date.now();\n this.records.push({\n id,\n start,\n end,\n delta: end - start,\n label,\n parent,\n children: this.records.filter((item) => item.parent === id),\n error: err,\n });\n this.records = this.records.filter((item) => item.parent !== id);\n };\n\n try {\n const result = await callback(id);\n done(null);\n resolve(result);\n } catch (e) {\n done(e instanceof Error ? e : Error(String(e)));\n reject(e);\n }\n });\n });\n }\n\n getRecord(id: string) {\n const index = this.records.findIndex((item) => item.id === id);\n const record = this.records[index];\n if (record && !record.parent) {\n this.records.splice(index, 1);\n }\n return record!;\n }\n}\n\nexport const asyncTrace = new AsyncTrace();\n","import { middleware } from '@aomex/core';\nimport { asyncTrace, type AsyncTraceRecord } from './async-trace';\n\nexport interface AsyncTraceMiddlewareProps {\n /**\n * 链路追踪记录,仅在中间件后面的任务结束后才会生成\n */\n readonly asyncTrace?: { record: AsyncTraceRecord };\n}\n\n/**\n * 追踪中间件从开始到结束的总链路\n */\nexport const traceMiddleware = (\n label: string,\n callback?: (record: AsyncTraceRecord, ctx: any) => any,\n) => {\n return middleware.mixin<AsyncTraceMiddlewareProps>(async (ctx, next) => {\n let traceId!: string;\n try {\n await asyncTrace.run(label, async (id) => {\n traceId = id;\n await next();\n });\n } finally {\n const record = asyncTrace.getRecord(traceId);\n ctx.asyncTrace = { record };\n await callback?.(record, ctx);\n }\n });\n};\n","import { asyncTrace, type AsyncTraceRecord } from './async-trace';\n\n/**\n * 追踪类的方法或静态方法的链路\n * ```typescript\n * class MyService {\n * .@traceMethod('label')\n * async getData() {\n * return [];\n * }\n * }\n * ```\n */\nexport const traceMethod = <T, P extends (...args: any[]) => Promise<T>>(\n label?: string | ((...args: Parameters<P>) => string),\n callback?: (record: AsyncTraceRecord) => any,\n) => {\n return (originalMethod: P, context: ClassMethodDecoratorContext) => {\n return async function (this: object, ...args: Parameters<P>): Promise<any> {\n let traceId!: string;\n try {\n return await asyncTrace.run<T>(\n label === undefined\n ? `${\n 'displayName' in this && typeof this.displayName === 'string'\n ? this.displayName\n : this.constructor.name\n }.${String(context.name)}()`\n : typeof label === 'string'\n ? label\n : label(...args),\n (id) => {\n traceId = id;\n return originalMethod.apply(this, args);\n },\n );\n } finally {\n await callback?.(asyncTrace.getRecord(traceId));\n }\n };\n };\n};\n","import { asyncTrace, type AsyncTraceRecord } from './async-trace';\n\n/**\n * 追踪代码段的链路\n * ```typescript\n * const result = await traceBlock('foo', async () => {\n * await ...\n * return 'bar';\n * }, (record)=> {\n * console.log(record); // { label: 'foo', delta: 123, ... }\n * });\n *\n * console.log(result); // 'bar'\n * ```\n */\nexport const traceBlock = async <T>(\n label: string,\n logic: () => Promise<T>,\n callback?: (record: AsyncTraceRecord) => any,\n): Promise<T> => {\n let traceId!: string;\n try {\n return await asyncTrace.run<T>(label, (id) => {\n traceId = id;\n return logic();\n });\n } finally {\n await callback?.(asyncTrace.getRecord(traceId));\n }\n};\n"],"mappings":";AAAA,SAAS,yBAAyB;AAqClC,IAAM,aAAN,MAAiB;AAAA,EACR,UAA8B,CAAC;AAAA,EAEnB,UAAU,IAAI,kBAA0B;AAAA,EACjD,aAAa;AAAA,EAEvB,IAAO,OAAe,UAAkD;AACtE,UAAM,SAAS,KAAK,QAAQ,SAAS;AAErC,QAAI,EAAE,KAAK,cAAc,OAAO,kBAAkB;AAChD,WAAK,aAAa;AAAA,IACpB;AAEA,WAAO,IAAI,QAAW,CAAC,SAAS,WAAW;AACzC,YAAM,QAAQ,KAAK,IAAI;AACvB,YAAM,KAAK,QAAQ,MAAM,KAAK;AAE9B,WAAK,QAAQ,IAAI,IAAI,YAAY;AAC/B,cAAM,OAAO,CAAC,QAAsB;AAClC,gBAAM,MAAM,KAAK,IAAI;AACrB,eAAK,QAAQ,KAAK;AAAA,YAChB;AAAA,YACA;AAAA,YACA;AAAA,YACA,OAAO,MAAM;AAAA,YACb;AAAA,YACA;AAAA,YACA,UAAU,KAAK,QAAQ,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE;AAAA,YAC1D,OAAO;AAAA,UACT,CAAC;AACD,eAAK,UAAU,KAAK,QAAQ,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE;AAAA,QACjE;AAEA,YAAI;AACF,gBAAM,SAAS,MAAM,SAAS,EAAE;AAChC,eAAK,IAAI;AACT,kBAAQ,MAAM;AAAA,QAChB,SAAS,GAAG;AACV,eAAK,aAAa,QAAQ,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC;AAC9C,iBAAO,CAAC;AAAA,QACV;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEA,UAAU,IAAY;AACpB,UAAM,QAAQ,KAAK,QAAQ,UAAU,CAAC,SAAS,KAAK,OAAO,EAAE;AAC7D,UAAM,SAAS,KAAK,QAAQ,KAAK;AACjC,QAAI,UAAU,CAAC,OAAO,QAAQ;AAC5B,WAAK,QAAQ,OAAO,OAAO,CAAC;AAAA,IAC9B;AACA,WAAO;AAAA,EACT;AACF;AAEO,IAAM,aAAa,IAAI,WAAW;;;AC5FzC,SAAS,kBAAkB;AAapB,IAAM,kBAAkB,CAC7B,OACA,aACG;AACH,SAAO,WAAW,MAAiC,OAAO,KAAK,SAAS;AACtE,QAAI;AACJ,QAAI;AACF,YAAM,WAAW,IAAI,OAAO,OAAO,OAAO;AACxC,kBAAU;AACV,cAAM,KAAK;AAAA,MACb,CAAC;AAAA,IACH,UAAE;AACA,YAAM,SAAS,WAAW,UAAU,OAAO;AAC3C,UAAI,aAAa,EAAE,OAAO;AAC1B,YAAM,WAAW,QAAQ,GAAG;AAAA,IAC9B;AAAA,EACF,CAAC;AACH;;;ACjBO,IAAM,cAAc,CACzB,OACA,aACG;AACH,SAAO,CAAC,gBAAmB,YAAyC;AAClE,WAAO,kBAAiC,MAAmC;AACzE,UAAI;AACJ,UAAI;AACF,eAAO,MAAM,WAAW;AAAA,UACtB,UAAU,SACN,GACE,iBAAiB,QAAQ,OAAO,KAAK,gBAAgB,WACjD,KAAK,cACL,KAAK,YAAY,IACvB,IAAI,OAAO,QAAQ,IAAI,CAAC,OACxB,OAAO,UAAU,WACf,QACA,MAAM,GAAG,IAAI;AAAA,UACnB,CAAC,OAAO;AACN,sBAAU;AACV,mBAAO,eAAe,MAAM,MAAM,IAAI;AAAA,UACxC;AAAA,QACF;AAAA,MACF,UAAE;AACA,cAAM,WAAW,WAAW,UAAU,OAAO,CAAC;AAAA,MAChD;AAAA,IACF;AAAA,EACF;AACF;;;AC1BO,IAAM,aAAa,OACxB,OACA,OACA,aACe;AACf,MAAI;AACJ,MAAI;AACF,WAAO,MAAM,WAAW,IAAO,OAAO,CAAC,OAAO;AAC5C,gBAAU;AACV,aAAO,MAAM;AAAA,IACf,CAAC;AAAA,EACH,UAAE;AACA,UAAM,WAAW,WAAW,UAAU,OAAO,CAAC;AAAA,EAChD;AACF;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aomex/async-trace",
3
- "version": "3.5.0",
3
+ "version": "3.6.0",
4
4
  "description": "异步逻辑链路追踪",
5
5
  "repository": "git@github.com:aomex/aomex.git",
6
6
  "homepage": "https://aomex.js.org",
@@ -32,10 +32,10 @@
32
32
  "@aomex/core": "^3.0.0"
33
33
  },
34
34
  "devDependencies": {
35
- "@aomex/console": "^3.5.0",
36
- "@aomex/core": "^3.5.0",
37
- "@aomex/internal-tools": "^3.5.0",
38
- "@aomex/web": "^3.5.0"
35
+ "@aomex/console": "^3.6.0",
36
+ "@aomex/web": "^3.6.0",
37
+ "@aomex/internal-tools": "^3.6.0",
38
+ "@aomex/core": "^3.6.0"
39
39
  },
40
40
  "scripts": {}
41
41
  }