autotel 4.0.0 → 4.2.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.
Files changed (232) hide show
  1. package/README.md +26 -1
  2. package/dist/auto.cjs +2 -2
  3. package/dist/auto.js +1 -1
  4. package/dist/correlation-id.cjs +1 -1
  5. package/dist/correlation-id.js +1 -1
  6. package/dist/decorators.cjs +1 -1
  7. package/dist/decorators.js +1 -1
  8. package/dist/{event-Dlqr4ZNL.cjs → event-BhHREDJk.cjs} +3 -3
  9. package/dist/{event-Dlqr4ZNL.cjs.map → event-BhHREDJk.cjs.map} +1 -1
  10. package/dist/{event-_58ryBjh.js → event-ByBTV9M2.js} +3 -3
  11. package/dist/{event-_58ryBjh.js.map → event-ByBTV9M2.js.map} +1 -1
  12. package/dist/event.cjs +1 -1
  13. package/dist/event.js +1 -1
  14. package/dist/{functional-BGkT8J-h.js → functional-DtI0u4vx.js} +19 -19
  15. package/dist/functional-DtI0u4vx.js.map +1 -0
  16. package/dist/{functional-C4CzoVrX.cjs → functional-zpzNLhky.cjs} +4 -4
  17. package/dist/{functional-C4CzoVrX.cjs.map → functional-zpzNLhky.cjs.map} +1 -1
  18. package/dist/functional.cjs +1 -1
  19. package/dist/functional.js +1 -1
  20. package/dist/http.cjs +1 -1
  21. package/dist/http.js +1 -1
  22. package/dist/index.cjs +5 -5
  23. package/dist/index.d.cts +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +5 -5
  26. package/dist/{init-DJQOdVlN.d.ts → init-B7u-DjxM.d.ts} +57 -2
  27. package/dist/init-B7u-DjxM.d.ts.map +1 -0
  28. package/dist/{init-DvapOXCc.cjs → init-BX7AmFRl.cjs} +40 -21
  29. package/dist/init-BX7AmFRl.cjs.map +1 -0
  30. package/dist/{init-Ch6t7MNI.js → init-D-jnNMix.js} +39 -20
  31. package/dist/init-D-jnNMix.js.map +1 -0
  32. package/dist/{init-CNp-ee80.d.cts → init-DSrRmVnz.d.cts} +57 -2
  33. package/dist/init-DSrRmVnz.d.cts.map +1 -0
  34. package/dist/instrumentation.cjs +1 -1
  35. package/dist/instrumentation.js +1 -1
  36. package/dist/logger-D3Ej3DII.js +446 -0
  37. package/dist/logger-D3Ej3DII.js.map +1 -0
  38. package/dist/logger-thMPLpOG.cjs +487 -0
  39. package/dist/logger-thMPLpOG.cjs.map +1 -0
  40. package/dist/logger.cjs +8 -236
  41. package/dist/logger.js +2 -204
  42. package/dist/messaging.cjs +1 -1
  43. package/dist/messaging.js +1 -1
  44. package/dist/semantic-helpers.cjs +1 -1
  45. package/dist/semantic-helpers.js +1 -1
  46. package/dist/{track-3HY4NGV-.cjs → track-D59FfpL0.cjs} +2 -2
  47. package/dist/{track-3HY4NGV-.cjs.map → track-D59FfpL0.cjs.map} +1 -1
  48. package/dist/{track-nsKVy-pj.js → track-wc0HafS_.js} +6 -6
  49. package/dist/track-wc0HafS_.js.map +1 -0
  50. package/dist/webhook.cjs +1 -1
  51. package/dist/webhook.js +1 -1
  52. package/dist/workflow-distributed.cjs +1 -1
  53. package/dist/workflow-distributed.js +1 -1
  54. package/dist/workflow.cjs +1 -1
  55. package/dist/workflow.js +1 -1
  56. package/dist/{yaml-config-B3dQ82GR.cjs → yaml-config-Ck2uB0Dp.cjs} +2 -1
  57. package/dist/yaml-config-Ck2uB0Dp.cjs.map +1 -0
  58. package/dist/yaml-config.cjs +1 -1
  59. package/dist/yaml-config.d.cts +7 -1
  60. package/dist/yaml-config.d.cts.map +1 -1
  61. package/dist/yaml-config.d.ts +7 -1
  62. package/dist/yaml-config.d.ts.map +1 -1
  63. package/dist/yaml-config.js +1 -0
  64. package/dist/yaml-config.js.map +1 -1
  65. package/package.json +1 -2
  66. package/skills/autotel-core/SKILL.md +2 -0
  67. package/skills/autotel-instrumentation/SKILL.md +25 -0
  68. package/skills/debug-missing-spans/SKILL.md +3 -1
  69. package/skills/migrate-to-autotel/SKILL.md +24 -23
  70. package/skills/review-otel-patterns/SKILL.md +5 -4
  71. package/dist/functional-BGkT8J-h.js.map +0 -1
  72. package/dist/init-CNp-ee80.d.cts.map +0 -1
  73. package/dist/init-Ch6t7MNI.js.map +0 -1
  74. package/dist/init-DJQOdVlN.d.ts.map +0 -1
  75. package/dist/init-DvapOXCc.cjs.map +0 -1
  76. package/dist/logger.cjs.map +0 -1
  77. package/dist/logger.js.map +0 -1
  78. package/dist/track-nsKVy-pj.js.map +0 -1
  79. package/dist/yaml-config-B3dQ82GR.cjs.map +0 -1
  80. package/src/attribute-redacting-processor.test.ts +0 -763
  81. package/src/attribute-redacting-processor.ts +0 -621
  82. package/src/attributes/attachers.ts +0 -161
  83. package/src/attributes/builders.ts +0 -529
  84. package/src/attributes/domains.ts +0 -42
  85. package/src/attributes/index.ts +0 -81
  86. package/src/attributes/registry.ts +0 -323
  87. package/src/attributes/types.ts +0 -211
  88. package/src/attributes/utils.ts +0 -64
  89. package/src/attributes/validators.ts +0 -266
  90. package/src/attributes.test.ts +0 -292
  91. package/src/auto.ts +0 -67
  92. package/src/autotel-logger.test.ts +0 -548
  93. package/src/autotel-logger.ts +0 -364
  94. package/src/baggage-span-processor.test.ts +0 -202
  95. package/src/baggage-span-processor.ts +0 -100
  96. package/src/business-baggage.test.ts +0 -500
  97. package/src/business-baggage.ts +0 -669
  98. package/src/circuit-breaker.test.ts +0 -341
  99. package/src/circuit-breaker.ts +0 -184
  100. package/src/config.test.ts +0 -94
  101. package/src/config.ts +0 -172
  102. package/src/correlated-events.test.ts +0 -151
  103. package/src/correlated-events.ts +0 -47
  104. package/src/correlation-id.test.ts +0 -163
  105. package/src/correlation-id.ts +0 -206
  106. package/src/db.test.ts +0 -252
  107. package/src/db.ts +0 -447
  108. package/src/decorators.test.ts +0 -153
  109. package/src/decorators.ts +0 -188
  110. package/src/define-event.test.ts +0 -41
  111. package/src/define-event.ts +0 -58
  112. package/src/devtools.ts +0 -60
  113. package/src/drain-pipeline.test.ts +0 -68
  114. package/src/drain-pipeline.ts +0 -199
  115. package/src/drain-toolkit.test.ts +0 -113
  116. package/src/drain-toolkit.ts +0 -129
  117. package/src/enricher-toolkit.test.ts +0 -67
  118. package/src/enricher-toolkit.ts +0 -79
  119. package/src/enrichers.test.ts +0 -150
  120. package/src/enrichers.ts +0 -145
  121. package/src/env-config.test.ts +0 -323
  122. package/src/env-config.ts +0 -309
  123. package/src/error-catalog.test.ts +0 -133
  124. package/src/error-catalog.ts +0 -262
  125. package/src/event-queue.test.ts +0 -864
  126. package/src/event-queue.ts +0 -699
  127. package/src/event-subscriber.ts +0 -262
  128. package/src/event-testing.ts +0 -197
  129. package/src/event.test.ts +0 -1104
  130. package/src/event.ts +0 -988
  131. package/src/events-config.ts +0 -235
  132. package/src/exporters.ts +0 -165
  133. package/src/filtering-span-processor.test.ts +0 -281
  134. package/src/filtering-span-processor.ts +0 -111
  135. package/src/flatten-attributes.test.ts +0 -76
  136. package/src/flatten-attributes.ts +0 -80
  137. package/src/functional.strict-types.typecheck.ts +0 -53
  138. package/src/functional.test.ts +0 -1464
  139. package/src/functional.ts +0 -2539
  140. package/src/functional.types.test.ts +0 -135
  141. package/src/hook.mjs +0 -15
  142. package/src/http.test.ts +0 -485
  143. package/src/http.ts +0 -424
  144. package/src/index.ts +0 -433
  145. package/src/init-auto-redactor.test.ts +0 -53
  146. package/src/init-redactor.test.ts +0 -8
  147. package/src/init.customization.test.ts +0 -594
  148. package/src/init.integrations.test.ts +0 -399
  149. package/src/init.openllmetry.test.ts +0 -194
  150. package/src/init.protocol.test.ts +0 -215
  151. package/src/init.ts +0 -2312
  152. package/src/instrumentation.test.ts +0 -108
  153. package/src/instrumentation.ts +0 -319
  154. package/src/logger.test.ts +0 -125
  155. package/src/logger.ts +0 -341
  156. package/src/messaging-adapters.test.ts +0 -595
  157. package/src/messaging-adapters.ts +0 -583
  158. package/src/messaging-testing.test.ts +0 -573
  159. package/src/messaging-testing.ts +0 -935
  160. package/src/messaging.test.ts +0 -1646
  161. package/src/messaging.ts +0 -2245
  162. package/src/metric-helpers.ts +0 -47
  163. package/src/metric-testing.ts +0 -197
  164. package/src/metric.ts +0 -446
  165. package/src/metrics.test.ts +0 -241
  166. package/src/node-require.ts +0 -123
  167. package/src/operation-context.ts +0 -93
  168. package/src/parse-error.test.ts +0 -73
  169. package/src/parse-error.ts +0 -112
  170. package/src/posthog-logs.test.ts +0 -115
  171. package/src/posthog-logs.ts +0 -77
  172. package/src/pretty-console-exporter.test.ts +0 -545
  173. package/src/pretty-console-exporter.ts +0 -413
  174. package/src/pretty-log-formatter.test.ts +0 -123
  175. package/src/pretty-log-formatter.ts +0 -210
  176. package/src/processors/canonical-log-line-processor.test.ts +0 -523
  177. package/src/processors/canonical-log-line-processor.ts +0 -396
  178. package/src/processors.ts +0 -152
  179. package/src/rate-limiter.test.ts +0 -199
  180. package/src/rate-limiter.ts +0 -98
  181. package/src/redact-values.test.ts +0 -90
  182. package/src/redact-values.ts +0 -34
  183. package/src/register.ts +0 -37
  184. package/src/request-logger.test.ts +0 -545
  185. package/src/request-logger.ts +0 -342
  186. package/src/sampling.test.ts +0 -1060
  187. package/src/sampling.ts +0 -737
  188. package/src/security-schema.test.ts +0 -45
  189. package/src/security-schema.ts +0 -107
  190. package/src/semantic-conventions.ts +0 -15
  191. package/src/semantic-helpers.test.ts +0 -226
  192. package/src/semantic-helpers.ts +0 -438
  193. package/src/shutdown.test.ts +0 -364
  194. package/src/shutdown.ts +0 -246
  195. package/src/span-name-normalizer.test.ts +0 -377
  196. package/src/span-name-normalizer.ts +0 -213
  197. package/src/stable-hash.ts +0 -27
  198. package/src/structured-error.test.ts +0 -191
  199. package/src/structured-error.ts +0 -157
  200. package/src/stub.integration.test.ts +0 -361
  201. package/src/tail-sampling-processor.test.ts +0 -230
  202. package/src/tail-sampling-processor.ts +0 -55
  203. package/src/test-span-collector.test.ts +0 -234
  204. package/src/test-span-collector.ts +0 -150
  205. package/src/testing.ts +0 -705
  206. package/src/trace-context.test.ts +0 -73
  207. package/src/trace-context.ts +0 -567
  208. package/src/trace-helpers.new.test.ts +0 -278
  209. package/src/trace-helpers.test.ts +0 -290
  210. package/src/trace-helpers.ts +0 -710
  211. package/src/trace-hybrid.test.ts +0 -42
  212. package/src/trace-hybrid.ts +0 -37
  213. package/src/tracer-provider.test.ts +0 -183
  214. package/src/tracer-provider.ts +0 -266
  215. package/src/track.test.ts +0 -154
  216. package/src/track.ts +0 -216
  217. package/src/validate.test.ts +0 -287
  218. package/src/validate.ts +0 -307
  219. package/src/validation-attributes.ts +0 -43
  220. package/src/validation.test.ts +0 -330
  221. package/src/validation.ts +0 -246
  222. package/src/variable-name-inference.test.ts +0 -178
  223. package/src/variable-name-inference.ts +0 -242
  224. package/src/webhook.test.ts +0 -649
  225. package/src/webhook.ts +0 -637
  226. package/src/workflow-distributed.test.ts +0 -786
  227. package/src/workflow-distributed.ts +0 -916
  228. package/src/workflow.async-safety.integration.test.ts +0 -345
  229. package/src/workflow.test.ts +0 -647
  230. package/src/workflow.ts +0 -810
  231. package/src/yaml-config.test.ts +0 -337
  232. package/src/yaml-config.ts +0 -342
