autotel-playwright 0.2.0 → 0.2.1
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/dist/index.cjs +8 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +9 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.test.ts +53 -1
- package/src/index.ts +8 -2
package/dist/index.cjs
CHANGED
|
@@ -108,9 +108,15 @@ var test = test$1.test.extend({
|
|
|
108
108
|
setAttributesFromAnnotations(span, testInfo);
|
|
109
109
|
const ctx = autotel.otelTrace.setSpan(autotel.context.active(), span);
|
|
110
110
|
const carrier = {};
|
|
111
|
-
autotel.
|
|
111
|
+
autotel.context.with(ctx, () => {
|
|
112
|
+
autotel.propagation.inject(autotel.context.active(), carrier);
|
|
113
|
+
});
|
|
112
114
|
try {
|
|
113
|
-
await use({ carrier, apiBaseUrls, testInfo });
|
|
115
|
+
await autotel.context.with(ctx, () => use({ carrier, apiBaseUrls, testInfo }));
|
|
116
|
+
} catch (error) {
|
|
117
|
+
span.setStatus({ code: autotel.SpanStatusCode.ERROR, message: error instanceof Error ? error.message : "Unknown error" });
|
|
118
|
+
span.recordException(error instanceof Error ? error : new Error(String(error)));
|
|
119
|
+
throw error;
|
|
114
120
|
} finally {
|
|
115
121
|
span.end();
|
|
116
122
|
const traceId = span.spanContext().traceId;
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"names":["TestSpanCollector","getAutotelTracerProvider","SimpleSpanProcessor","base","getTracer","otelTrace","otelContext","propagation","SpanStatusCode"],"mappings":";;;;;;;;AAmCA,IAAM,WAAA,GAAc,kBAAA;AACpB,IAAM,cAAA,GAAiB,OAAA;AAEvB,IAAI,SAAA,GAAsC,IAAA;AAM1C,SAAS,eAAA,GAAqC;AAC5C,EAAA,IAAI,CAAC,SAAA,EAAW;AACd,IAAA,SAAA,GAAY,IAAIA,mCAAA,EAAkB;AAClC,IAAA,MAAM,WAAWC,gCAAA,EAAyB;AAC1C,IAAA,IAAI,sBAAsB,QAAA,EAAU;AAClC,MAAC,QAAA,CAAyC,gBAAA;AAAA,QACxC,IAAIC,+BAAoB,SAAS;AAAA,OACnC;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,SAAA;AACT;AAGA,IAAM,gBAAA,GAAmB,cAAA;AACzB,IAAM,cAAA,GAAiB,+BAAA;AAEvB,SAAS,cAAA,GAA2B;AAClC,EAAA,MAAM,CAAA,GAAI,OAAA,CAAQ,GAAA,CAAI,gBAAgB,CAAA;AACtC,EAAA,MAAM,CAAA,GAAI,OAAA,CAAQ,GAAA,CAAI,cAAc,CAAA;AACpC,EAAA,MAAM,OAAiB,EAAC;AACxB,EAAA,IAAI,GAAG,IAAA,CAAK,IAAA,CAAK,EAAE,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAC,CAAA;AACrC,EAAA,IAAI,GAAG,IAAA,CAAK,IAAA,CAAK,EAAE,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAC,CAAA;AACrC,EAAA,OAAO,CAAC,GAAG,IAAI,GAAA,CAAI,IAAI,CAAC,CAAA;AAC1B;AAQA,SAAS,mBAAA,CAAoB,YAAoB,WAAA,EAAgC;AAC/E,EAAA,IAAI,WAAA,CAAY,MAAA,KAAW,CAAA,EAAG,OAAO,KAAA;AACrC,EAAA,IAAI;AACF,IAAA,MAAM,CAAA,GAAI,IAAI,GAAA,CAAI,UAAU,CAAA;AAC5B,IAAA,MAAM,gBAAgB,CAAA,CAAE,MAAA;AACxB,IAAA,MAAM,kBAAkB,CAAA,CAAE,QAAA;AAC1B,IAAA,OAAO,WAAA,CAAY,IAAA,CAAK,CAACC,KAAAA,KAAS;AAChC,MAAA,IAAI;AACF,QAAA,MAAM,CAAA,GAAI,IAAI,GAAA,CAAIA,KAAI,CAAA;AACtB,QAAA,IAAI,aAAA,KAAkB,CAAA,CAAE,MAAA,EAAQ,OAAO,KAAA;AACvC,QAAA,MAAM,eAAe,CAAA,CAAE,QAAA,CAAS,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA,IAAK,GAAA;AACtD,QAAA,IAAI,YAAA,KAAiB,KAAK,OAAO,IAAA;AACjC,QAAA,OACE,eAAA,KAAoB,YAAA,IAAgB,eAAA,CAAgB,UAAA,CAAW,eAAe,GAAG,CAAA;AAAA,MAErF,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,UAAA,CAAW,WAAWA,KAAI,CAAA;AAAA,MACnC;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,YAAY,IAAA,CAAK,CAACA,UAAS,UAAA,CAAW,UAAA,CAAWA,KAAI,CAAC,CAAA;AAAA,EAC/D;AACF;AAGO,IAAM,4BAAA,GAA+B;AAE5C,SAAS,4BAAA,CACP,MACA,QAAA,EACM;AACN,EAAA,KAAA,MAAW,CAAA,IAAK,SAAS,WAAA,EAAa;AACpC,IAAA,IAAI,CAAA,CAAE,IAAA,KAAS,4BAAA,IAAgC,CAAC,EAAE,WAAA,EAAa;AAC/D,IAAA,MAAM,OAAA,GAAU,CAAA,CAAE,WAAA,CAAY,KAAA,CAAM,GAAG,CAAA;AACvC,IAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,MAAA,MAAM,KAAA,GAAQ,KAAA,CAAM,KAAA,CAAM,GAAG,CAAA;AAC7B,MAAA,IAAI,KAAA,CAAM,UAAU,CAAA,EAAG;AACrB,QAAA,MAAM,GAAA,GAAM,KAAA,CAAM,CAAC,CAAA,CAAE,IAAA,EAAK;AAC1B,QAAA,MAAM,KAAA,GAAQ,MAAM,KAAA,CAAM,CAAC,EAAE,IAAA,CAAK,GAAG,EAAE,IAAA,EAAK;AAC5C,QAAA,IAAA,CAAK,YAAA,CAAa,KAAK,KAAK,CAAA;AAAA,MAC9B;AAAA,IACF;AAAA,EACF;AACF;AAKA,SAAS,iBAAA,CACP,GAAA,EACA,OAAA,EACA,WAAA,EACA,SACA,QAAA,EACgB;AAChB,EAAA,MAAM,IAAA,GAAO,WAAW,EAAC;AACzB,EAAA,IAAI,CAAC,mBAAA,CAAoB,GAAA,EAAK,WAAW,GAAG,OAAO,IAAA;AACnD,EAAA,OAAO;AAAA,IACL,GAAG,IAAA;AAAA,IACH,OAAA,EAAS,EAAE,GAAI,IAAA,CAAK,SAAoC,GAAG,OAAA,EAAS,eAAe,QAAA;AAAS,GAC9F;AACF;AAGA,SAAS,sBAAA,CACP,OAAA,EACA,WAAA,EACA,OAAA,EACA,QAAA,EACmB;AACnB,EAAA,MAAM,KAAA,GAAQ,CAAC,GAAA,EAAa,OAAA,KAC1B,iBAAA,CAAkB,KAAK,OAAA,EAAS,WAAA,EAAa,OAAA,EAAS,QAAA,CAAS,KAAK,CAAA;AAEtE,EAAA,OAAO;AAAA,IACL,GAAA,EAAK,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,IAAI,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACpF,IAAA,EAAM,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,KAAK,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACtF,GAAA,EAAK,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,IAAI,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACpF,KAAA,EAAO,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,MAAM,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACxF,MAAA,EAAQ,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,OAAO,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IAC1F,IAAA,EAAM,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,KAAK,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACtF,OAAO,CAAC,YAAA,EAA0C,OAAA,KAChD,OAAA,CAAQ,MAAM,YAAA,EAAc,KAAA,CAAM,OAAO,YAAA,KAAiB,WAAW,YAAA,GAAe,YAAA,CAAa,GAAA,EAAI,EAAG,OAAO,CAAC,CAAA;AAAA,IAClH,YAAA,EAAc,CAAC,OAAA,KAAgC,OAAA,CAAQ,aAAa,OAAO,CAAA;AAAA,IAC3E,OAAA,EAAS,MAAM,OAAA,CAAQ,OAAA;AAAQ,GACjC;AACF;AAQO,IAAM,IAAA,GAAOA,YAAK,MAAA,CAItB;AAAA,EACD,aAAA,EAAe;AAAA;AAAA,IAEb,OAAO,EAAC,EAAG,GAAA,EAAK,QAAA,KAAa;AAC3B,MAAA,eAAA,EAAgB;AAChB,MAAA,MAAM,cAAc,cAAA,EAAe;AACnC,MAAA,MAAM,MAAA,GAASC,iBAAA,CAAU,WAAA,EAAa,cAAc,CAAA;AACpD,MAAA,MAAM,QAAA,GAAW,CAAA,IAAA,EAAO,QAAA,CAAS,KAAK,CAAA,CAAA;AACtC,MAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,QAAA,EAAU;AAAA,QACtC,UAAA,EAAY;AAAA,UACV,cAAc,QAAA,CAAS,KAAA;AAAA,UACvB,cAAA,EAAgB,SAAS,OAAA,CAAQ,IAAA;AAAA,UACjC,WAAA,EAAa,SAAS,IAAA,IAAQ,EAAA;AAAA,UAC9B,WAAA,EAAa,SAAS,IAAA,IAAQ;AAAA;AAChC,OACD,CAAA;AACD,MAAA,4BAAA,CAA6B,MAAM,QAAQ,CAAA;AAC3C,MAAA,MAAM,MAAMC,iBAAA,CAAU,OAAA,CAAQC,eAAA,CAAY,MAAA,IAAU,IAAI,CAAA;AACxD,MAAA,MAAM,UAAkC,EAAC;AACzC,MAAAC,mBAAA,CAAY,MAAA,CAAO,KAAK,OAAO,CAAA;AAC/B,MAAA,IAAI;AACF,QAAA,MAAM,GAAA,CAAI,EAAE,OAAA,EAAS,WAAA,EAAa,UAAU,CAAA;AAAA,MAC9C,CAAA,SAAE;AACA,QAAA,IAAA,CAAK,GAAA,EAAI;AACT,QAAA,MAAM,OAAA,GAAU,IAAA,CAAK,WAAA,EAAY,CAAE,OAAA;AACnC,QAAA,MAAM,UAAA,GAAa,IAAA,CAAK,WAAA,EAAY,CAAE,MAAA;AACtC,QAAA,MAAM,KAAA,GAAQ,SAAA,CAAW,UAAA,CAAW,OAAA,EAAS,UAAU,CAAA;AACvD,QAAA,IAAI,KAAA,CAAM,SAAS,CAAA,EAAG;AACpB,UAAA,QAAA,CAAS,YAAY,IAAA,CAAK;AAAA,YACxB,IAAA,EAAM,YAAA;AAAA,YACN,WAAA,EAAa,IAAA,CAAK,SAAA,CAAU,KAAK;AAAA,WAClC,CAAA;AAAA,QACH;AAAA,MACF;AAAA,IACF,CAAA;AAAA,IACA,EAAE,OAAO,MAAA;AAAO,GAClB;AAAA,EAEA,MAAM,OAAO,EAAE,IAAA,EAAM,aAAA,IAAiB,GAAA,KAAQ;AAC5C,IAAA,MAAM,EAAE,OAAA,EAAS,WAAA,EAAa,QAAA,EAAS,GAAI,aAAA;AAC3C,IAAA,IAAI,WAAA,CAAY,SAAS,CAAA,EAAG;AAC1B,MAAA,MAAM,IAAA,CAAK,KAAA,CAAM,MAAA,EAAQ,OAAO,KAAA,KAAU;AACxC,QAAA,MAAM,OAAA,GAAU,MAAM,OAAA,EAAQ;AAC9B,QAAA,MAAM,GAAA,GAAM,QAAQ,GAAA,EAAI;AACxB,QAAA,IAAI,mBAAA,CAAoB,GAAA,EAAK,WAAW,CAAA,EAAG;AACzC,UAAA,MAAM,OAAA,GAAU;AAAA,YACd,GAAG,QAAQ,OAAA,EAAQ;AAAA,YACnB,GAAG,OAAA;AAAA,YACH,eAAe,QAAA,CAAS;AAAA,WAC1B;AACA,UAAA,MAAM,KAAA,CAAM,QAAA,CAAS,EAAE,OAAA,EAAS,CAAA;AAAA,QAClC,CAAA,MAAO;AACL,UAAA,MAAM,MAAM,QAAA,EAAS;AAAA,QACvB;AAAA,MACF,CAAC,CAAA;AAAA,IACH;AACA,IAAA,MAAM,IAAI,IAAI,CAAA;AAAA,EAChB,CAAA;AAAA,EAEA,kBAAkB,OAAO,EAAE,OAAA,EAAS,aAAA,IAAiB,GAAA,KAAQ;AAC3D,IAAA,MAAM,OAAA,GAAU,sBAAA;AAAA,MACd,OAAA;AAAA,MACA,aAAA,CAAc,WAAA;AAAA,MACd,aAAA,CAAc,OAAA;AAAA,MACd,aAAA,CAAc;AAAA,KAChB;AACA,IAAA,MAAM,IAAI,OAAO,CAAA;AAAA,EACnB;AACF,CAAC;AA4BD,eAAsB,IAAA,CAAQ,MAAc,EAAA,EAAkC;AAC5E,EAAA,MAAM,MAAA,GAASH,iBAAA,CAAU,WAAA,EAAa,cAAc,CAAA;AACpD,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,CAAA,KAAA,EAAQ,IAAI,CAAA,CAAA,EAAI;AAAA,IAC5C,UAAA,EAAY,EAAE,WAAA,EAAa,IAAA;AAAK,GACjC,CAAA;AACD,EAAA,IAAI;AACF,IAAA,OAAO,MAAME,eAAA,CAAY,IAAA,CAAKD,iBAAA,CAAU,OAAA,CAAQC,gBAAY,MAAA,EAAO,EAAG,IAAI,CAAA,EAAG,EAAE,CAAA;AAAA,EACjF,SAAS,KAAA,EAAO;AACd,IAAA,IAAA,CAAK,SAAA,CAAU,EAAE,IAAA,EAAME,sBAAA,CAAe,KAAA,EAAO,OAAA,EAAS,KAAA,YAAiB,KAAA,GAAQ,KAAA,CAAM,OAAA,GAAU,eAAA,EAAiB,CAAA;AAChH,IAAA,IAAA,CAAK,eAAA,CAAgB,iBAAiB,KAAA,GAAQ,KAAA,GAAQ,IAAI,KAAA,CAAM,MAAA,CAAO,KAAK,CAAC,CAAC,CAAA;AAC9E,IAAA,MAAM,KAAA;AAAA,EACR,CAAA,SAAE;AACA,IAAA,IAAA,CAAK,GAAA,EAAI;AAAA,EACX;AACF;AAMO,SAAS,kBAAkB,WAAA,EAAkD;AAClF,EAAA,OAAO,YAAY;AACjB,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,OAAO,SAAS,CAAA;AACvC,IAAA,IAAA,CAAK;AAAA,MACH,OAAA,EAAS,WAAA;AAAA,MACT,KAAA,EAAO,IAAA;AAAA,MACP,GAAG;AAAA,KACJ,CAAA;AAAA,EACH,CAAA;AACF","file":"index.cjs","sourcesContent":["/**\n * autotel-playwright\n *\n * Playwright fixture that creates one OTel span per test and injects W3C trace\n * context into requests to your API so \"test → API\" appears as one trace.\n *\n * @example\n * // globalSetup.ts: init({ service: 'e2e-tests' });\n * // In spec:\n * import { test, expect } from 'autotel-playwright';\n * test('checks health', async ({ page }) => {\n * await page.goto(API_BASE_URL + '/health'); // request gets traceparent\n * });\n * // Node-side API calls with trace context:\n * test('api health', async ({ requestWithTrace }) => {\n * const res = await requestWithTrace.get(API_BASE_URL + '/health');\n * expect(res.ok()).toBeTruthy();\n * });\n */\n\nimport { test as base } from '@playwright/test';\nimport type { Page, APIRequestContext, Request as PlaywrightRequest } from '@playwright/test';\nimport type { TestInfo } from '@playwright/test';\nimport type { AutotelConfig } from 'autotel';\nimport {\n getTracer,\n getAutotelTracerProvider,\n context as otelContext,\n propagation,\n otelTrace,\n SpanStatusCode,\n} from 'autotel';\nimport { TestSpanCollector } from 'autotel/test-span-collector';\nimport { SimpleSpanProcessor } from 'autotel/processors';\n\nconst TRACER_NAME = 'playwright-tests';\nconst TRACER_VERSION = '0.1.0';\n\nlet collector: TestSpanCollector | null = null;\n\ninterface TracerProviderWithProcessor {\n addSpanProcessor(processor: unknown): void;\n}\n\nfunction ensureCollector(): TestSpanCollector {\n if (!collector) {\n collector = new TestSpanCollector();\n const provider = getAutotelTracerProvider();\n if ('addSpanProcessor' in provider) {\n (provider as TracerProviderWithProcessor).addSpanProcessor(\n new SimpleSpanProcessor(collector),\n );\n }\n }\n return collector;\n}\n\n/** Env keys for API base URL (requests to this origin get trace context injected). */\nconst ENV_API_BASE_URL = 'API_BASE_URL';\nconst ENV_API_ORIGIN = 'AUTOTEL_PLAYWRIGHT_API_ORIGIN';\n\nfunction getApiBaseUrls(): string[] {\n const a = process.env[ENV_API_BASE_URL];\n const b = process.env[ENV_API_ORIGIN];\n const urls: string[] = [];\n if (a) urls.push(a.replace(/\\/$/, ''));\n if (b) urls.push(b.replace(/\\/$/, ''));\n return [...new Set(urls)];\n}\n\n/**\n * Returns true if requestUrl should receive trace headers for the given apiBaseUrls.\n * When a base URL includes a path (e.g. http://localhost:3000/api), only requests\n * whose path starts with that path segment match; same-origin but different path\n * (e.g. /health) must not match to avoid leaking trace context to unrelated endpoints.\n */\nfunction urlMatchesApiOrigin(requestUrl: string, apiBaseUrls: string[]): boolean {\n if (apiBaseUrls.length === 0) return false;\n try {\n const u = new URL(requestUrl);\n const requestOrigin = u.origin;\n const requestPathname = u.pathname;\n return apiBaseUrls.some((base) => {\n try {\n const b = new URL(base);\n if (requestOrigin !== b.origin) return false;\n const basePathname = b.pathname.replace(/\\/$/, '') || '/';\n if (basePathname === '/') return true;\n return (\n requestPathname === basePathname || requestPathname.startsWith(basePathname + '/')\n );\n } catch {\n return requestUrl.startsWith(base);\n }\n });\n } catch {\n return apiBaseUrls.some((base) => requestUrl.startsWith(base));\n }\n}\n\n/** Annotation type for custom span attributes: description should be \"key=value\" or \"key=value1;key2=value2\". */\nexport const AUTOTEL_ATTRIBUTE_ANNOTATION = 'autotel.attribute';\n\nfunction setAttributesFromAnnotations(\n span: { setAttribute: (k: string, v: string | number | boolean) => void },\n testInfo: { annotations: Array<{ type: string; description?: string }> },\n): void {\n for (const a of testInfo.annotations) {\n if (a.type !== AUTOTEL_ATTRIBUTE_ANNOTATION || !a.description) continue;\n const entries = a.description.split(';');\n for (const entry of entries) {\n const parts = entry.split('=');\n if (parts.length >= 2) {\n const key = parts[0].trim();\n const value = parts.slice(1).join('=').trim();\n span.setAttribute(key, value);\n }\n }\n }\n}\n\n/** Internal: options for get/post/put/patch/delete/head/fetch that may include headers. */\ntype RequestOptions = Record<string, unknown> & { headers?: Record<string, string> };\n\nfunction mergeTraceHeaders(\n url: string,\n options: RequestOptions | undefined,\n apiBaseUrls: string[],\n carrier: Record<string, string>,\n testName: string,\n): RequestOptions {\n const opts = options ?? {};\n if (!urlMatchesApiOrigin(url, apiBaseUrls)) return opts;\n return {\n ...opts,\n headers: { ...(opts.headers as Record<string, string>), ...carrier, 'x-test-name': testName },\n };\n}\n\n/** Wraps APIRequestContext so requests to API_BASE_URL get trace context injected. */\nfunction createRequestWithTrace(\n request: APIRequestContext,\n apiBaseUrls: string[],\n carrier: Record<string, string>,\n testInfo: TestInfo,\n): APIRequestContext {\n const merge = (url: string, options?: RequestOptions) =>\n mergeTraceHeaders(url, options, apiBaseUrls, carrier, testInfo.title);\n\n return {\n get: (url: string, options?: RequestOptions) => request.get(url, merge(url, options)),\n post: (url: string, options?: RequestOptions) => request.post(url, merge(url, options)),\n put: (url: string, options?: RequestOptions) => request.put(url, merge(url, options)),\n patch: (url: string, options?: RequestOptions) => request.patch(url, merge(url, options)),\n delete: (url: string, options?: RequestOptions) => request.delete(url, merge(url, options)),\n head: (url: string, options?: RequestOptions) => request.head(url, merge(url, options)),\n fetch: (urlOrRequest: string | PlaywrightRequest, options?: RequestOptions) =>\n request.fetch(urlOrRequest, merge(typeof urlOrRequest === 'string' ? urlOrRequest : urlOrRequest.url(), options)),\n storageState: (options?: { path?: string }) => request.storageState(options),\n dispose: () => request.dispose(),\n } as APIRequestContext;\n}\n\ntype OtelTestSpan = {\n carrier: Record<string, string>;\n apiBaseUrls: string[];\n testInfo: TestInfo;\n};\n\nexport const test = base.extend<{\n page: Page;\n requestWithTrace: APIRequestContext;\n _otelTestSpan: OtelTestSpan;\n}>({\n _otelTestSpan: [\n // eslint-disable-next-line no-empty-pattern\n async ({}, use, testInfo) => {\n ensureCollector();\n const apiBaseUrls = getApiBaseUrls();\n const tracer = getTracer(TRACER_NAME, TRACER_VERSION);\n const spanName = `e2e:${testInfo.title}`;\n const span = tracer.startSpan(spanName, {\n attributes: {\n 'test.title': testInfo.title,\n 'test.project': testInfo.project.name,\n 'test.file': testInfo.file ?? '',\n 'test.line': testInfo.line ?? 0,\n },\n });\n setAttributesFromAnnotations(span, testInfo);\n const ctx = otelTrace.setSpan(otelContext.active(), span);\n const carrier: Record<string, string> = {};\n propagation.inject(ctx, carrier);\n try {\n await use({ carrier, apiBaseUrls, testInfo });\n } finally {\n span.end();\n const traceId = span.spanContext().traceId;\n const rootSpanId = span.spanContext().spanId;\n const spans = collector!.drainTrace(traceId, rootSpanId);\n if (spans.length > 0) {\n testInfo.annotations.push({\n type: 'otel-spans',\n description: JSON.stringify(spans),\n });\n }\n }\n },\n { scope: 'test' },\n ],\n\n page: async ({ page, _otelTestSpan }, use) => {\n const { carrier, apiBaseUrls, testInfo } = _otelTestSpan;\n if (apiBaseUrls.length > 0) {\n await page.route('**/*', async (route) => {\n const request = route.request();\n const url = request.url();\n if (urlMatchesApiOrigin(url, apiBaseUrls)) {\n const headers = {\n ...request.headers(),\n ...carrier,\n 'x-test-name': testInfo.title,\n };\n await route.continue({ headers });\n } else {\n await route.continue();\n }\n });\n }\n await use(page);\n },\n\n requestWithTrace: async ({ request, _otelTestSpan }, use) => {\n const wrapped = createRequestWithTrace(\n request,\n _otelTestSpan.apiBaseUrls,\n _otelTestSpan.carrier,\n _otelTestSpan.testInfo,\n );\n await use(wrapped);\n },\n});\n\nexport { expect } from '@playwright/test';\n\n// Re-export trace context helpers for DX convenience\nexport {\n getTraceContext,\n resolveTraceUrl,\n isTracing,\n enrichWithTraceContext,\n} from 'autotel';\n\nexport type { OtelTraceContext } from 'autotel';\n\n/**\n * Runs a named step as a child span of the current test span. Use inside a test to get\n * step-level spans (e.g. \"step:login\", \"step:navigate\") under the test span in the same trace.\n *\n * @example\n * test('user flow', async ({ page }) => {\n * await step('login', async () => {\n * await page.click('button[type=submit]');\n * });\n * await step('open profile', async () => {\n * await page.goto('/profile');\n * });\n * });\n */\nexport async function step<T>(name: string, fn: () => Promise<T>): Promise<T> {\n const tracer = getTracer(TRACER_NAME, TRACER_VERSION);\n const span = tracer.startSpan(`step:${name}`, {\n attributes: { 'step.name': name },\n });\n try {\n return await otelContext.with(otelTrace.setSpan(otelContext.active(), span), fn);\n } catch (error) {\n span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : 'Unknown error' });\n span.recordException(error instanceof Error ? error : new Error(String(error)));\n throw error;\n } finally {\n span.end();\n }\n}\n\n/**\n * Returns a function suitable for Playwright globalSetup that inits autotel.\n * Call autotel.init() with the given options (or defaults) so test spans are exported.\n */\nexport function createGlobalSetup(initOptions?: AutotelConfig): () => Promise<void> {\n return async () => {\n const { init } = await import('autotel');\n init({\n service: 'e2e-tests',\n debug: true,\n ...initOptions,\n });\n };\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"names":["TestSpanCollector","getAutotelTracerProvider","SimpleSpanProcessor","base","getTracer","otelTrace","otelContext","propagation","SpanStatusCode"],"mappings":";;;;;;;;AAmCA,IAAM,WAAA,GAAc,kBAAA;AACpB,IAAM,cAAA,GAAiB,OAAA;AAEvB,IAAI,SAAA,GAAsC,IAAA;AAM1C,SAAS,eAAA,GAAqC;AAC5C,EAAA,IAAI,CAAC,SAAA,EAAW;AACd,IAAA,SAAA,GAAY,IAAIA,mCAAA,EAAkB;AAClC,IAAA,MAAM,WAAWC,gCAAA,EAAyB;AAC1C,IAAA,IAAI,sBAAsB,QAAA,EAAU;AAClC,MAAC,QAAA,CAAyC,gBAAA;AAAA,QACxC,IAAIC,+BAAoB,SAAS;AAAA,OACnC;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,SAAA;AACT;AAGA,IAAM,gBAAA,GAAmB,cAAA;AACzB,IAAM,cAAA,GAAiB,+BAAA;AAEvB,SAAS,cAAA,GAA2B;AAClC,EAAA,MAAM,CAAA,GAAI,OAAA,CAAQ,GAAA,CAAI,gBAAgB,CAAA;AACtC,EAAA,MAAM,CAAA,GAAI,OAAA,CAAQ,GAAA,CAAI,cAAc,CAAA;AACpC,EAAA,MAAM,OAAiB,EAAC;AACxB,EAAA,IAAI,GAAG,IAAA,CAAK,IAAA,CAAK,EAAE,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAC,CAAA;AACrC,EAAA,IAAI,GAAG,IAAA,CAAK,IAAA,CAAK,EAAE,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAC,CAAA;AACrC,EAAA,OAAO,CAAC,GAAG,IAAI,GAAA,CAAI,IAAI,CAAC,CAAA;AAC1B;AAQA,SAAS,mBAAA,CAAoB,YAAoB,WAAA,EAAgC;AAC/E,EAAA,IAAI,WAAA,CAAY,MAAA,KAAW,CAAA,EAAG,OAAO,KAAA;AACrC,EAAA,IAAI;AACF,IAAA,MAAM,CAAA,GAAI,IAAI,GAAA,CAAI,UAAU,CAAA;AAC5B,IAAA,MAAM,gBAAgB,CAAA,CAAE,MAAA;AACxB,IAAA,MAAM,kBAAkB,CAAA,CAAE,QAAA;AAC1B,IAAA,OAAO,WAAA,CAAY,IAAA,CAAK,CAACC,KAAAA,KAAS;AAChC,MAAA,IAAI;AACF,QAAA,MAAM,CAAA,GAAI,IAAI,GAAA,CAAIA,KAAI,CAAA;AACtB,QAAA,IAAI,aAAA,KAAkB,CAAA,CAAE,MAAA,EAAQ,OAAO,KAAA;AACvC,QAAA,MAAM,eAAe,CAAA,CAAE,QAAA,CAAS,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA,IAAK,GAAA;AACtD,QAAA,IAAI,YAAA,KAAiB,KAAK,OAAO,IAAA;AACjC,QAAA,OACE,eAAA,KAAoB,YAAA,IAAgB,eAAA,CAAgB,UAAA,CAAW,eAAe,GAAG,CAAA;AAAA,MAErF,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,UAAA,CAAW,WAAWA,KAAI,CAAA;AAAA,MACnC;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,YAAY,IAAA,CAAK,CAACA,UAAS,UAAA,CAAW,UAAA,CAAWA,KAAI,CAAC,CAAA;AAAA,EAC/D;AACF;AAGO,IAAM,4BAAA,GAA+B;AAE5C,SAAS,4BAAA,CACP,MACA,QAAA,EACM;AACN,EAAA,KAAA,MAAW,CAAA,IAAK,SAAS,WAAA,EAAa;AACpC,IAAA,IAAI,CAAA,CAAE,IAAA,KAAS,4BAAA,IAAgC,CAAC,EAAE,WAAA,EAAa;AAC/D,IAAA,MAAM,OAAA,GAAU,CAAA,CAAE,WAAA,CAAY,KAAA,CAAM,GAAG,CAAA;AACvC,IAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,MAAA,MAAM,KAAA,GAAQ,KAAA,CAAM,KAAA,CAAM,GAAG,CAAA;AAC7B,MAAA,IAAI,KAAA,CAAM,UAAU,CAAA,EAAG;AACrB,QAAA,MAAM,GAAA,GAAM,KAAA,CAAM,CAAC,CAAA,CAAE,IAAA,EAAK;AAC1B,QAAA,MAAM,KAAA,GAAQ,MAAM,KAAA,CAAM,CAAC,EAAE,IAAA,CAAK,GAAG,EAAE,IAAA,EAAK;AAC5C,QAAA,IAAA,CAAK,YAAA,CAAa,KAAK,KAAK,CAAA;AAAA,MAC9B;AAAA,IACF;AAAA,EACF;AACF;AAKA,SAAS,iBAAA,CACP,GAAA,EACA,OAAA,EACA,WAAA,EACA,SACA,QAAA,EACgB;AAChB,EAAA,MAAM,IAAA,GAAO,WAAW,EAAC;AACzB,EAAA,IAAI,CAAC,mBAAA,CAAoB,GAAA,EAAK,WAAW,GAAG,OAAO,IAAA;AACnD,EAAA,OAAO;AAAA,IACL,GAAG,IAAA;AAAA,IACH,OAAA,EAAS,EAAE,GAAI,IAAA,CAAK,SAAoC,GAAG,OAAA,EAAS,eAAe,QAAA;AAAS,GAC9F;AACF;AAGA,SAAS,sBAAA,CACP,OAAA,EACA,WAAA,EACA,OAAA,EACA,QAAA,EACmB;AACnB,EAAA,MAAM,KAAA,GAAQ,CAAC,GAAA,EAAa,OAAA,KAC1B,iBAAA,CAAkB,KAAK,OAAA,EAAS,WAAA,EAAa,OAAA,EAAS,QAAA,CAAS,KAAK,CAAA;AAEtE,EAAA,OAAO;AAAA,IACL,GAAA,EAAK,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,IAAI,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACpF,IAAA,EAAM,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,KAAK,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACtF,GAAA,EAAK,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,IAAI,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACpF,KAAA,EAAO,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,MAAM,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACxF,MAAA,EAAQ,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,OAAO,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IAC1F,IAAA,EAAM,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,KAAK,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACtF,OAAO,CAAC,YAAA,EAA0C,OAAA,KAChD,OAAA,CAAQ,MAAM,YAAA,EAAc,KAAA,CAAM,OAAO,YAAA,KAAiB,WAAW,YAAA,GAAe,YAAA,CAAa,GAAA,EAAI,EAAG,OAAO,CAAC,CAAA;AAAA,IAClH,YAAA,EAAc,CAAC,OAAA,KAAgC,OAAA,CAAQ,aAAa,OAAO,CAAA;AAAA,IAC3E,OAAA,EAAS,MAAM,OAAA,CAAQ,OAAA;AAAQ,GACjC;AACF;AAQO,IAAM,IAAA,GAAOA,YAAK,MAAA,CAItB;AAAA,EACD,aAAA,EAAe;AAAA;AAAA,IAEb,OAAO,EAAC,EAAG,GAAA,EAAK,QAAA,KAAa;AAC3B,MAAA,eAAA,EAAgB;AAChB,MAAA,MAAM,cAAc,cAAA,EAAe;AACnC,MAAA,MAAM,MAAA,GAASC,iBAAA,CAAU,WAAA,EAAa,cAAc,CAAA;AACpD,MAAA,MAAM,QAAA,GAAW,CAAA,IAAA,EAAO,QAAA,CAAS,KAAK,CAAA,CAAA;AACtC,MAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,QAAA,EAAU;AAAA,QACtC,UAAA,EAAY;AAAA,UACV,cAAc,QAAA,CAAS,KAAA;AAAA,UACvB,cAAA,EAAgB,SAAS,OAAA,CAAQ,IAAA;AAAA,UACjC,WAAA,EAAa,SAAS,IAAA,IAAQ,EAAA;AAAA,UAC9B,WAAA,EAAa,SAAS,IAAA,IAAQ;AAAA;AAChC,OACD,CAAA;AACD,MAAA,4BAAA,CAA6B,MAAM,QAAQ,CAAA;AAC3C,MAAA,MAAM,MAAMC,iBAAA,CAAU,OAAA,CAAQC,eAAA,CAAY,MAAA,IAAU,IAAI,CAAA;AACxD,MAAA,MAAM,UAAkC,EAAC;AACzC,MAAAA,eAAA,CAAY,IAAA,CAAK,KAAK,MAAM;AAC1B,QAAAC,mBAAA,CAAY,MAAA,CAAOD,eAAA,CAAY,MAAA,EAAO,EAAG,OAAO,CAAA;AAAA,MAClD,CAAC,CAAA;AACD,MAAA,IAAI;AACF,QAAA,MAAMA,eAAA,CAAY,IAAA,CAAK,GAAA,EAAK,MAAM,GAAA,CAAI,EAAE,OAAA,EAAS,WAAA,EAAa,QAAA,EAAU,CAAC,CAAA;AAAA,MAC3E,SAAS,KAAA,EAAO;AACd,QAAA,IAAA,CAAK,SAAA,CAAU,EAAE,IAAA,EAAME,sBAAA,CAAe,KAAA,EAAO,OAAA,EAAS,KAAA,YAAiB,KAAA,GAAQ,KAAA,CAAM,OAAA,GAAU,eAAA,EAAiB,CAAA;AAChH,QAAA,IAAA,CAAK,eAAA,CAAgB,iBAAiB,KAAA,GAAQ,KAAA,GAAQ,IAAI,KAAA,CAAM,MAAA,CAAO,KAAK,CAAC,CAAC,CAAA;AAC9E,QAAA,MAAM,KAAA;AAAA,MACR,CAAA,SAAE;AACA,QAAA,IAAA,CAAK,GAAA,EAAI;AACT,QAAA,MAAM,OAAA,GAAU,IAAA,CAAK,WAAA,EAAY,CAAE,OAAA;AACnC,QAAA,MAAM,UAAA,GAAa,IAAA,CAAK,WAAA,EAAY,CAAE,MAAA;AACtC,QAAA,MAAM,KAAA,GAAQ,SAAA,CAAW,UAAA,CAAW,OAAA,EAAS,UAAU,CAAA;AACvD,QAAA,IAAI,KAAA,CAAM,SAAS,CAAA,EAAG;AACpB,UAAA,QAAA,CAAS,YAAY,IAAA,CAAK;AAAA,YACxB,IAAA,EAAM,YAAA;AAAA,YACN,WAAA,EAAa,IAAA,CAAK,SAAA,CAAU,KAAK;AAAA,WAClC,CAAA;AAAA,QACH;AAAA,MACF;AAAA,IACF,CAAA;AAAA,IACA,EAAE,OAAO,MAAA;AAAO,GAClB;AAAA,EAEA,MAAM,OAAO,EAAE,IAAA,EAAM,aAAA,IAAiB,GAAA,KAAQ;AAC5C,IAAA,MAAM,EAAE,OAAA,EAAS,WAAA,EAAa,QAAA,EAAS,GAAI,aAAA;AAC3C,IAAA,IAAI,WAAA,CAAY,SAAS,CAAA,EAAG;AAC1B,MAAA,MAAM,IAAA,CAAK,KAAA,CAAM,MAAA,EAAQ,OAAO,KAAA,KAAU;AACxC,QAAA,MAAM,OAAA,GAAU,MAAM,OAAA,EAAQ;AAC9B,QAAA,MAAM,GAAA,GAAM,QAAQ,GAAA,EAAI;AACxB,QAAA,IAAI,mBAAA,CAAoB,GAAA,EAAK,WAAW,CAAA,EAAG;AACzC,UAAA,MAAM,OAAA,GAAU;AAAA,YACd,GAAG,QAAQ,OAAA,EAAQ;AAAA,YACnB,GAAG,OAAA;AAAA,YACH,eAAe,QAAA,CAAS;AAAA,WAC1B;AACA,UAAA,MAAM,KAAA,CAAM,QAAA,CAAS,EAAE,OAAA,EAAS,CAAA;AAAA,QAClC,CAAA,MAAO;AACL,UAAA,MAAM,MAAM,QAAA,EAAS;AAAA,QACvB;AAAA,MACF,CAAC,CAAA;AAAA,IACH;AACA,IAAA,MAAM,IAAI,IAAI,CAAA;AAAA,EAChB,CAAA;AAAA,EAEA,kBAAkB,OAAO,EAAE,OAAA,EAAS,aAAA,IAAiB,GAAA,KAAQ;AAC3D,IAAA,MAAM,OAAA,GAAU,sBAAA;AAAA,MACd,OAAA;AAAA,MACA,aAAA,CAAc,WAAA;AAAA,MACd,aAAA,CAAc,OAAA;AAAA,MACd,aAAA,CAAc;AAAA,KAChB;AACA,IAAA,MAAM,IAAI,OAAO,CAAA;AAAA,EACnB;AACF,CAAC;AA4BD,eAAsB,IAAA,CAAQ,MAAc,EAAA,EAAkC;AAC5E,EAAA,MAAM,MAAA,GAASJ,iBAAA,CAAU,WAAA,EAAa,cAAc,CAAA;AACpD,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,CAAA,KAAA,EAAQ,IAAI,CAAA,CAAA,EAAI;AAAA,IAC5C,UAAA,EAAY,EAAE,WAAA,EAAa,IAAA;AAAK,GACjC,CAAA;AACD,EAAA,IAAI;AACF,IAAA,OAAO,MAAME,eAAA,CAAY,IAAA,CAAKD,iBAAA,CAAU,OAAA,CAAQC,gBAAY,MAAA,EAAO,EAAG,IAAI,CAAA,EAAG,EAAE,CAAA;AAAA,EACjF,SAAS,KAAA,EAAO;AACd,IAAA,IAAA,CAAK,SAAA,CAAU,EAAE,IAAA,EAAME,sBAAA,CAAe,KAAA,EAAO,OAAA,EAAS,KAAA,YAAiB,KAAA,GAAQ,KAAA,CAAM,OAAA,GAAU,eAAA,EAAiB,CAAA;AAChH,IAAA,IAAA,CAAK,eAAA,CAAgB,iBAAiB,KAAA,GAAQ,KAAA,GAAQ,IAAI,KAAA,CAAM,MAAA,CAAO,KAAK,CAAC,CAAC,CAAA;AAC9E,IAAA,MAAM,KAAA;AAAA,EACR,CAAA,SAAE;AACA,IAAA,IAAA,CAAK,GAAA,EAAI;AAAA,EACX;AACF;AAMO,SAAS,kBAAkB,WAAA,EAAkD;AAClF,EAAA,OAAO,YAAY;AACjB,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,OAAO,SAAS,CAAA;AACvC,IAAA,IAAA,CAAK;AAAA,MACH,OAAA,EAAS,WAAA;AAAA,MACT,KAAA,EAAO,IAAA;AAAA,MACP,GAAG;AAAA,KACJ,CAAA;AAAA,EACH,CAAA;AACF","file":"index.cjs","sourcesContent":["/**\n * autotel-playwright\n *\n * Playwright fixture that creates one OTel span per test and injects W3C trace\n * context into requests to your API so \"test → API\" appears as one trace.\n *\n * @example\n * // globalSetup.ts: init({ service: 'e2e-tests' });\n * // In spec:\n * import { test, expect } from 'autotel-playwright';\n * test('checks health', async ({ page }) => {\n * await page.goto(API_BASE_URL + '/health'); // request gets traceparent\n * });\n * // Node-side API calls with trace context:\n * test('api health', async ({ requestWithTrace }) => {\n * const res = await requestWithTrace.get(API_BASE_URL + '/health');\n * expect(res.ok()).toBeTruthy();\n * });\n */\n\nimport { test as base } from '@playwright/test';\nimport type { Page, APIRequestContext, Request as PlaywrightRequest } from '@playwright/test';\nimport type { TestInfo } from '@playwright/test';\nimport type { AutotelConfig } from 'autotel';\nimport {\n getTracer,\n getAutotelTracerProvider,\n context as otelContext,\n propagation,\n otelTrace,\n SpanStatusCode,\n} from 'autotel';\nimport { TestSpanCollector } from 'autotel/test-span-collector';\nimport { SimpleSpanProcessor } from 'autotel/processors';\n\nconst TRACER_NAME = 'playwright-tests';\nconst TRACER_VERSION = '0.1.0';\n\nlet collector: TestSpanCollector | null = null;\n\ninterface TracerProviderWithProcessor {\n addSpanProcessor(processor: unknown): void;\n}\n\nfunction ensureCollector(): TestSpanCollector {\n if (!collector) {\n collector = new TestSpanCollector();\n const provider = getAutotelTracerProvider();\n if ('addSpanProcessor' in provider) {\n (provider as TracerProviderWithProcessor).addSpanProcessor(\n new SimpleSpanProcessor(collector),\n );\n }\n }\n return collector;\n}\n\n/** Env keys for API base URL (requests to this origin get trace context injected). */\nconst ENV_API_BASE_URL = 'API_BASE_URL';\nconst ENV_API_ORIGIN = 'AUTOTEL_PLAYWRIGHT_API_ORIGIN';\n\nfunction getApiBaseUrls(): string[] {\n const a = process.env[ENV_API_BASE_URL];\n const b = process.env[ENV_API_ORIGIN];\n const urls: string[] = [];\n if (a) urls.push(a.replace(/\\/$/, ''));\n if (b) urls.push(b.replace(/\\/$/, ''));\n return [...new Set(urls)];\n}\n\n/**\n * Returns true if requestUrl should receive trace headers for the given apiBaseUrls.\n * When a base URL includes a path (e.g. http://localhost:3000/api), only requests\n * whose path starts with that path segment match; same-origin but different path\n * (e.g. /health) must not match to avoid leaking trace context to unrelated endpoints.\n */\nfunction urlMatchesApiOrigin(requestUrl: string, apiBaseUrls: string[]): boolean {\n if (apiBaseUrls.length === 0) return false;\n try {\n const u = new URL(requestUrl);\n const requestOrigin = u.origin;\n const requestPathname = u.pathname;\n return apiBaseUrls.some((base) => {\n try {\n const b = new URL(base);\n if (requestOrigin !== b.origin) return false;\n const basePathname = b.pathname.replace(/\\/$/, '') || '/';\n if (basePathname === '/') return true;\n return (\n requestPathname === basePathname || requestPathname.startsWith(basePathname + '/')\n );\n } catch {\n return requestUrl.startsWith(base);\n }\n });\n } catch {\n return apiBaseUrls.some((base) => requestUrl.startsWith(base));\n }\n}\n\n/** Annotation type for custom span attributes: description should be \"key=value\" or \"key=value1;key2=value2\". */\nexport const AUTOTEL_ATTRIBUTE_ANNOTATION = 'autotel.attribute';\n\nfunction setAttributesFromAnnotations(\n span: { setAttribute: (k: string, v: string | number | boolean) => void },\n testInfo: { annotations: Array<{ type: string; description?: string }> },\n): void {\n for (const a of testInfo.annotations) {\n if (a.type !== AUTOTEL_ATTRIBUTE_ANNOTATION || !a.description) continue;\n const entries = a.description.split(';');\n for (const entry of entries) {\n const parts = entry.split('=');\n if (parts.length >= 2) {\n const key = parts[0].trim();\n const value = parts.slice(1).join('=').trim();\n span.setAttribute(key, value);\n }\n }\n }\n}\n\n/** Internal: options for get/post/put/patch/delete/head/fetch that may include headers. */\ntype RequestOptions = Record<string, unknown> & { headers?: Record<string, string> };\n\nfunction mergeTraceHeaders(\n url: string,\n options: RequestOptions | undefined,\n apiBaseUrls: string[],\n carrier: Record<string, string>,\n testName: string,\n): RequestOptions {\n const opts = options ?? {};\n if (!urlMatchesApiOrigin(url, apiBaseUrls)) return opts;\n return {\n ...opts,\n headers: { ...(opts.headers as Record<string, string>), ...carrier, 'x-test-name': testName },\n };\n}\n\n/** Wraps APIRequestContext so requests to API_BASE_URL get trace context injected. */\nfunction createRequestWithTrace(\n request: APIRequestContext,\n apiBaseUrls: string[],\n carrier: Record<string, string>,\n testInfo: TestInfo,\n): APIRequestContext {\n const merge = (url: string, options?: RequestOptions) =>\n mergeTraceHeaders(url, options, apiBaseUrls, carrier, testInfo.title);\n\n return {\n get: (url: string, options?: RequestOptions) => request.get(url, merge(url, options)),\n post: (url: string, options?: RequestOptions) => request.post(url, merge(url, options)),\n put: (url: string, options?: RequestOptions) => request.put(url, merge(url, options)),\n patch: (url: string, options?: RequestOptions) => request.patch(url, merge(url, options)),\n delete: (url: string, options?: RequestOptions) => request.delete(url, merge(url, options)),\n head: (url: string, options?: RequestOptions) => request.head(url, merge(url, options)),\n fetch: (urlOrRequest: string | PlaywrightRequest, options?: RequestOptions) =>\n request.fetch(urlOrRequest, merge(typeof urlOrRequest === 'string' ? urlOrRequest : urlOrRequest.url(), options)),\n storageState: (options?: { path?: string }) => request.storageState(options),\n dispose: () => request.dispose(),\n } as APIRequestContext;\n}\n\ntype OtelTestSpan = {\n carrier: Record<string, string>;\n apiBaseUrls: string[];\n testInfo: TestInfo;\n};\n\nexport const test = base.extend<{\n page: Page;\n requestWithTrace: APIRequestContext;\n _otelTestSpan: OtelTestSpan;\n}>({\n _otelTestSpan: [\n // eslint-disable-next-line no-empty-pattern\n async ({}, use, testInfo) => {\n ensureCollector();\n const apiBaseUrls = getApiBaseUrls();\n const tracer = getTracer(TRACER_NAME, TRACER_VERSION);\n const spanName = `e2e:${testInfo.title}`;\n const span = tracer.startSpan(spanName, {\n attributes: {\n 'test.title': testInfo.title,\n 'test.project': testInfo.project.name,\n 'test.file': testInfo.file ?? '',\n 'test.line': testInfo.line ?? 0,\n },\n });\n setAttributesFromAnnotations(span, testInfo);\n const ctx = otelTrace.setSpan(otelContext.active(), span);\n const carrier: Record<string, string> = {};\n otelContext.with(ctx, () => {\n propagation.inject(otelContext.active(), carrier);\n });\n try {\n await otelContext.with(ctx, () => use({ carrier, apiBaseUrls, testInfo }));\n } catch (error) {\n span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : 'Unknown error' });\n span.recordException(error instanceof Error ? error : new Error(String(error)));\n throw error;\n } finally {\n span.end();\n const traceId = span.spanContext().traceId;\n const rootSpanId = span.spanContext().spanId;\n const spans = collector!.drainTrace(traceId, rootSpanId);\n if (spans.length > 0) {\n testInfo.annotations.push({\n type: 'otel-spans',\n description: JSON.stringify(spans),\n });\n }\n }\n },\n { scope: 'test' },\n ],\n\n page: async ({ page, _otelTestSpan }, use) => {\n const { carrier, apiBaseUrls, testInfo } = _otelTestSpan;\n if (apiBaseUrls.length > 0) {\n await page.route('**/*', async (route) => {\n const request = route.request();\n const url = request.url();\n if (urlMatchesApiOrigin(url, apiBaseUrls)) {\n const headers = {\n ...request.headers(),\n ...carrier,\n 'x-test-name': testInfo.title,\n };\n await route.continue({ headers });\n } else {\n await route.continue();\n }\n });\n }\n await use(page);\n },\n\n requestWithTrace: async ({ request, _otelTestSpan }, use) => {\n const wrapped = createRequestWithTrace(\n request,\n _otelTestSpan.apiBaseUrls,\n _otelTestSpan.carrier,\n _otelTestSpan.testInfo,\n );\n await use(wrapped);\n },\n});\n\nexport { expect } from '@playwright/test';\n\n// Re-export trace context helpers for DX convenience\nexport {\n getTraceContext,\n resolveTraceUrl,\n isTracing,\n enrichWithTraceContext,\n} from 'autotel';\n\nexport type { OtelTraceContext } from 'autotel';\n\n/**\n * Runs a named step as a child span of the current test span. Use inside a test to get\n * step-level spans (e.g. \"step:login\", \"step:navigate\") under the test span in the same trace.\n *\n * @example\n * test('user flow', async ({ page }) => {\n * await step('login', async () => {\n * await page.click('button[type=submit]');\n * });\n * await step('open profile', async () => {\n * await page.goto('/profile');\n * });\n * });\n */\nexport async function step<T>(name: string, fn: () => Promise<T>): Promise<T> {\n const tracer = getTracer(TRACER_NAME, TRACER_VERSION);\n const span = tracer.startSpan(`step:${name}`, {\n attributes: { 'step.name': name },\n });\n try {\n return await otelContext.with(otelTrace.setSpan(otelContext.active(), span), fn);\n } catch (error) {\n span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : 'Unknown error' });\n span.recordException(error instanceof Error ? error : new Error(String(error)));\n throw error;\n } finally {\n span.end();\n }\n}\n\n/**\n * Returns a function suitable for Playwright globalSetup that inits autotel.\n * Call autotel.init() with the given options (or defaults) so test spans are exported.\n */\nexport function createGlobalSetup(initOptions?: AutotelConfig): () => Promise<void> {\n return async () => {\n const { init } = await import('autotel');\n init({\n service: 'e2e-tests',\n debug: true,\n ...initOptions,\n });\n };\n}\n"]}
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { test as test$1 } from '@playwright/test';
|
|
2
2
|
export { expect } from '@playwright/test';
|
|
3
|
-
import { getTracer, otelTrace, context, propagation,
|
|
3
|
+
import { getTracer, otelTrace, context, propagation, SpanStatusCode, getAutotelTracerProvider } from 'autotel';
|
|
4
4
|
export { enrichWithTraceContext, getTraceContext, isTracing, resolveTraceUrl } from 'autotel';
|
|
5
5
|
import { TestSpanCollector } from 'autotel/test-span-collector';
|
|
6
6
|
import { SimpleSpanProcessor } from 'autotel/processors';
|
|
@@ -108,9 +108,15 @@ var test = test$1.extend({
|
|
|
108
108
|
setAttributesFromAnnotations(span, testInfo);
|
|
109
109
|
const ctx = otelTrace.setSpan(context.active(), span);
|
|
110
110
|
const carrier = {};
|
|
111
|
-
|
|
111
|
+
context.with(ctx, () => {
|
|
112
|
+
propagation.inject(context.active(), carrier);
|
|
113
|
+
});
|
|
112
114
|
try {
|
|
113
|
-
await use({ carrier, apiBaseUrls, testInfo });
|
|
115
|
+
await context.with(ctx, () => use({ carrier, apiBaseUrls, testInfo }));
|
|
116
|
+
} catch (error) {
|
|
117
|
+
span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : "Unknown error" });
|
|
118
|
+
span.recordException(error instanceof Error ? error : new Error(String(error)));
|
|
119
|
+
throw error;
|
|
114
120
|
} finally {
|
|
115
121
|
span.end();
|
|
116
122
|
const traceId = span.spanContext().traceId;
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"names":["base","otelContext"],"mappings":";;;;;;;;AAmCA,IAAM,WAAA,GAAc,kBAAA;AACpB,IAAM,cAAA,GAAiB,OAAA;AAEvB,IAAI,SAAA,GAAsC,IAAA;AAM1C,SAAS,eAAA,GAAqC;AAC5C,EAAA,IAAI,CAAC,SAAA,EAAW;AACd,IAAA,SAAA,GAAY,IAAI,iBAAA,EAAkB;AAClC,IAAA,MAAM,WAAW,wBAAA,EAAyB;AAC1C,IAAA,IAAI,sBAAsB,QAAA,EAAU;AAClC,MAAC,QAAA,CAAyC,gBAAA;AAAA,QACxC,IAAI,oBAAoB,SAAS;AAAA,OACnC;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,SAAA;AACT;AAGA,IAAM,gBAAA,GAAmB,cAAA;AACzB,IAAM,cAAA,GAAiB,+BAAA;AAEvB,SAAS,cAAA,GAA2B;AAClC,EAAA,MAAM,CAAA,GAAI,OAAA,CAAQ,GAAA,CAAI,gBAAgB,CAAA;AACtC,EAAA,MAAM,CAAA,GAAI,OAAA,CAAQ,GAAA,CAAI,cAAc,CAAA;AACpC,EAAA,MAAM,OAAiB,EAAC;AACxB,EAAA,IAAI,GAAG,IAAA,CAAK,IAAA,CAAK,EAAE,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAC,CAAA;AACrC,EAAA,IAAI,GAAG,IAAA,CAAK,IAAA,CAAK,EAAE,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAC,CAAA;AACrC,EAAA,OAAO,CAAC,GAAG,IAAI,GAAA,CAAI,IAAI,CAAC,CAAA;AAC1B;AAQA,SAAS,mBAAA,CAAoB,YAAoB,WAAA,EAAgC;AAC/E,EAAA,IAAI,WAAA,CAAY,MAAA,KAAW,CAAA,EAAG,OAAO,KAAA;AACrC,EAAA,IAAI;AACF,IAAA,MAAM,CAAA,GAAI,IAAI,GAAA,CAAI,UAAU,CAAA;AAC5B,IAAA,MAAM,gBAAgB,CAAA,CAAE,MAAA;AACxB,IAAA,MAAM,kBAAkB,CAAA,CAAE,QAAA;AAC1B,IAAA,OAAO,WAAA,CAAY,IAAA,CAAK,CAACA,KAAAA,KAAS;AAChC,MAAA,IAAI;AACF,QAAA,MAAM,CAAA,GAAI,IAAI,GAAA,CAAIA,KAAI,CAAA;AACtB,QAAA,IAAI,aAAA,KAAkB,CAAA,CAAE,MAAA,EAAQ,OAAO,KAAA;AACvC,QAAA,MAAM,eAAe,CAAA,CAAE,QAAA,CAAS,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA,IAAK,GAAA;AACtD,QAAA,IAAI,YAAA,KAAiB,KAAK,OAAO,IAAA;AACjC,QAAA,OACE,eAAA,KAAoB,YAAA,IAAgB,eAAA,CAAgB,UAAA,CAAW,eAAe,GAAG,CAAA;AAAA,MAErF,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,UAAA,CAAW,WAAWA,KAAI,CAAA;AAAA,MACnC;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,YAAY,IAAA,CAAK,CAACA,UAAS,UAAA,CAAW,UAAA,CAAWA,KAAI,CAAC,CAAA;AAAA,EAC/D;AACF;AAGO,IAAM,4BAAA,GAA+B;AAE5C,SAAS,4BAAA,CACP,MACA,QAAA,EACM;AACN,EAAA,KAAA,MAAW,CAAA,IAAK,SAAS,WAAA,EAAa;AACpC,IAAA,IAAI,CAAA,CAAE,IAAA,KAAS,4BAAA,IAAgC,CAAC,EAAE,WAAA,EAAa;AAC/D,IAAA,MAAM,OAAA,GAAU,CAAA,CAAE,WAAA,CAAY,KAAA,CAAM,GAAG,CAAA;AACvC,IAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,MAAA,MAAM,KAAA,GAAQ,KAAA,CAAM,KAAA,CAAM,GAAG,CAAA;AAC7B,MAAA,IAAI,KAAA,CAAM,UAAU,CAAA,EAAG;AACrB,QAAA,MAAM,GAAA,GAAM,KAAA,CAAM,CAAC,CAAA,CAAE,IAAA,EAAK;AAC1B,QAAA,MAAM,KAAA,GAAQ,MAAM,KAAA,CAAM,CAAC,EAAE,IAAA,CAAK,GAAG,EAAE,IAAA,EAAK;AAC5C,QAAA,IAAA,CAAK,YAAA,CAAa,KAAK,KAAK,CAAA;AAAA,MAC9B;AAAA,IACF;AAAA,EACF;AACF;AAKA,SAAS,iBAAA,CACP,GAAA,EACA,OAAA,EACA,WAAA,EACA,SACA,QAAA,EACgB;AAChB,EAAA,MAAM,IAAA,GAAO,WAAW,EAAC;AACzB,EAAA,IAAI,CAAC,mBAAA,CAAoB,GAAA,EAAK,WAAW,GAAG,OAAO,IAAA;AACnD,EAAA,OAAO;AAAA,IACL,GAAG,IAAA;AAAA,IACH,OAAA,EAAS,EAAE,GAAI,IAAA,CAAK,SAAoC,GAAG,OAAA,EAAS,eAAe,QAAA;AAAS,GAC9F;AACF;AAGA,SAAS,sBAAA,CACP,OAAA,EACA,WAAA,EACA,OAAA,EACA,QAAA,EACmB;AACnB,EAAA,MAAM,KAAA,GAAQ,CAAC,GAAA,EAAa,OAAA,KAC1B,iBAAA,CAAkB,KAAK,OAAA,EAAS,WAAA,EAAa,OAAA,EAAS,QAAA,CAAS,KAAK,CAAA;AAEtE,EAAA,OAAO;AAAA,IACL,GAAA,EAAK,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,IAAI,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACpF,IAAA,EAAM,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,KAAK,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACtF,GAAA,EAAK,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,IAAI,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACpF,KAAA,EAAO,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,MAAM,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACxF,MAAA,EAAQ,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,OAAO,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IAC1F,IAAA,EAAM,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,KAAK,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACtF,OAAO,CAAC,YAAA,EAA0C,OAAA,KAChD,OAAA,CAAQ,MAAM,YAAA,EAAc,KAAA,CAAM,OAAO,YAAA,KAAiB,WAAW,YAAA,GAAe,YAAA,CAAa,GAAA,EAAI,EAAG,OAAO,CAAC,CAAA;AAAA,IAClH,YAAA,EAAc,CAAC,OAAA,KAAgC,OAAA,CAAQ,aAAa,OAAO,CAAA;AAAA,IAC3E,OAAA,EAAS,MAAM,OAAA,CAAQ,OAAA;AAAQ,GACjC;AACF;AAQO,IAAM,IAAA,GAAOA,OAAK,MAAA,CAItB;AAAA,EACD,aAAA,EAAe;AAAA;AAAA,IAEb,OAAO,EAAC,EAAG,GAAA,EAAK,QAAA,KAAa;AAC3B,MAAA,eAAA,EAAgB;AAChB,MAAA,MAAM,cAAc,cAAA,EAAe;AACnC,MAAA,MAAM,MAAA,GAAS,SAAA,CAAU,WAAA,EAAa,cAAc,CAAA;AACpD,MAAA,MAAM,QAAA,GAAW,CAAA,IAAA,EAAO,QAAA,CAAS,KAAK,CAAA,CAAA;AACtC,MAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,QAAA,EAAU;AAAA,QACtC,UAAA,EAAY;AAAA,UACV,cAAc,QAAA,CAAS,KAAA;AAAA,UACvB,cAAA,EAAgB,SAAS,OAAA,CAAQ,IAAA;AAAA,UACjC,WAAA,EAAa,SAAS,IAAA,IAAQ,EAAA;AAAA,UAC9B,WAAA,EAAa,SAAS,IAAA,IAAQ;AAAA;AAChC,OACD,CAAA;AACD,MAAA,4BAAA,CAA6B,MAAM,QAAQ,CAAA;AAC3C,MAAA,MAAM,MAAM,SAAA,CAAU,OAAA,CAAQC,OAAA,CAAY,MAAA,IAAU,IAAI,CAAA;AACxD,MAAA,MAAM,UAAkC,EAAC;AACzC,MAAA,WAAA,CAAY,MAAA,CAAO,KAAK,OAAO,CAAA;AAC/B,MAAA,IAAI;AACF,QAAA,MAAM,GAAA,CAAI,EAAE,OAAA,EAAS,WAAA,EAAa,UAAU,CAAA;AAAA,MAC9C,CAAA,SAAE;AACA,QAAA,IAAA,CAAK,GAAA,EAAI;AACT,QAAA,MAAM,OAAA,GAAU,IAAA,CAAK,WAAA,EAAY,CAAE,OAAA;AACnC,QAAA,MAAM,UAAA,GAAa,IAAA,CAAK,WAAA,EAAY,CAAE,MAAA;AACtC,QAAA,MAAM,KAAA,GAAQ,SAAA,CAAW,UAAA,CAAW,OAAA,EAAS,UAAU,CAAA;AACvD,QAAA,IAAI,KAAA,CAAM,SAAS,CAAA,EAAG;AACpB,UAAA,QAAA,CAAS,YAAY,IAAA,CAAK;AAAA,YACxB,IAAA,EAAM,YAAA;AAAA,YACN,WAAA,EAAa,IAAA,CAAK,SAAA,CAAU,KAAK;AAAA,WAClC,CAAA;AAAA,QACH;AAAA,MACF;AAAA,IACF,CAAA;AAAA,IACA,EAAE,OAAO,MAAA;AAAO,GAClB;AAAA,EAEA,MAAM,OAAO,EAAE,IAAA,EAAM,aAAA,IAAiB,GAAA,KAAQ;AAC5C,IAAA,MAAM,EAAE,OAAA,EAAS,WAAA,EAAa,QAAA,EAAS,GAAI,aAAA;AAC3C,IAAA,IAAI,WAAA,CAAY,SAAS,CAAA,EAAG;AAC1B,MAAA,MAAM,IAAA,CAAK,KAAA,CAAM,MAAA,EAAQ,OAAO,KAAA,KAAU;AACxC,QAAA,MAAM,OAAA,GAAU,MAAM,OAAA,EAAQ;AAC9B,QAAA,MAAM,GAAA,GAAM,QAAQ,GAAA,EAAI;AACxB,QAAA,IAAI,mBAAA,CAAoB,GAAA,EAAK,WAAW,CAAA,EAAG;AACzC,UAAA,MAAM,OAAA,GAAU;AAAA,YACd,GAAG,QAAQ,OAAA,EAAQ;AAAA,YACnB,GAAG,OAAA;AAAA,YACH,eAAe,QAAA,CAAS;AAAA,WAC1B;AACA,UAAA,MAAM,KAAA,CAAM,QAAA,CAAS,EAAE,OAAA,EAAS,CAAA;AAAA,QAClC,CAAA,MAAO;AACL,UAAA,MAAM,MAAM,QAAA,EAAS;AAAA,QACvB;AAAA,MACF,CAAC,CAAA;AAAA,IACH;AACA,IAAA,MAAM,IAAI,IAAI,CAAA;AAAA,EAChB,CAAA;AAAA,EAEA,kBAAkB,OAAO,EAAE,OAAA,EAAS,aAAA,IAAiB,GAAA,KAAQ;AAC3D,IAAA,MAAM,OAAA,GAAU,sBAAA;AAAA,MACd,OAAA;AAAA,MACA,aAAA,CAAc,WAAA;AAAA,MACd,aAAA,CAAc,OAAA;AAAA,MACd,aAAA,CAAc;AAAA,KAChB;AACA,IAAA,MAAM,IAAI,OAAO,CAAA;AAAA,EACnB;AACF,CAAC;AA4BD,eAAsB,IAAA,CAAQ,MAAc,EAAA,EAAkC;AAC5E,EAAA,MAAM,MAAA,GAAS,SAAA,CAAU,WAAA,EAAa,cAAc,CAAA;AACpD,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,CAAA,KAAA,EAAQ,IAAI,CAAA,CAAA,EAAI;AAAA,IAC5C,UAAA,EAAY,EAAE,WAAA,EAAa,IAAA;AAAK,GACjC,CAAA;AACD,EAAA,IAAI;AACF,IAAA,OAAO,MAAMA,OAAA,CAAY,IAAA,CAAK,SAAA,CAAU,OAAA,CAAQA,QAAY,MAAA,EAAO,EAAG,IAAI,CAAA,EAAG,EAAE,CAAA;AAAA,EACjF,SAAS,KAAA,EAAO;AACd,IAAA,IAAA,CAAK,SAAA,CAAU,EAAE,IAAA,EAAM,cAAA,CAAe,KAAA,EAAO,OAAA,EAAS,KAAA,YAAiB,KAAA,GAAQ,KAAA,CAAM,OAAA,GAAU,eAAA,EAAiB,CAAA;AAChH,IAAA,IAAA,CAAK,eAAA,CAAgB,iBAAiB,KAAA,GAAQ,KAAA,GAAQ,IAAI,KAAA,CAAM,MAAA,CAAO,KAAK,CAAC,CAAC,CAAA;AAC9E,IAAA,MAAM,KAAA;AAAA,EACR,CAAA,SAAE;AACA,IAAA,IAAA,CAAK,GAAA,EAAI;AAAA,EACX;AACF;AAMO,SAAS,kBAAkB,WAAA,EAAkD;AAClF,EAAA,OAAO,YAAY;AACjB,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,OAAO,SAAS,CAAA;AACvC,IAAA,IAAA,CAAK;AAAA,MACH,OAAA,EAAS,WAAA;AAAA,MACT,KAAA,EAAO,IAAA;AAAA,MACP,GAAG;AAAA,KACJ,CAAA;AAAA,EACH,CAAA;AACF","file":"index.js","sourcesContent":["/**\n * autotel-playwright\n *\n * Playwright fixture that creates one OTel span per test and injects W3C trace\n * context into requests to your API so \"test → API\" appears as one trace.\n *\n * @example\n * // globalSetup.ts: init({ service: 'e2e-tests' });\n * // In spec:\n * import { test, expect } from 'autotel-playwright';\n * test('checks health', async ({ page }) => {\n * await page.goto(API_BASE_URL + '/health'); // request gets traceparent\n * });\n * // Node-side API calls with trace context:\n * test('api health', async ({ requestWithTrace }) => {\n * const res = await requestWithTrace.get(API_BASE_URL + '/health');\n * expect(res.ok()).toBeTruthy();\n * });\n */\n\nimport { test as base } from '@playwright/test';\nimport type { Page, APIRequestContext, Request as PlaywrightRequest } from '@playwright/test';\nimport type { TestInfo } from '@playwright/test';\nimport type { AutotelConfig } from 'autotel';\nimport {\n getTracer,\n getAutotelTracerProvider,\n context as otelContext,\n propagation,\n otelTrace,\n SpanStatusCode,\n} from 'autotel';\nimport { TestSpanCollector } from 'autotel/test-span-collector';\nimport { SimpleSpanProcessor } from 'autotel/processors';\n\nconst TRACER_NAME = 'playwright-tests';\nconst TRACER_VERSION = '0.1.0';\n\nlet collector: TestSpanCollector | null = null;\n\ninterface TracerProviderWithProcessor {\n addSpanProcessor(processor: unknown): void;\n}\n\nfunction ensureCollector(): TestSpanCollector {\n if (!collector) {\n collector = new TestSpanCollector();\n const provider = getAutotelTracerProvider();\n if ('addSpanProcessor' in provider) {\n (provider as TracerProviderWithProcessor).addSpanProcessor(\n new SimpleSpanProcessor(collector),\n );\n }\n }\n return collector;\n}\n\n/** Env keys for API base URL (requests to this origin get trace context injected). */\nconst ENV_API_BASE_URL = 'API_BASE_URL';\nconst ENV_API_ORIGIN = 'AUTOTEL_PLAYWRIGHT_API_ORIGIN';\n\nfunction getApiBaseUrls(): string[] {\n const a = process.env[ENV_API_BASE_URL];\n const b = process.env[ENV_API_ORIGIN];\n const urls: string[] = [];\n if (a) urls.push(a.replace(/\\/$/, ''));\n if (b) urls.push(b.replace(/\\/$/, ''));\n return [...new Set(urls)];\n}\n\n/**\n * Returns true if requestUrl should receive trace headers for the given apiBaseUrls.\n * When a base URL includes a path (e.g. http://localhost:3000/api), only requests\n * whose path starts with that path segment match; same-origin but different path\n * (e.g. /health) must not match to avoid leaking trace context to unrelated endpoints.\n */\nfunction urlMatchesApiOrigin(requestUrl: string, apiBaseUrls: string[]): boolean {\n if (apiBaseUrls.length === 0) return false;\n try {\n const u = new URL(requestUrl);\n const requestOrigin = u.origin;\n const requestPathname = u.pathname;\n return apiBaseUrls.some((base) => {\n try {\n const b = new URL(base);\n if (requestOrigin !== b.origin) return false;\n const basePathname = b.pathname.replace(/\\/$/, '') || '/';\n if (basePathname === '/') return true;\n return (\n requestPathname === basePathname || requestPathname.startsWith(basePathname + '/')\n );\n } catch {\n return requestUrl.startsWith(base);\n }\n });\n } catch {\n return apiBaseUrls.some((base) => requestUrl.startsWith(base));\n }\n}\n\n/** Annotation type for custom span attributes: description should be \"key=value\" or \"key=value1;key2=value2\". */\nexport const AUTOTEL_ATTRIBUTE_ANNOTATION = 'autotel.attribute';\n\nfunction setAttributesFromAnnotations(\n span: { setAttribute: (k: string, v: string | number | boolean) => void },\n testInfo: { annotations: Array<{ type: string; description?: string }> },\n): void {\n for (const a of testInfo.annotations) {\n if (a.type !== AUTOTEL_ATTRIBUTE_ANNOTATION || !a.description) continue;\n const entries = a.description.split(';');\n for (const entry of entries) {\n const parts = entry.split('=');\n if (parts.length >= 2) {\n const key = parts[0].trim();\n const value = parts.slice(1).join('=').trim();\n span.setAttribute(key, value);\n }\n }\n }\n}\n\n/** Internal: options for get/post/put/patch/delete/head/fetch that may include headers. */\ntype RequestOptions = Record<string, unknown> & { headers?: Record<string, string> };\n\nfunction mergeTraceHeaders(\n url: string,\n options: RequestOptions | undefined,\n apiBaseUrls: string[],\n carrier: Record<string, string>,\n testName: string,\n): RequestOptions {\n const opts = options ?? {};\n if (!urlMatchesApiOrigin(url, apiBaseUrls)) return opts;\n return {\n ...opts,\n headers: { ...(opts.headers as Record<string, string>), ...carrier, 'x-test-name': testName },\n };\n}\n\n/** Wraps APIRequestContext so requests to API_BASE_URL get trace context injected. */\nfunction createRequestWithTrace(\n request: APIRequestContext,\n apiBaseUrls: string[],\n carrier: Record<string, string>,\n testInfo: TestInfo,\n): APIRequestContext {\n const merge = (url: string, options?: RequestOptions) =>\n mergeTraceHeaders(url, options, apiBaseUrls, carrier, testInfo.title);\n\n return {\n get: (url: string, options?: RequestOptions) => request.get(url, merge(url, options)),\n post: (url: string, options?: RequestOptions) => request.post(url, merge(url, options)),\n put: (url: string, options?: RequestOptions) => request.put(url, merge(url, options)),\n patch: (url: string, options?: RequestOptions) => request.patch(url, merge(url, options)),\n delete: (url: string, options?: RequestOptions) => request.delete(url, merge(url, options)),\n head: (url: string, options?: RequestOptions) => request.head(url, merge(url, options)),\n fetch: (urlOrRequest: string | PlaywrightRequest, options?: RequestOptions) =>\n request.fetch(urlOrRequest, merge(typeof urlOrRequest === 'string' ? urlOrRequest : urlOrRequest.url(), options)),\n storageState: (options?: { path?: string }) => request.storageState(options),\n dispose: () => request.dispose(),\n } as APIRequestContext;\n}\n\ntype OtelTestSpan = {\n carrier: Record<string, string>;\n apiBaseUrls: string[];\n testInfo: TestInfo;\n};\n\nexport const test = base.extend<{\n page: Page;\n requestWithTrace: APIRequestContext;\n _otelTestSpan: OtelTestSpan;\n}>({\n _otelTestSpan: [\n // eslint-disable-next-line no-empty-pattern\n async ({}, use, testInfo) => {\n ensureCollector();\n const apiBaseUrls = getApiBaseUrls();\n const tracer = getTracer(TRACER_NAME, TRACER_VERSION);\n const spanName = `e2e:${testInfo.title}`;\n const span = tracer.startSpan(spanName, {\n attributes: {\n 'test.title': testInfo.title,\n 'test.project': testInfo.project.name,\n 'test.file': testInfo.file ?? '',\n 'test.line': testInfo.line ?? 0,\n },\n });\n setAttributesFromAnnotations(span, testInfo);\n const ctx = otelTrace.setSpan(otelContext.active(), span);\n const carrier: Record<string, string> = {};\n propagation.inject(ctx, carrier);\n try {\n await use({ carrier, apiBaseUrls, testInfo });\n } finally {\n span.end();\n const traceId = span.spanContext().traceId;\n const rootSpanId = span.spanContext().spanId;\n const spans = collector!.drainTrace(traceId, rootSpanId);\n if (spans.length > 0) {\n testInfo.annotations.push({\n type: 'otel-spans',\n description: JSON.stringify(spans),\n });\n }\n }\n },\n { scope: 'test' },\n ],\n\n page: async ({ page, _otelTestSpan }, use) => {\n const { carrier, apiBaseUrls, testInfo } = _otelTestSpan;\n if (apiBaseUrls.length > 0) {\n await page.route('**/*', async (route) => {\n const request = route.request();\n const url = request.url();\n if (urlMatchesApiOrigin(url, apiBaseUrls)) {\n const headers = {\n ...request.headers(),\n ...carrier,\n 'x-test-name': testInfo.title,\n };\n await route.continue({ headers });\n } else {\n await route.continue();\n }\n });\n }\n await use(page);\n },\n\n requestWithTrace: async ({ request, _otelTestSpan }, use) => {\n const wrapped = createRequestWithTrace(\n request,\n _otelTestSpan.apiBaseUrls,\n _otelTestSpan.carrier,\n _otelTestSpan.testInfo,\n );\n await use(wrapped);\n },\n});\n\nexport { expect } from '@playwright/test';\n\n// Re-export trace context helpers for DX convenience\nexport {\n getTraceContext,\n resolveTraceUrl,\n isTracing,\n enrichWithTraceContext,\n} from 'autotel';\n\nexport type { OtelTraceContext } from 'autotel';\n\n/**\n * Runs a named step as a child span of the current test span. Use inside a test to get\n * step-level spans (e.g. \"step:login\", \"step:navigate\") under the test span in the same trace.\n *\n * @example\n * test('user flow', async ({ page }) => {\n * await step('login', async () => {\n * await page.click('button[type=submit]');\n * });\n * await step('open profile', async () => {\n * await page.goto('/profile');\n * });\n * });\n */\nexport async function step<T>(name: string, fn: () => Promise<T>): Promise<T> {\n const tracer = getTracer(TRACER_NAME, TRACER_VERSION);\n const span = tracer.startSpan(`step:${name}`, {\n attributes: { 'step.name': name },\n });\n try {\n return await otelContext.with(otelTrace.setSpan(otelContext.active(), span), fn);\n } catch (error) {\n span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : 'Unknown error' });\n span.recordException(error instanceof Error ? error : new Error(String(error)));\n throw error;\n } finally {\n span.end();\n }\n}\n\n/**\n * Returns a function suitable for Playwright globalSetup that inits autotel.\n * Call autotel.init() with the given options (or defaults) so test spans are exported.\n */\nexport function createGlobalSetup(initOptions?: AutotelConfig): () => Promise<void> {\n return async () => {\n const { init } = await import('autotel');\n init({\n service: 'e2e-tests',\n debug: true,\n ...initOptions,\n });\n };\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"names":["base","otelContext"],"mappings":";;;;;;;;AAmCA,IAAM,WAAA,GAAc,kBAAA;AACpB,IAAM,cAAA,GAAiB,OAAA;AAEvB,IAAI,SAAA,GAAsC,IAAA;AAM1C,SAAS,eAAA,GAAqC;AAC5C,EAAA,IAAI,CAAC,SAAA,EAAW;AACd,IAAA,SAAA,GAAY,IAAI,iBAAA,EAAkB;AAClC,IAAA,MAAM,WAAW,wBAAA,EAAyB;AAC1C,IAAA,IAAI,sBAAsB,QAAA,EAAU;AAClC,MAAC,QAAA,CAAyC,gBAAA;AAAA,QACxC,IAAI,oBAAoB,SAAS;AAAA,OACnC;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,SAAA;AACT;AAGA,IAAM,gBAAA,GAAmB,cAAA;AACzB,IAAM,cAAA,GAAiB,+BAAA;AAEvB,SAAS,cAAA,GAA2B;AAClC,EAAA,MAAM,CAAA,GAAI,OAAA,CAAQ,GAAA,CAAI,gBAAgB,CAAA;AACtC,EAAA,MAAM,CAAA,GAAI,OAAA,CAAQ,GAAA,CAAI,cAAc,CAAA;AACpC,EAAA,MAAM,OAAiB,EAAC;AACxB,EAAA,IAAI,GAAG,IAAA,CAAK,IAAA,CAAK,EAAE,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAC,CAAA;AACrC,EAAA,IAAI,GAAG,IAAA,CAAK,IAAA,CAAK,EAAE,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAC,CAAA;AACrC,EAAA,OAAO,CAAC,GAAG,IAAI,GAAA,CAAI,IAAI,CAAC,CAAA;AAC1B;AAQA,SAAS,mBAAA,CAAoB,YAAoB,WAAA,EAAgC;AAC/E,EAAA,IAAI,WAAA,CAAY,MAAA,KAAW,CAAA,EAAG,OAAO,KAAA;AACrC,EAAA,IAAI;AACF,IAAA,MAAM,CAAA,GAAI,IAAI,GAAA,CAAI,UAAU,CAAA;AAC5B,IAAA,MAAM,gBAAgB,CAAA,CAAE,MAAA;AACxB,IAAA,MAAM,kBAAkB,CAAA,CAAE,QAAA;AAC1B,IAAA,OAAO,WAAA,CAAY,IAAA,CAAK,CAACA,KAAAA,KAAS;AAChC,MAAA,IAAI;AACF,QAAA,MAAM,CAAA,GAAI,IAAI,GAAA,CAAIA,KAAI,CAAA;AACtB,QAAA,IAAI,aAAA,KAAkB,CAAA,CAAE,MAAA,EAAQ,OAAO,KAAA;AACvC,QAAA,MAAM,eAAe,CAAA,CAAE,QAAA,CAAS,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA,IAAK,GAAA;AACtD,QAAA,IAAI,YAAA,KAAiB,KAAK,OAAO,IAAA;AACjC,QAAA,OACE,eAAA,KAAoB,YAAA,IAAgB,eAAA,CAAgB,UAAA,CAAW,eAAe,GAAG,CAAA;AAAA,MAErF,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,UAAA,CAAW,WAAWA,KAAI,CAAA;AAAA,MACnC;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,YAAY,IAAA,CAAK,CAACA,UAAS,UAAA,CAAW,UAAA,CAAWA,KAAI,CAAC,CAAA;AAAA,EAC/D;AACF;AAGO,IAAM,4BAAA,GAA+B;AAE5C,SAAS,4BAAA,CACP,MACA,QAAA,EACM;AACN,EAAA,KAAA,MAAW,CAAA,IAAK,SAAS,WAAA,EAAa;AACpC,IAAA,IAAI,CAAA,CAAE,IAAA,KAAS,4BAAA,IAAgC,CAAC,EAAE,WAAA,EAAa;AAC/D,IAAA,MAAM,OAAA,GAAU,CAAA,CAAE,WAAA,CAAY,KAAA,CAAM,GAAG,CAAA;AACvC,IAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,MAAA,MAAM,KAAA,GAAQ,KAAA,CAAM,KAAA,CAAM,GAAG,CAAA;AAC7B,MAAA,IAAI,KAAA,CAAM,UAAU,CAAA,EAAG;AACrB,QAAA,MAAM,GAAA,GAAM,KAAA,CAAM,CAAC,CAAA,CAAE,IAAA,EAAK;AAC1B,QAAA,MAAM,KAAA,GAAQ,MAAM,KAAA,CAAM,CAAC,EAAE,IAAA,CAAK,GAAG,EAAE,IAAA,EAAK;AAC5C,QAAA,IAAA,CAAK,YAAA,CAAa,KAAK,KAAK,CAAA;AAAA,MAC9B;AAAA,IACF;AAAA,EACF;AACF;AAKA,SAAS,iBAAA,CACP,GAAA,EACA,OAAA,EACA,WAAA,EACA,SACA,QAAA,EACgB;AAChB,EAAA,MAAM,IAAA,GAAO,WAAW,EAAC;AACzB,EAAA,IAAI,CAAC,mBAAA,CAAoB,GAAA,EAAK,WAAW,GAAG,OAAO,IAAA;AACnD,EAAA,OAAO;AAAA,IACL,GAAG,IAAA;AAAA,IACH,OAAA,EAAS,EAAE,GAAI,IAAA,CAAK,SAAoC,GAAG,OAAA,EAAS,eAAe,QAAA;AAAS,GAC9F;AACF;AAGA,SAAS,sBAAA,CACP,OAAA,EACA,WAAA,EACA,OAAA,EACA,QAAA,EACmB;AACnB,EAAA,MAAM,KAAA,GAAQ,CAAC,GAAA,EAAa,OAAA,KAC1B,iBAAA,CAAkB,KAAK,OAAA,EAAS,WAAA,EAAa,OAAA,EAAS,QAAA,CAAS,KAAK,CAAA;AAEtE,EAAA,OAAO;AAAA,IACL,GAAA,EAAK,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,IAAI,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACpF,IAAA,EAAM,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,KAAK,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACtF,GAAA,EAAK,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,IAAI,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACpF,KAAA,EAAO,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,MAAM,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACxF,MAAA,EAAQ,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,OAAO,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IAC1F,IAAA,EAAM,CAAC,GAAA,EAAa,OAAA,KAA6B,OAAA,CAAQ,KAAK,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,OAAO,CAAC,CAAA;AAAA,IACtF,OAAO,CAAC,YAAA,EAA0C,OAAA,KAChD,OAAA,CAAQ,MAAM,YAAA,EAAc,KAAA,CAAM,OAAO,YAAA,KAAiB,WAAW,YAAA,GAAe,YAAA,CAAa,GAAA,EAAI,EAAG,OAAO,CAAC,CAAA;AAAA,IAClH,YAAA,EAAc,CAAC,OAAA,KAAgC,OAAA,CAAQ,aAAa,OAAO,CAAA;AAAA,IAC3E,OAAA,EAAS,MAAM,OAAA,CAAQ,OAAA;AAAQ,GACjC;AACF;AAQO,IAAM,IAAA,GAAOA,OAAK,MAAA,CAItB;AAAA,EACD,aAAA,EAAe;AAAA;AAAA,IAEb,OAAO,EAAC,EAAG,GAAA,EAAK,QAAA,KAAa;AAC3B,MAAA,eAAA,EAAgB;AAChB,MAAA,MAAM,cAAc,cAAA,EAAe;AACnC,MAAA,MAAM,MAAA,GAAS,SAAA,CAAU,WAAA,EAAa,cAAc,CAAA;AACpD,MAAA,MAAM,QAAA,GAAW,CAAA,IAAA,EAAO,QAAA,CAAS,KAAK,CAAA,CAAA;AACtC,MAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,QAAA,EAAU;AAAA,QACtC,UAAA,EAAY;AAAA,UACV,cAAc,QAAA,CAAS,KAAA;AAAA,UACvB,cAAA,EAAgB,SAAS,OAAA,CAAQ,IAAA;AAAA,UACjC,WAAA,EAAa,SAAS,IAAA,IAAQ,EAAA;AAAA,UAC9B,WAAA,EAAa,SAAS,IAAA,IAAQ;AAAA;AAChC,OACD,CAAA;AACD,MAAA,4BAAA,CAA6B,MAAM,QAAQ,CAAA;AAC3C,MAAA,MAAM,MAAM,SAAA,CAAU,OAAA,CAAQC,OAAA,CAAY,MAAA,IAAU,IAAI,CAAA;AACxD,MAAA,MAAM,UAAkC,EAAC;AACzC,MAAAA,OAAA,CAAY,IAAA,CAAK,KAAK,MAAM;AAC1B,QAAA,WAAA,CAAY,MAAA,CAAOA,OAAA,CAAY,MAAA,EAAO,EAAG,OAAO,CAAA;AAAA,MAClD,CAAC,CAAA;AACD,MAAA,IAAI;AACF,QAAA,MAAMA,OAAA,CAAY,IAAA,CAAK,GAAA,EAAK,MAAM,GAAA,CAAI,EAAE,OAAA,EAAS,WAAA,EAAa,QAAA,EAAU,CAAC,CAAA;AAAA,MAC3E,SAAS,KAAA,EAAO;AACd,QAAA,IAAA,CAAK,SAAA,CAAU,EAAE,IAAA,EAAM,cAAA,CAAe,KAAA,EAAO,OAAA,EAAS,KAAA,YAAiB,KAAA,GAAQ,KAAA,CAAM,OAAA,GAAU,eAAA,EAAiB,CAAA;AAChH,QAAA,IAAA,CAAK,eAAA,CAAgB,iBAAiB,KAAA,GAAQ,KAAA,GAAQ,IAAI,KAAA,CAAM,MAAA,CAAO,KAAK,CAAC,CAAC,CAAA;AAC9E,QAAA,MAAM,KAAA;AAAA,MACR,CAAA,SAAE;AACA,QAAA,IAAA,CAAK,GAAA,EAAI;AACT,QAAA,MAAM,OAAA,GAAU,IAAA,CAAK,WAAA,EAAY,CAAE,OAAA;AACnC,QAAA,MAAM,UAAA,GAAa,IAAA,CAAK,WAAA,EAAY,CAAE,MAAA;AACtC,QAAA,MAAM,KAAA,GAAQ,SAAA,CAAW,UAAA,CAAW,OAAA,EAAS,UAAU,CAAA;AACvD,QAAA,IAAI,KAAA,CAAM,SAAS,CAAA,EAAG;AACpB,UAAA,QAAA,CAAS,YAAY,IAAA,CAAK;AAAA,YACxB,IAAA,EAAM,YAAA;AAAA,YACN,WAAA,EAAa,IAAA,CAAK,SAAA,CAAU,KAAK;AAAA,WAClC,CAAA;AAAA,QACH;AAAA,MACF;AAAA,IACF,CAAA;AAAA,IACA,EAAE,OAAO,MAAA;AAAO,GAClB;AAAA,EAEA,MAAM,OAAO,EAAE,IAAA,EAAM,aAAA,IAAiB,GAAA,KAAQ;AAC5C,IAAA,MAAM,EAAE,OAAA,EAAS,WAAA,EAAa,QAAA,EAAS,GAAI,aAAA;AAC3C,IAAA,IAAI,WAAA,CAAY,SAAS,CAAA,EAAG;AAC1B,MAAA,MAAM,IAAA,CAAK,KAAA,CAAM,MAAA,EAAQ,OAAO,KAAA,KAAU;AACxC,QAAA,MAAM,OAAA,GAAU,MAAM,OAAA,EAAQ;AAC9B,QAAA,MAAM,GAAA,GAAM,QAAQ,GAAA,EAAI;AACxB,QAAA,IAAI,mBAAA,CAAoB,GAAA,EAAK,WAAW,CAAA,EAAG;AACzC,UAAA,MAAM,OAAA,GAAU;AAAA,YACd,GAAG,QAAQ,OAAA,EAAQ;AAAA,YACnB,GAAG,OAAA;AAAA,YACH,eAAe,QAAA,CAAS;AAAA,WAC1B;AACA,UAAA,MAAM,KAAA,CAAM,QAAA,CAAS,EAAE,OAAA,EAAS,CAAA;AAAA,QAClC,CAAA,MAAO;AACL,UAAA,MAAM,MAAM,QAAA,EAAS;AAAA,QACvB;AAAA,MACF,CAAC,CAAA;AAAA,IACH;AACA,IAAA,MAAM,IAAI,IAAI,CAAA;AAAA,EAChB,CAAA;AAAA,EAEA,kBAAkB,OAAO,EAAE,OAAA,EAAS,aAAA,IAAiB,GAAA,KAAQ;AAC3D,IAAA,MAAM,OAAA,GAAU,sBAAA;AAAA,MACd,OAAA;AAAA,MACA,aAAA,CAAc,WAAA;AAAA,MACd,aAAA,CAAc,OAAA;AAAA,MACd,aAAA,CAAc;AAAA,KAChB;AACA,IAAA,MAAM,IAAI,OAAO,CAAA;AAAA,EACnB;AACF,CAAC;AA4BD,eAAsB,IAAA,CAAQ,MAAc,EAAA,EAAkC;AAC5E,EAAA,MAAM,MAAA,GAAS,SAAA,CAAU,WAAA,EAAa,cAAc,CAAA;AACpD,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,CAAA,KAAA,EAAQ,IAAI,CAAA,CAAA,EAAI;AAAA,IAC5C,UAAA,EAAY,EAAE,WAAA,EAAa,IAAA;AAAK,GACjC,CAAA;AACD,EAAA,IAAI;AACF,IAAA,OAAO,MAAMA,OAAA,CAAY,IAAA,CAAK,SAAA,CAAU,OAAA,CAAQA,QAAY,MAAA,EAAO,EAAG,IAAI,CAAA,EAAG,EAAE,CAAA;AAAA,EACjF,SAAS,KAAA,EAAO;AACd,IAAA,IAAA,CAAK,SAAA,CAAU,EAAE,IAAA,EAAM,cAAA,CAAe,KAAA,EAAO,OAAA,EAAS,KAAA,YAAiB,KAAA,GAAQ,KAAA,CAAM,OAAA,GAAU,eAAA,EAAiB,CAAA;AAChH,IAAA,IAAA,CAAK,eAAA,CAAgB,iBAAiB,KAAA,GAAQ,KAAA,GAAQ,IAAI,KAAA,CAAM,MAAA,CAAO,KAAK,CAAC,CAAC,CAAA;AAC9E,IAAA,MAAM,KAAA;AAAA,EACR,CAAA,SAAE;AACA,IAAA,IAAA,CAAK,GAAA,EAAI;AAAA,EACX;AACF;AAMO,SAAS,kBAAkB,WAAA,EAAkD;AAClF,EAAA,OAAO,YAAY;AACjB,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,OAAO,SAAS,CAAA;AACvC,IAAA,IAAA,CAAK;AAAA,MACH,OAAA,EAAS,WAAA;AAAA,MACT,KAAA,EAAO,IAAA;AAAA,MACP,GAAG;AAAA,KACJ,CAAA;AAAA,EACH,CAAA;AACF","file":"index.js","sourcesContent":["/**\n * autotel-playwright\n *\n * Playwright fixture that creates one OTel span per test and injects W3C trace\n * context into requests to your API so \"test → API\" appears as one trace.\n *\n * @example\n * // globalSetup.ts: init({ service: 'e2e-tests' });\n * // In spec:\n * import { test, expect } from 'autotel-playwright';\n * test('checks health', async ({ page }) => {\n * await page.goto(API_BASE_URL + '/health'); // request gets traceparent\n * });\n * // Node-side API calls with trace context:\n * test('api health', async ({ requestWithTrace }) => {\n * const res = await requestWithTrace.get(API_BASE_URL + '/health');\n * expect(res.ok()).toBeTruthy();\n * });\n */\n\nimport { test as base } from '@playwright/test';\nimport type { Page, APIRequestContext, Request as PlaywrightRequest } from '@playwright/test';\nimport type { TestInfo } from '@playwright/test';\nimport type { AutotelConfig } from 'autotel';\nimport {\n getTracer,\n getAutotelTracerProvider,\n context as otelContext,\n propagation,\n otelTrace,\n SpanStatusCode,\n} from 'autotel';\nimport { TestSpanCollector } from 'autotel/test-span-collector';\nimport { SimpleSpanProcessor } from 'autotel/processors';\n\nconst TRACER_NAME = 'playwright-tests';\nconst TRACER_VERSION = '0.1.0';\n\nlet collector: TestSpanCollector | null = null;\n\ninterface TracerProviderWithProcessor {\n addSpanProcessor(processor: unknown): void;\n}\n\nfunction ensureCollector(): TestSpanCollector {\n if (!collector) {\n collector = new TestSpanCollector();\n const provider = getAutotelTracerProvider();\n if ('addSpanProcessor' in provider) {\n (provider as TracerProviderWithProcessor).addSpanProcessor(\n new SimpleSpanProcessor(collector),\n );\n }\n }\n return collector;\n}\n\n/** Env keys for API base URL (requests to this origin get trace context injected). */\nconst ENV_API_BASE_URL = 'API_BASE_URL';\nconst ENV_API_ORIGIN = 'AUTOTEL_PLAYWRIGHT_API_ORIGIN';\n\nfunction getApiBaseUrls(): string[] {\n const a = process.env[ENV_API_BASE_URL];\n const b = process.env[ENV_API_ORIGIN];\n const urls: string[] = [];\n if (a) urls.push(a.replace(/\\/$/, ''));\n if (b) urls.push(b.replace(/\\/$/, ''));\n return [...new Set(urls)];\n}\n\n/**\n * Returns true if requestUrl should receive trace headers for the given apiBaseUrls.\n * When a base URL includes a path (e.g. http://localhost:3000/api), only requests\n * whose path starts with that path segment match; same-origin but different path\n * (e.g. /health) must not match to avoid leaking trace context to unrelated endpoints.\n */\nfunction urlMatchesApiOrigin(requestUrl: string, apiBaseUrls: string[]): boolean {\n if (apiBaseUrls.length === 0) return false;\n try {\n const u = new URL(requestUrl);\n const requestOrigin = u.origin;\n const requestPathname = u.pathname;\n return apiBaseUrls.some((base) => {\n try {\n const b = new URL(base);\n if (requestOrigin !== b.origin) return false;\n const basePathname = b.pathname.replace(/\\/$/, '') || '/';\n if (basePathname === '/') return true;\n return (\n requestPathname === basePathname || requestPathname.startsWith(basePathname + '/')\n );\n } catch {\n return requestUrl.startsWith(base);\n }\n });\n } catch {\n return apiBaseUrls.some((base) => requestUrl.startsWith(base));\n }\n}\n\n/** Annotation type for custom span attributes: description should be \"key=value\" or \"key=value1;key2=value2\". */\nexport const AUTOTEL_ATTRIBUTE_ANNOTATION = 'autotel.attribute';\n\nfunction setAttributesFromAnnotations(\n span: { setAttribute: (k: string, v: string | number | boolean) => void },\n testInfo: { annotations: Array<{ type: string; description?: string }> },\n): void {\n for (const a of testInfo.annotations) {\n if (a.type !== AUTOTEL_ATTRIBUTE_ANNOTATION || !a.description) continue;\n const entries = a.description.split(';');\n for (const entry of entries) {\n const parts = entry.split('=');\n if (parts.length >= 2) {\n const key = parts[0].trim();\n const value = parts.slice(1).join('=').trim();\n span.setAttribute(key, value);\n }\n }\n }\n}\n\n/** Internal: options for get/post/put/patch/delete/head/fetch that may include headers. */\ntype RequestOptions = Record<string, unknown> & { headers?: Record<string, string> };\n\nfunction mergeTraceHeaders(\n url: string,\n options: RequestOptions | undefined,\n apiBaseUrls: string[],\n carrier: Record<string, string>,\n testName: string,\n): RequestOptions {\n const opts = options ?? {};\n if (!urlMatchesApiOrigin(url, apiBaseUrls)) return opts;\n return {\n ...opts,\n headers: { ...(opts.headers as Record<string, string>), ...carrier, 'x-test-name': testName },\n };\n}\n\n/** Wraps APIRequestContext so requests to API_BASE_URL get trace context injected. */\nfunction createRequestWithTrace(\n request: APIRequestContext,\n apiBaseUrls: string[],\n carrier: Record<string, string>,\n testInfo: TestInfo,\n): APIRequestContext {\n const merge = (url: string, options?: RequestOptions) =>\n mergeTraceHeaders(url, options, apiBaseUrls, carrier, testInfo.title);\n\n return {\n get: (url: string, options?: RequestOptions) => request.get(url, merge(url, options)),\n post: (url: string, options?: RequestOptions) => request.post(url, merge(url, options)),\n put: (url: string, options?: RequestOptions) => request.put(url, merge(url, options)),\n patch: (url: string, options?: RequestOptions) => request.patch(url, merge(url, options)),\n delete: (url: string, options?: RequestOptions) => request.delete(url, merge(url, options)),\n head: (url: string, options?: RequestOptions) => request.head(url, merge(url, options)),\n fetch: (urlOrRequest: string | PlaywrightRequest, options?: RequestOptions) =>\n request.fetch(urlOrRequest, merge(typeof urlOrRequest === 'string' ? urlOrRequest : urlOrRequest.url(), options)),\n storageState: (options?: { path?: string }) => request.storageState(options),\n dispose: () => request.dispose(),\n } as APIRequestContext;\n}\n\ntype OtelTestSpan = {\n carrier: Record<string, string>;\n apiBaseUrls: string[];\n testInfo: TestInfo;\n};\n\nexport const test = base.extend<{\n page: Page;\n requestWithTrace: APIRequestContext;\n _otelTestSpan: OtelTestSpan;\n}>({\n _otelTestSpan: [\n // eslint-disable-next-line no-empty-pattern\n async ({}, use, testInfo) => {\n ensureCollector();\n const apiBaseUrls = getApiBaseUrls();\n const tracer = getTracer(TRACER_NAME, TRACER_VERSION);\n const spanName = `e2e:${testInfo.title}`;\n const span = tracer.startSpan(spanName, {\n attributes: {\n 'test.title': testInfo.title,\n 'test.project': testInfo.project.name,\n 'test.file': testInfo.file ?? '',\n 'test.line': testInfo.line ?? 0,\n },\n });\n setAttributesFromAnnotations(span, testInfo);\n const ctx = otelTrace.setSpan(otelContext.active(), span);\n const carrier: Record<string, string> = {};\n otelContext.with(ctx, () => {\n propagation.inject(otelContext.active(), carrier);\n });\n try {\n await otelContext.with(ctx, () => use({ carrier, apiBaseUrls, testInfo }));\n } catch (error) {\n span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : 'Unknown error' });\n span.recordException(error instanceof Error ? error : new Error(String(error)));\n throw error;\n } finally {\n span.end();\n const traceId = span.spanContext().traceId;\n const rootSpanId = span.spanContext().spanId;\n const spans = collector!.drainTrace(traceId, rootSpanId);\n if (spans.length > 0) {\n testInfo.annotations.push({\n type: 'otel-spans',\n description: JSON.stringify(spans),\n });\n }\n }\n },\n { scope: 'test' },\n ],\n\n page: async ({ page, _otelTestSpan }, use) => {\n const { carrier, apiBaseUrls, testInfo } = _otelTestSpan;\n if (apiBaseUrls.length > 0) {\n await page.route('**/*', async (route) => {\n const request = route.request();\n const url = request.url();\n if (urlMatchesApiOrigin(url, apiBaseUrls)) {\n const headers = {\n ...request.headers(),\n ...carrier,\n 'x-test-name': testInfo.title,\n };\n await route.continue({ headers });\n } else {\n await route.continue();\n }\n });\n }\n await use(page);\n },\n\n requestWithTrace: async ({ request, _otelTestSpan }, use) => {\n const wrapped = createRequestWithTrace(\n request,\n _otelTestSpan.apiBaseUrls,\n _otelTestSpan.carrier,\n _otelTestSpan.testInfo,\n );\n await use(wrapped);\n },\n});\n\nexport { expect } from '@playwright/test';\n\n// Re-export trace context helpers for DX convenience\nexport {\n getTraceContext,\n resolveTraceUrl,\n isTracing,\n enrichWithTraceContext,\n} from 'autotel';\n\nexport type { OtelTraceContext } from 'autotel';\n\n/**\n * Runs a named step as a child span of the current test span. Use inside a test to get\n * step-level spans (e.g. \"step:login\", \"step:navigate\") under the test span in the same trace.\n *\n * @example\n * test('user flow', async ({ page }) => {\n * await step('login', async () => {\n * await page.click('button[type=submit]');\n * });\n * await step('open profile', async () => {\n * await page.goto('/profile');\n * });\n * });\n */\nexport async function step<T>(name: string, fn: () => Promise<T>): Promise<T> {\n const tracer = getTracer(TRACER_NAME, TRACER_VERSION);\n const span = tracer.startSpan(`step:${name}`, {\n attributes: { 'step.name': name },\n });\n try {\n return await otelContext.with(otelTrace.setSpan(otelContext.active(), span), fn);\n } catch (error) {\n span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : 'Unknown error' });\n span.recordException(error instanceof Error ? error : new Error(String(error)));\n throw error;\n } finally {\n span.end();\n }\n}\n\n/**\n * Returns a function suitable for Playwright globalSetup that inits autotel.\n * Call autotel.init() with the given options (or defaults) so test spans are exported.\n */\nexport function createGlobalSetup(initOptions?: AutotelConfig): () => Promise<void> {\n return async () => {\n const { init } = await import('autotel');\n init({\n service: 'e2e-tests',\n debug: true,\n ...initOptions,\n });\n };\n}\n"]}
|
package/package.json
CHANGED
package/src/index.test.ts
CHANGED
|
@@ -23,6 +23,7 @@ type TestSpanFixtureFn = (
|
|
|
23
23
|
const state: { fixtures?: Fixtures } = {};
|
|
24
24
|
let spanIdCounter = 0;
|
|
25
25
|
let mockDrainResult: unknown[] = [];
|
|
26
|
+
const contextWithSpy = vi.fn((_ctx: unknown, fn: () => Promise<unknown>) => fn());
|
|
26
27
|
const createdSpans: Array<{
|
|
27
28
|
end: ReturnType<typeof vi.fn>;
|
|
28
29
|
recordException: ReturnType<typeof vi.fn>;
|
|
@@ -45,7 +46,7 @@ vi.mock('autotel', () => ({
|
|
|
45
46
|
SpanStatusCode: { UNSET: 0, OK: 1, ERROR: 2 },
|
|
46
47
|
context: {
|
|
47
48
|
active: () => ({}),
|
|
48
|
-
with:
|
|
49
|
+
with: contextWithSpy,
|
|
49
50
|
},
|
|
50
51
|
getTracer: () => ({
|
|
51
52
|
startSpan: () => {
|
|
@@ -99,6 +100,7 @@ describe('autotel-playwright requestWithTrace.fetch', () => {
|
|
|
99
100
|
createdSpans.length = 0;
|
|
100
101
|
spanIdCounter = 0;
|
|
101
102
|
mockDrainResult = [];
|
|
103
|
+
contextWithSpy.mockClear();
|
|
102
104
|
vi.resetModules();
|
|
103
105
|
});
|
|
104
106
|
|
|
@@ -189,6 +191,7 @@ describe('autotel-playwright annotations', () => {
|
|
|
189
191
|
createdSpans.length = 0;
|
|
190
192
|
spanIdCounter = 0;
|
|
191
193
|
mockDrainResult = [];
|
|
194
|
+
contextWithSpy.mockClear();
|
|
192
195
|
vi.resetModules();
|
|
193
196
|
});
|
|
194
197
|
|
|
@@ -247,6 +250,55 @@ describe('autotel-playwright annotations', () => {
|
|
|
247
250
|
{ spanId: 's1', name: 'e2e:test', startTimeMs: 1000, durationMs: 100, status: 'ok' },
|
|
248
251
|
]);
|
|
249
252
|
});
|
|
253
|
+
|
|
254
|
+
it('marks the test span as error and records exception when test body throws', async () => {
|
|
255
|
+
await import('./index');
|
|
256
|
+
|
|
257
|
+
const spanFixture = state.fixtures?._otelTestSpan;
|
|
258
|
+
const spanFixtureFn = Array.isArray(spanFixture) ? spanFixture[0] : spanFixture;
|
|
259
|
+
expect(spanFixtureFn).toBeTypeOf('function');
|
|
260
|
+
|
|
261
|
+
const testError = new Error('fixture blew up');
|
|
262
|
+
await expect(
|
|
263
|
+
spanFixtureFn?.(
|
|
264
|
+
{},
|
|
265
|
+
async () => {
|
|
266
|
+
throw testError;
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
annotations: [],
|
|
270
|
+
project: { name: 'chromium' },
|
|
271
|
+
title: 'failing fixture test',
|
|
272
|
+
},
|
|
273
|
+
),
|
|
274
|
+
).rejects.toThrow('fixture blew up');
|
|
275
|
+
|
|
276
|
+
const span = createdSpans[0];
|
|
277
|
+
expect(span).toBeDefined();
|
|
278
|
+
expect(span.setStatus).toHaveBeenCalled();
|
|
279
|
+
expect(span.recordException).toHaveBeenCalledWith(testError);
|
|
280
|
+
});
|
|
281
|
+
|
|
282
|
+
it('runs test body inside the test span context', async () => {
|
|
283
|
+
await import('./index');
|
|
284
|
+
|
|
285
|
+
const spanFixture = state.fixtures?._otelTestSpan;
|
|
286
|
+
const spanFixtureFn = Array.isArray(spanFixture) ? spanFixture[0] : spanFixture;
|
|
287
|
+
expect(spanFixtureFn).toBeTypeOf('function');
|
|
288
|
+
|
|
289
|
+
await spanFixtureFn?.(
|
|
290
|
+
{},
|
|
291
|
+
async () => {},
|
|
292
|
+
{
|
|
293
|
+
annotations: [],
|
|
294
|
+
project: { name: 'chromium' },
|
|
295
|
+
title: 'context propagation test',
|
|
296
|
+
},
|
|
297
|
+
);
|
|
298
|
+
|
|
299
|
+
// Once to build carrier, once to run the test body under the span context.
|
|
300
|
+
expect(contextWithSpy).toHaveBeenCalledTimes(2);
|
|
301
|
+
});
|
|
250
302
|
});
|
|
251
303
|
|
|
252
304
|
describe('autotel-playwright step', () => {
|
package/src/index.ts
CHANGED
|
@@ -190,9 +190,15 @@ export const test = base.extend<{
|
|
|
190
190
|
setAttributesFromAnnotations(span, testInfo);
|
|
191
191
|
const ctx = otelTrace.setSpan(otelContext.active(), span);
|
|
192
192
|
const carrier: Record<string, string> = {};
|
|
193
|
-
|
|
193
|
+
otelContext.with(ctx, () => {
|
|
194
|
+
propagation.inject(otelContext.active(), carrier);
|
|
195
|
+
});
|
|
194
196
|
try {
|
|
195
|
-
await use({ carrier, apiBaseUrls, testInfo });
|
|
197
|
+
await otelContext.with(ctx, () => use({ carrier, apiBaseUrls, testInfo }));
|
|
198
|
+
} catch (error) {
|
|
199
|
+
span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : 'Unknown error' });
|
|
200
|
+
span.recordException(error instanceof Error ? error : new Error(String(error)));
|
|
201
|
+
throw error;
|
|
196
202
|
} finally {
|
|
197
203
|
span.end();
|
|
198
204
|
const traceId = span.spanContext().traceId;
|