package/src/validation.ts DELETED
@@ -1,246 +0,0 @@
1
- /**
2
- * Input validation for events events and attributes
3
- *
4
- * Prevents:
5
- * - Invalid event names
6
- * - Oversized payloads
7
- * - Circular references
8
- * - Sensitive data leaks
9
- */
10
-
11
- import type { EventAttributes } from './event-subscriber';
12
-
13
- export interface ValidationConfig {
14
- /** Max event name length (default: 100) */
15
- maxEventNameLength: number;
16
- /** Max attribute key length (default: 100) */
17
- maxAttributeKeyLength: number;
18
- /** Max attribute value length for strings (default: 1000) */
19
- maxAttributeValueLength: number;
20
- /** Max total attributes per event (default: 50) */
21
- maxAttributeCount: number;
22
- /** Max nesting depth for objects (default: 3) */
23
- maxNestingDepth: number;
24
- /** Sensitive field patterns to redact */
25
- sensitivePatterns: RegExp[];
26
- }
27
-
28
- const DEFAULT_CONFIG: ValidationConfig = {
29
- maxEventNameLength: 100,
30
- maxAttributeKeyLength: 100,
31
- maxAttributeValueLength: 1000,
32
- maxAttributeCount: 50,
33
- maxNestingDepth: 3,
34
- sensitivePatterns: [
35
- /password/i,
36
- /secret/i,
37
- /token/i,
38
- /api[_-]?key/i,
39
- /access[_-]?key/i,
40
- /private[_-]?key/i,
41
- /auth/i,
42
- /credential/i,
43
- /ssn/i,
44
- /credit[_-]?card/i,
45
- ],
46
- };
47
-
48
- export class ValidationError extends Error {
49
- constructor(message: string) {
50
- super(message);
51
- this.name = 'ValidationError';
52
- }
53
- }
54
-
55
- /**
56
- * Validate and sanitize event name
57
- * Throws ValidationError if invalid
58
- */
59
- export function validateEventName(
60
- eventName: string,
61
- config: ValidationConfig = DEFAULT_CONFIG,
62
- ): string {
63
- // Check type
64
- if (typeof eventName !== 'string') {
65
- throw new ValidationError(
66
- `Event name must be a string, got ${typeof eventName}`,
67
- );
68
- }
69
-
70
- // Check non-empty
71
- const trimmed = eventName.trim();
72
- if (trimmed.length === 0) {
73
- throw new ValidationError('Event name cannot be empty');
74
- }
75
-
76
- // Check length
77
- if (trimmed.length > config.maxEventNameLength) {
78
- throw new ValidationError(
79
- `Event name too long (${trimmed.length} chars). ` +
80
- `Max: ${config.maxEventNameLength}`,
81
- );
82
- }
83
-
84
- // Check valid characters (alphanumeric, dots, underscores, hyphens)
85
- if (!/^[a-zA-Z0-9._-]+$/.test(trimmed)) {
86
- throw new ValidationError(
87
- `Event name contains invalid characters: "${trimmed}". ` +
88
- 'Use only letters, numbers, dots, underscores, and hyphens.',
89
- );
90
- }
91
-
92
- return trimmed;
93
- }
94
-
95
- /**
96
- * Validate and sanitize attributes
97
- * Returns sanitized attributes (sensitive data redacted)
98
- */
99
- export function validateAttributes(
100
- attributes: EventAttributes | undefined,
101
- config: ValidationConfig = DEFAULT_CONFIG,
102
- ): EventAttributes | undefined {
103
- if (attributes === undefined || attributes === null) {
104
- return undefined;
105
- }
106
-
107
- // Check type
108
- if (typeof attributes !== 'object' || Array.isArray(attributes)) {
109
- throw new ValidationError('Attributes must be an object');
110
- }
111
-
112
- // Count attributes
113
- const keys = Object.keys(attributes);
114
- if (keys.length > config.maxAttributeCount) {
115
- throw new ValidationError(
116
- `Too many attributes (${keys.length}). ` +
117
- `Max: ${config.maxAttributeCount}`,
118
- );
119
- }
120
-
121
- // Validate and sanitize each attribute
122
- const sanitized: EventAttributes = {};
123
-
124
- for (const key of keys) {
125
- // Validate key
126
- if (key.length > config.maxAttributeKeyLength) {
127
- throw new ValidationError(
128
- `Attribute key too long: "${key.slice(0, 20)}..." ` +
129
- `(${key.length} chars). Max: ${config.maxAttributeKeyLength}`,
130
- );
131
- }
132
-
133
- const value = attributes[key];
134
-
135
- // Redact sensitive *strings* only. Numeric/boolean values are not
136
- // credentials and replacing them with the literal string '[REDACTED]'
137
- // both leaks no useful signal and breaks downstream type expectations
138
- // (e.g. an LLM `promptTokens` counter becoming a string poisons every
139
- // consumer that treats it as a number).
140
- const isSensitive =
141
- typeof value === 'string' &&
142
- config.sensitivePatterns.some((pattern) => pattern.test(key));
143
-
144
- if (isSensitive) {
145
- sanitized[key] = '[REDACTED]';
146
- continue;
147
- }
148
-
149
- sanitized[key] = sanitizeValue(value, config, 1) as
150
- | string
151
- | number
152
- | boolean;
153
- }
154
-
155
- return sanitized;
156
- }
157
-
158
- /**
159
- * Sanitize attribute value (recursive)
160
- */
161
- function sanitizeValue(
162
- value: unknown,
163
- config: ValidationConfig,
164
- depth: number,
165
- ): unknown {
166
- // Check nesting depth
167
- if (depth > config.maxNestingDepth) {
168
- return '[MAX_DEPTH_EXCEEDED]';
169
- }
170
-
171
- // Handle null/undefined
172
- if (value === null || value === undefined) {
173
- return value;
174
- }
175
-
176
- // Handle primitives
177
- if (typeof value === 'string') {
178
- if (value.length > config.maxAttributeValueLength) {
179
- return value.slice(0, config.maxAttributeValueLength) + '...';
180
- }
181
- return value;
182
- }
183
-
184
- if (typeof value === 'number' || typeof value === 'boolean') {
185
- return value;
186
- }
187
-
188
- // Handle arrays
189
- if (Array.isArray(value)) {
190
- return value.map((item) => sanitizeValue(item, config, depth + 1));
191
- }
192
-
193
- // Handle objects
194
- if (typeof value === 'object') {
195
- try {
196
- // Check for circular references
197
- JSON.stringify(value);
198
-
199
- const sanitized: Record<string, unknown> = {};
200
- for (const key in value) {
201
- if (Object.prototype.hasOwnProperty.call(value, key)) {
202
- const nested = (value as Record<string, unknown>)[key];
203
- // See top-level branch above: only string values are redacted.
204
- const isSensitive =
205
- typeof nested === 'string' &&
206
- config.sensitivePatterns.some((pattern) => pattern.test(key));
207
-
208
- sanitized[key] = isSensitive
209
- ? '[REDACTED]'
210
- : sanitizeValue(nested, config, depth + 1);
211
- }
212
- }
213
- return sanitized;
214
- } catch {
215
- // Circular reference detected
216
- return '[CIRCULAR]';
217
- }
218
- }
219
-
220
- // Unsupported type (function, symbol, etc.)
221
- return `[${typeof value}]`;
222
- }
223
-
224
- /**
225
- * Validate and sanitize an events event
226
- * Returns { eventName, attributes } with sanitized values
227
- */
228
- export function validateEvent(
229
- eventName: string,
230
- attributes?: EventAttributes,
231
- config?: Partial<ValidationConfig>,
232
- ): { eventName: string; attributes?: EventAttributes } {
233
- const fullConfig = { ...DEFAULT_CONFIG, ...config };
234
-
235
- return {
236
- eventName: validateEventName(eventName, fullConfig),
237
- attributes: validateAttributes(attributes, fullConfig),
238
- };
239
- }
240
-
241
- /**
242
- * Get default validation config (for testing/customization)
243
- */
244
- export function getDefaultValidationConfig(): ValidationConfig {
245
- return { ...DEFAULT_CONFIG };
246
- }
@@ -1,178 +0,0 @@
1
- import { describe, it, expect, beforeEach } from 'vitest';
2
- import {
3
- inferVariableNameFromCallStack,
4
- clearInferenceCache,
5
- } from './variable-name-inference';
6
-
7
- // Helper function that simulates trace() for testing
8
- function trace<T>(fn: T): T {
9
- const varName = inferVariableNameFromCallStack();
10
- // Attach the inferred name to the function for verification
11
- (fn as { __inferredName?: string }).__inferredName = varName;
12
- return fn;
13
- }
14
-
15
- describe('variable-name-inference', () => {
16
- beforeEach(() => {
17
- // Clear cache before each test to ensure isolation
18
- clearInferenceCache();
19
- });
20
-
21
- describe('inferVariableNameFromCallStack', () => {
22
- it('should infer variable name from const assignment', () => {
23
- const testFunction = trace(() => 'test');
24
-
25
- expect((testFunction as { __inferredName?: string }).__inferredName).toBe(
26
- 'testFunction',
27
- );
28
- });
29
-
30
- it('should cache inference results', () => {
31
- // Helper to test caching from same location
32
- function callFromSameLocation() {
33
- const cachedResult = trace(() => 'test');
34
- return (cachedResult as { __inferredName?: string }).__inferredName;
35
- }
36
-
37
- const result1 = callFromSameLocation();
38
- const result2 = callFromSameLocation();
39
-
40
- // Both calls from same location should get same cached result
41
- expect(result1).toBe('cachedResult');
42
- expect(result2).toBe('cachedResult');
43
- });
44
-
45
- it('should gracefully handle errors', () => {
46
- // This test verifies that even if something goes wrong,
47
- // the function returns undefined rather than throwing
48
- expect(() => trace(() => 'test')).not.toThrow();
49
- });
50
- });
51
-
52
- describe('pattern matching', () => {
53
- // These tests verify that the regex patterns work correctly
54
- // by creating actual assignments and checking inference
55
-
56
- it('should match const pattern', () => {
57
- const myConstVariable = trace(() => 'test');
58
- expect(
59
- (myConstVariable as { __inferredName?: string }).__inferredName,
60
- ).toBe('myConstVariable');
61
- });
62
-
63
- it('should handle camelCase names', () => {
64
- const myCamelCaseVariableName = trace(() => 'test');
65
- expect(
66
- (myCamelCaseVariableName as { __inferredName?: string }).__inferredName,
67
- ).toBe('myCamelCaseVariableName');
68
- });
69
-
70
- it('should handle PascalCase names', () => {
71
- const MyPascalCaseName = trace(() => 'test');
72
- expect(
73
- (MyPascalCaseName as { __inferredName?: string }).__inferredName,
74
- ).toBe('MyPascalCaseName');
75
- });
76
-
77
- it('should handle snake_case names', () => {
78
- const my_snake_case_name = trace(() => 'test');
79
- expect(
80
- (my_snake_case_name as { __inferredName?: string }).__inferredName,
81
- ).toBe('my_snake_case_name');
82
- });
83
-
84
- it('should handle names with numbers', () => {
85
- const myVariable123 = trace(() => 'test');
86
- expect(
87
- (myVariable123 as { __inferredName?: string }).__inferredName,
88
- ).toBe('myVariable123');
89
- });
90
-
91
- it('should handle names with dollar signs', () => {
92
- const $myVariable = trace(() => 'test');
93
- expect(($myVariable as { __inferredName?: string }).__inferredName).toBe(
94
- '$myVariable',
95
- );
96
- });
97
-
98
- it('should handle names with underscores', () => {
99
- const _privateVariable = trace(() => 'test');
100
- expect(
101
- (_privateVariable as { __inferredName?: string }).__inferredName,
102
- ).toBe('_privateVariable');
103
- });
104
- });
105
-
106
- describe('edge cases', () => {
107
- it('should handle multiple spaces in assignment', () => {
108
- const spacedVariable = trace(() => 'test');
109
- expect(
110
- (spacedVariable as { __inferredName?: string }).__inferredName,
111
- ).toBe('spacedVariable');
112
- });
113
-
114
- it('should handle assignment with no spaces', () => {
115
- const noSpaces = trace(() => 'test');
116
- expect((noSpaces as { __inferredName?: string }).__inferredName).toBe(
117
- 'noSpaces',
118
- );
119
- });
120
- });
121
-
122
- describe('caching behavior', () => {
123
- it('should cache results for same call location', () => {
124
- // Helper function to call from same location multiple times
125
- function callFromSameLocation() {
126
- const cachedResult = trace(() => 'test');
127
- return (cachedResult as { __inferredName?: string }).__inferredName;
128
- }
129
-
130
- const result1 = callFromSameLocation();
131
- const result2 = callFromSameLocation();
132
-
133
- // Both calls from same source location should return same result
134
- expect(result1).toBe('cachedResult');
135
- expect(result2).toBe('cachedResult');
136
- });
137
-
138
- it('should clear cache when requested', () => {
139
- const beforeClear = trace(() => 'test');
140
- const result1 = (beforeClear as { __inferredName?: string })
141
- .__inferredName;
142
-
143
- clearInferenceCache();
144
-
145
- const afterClear = trace(() => 'test');
146
- const result2 = (afterClear as { __inferredName?: string })
147
- .__inferredName;
148
-
149
- // Both should infer correctly regardless of cache
150
- expect(result1).toBe('beforeClear');
151
- expect(result2).toBe('afterClear');
152
- });
153
- });
154
-
155
- describe('integration with trace pattern', () => {
156
- it('should work with factory pattern simulation', () => {
157
- // Simulate the factory pattern: trace((ctx) => async () => {})
158
- const myFactoryFunction = trace((_ctx: unknown) => async () => {
159
- return 'test';
160
- });
161
-
162
- expect(
163
- (myFactoryFunction as { __inferredName?: string }).__inferredName,
164
- ).toBe('myFactoryFunction');
165
- });
166
-
167
- it('should work with direct pattern simulation', () => {
168
- // Simulate direct pattern: trace(async () => {})
169
- const myDirectFunction = trace(async () => {
170
- return 'test';
171
- });
172
-
173
- expect(
174
- (myDirectFunction as { __inferredName?: string }).__inferredName,
175
- ).toBe('myDirectFunction');
176
- });
177
- });
178
- });
@@ -1,242 +0,0 @@
1
- /**
2
- * Variable Name Inference Utility
3
- *
4
- * Attempts to infer variable names from const/export const assignments
5
- * by analyzing the call stack and parsing source code.
6
- *
7
- * This is a best-effort approach with graceful degradation - if inference
8
- * fails for any reason, it returns undefined without breaking the application.
9
- */
10
-
11
- import { readFileSync } from 'node:fs';
12
- import { fileURLToPath } from 'node:url';
13
-
14
- interface CallLocation {
15
- file: string;
16
- line: number;
17
- column: number;
18
- }
19
-
20
- /**
21
- * LRU Cache for inferred variable names
22
- * Key: "file:line" (e.g., "/path/to/file.ts:42")
23
- * Value: inferred variable name or undefined
24
- */
25
- const inferenceCache = new Map<string, string | undefined>();
26
- const MAX_CACHE_SIZE = 50;
27
-
28
- /**
29
- * Captures the current call stack
30
- */
31
- function captureStackTrace(): string {
32
- const originalStackTraceLimit = Error.stackTraceLimit;
33
- Error.stackTraceLimit = 10; // Only need first few frames
34
-
35
- const err = new Error('Stack trace capture');
36
- const stack = err.stack || '';
37
-
38
- Error.stackTraceLimit = originalStackTraceLimit;
39
- return stack;
40
- }
41
-
42
- /**
43
- * Parses the stack trace to find where trace() was called
44
- *
45
- * Stack trace format (Node.js):
46
- * at functionName (file:line:column)
47
- * at file:line:column
48
- *
49
- * We skip frames until we find one that's NOT in functional.ts or this file.
50
- * We also need to skip one additional frame (the trace/span/instrument function itself)
51
- * to get to the actual user code.
52
- */
53
- function parseCallLocation(stack: string): CallLocation | undefined {
54
- const lines = stack.split('\n');
55
- let skippedExternalFrame = false;
56
-
57
- for (const line of lines) {
58
- // Skip if line contains this file or functional.ts (internal frames)
59
- // Be specific about the filename to avoid matching test files
60
- if (
61
- line.includes('variable-name-inference.ts') ||
62
- line.includes('variable-name-inference.js') ||
63
- line.includes('functional.ts') ||
64
- line.includes('functional.js')
65
- ) {
66
- continue;
67
- }
68
-
69
- // Match various stack trace formats
70
- // Format 1: at functionName (file:line:column)
71
- // Format 2: at file:line:column
72
- const match =
73
- line.match(/at\s+(?:.*\s+)?\(?([^:]+):(\d+):(\d+)\)?/) ||
74
- line.match(/^.*?([^:]+):(\d+):(\d+)/);
75
-
76
- if (match) {
77
- let filePath = match[1]!.trim();
78
-
79
- // Handle file:// URLs (convert to paths)
80
- if (filePath.startsWith('file://')) {
81
- try {
82
- filePath = fileURLToPath(filePath);
83
- } catch {
84
- continue;
85
- }
86
- }
87
-
88
- // Skip the first external frame (the trace/span function itself)
89
- // We want the frame where the user CALLS trace(), not inside trace()
90
- if (!skippedExternalFrame) {
91
- skippedExternalFrame = true;
92
- continue;
93
- }
94
-
95
- return {
96
- file: filePath,
97
- line: Number.parseInt(match[2]!, 10),
98
- column: Number.parseInt(match[3]!, 10),
99
- };
100
- }
101
- }
102
-
103
- return undefined;
104
- }
105
-
106
- /**
107
- * Reads a specific line from a source file
108
- */
109
- function readSourceLine(
110
- filePath: string,
111
- lineNumber: number,
112
- ): string | undefined {
113
- try {
114
- // Check if we can access the file system (not available in edge runtimes)
115
- if (typeof readFileSync !== 'function') {
116
- return undefined;
117
- }
118
-
119
- const content = readFileSync(filePath, 'utf8');
120
- const lines = content.split('\n');
121
-
122
- // Line numbers are 1-based
123
- return lines[lineNumber - 1];
124
- } catch {
125
- // File doesn't exist, permission denied, or other error
126
- return undefined;
127
- }
128
- }
129
-
130
- /**
131
- * Extracts variable name from source code line using regex patterns
132
- *
133
- * Supported patterns:
134
- * - const varName = anyFunction(
135
- * - export const varName = anyFunction(
136
- * - let varName = anyFunction(
137
- * - var varName = anyFunction(
138
- *
139
- * Note: This won't work with destructuring assignments or complex patterns
140
- */
141
- function extractVariableName(sourceLine: string): string | undefined {
142
- // Remove leading/trailing whitespace
143
- const trimmed = sourceLine.trim();
144
-
145
- // Pattern: (export)? (const|let|var) varName = anyFunctionCall(
146
- // We match any function call, not just trace(), to support wrapper functions
147
- const patterns = [
148
- // export const varName = anyFunction(
149
- /export\s+const\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\s*=\s*[a-zA-Z_$][a-zA-Z0-9_$]*\s*\(/,
150
- // const varName = anyFunction(
151
- /const\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\s*=\s*[a-zA-Z_$][a-zA-Z0-9_$]*\s*\(/,
152
- // export let varName = anyFunction(
153
- /export\s+let\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\s*=\s*[a-zA-Z_$][a-zA-Z0-9_$]*\s*\(/,
154
- // let varName = anyFunction(
155
- /let\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\s*=\s*[a-zA-Z_$][a-zA-Z0-9_$]*\s*\(/,
156
- // export var varName = anyFunction(
157
- /export\s+var\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\s*=\s*[a-zA-Z_$][a-zA-Z0-9_$]*\s*\(/,
158
- // var varName = anyFunction(
159
- /var\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\s*=\s*[a-zA-Z_$][a-zA-Z0-9_$]*\s*\(/,
160
- ];
161
-
162
- for (const pattern of patterns) {
163
- const match = trimmed.match(pattern);
164
- if (match && match[1]) {
165
- return match[1];
166
- }
167
- }
168
-
169
- return undefined;
170
- }
171
-
172
- /**
173
- * Adds an entry to the cache with LRU eviction
174
- */
175
- function cacheInference(key: string, value: string | undefined): void {
176
- // If cache is full, remove oldest entry (first entry in Map)
177
- if (inferenceCache.size >= MAX_CACHE_SIZE) {
178
- const firstKey = inferenceCache.keys().next().value;
179
- if (firstKey) {
180
- inferenceCache.delete(firstKey);
181
- }
182
- }
183
-
184
- inferenceCache.set(key, value);
185
- }
186
-
187
- /**
188
- * Main entry point: Attempts to infer the variable name from the call stack
189
- *
190
- * This function:
191
- * 1. Captures the call stack
192
- * 2. Parses it to find where trace() was called (file + line)
193
- * 3. Reads that line from the source file
194
- * 4. Extracts the variable name using regex
195
- *
196
- * Returns undefined if inference fails at any step (graceful degradation).
197
- * Results are cached to avoid repeated file I/O.
198
- *
199
- * @returns The inferred variable name, or undefined if inference failed
200
- */
201
- export function inferVariableNameFromCallStack(): string | undefined {
202
- try {
203
- // Capture stack trace
204
- const stack = captureStackTrace();
205
-
206
- // Parse stack to find trace() call location
207
- const callLocation = parseCallLocation(stack);
208
- if (!callLocation) {
209
- return undefined;
210
- }
211
-
212
- // Check cache
213
- const cacheKey = `${callLocation.file}:${callLocation.line}`;
214
- if (inferenceCache.has(cacheKey)) {
215
- return inferenceCache.get(cacheKey);
216
- }
217
-
218
- // Read source line
219
- const sourceLine = readSourceLine(callLocation.file, callLocation.line);
220
- if (!sourceLine) {
221
- return undefined;
222
- }
223
-
224
- // Extract variable name
225
- const variableName = extractVariableName(sourceLine);
226
-
227
- // Cache result (even if undefined, to avoid repeated failed attempts)
228
- cacheInference(cacheKey, variableName);
229
-
230
- return variableName;
231
- } catch {
232
- // Graceful degradation - don't break the app if inference fails
233
- return undefined;
234
- }
235
- }
236
-
237
- /**
238
- * Clears the inference cache (useful for testing)
239
- */
240
- export function clearInferenceCache(): void {
241
- inferenceCache.clear();
242
- }