reporting-labs 0.6.1 → 0.6.2

package/README.md

@@ -88,7 +88,28 @@ One line per test. With this the report can rank failures by priority, group the
 
 - Known keys: `priority`, `severity`, `owner`, `feature`, `epic`, `story`, `issue`, `component`, `team`. Any other key you pass is shown too.
 - Your Playwright tags like `@sanity` or `@regression` stay as they are and still show on the test.
-- To make story and epic keys clickable, set `links` in the config: `links: { story: 'https://yourteam.atlassian.net/browse/{id}' }`.
+- To make story and epic keys clickable, set `links` in the config: `links: { story: 'https://yourteam.atlassian.net/browse/{id}' }`. Several ids (`story: ['SHOP-1', 'SHOP-2']`) become one link each.
+- A link whose URL needs more than the shown value (a workspace, a project, an organisation) takes an object. Any tool, any URL shape: every `{placeholder}` in `url` is filled from the object you pass in `meta()`, `display` is what the report shows (default `{id}`), the other fields only build the URL. ALM Octane / ValueEdge as an example:
+
+  ```ts
+  // reporting-labs.config.ts
+  links: {
+    octaneTestCase: {
+      url: 'https://oss.valueedge.com/ui/?p={p}#/entity-navigation?entityType=test&id={id}',
+      display: '{id}',
+    },
+  },
+  ```
+
+  ```ts
+  // tests/notifications.spec.ts
+  test('TC003 - manual trigger with all notifications disabled', async ({ page }) => {
+    meta({ priority: 'P1', owner: 'chetan', octaneTestCase: { id: '58966', p: '4001/14014' } });
+    // ... your test as usual
+  });
+  ```
+
+  The test shows a chip **octaneTestCase 58966**; clicking it opens the full URL. `p` never appears in the report and can differ per test. The same shape covers Azure DevOps (`url: 'https://dev.azure.com/{org}/{project}/_workitems/edit/{id}', display: 'AB#{id}'`) or any in-house tool. Jira, TestRail, Xray and Zephyr need only the plain `{id}` string.
 - Forgot one? After every run the console lists the tests that have no `meta()`, with file and line. Turn it off with `warnMissingMeta: false`.
 - `priority`, `severity`, `feature` and `owner` each get a tab in the Breakdown chart and a filter on the Tests page. Want the same for your own key, say `meta({ team: 'web' })`? Add it to `dimensions` in the config: `dimensions: ['priority', 'severity', 'feature', 'owner', 'team']`.
 
@@ -284,7 +305,7 @@ Every option is optional. `npx reporting-labs init` writes them all, with commen
 | `project` | – | `{ name, version, team, url }` shown under the title |
 | `metadata` | `{}` | Chips in the header, e.g. `{ env: 'staging', build: '#1842' }`. `build` labels the run in the trend; in CI the run number is used when it is not set |
 | `env` | – | Extra rows on the Environment card |
-| `links` | `{}` | Turn meta keys into links. `{id}` is replaced by the value |
+| `links` | `{}` | Turn meta keys into links. `{id}` is replaced by the value. An object `{ url, display }` builds the URL from several fields of an object passed to `meta()`, see below |
 | `maskKeys` | `[]` | Extra keys to mask as `****` |
 | `dimensions` | `['priority','severity','feature','owner']` | Which `meta()` keys get a tab in the Breakdown chart and a dropdown filter on the Tests page. Add your own key, e.g. `'team'`, to get a chart for it |
 | `dimensionOrder` | P0…P4, blocker…trivial | The order values appear in those charts and filters. Only needed for your own values, e.g. `{ severity: ['high','medium','low'] }` |

package/dist/auto.js

@@ -154,28 +154,65 @@ function patchContext(ctx) {
     };
     proto[PATCHED] = true;
 }
+/** Wrap `obj[name]` (found on the prototype chain) so `after(result)` sees each resolved return value. */
+function wrapAsync(obj, name, after) {
+    let proto = obj;
+    while (proto && !Object.prototype.hasOwnProperty.call(proto, name))
+        proto = Object.getPrototypeOf(proto);
+    if (!proto || typeof proto[name] !== 'function' || proto[name][PATCHED])
+        return;
+    const original = proto[name];
+    const wrapped = async function (...args) {
+        const result = await original.apply(this, args);
+        try {
+            after(result);
+        }
+        catch { /* never break the caller */ }
+        return result;
+    };
+    wrapped[PATCHED] = true;
+    proto[name] = wrapped;
+}
+/**
+ * Hook the places an APIRequestContext can come from, and patch the shared prototype the
+ * first time one shows up:
+ *   - playwright.request.newContext()        (the `request` fixture, manual contexts)
+ *   - browser.newContext() / launchPersistentContext() / connect*()   (page.request, context.request)
+ *
+ * No context is created here. An earlier version made a throwaway context at import time and
+ * disposed it; when that dispose raced with the test runner's tracing bookkeeping the runner
+ * tried to start a trace on a closed context and every test failed with
+ * "apiRequestContext._wrapApiCall: Target page, context or browser has been closed".
+ */
 function install() {
     let api;
     try {
-        api = pw().request;
+        api = pw();
     }
     catch {
         return;
     }
-    if (!api || typeof api.newContext !== 'function')
-        return;
-    const apiProto = Object.getPrototypeOf(api);
-    if (apiProto[PATCHED])
-        return;
-    apiProto[PATCHED] = true;
-    // Any context created later through request.newContext() patches the shared prototype on the spot.
-    const newContext = apiProto.newContext;
-    apiProto.newContext = async function patchedNewContext(...args) {
-        const ctx = await newContext.apply(this, args);
-        patchContext(ctx);
-        return ctx;
+    const { request, chromium, firefox, webkit } = api;
+    if (request && typeof request.newContext === 'function')
+        wrapAsync(request, 'newContext', ctx => patchContext(ctx));
+    const onBrowser = (browser) => {
+        if (!browser || typeof browser.newContext !== 'function')
+            return;
+        wrapAsync(browser, 'newContext', ctx => ctx?.request && patchContext(ctx.request));
+        try {
+            for (const ctx of browser.contexts())
+                if (ctx?.request)
+                    patchContext(ctx.request);
+        }
+        catch { /* not a browser */ }
     };
-    // And do it right away with a throwaway context, so page.request works even if no request fixture is ever created.
-    api.newContext().then((ctx) => { patchContext(ctx); return ctx.dispose(); }).catch(() => { });
+    for (const bt of [chromium, firefox, webkit]) {
+        if (!bt)
+            continue;
+        wrapAsync(bt, 'launch', onBrowser);
+        wrapAsync(bt, 'connect', onBrowser);
+        wrapAsync(bt, 'connectOverCDP', onBrowser);
+        wrapAsync(bt, 'launchPersistentContext', ctx => ctx?.request && patchContext(ctx.request));
+    }
 }
 install();

package/dist/meta.d.ts

@@ -4,6 +4,9 @@ import type { ApiCall, TestMeta } from './types';
  *
  * @example
  * meta({ priority: 'P1', severity: 'critical', owner: 'naveen', feature: 'checkout', story: 'SHOP-231' });
+ *
+ * A value can be an object when the link needs more than one parameter (see `links` in the config):
+ *   meta({ octaneTestCase: { id: '58966', p: '4001/14014' } });
  */
 export declare function meta(values: TestMeta): void;
 /**

package/dist/meta.js

@@ -16,13 +16,19 @@ function info() {
  *
  * @example
  * meta({ priority: 'P1', severity: 'critical', owner: 'naveen', feature: 'checkout', story: 'SHOP-231' });
+ *
+ * A value can be an object when the link needs more than one parameter (see `links` in the config):
+ *   meta({ octaneTestCase: { id: '58966', p: '4001/14014' } });
  */
 function meta(values) {
     const i = info();
     for (const [k, v] of Object.entries(values)) {
         if (v === undefined)
             continue;
-        i.annotations.push({ type: k.toLowerCase(), description: String(v) });
+        // Objects (e.g. { id: '58966', p: '4001/14014' } for a multi-parameter link) travel as JSON.
+        // Arrays (story: ['SHOP-1', 'SHOP-2']) become one chip per value; objects (a multi-parameter link) travel as JSON.
+        const text = Array.isArray(v) ? v.map(String).join(', ') : v !== null && typeof v === 'object' ? JSON.stringify(v) : String(v);
+        i.annotations.push({ type: k.toLowerCase(), description: text });
     }
 }
 /**

package/dist/reporter.d.ts

@@ -34,7 +34,15 @@ export default class ReportingLabsReporter implements Reporter {
     private dimensions;
     /** Keys picked up from tags and annotations even when they are not breakdown dimensions. */
     private metaKeys;
-    /** Pull meta values (priority, owner, story, epic...) from annotations and tags. */
+    /** The link template for a (lower-cased) meta key, falling back to '*'. */
+    private linkTemplate;
+    /** `links` reduced to URL templates, the shape the template expects. */
+    private linkUrls;
+    /**
+     * Pull meta values (priority, owner, story, epic...) from annotations and tags.
+     * An object value (meta({ octaneTestCase: { id, p } })) is folded to its display text and, when the key has a
+     * link template, to a ready-made href in `links`; the other fields never show in the report.
+     */
     private extractMeta;
     /** A local image file (path relative to the config) is embedded as a data URI so the report stays self-contained. URLs and data URIs pass through. */
     private resolveLogo;

package/dist/reporter.js

@@ -105,6 +105,7 @@ class ReportingLabsReporter {
             const last = test.results[test.results.length - 1];
             const resultAnn = (last?.annotations ?? []);
             const annotations = [...test.annotations, ...resultAnn.filter(a => !test.annotations.some(b => b.type === a.type && b.description === a.description))];
+            const extracted = this.extractMeta(test);
             tests.push({
                 id: test.id,
                 key: `${project}::${file}::${[...titlePath, test.title].join(' › ')}${test.repeatEachIndex ? ' #' + (test.repeatEachIndex + 1) : ''}`,
@@ -116,7 +117,8 @@ class ReportingLabsReporter {
                 project,
                 tags: test.tags,
                 annotations,
-                meta: this.extractMeta(test),
+                meta: extracted.meta,
+                links: Object.keys(extracted.links).length ? extracted.links : undefined,
                 outcome,
                 expectedFailure,
                 note,
@@ -195,7 +197,7 @@ class ReportingLabsReporter {
                     ...(this.options.dimensionOrder ?? {}),
                 },
                 project: this.options.project,
-                links: this.options.links ?? {},
+                links: this.linkUrls(),
                 customCss: this.options.customCss ?? '',
                 editorLinks: this.options.editorLinks ?? !process.env.CI,
             },
@@ -352,10 +354,34 @@ class ReportingLabsReporter {
     metaKeys() {
         return [...new Set([...this.dimensions(), ...META_KEYS, ...Object.keys(this.options.links ?? {}).map(k => k.toLowerCase())])].filter(k => k !== '*');
     }
-    /** Pull meta values (priority, owner, story, epic...) from annotations and tags. */
+    /** The link template for a (lower-cased) meta key, falling back to '*'. */
+    linkTemplate(key) {
+        let star;
+        for (const [k, v] of Object.entries(this.options.links ?? {})) {
+            if (k.toLowerCase() === key)
+                return v;
+            if (k === '*')
+                star = v;
+        }
+        return star;
+    }
+    /** `links` reduced to URL templates, the shape the template expects. */
+    linkUrls() {
+        const out = {};
+        // Meta keys are lower-cased on the way in, so link keys must be too (links: { testCaseId } did not match before).
+        for (const [k, v] of Object.entries(this.options.links ?? {}))
+            out[k.toLowerCase()] = typeof v === 'string' ? v : v.url;
+        return out;
+    }
+    /**
+     * Pull meta values (priority, owner, story, epic...) from annotations and tags.
+     * An object value (meta({ octaneTestCase: { id, p } })) is folded to its display text and, when the key has a
+     * link template, to a ready-made href in `links`; the other fields never show in the report.
+     */
     extractMeta(test) {
         const dims = this.metaKeys();
         const meta = {};
+        const links = {};
         // Tags first (describe-level, then test-level), annotations last so a test can override its describe's tags.
         for (const raw of test.tags) {
             const tag = raw.replace(/^@/, '');
@@ -371,10 +397,22 @@ class ReportingLabsReporter {
         }
         for (const a of test.annotations) {
             const k = a.type.toLowerCase();
-            if (dims.includes(k) && a.description)
+            if (!dims.includes(k) || !a.description)
+                continue;
+            const fields = parseObject(a.description);
+            if (!fields) {
                 meta[k] = a.description;
+                continue;
+            }
+            const tpl = this.linkTemplate(k);
+            const display = typeof tpl === 'object' && tpl.display ? tpl.display : '{id}';
+            const shown = fill(display, fields, false);
+            meta[k] = shown || String(fields.id ?? Object.values(fields)[0] ?? '');
+            const url = typeof tpl === 'string' ? tpl : tpl?.url;
+            if (url)
+                links[k] = fill(url, fields, true);
         }
-        return meta;
+        return { meta, links };
     }
     /** A local image file (path relative to the config) is embedded as a data URI so the report stays self-contained. URLs and data URIs pass through. */
     resolveLogo(logo) {
@@ -622,3 +660,25 @@ function stripAnsi(s) {
 function sanitize(s) {
     return s.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '').slice(0, 40);
 }
+/** A JSON object literal in an annotation description (what meta() writes for object values), else undefined. */
+function parseObject(text) {
+    if (!text.startsWith('{'))
+        return undefined;
+    try {
+        const v = JSON.parse(text);
+        return v && typeof v === 'object' && !Array.isArray(v) ? v : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+/** Replace {field} placeholders; for URLs each value is encoded except '/' and ':' so a value like '4001/14014' survives. */
+function fill(template, fields, forUrl) {
+    return template.replace(/\{(\w+)\}/g, (_m, name) => {
+        const v = fields[name];
+        if (v === undefined || v === null)
+            return '';
+        const text = String(v);
+        return forUrl ? encodeURIComponent(text).replace(/%2F/gi, '/').replace(/%3A/gi, ':') : text;
+    });
+}

package/dist/template.html

@@ -1488,8 +1488,8 @@ function renderDetail(t){
       editorLink(t))),
     h('div',{class:'badges'}, h('span',{class:'badge '+t.outcome},label[t.outcome]), t.expectedFailure? h('span',{class:'badge xfail',title:'Marked test.fail(): failing is the expected result'},'Expected failure') : null, sinceBadge(t), dots(t,10), data.bdd?h('span',{class:'badge scenario'},'Scenario'):null, t.tags.map(g=>h('span',{class:'badge tag'},g)), data.projects.length>1?h('span',{class:'badge tag'},t.project):null, h('span',{class:'loc'}, t.file+':'+t.line+' · '+ms(t.duration)+(t.outcome==='timedOut'&&t.timeout?' · timeout '+ms(t.timeout):'')+(t.retries?' · retries '+t.retries:''))));
   const metaKeys=Object.keys(t.meta);
-  const linkFor=(k,v)=>{ const tpl=data.options.links[k]||data.options.links['*']; if(tpl) return tpl.replace('{id}',encodeURIComponent(v)); if(/^https?:\/\//.test(v)) return v; return null; };
-  if(metaKeys.length) d.append(h('div',{class:'metas'}, metaKeys.map(k=>{ const v=t.meta[k], low=/^(P[3-4]|low|minor|trivial|normal|medium)$/i.test(v), href=linkFor(k,v); return h('span',{class:'meta '+k+(low?' low':'')}, h('span',{class:'k'},k), href? h('a',{href,target:'_blank',rel:'noopener'},v) : h('span',{class:'v'},v)); })));
+  const linkFor=(k,v)=>{ if(t.links&&t.links[k]) return t.links[k]; const tpl=data.options.links[k]||data.options.links['*']; if(tpl) return tpl.replace('{id}',encodeURIComponent(v)); if(/^https?:\/\//.test(v)) return v; return null; };
+  if(metaKeys.length) d.append(h('div',{class:'metas'}, metaKeys.map(k=>{ const v=t.meta[k], low=/^(P[3-4]|low|minor|trivial|normal|medium)$/i.test(v); const parts=(t.links&&t.links[k])||!data.options.links[k]&&!data.options.links['*']?[v]:v.split(/,\s+/); const nodes=[]; parts.forEach((part,i)=>{ const href=linkFor(k,part); if(i) nodes.push(', '); nodes.push(href? h('a',{href,target:'_blank',rel:'noopener'},part) : h('span',{class:'v'},part)); }); return h('span',{class:'meta '+k+(low?' low':'')}, h('span',{class:'k'},k), ...nodes); })));
   const otherAnn=t.annotations.filter(a=>!DIMS.includes(a.type.toLowerCase()) && !(a.type.toLowerCase() in t.meta));
   if(otherAnn.length) d.append(h('h4',{},'Annotations'), h('dl',{class:'kv'}, otherAnn.map(a=>[h('dt',{},a.type),h('dd',{},a.description||'')])));
   if(t.results.length>1){

package/dist/template.js

@@ -1554,8 +1554,8 @@ function renderDetail(t){
       editorLink(t))),
     h('div',{class:'badges'}, h('span',{class:'badge '+t.outcome},label[t.outcome]), t.expectedFailure? h('span',{class:'badge xfail',title:'Marked test.fail(): failing is the expected result'},'Expected failure') : null, sinceBadge(t), dots(t,10), data.bdd?h('span',{class:'badge scenario'},'Scenario'):null, t.tags.map(g=>h('span',{class:'badge tag'},g)), data.projects.length>1?h('span',{class:'badge tag'},t.project):null, h('span',{class:'loc'}, t.file+':'+t.line+' · '+ms(t.duration)+(t.outcome==='timedOut'&&t.timeout?' · timeout '+ms(t.timeout):'')+(t.retries?' · retries '+t.retries:''))));
   const metaKeys=Object.keys(t.meta);
-  const linkFor=(k,v)=>{ const tpl=data.options.links[k]||data.options.links['*']; if(tpl) return tpl.replace('{id}',encodeURIComponent(v)); if(/^https?:\/\//.test(v)) return v; return null; };
-  if(metaKeys.length) d.append(h('div',{class:'metas'}, metaKeys.map(k=>{ const v=t.meta[k], low=/^(P[3-4]|low|minor|trivial|normal|medium)$/i.test(v), href=linkFor(k,v); return h('span',{class:'meta '+k+(low?' low':'')}, h('span',{class:'k'},k), href? h('a',{href,target:'_blank',rel:'noopener'},v) : h('span',{class:'v'},v)); })));
+  const linkFor=(k,v)=>{ if(t.links&&t.links[k]) return t.links[k]; const tpl=data.options.links[k]||data.options.links['*']; if(tpl) return tpl.replace('{id}',encodeURIComponent(v)); if(/^https?:\/\//.test(v)) return v; return null; };
+  if(metaKeys.length) d.append(h('div',{class:'metas'}, metaKeys.map(k=>{ const v=t.meta[k], low=/^(P[3-4]|low|minor|trivial|normal|medium)$/i.test(v); const parts=(t.links&&t.links[k])||!data.options.links[k]&&!data.options.links['*']?[v]:v.split(/,\s+/); const nodes=[]; parts.forEach((part,i)=>{ const href=linkFor(k,part); if(i) nodes.push(', '); nodes.push(href? h('a',{href,target:'_blank',rel:'noopener'},part) : h('span',{class:'v'},part)); }); return h('span',{class:'meta '+k+(low?' low':'')}, h('span',{class:'k'},k), ...nodes); })));
   const otherAnn=t.annotations.filter(a=>!DIMS.includes(a.type.toLowerCase()) && !(a.type.toLowerCase() in t.meta));
   if(otherAnn.length) d.append(h('h4',{},'Annotations'), h('dl',{class:'kv'}, otherAnn.map(a=>[h('dt',{},a.type),h('dd',{},a.description||'')])));
   if(t.results.length>1){

package/dist/types.d.ts

@@ -77,8 +77,14 @@ export interface ReportingLabsOptions {
     /**
      * Turn meta values into links. Key = meta key (story, epic, ticket, issue, jira...), value = URL template with {id}.
      * e.g. { story: 'https://acme.atlassian.net/browse/{id}', epic: 'https://acme.atlassian.net/browse/{id}' }
+     *
+     * A link that needs more than the displayed value takes an object. Placeholders name the fields of the
+     * object passed to meta(); `display` (default '{id}') is what the report shows, the rest only builds the URL:
+     *   links: { octaneTestCase: { url: 'https://oss.valueedge.com/ui/?p={p}#/entity-navigation?entityType=test&id={id}', display: '{id}' } }
+     *   meta({ octaneTestCase: { id: '58966', p: '4001/14014' } })
+     * The report shows "octaneTestCase 58966", clicking it opens the full URL; p is never shown.
      */
-    links?: Record<string, string>;
+    links?: Record<string, string | LinkTemplate>;
     /** Keys (case-insensitive substrings) whose values are masked in test data and API panels. */
     maskKeys?: string[];
     /** Keep a rolling run history next to the report and draw a trend chart. Per-test outcomes are stored too, which powers new-vs-known failures, flaky history and duration regressions. */
@@ -94,6 +100,13 @@ export interface ReportingLabsOptions {
     /** Style Given/When/Then steps as Gherkin and label describe blocks as Features/Scenarios. Default: auto-detect */
     bdd?: boolean;
 }
+/** A link built from several fields of a meta() object. */
+export interface LinkTemplate {
+    /** URL with {field} placeholders, e.g. 'https://tms.example.com/{project}/cases/{id}'. */
+    url: string;
+    /** What the report shows for this meta key, with the same placeholders. Default '{id}'. */
+    display?: string;
+}
 /** Lets you type a known value and still accept any string. */
 export type Loose<T extends string> = T | (string & {});
 /**
@@ -114,14 +127,14 @@ export interface TestMeta extends CustomMeta {
     feature?: string;
     /** Epic key, e.g. 'EPIC-18'. Becomes a link when `links.epic` is configured. */
     epic?: string;
-    /** User story key, e.g. 'SHOP-250'. Becomes a link when `links.story` is configured. */
-    story?: string;
-    /** Bug / issue key this test guards against, e.g. 'PROMO-118'. */
-    issue?: string;
+    /** User story key, e.g. 'SHOP-250', or several. Becomes a link when `links.story` is configured. */
+    story?: string | string[];
+    /** Bug / issue key this test guards against, e.g. 'PROMO-118', or several. */
+    issue?: string | string[];
     /** Test case id in your TCM tool (TestRail, Xray, Zephyr...). */
     testCaseId?: string;
-    /** Free-form tags or any other key you like. */
-    [key: string]: string | number | undefined;
+    /** Free-form tags or any other key you like. An object holds the fields of a multi-parameter link, see `links`. */
+    [key: string]: string | number | (string | number)[] | Record<string, string | number> | undefined;
 }
 /** Empty by default; augment it to add typed keys of your own. */
 export interface CustomMeta {
@@ -237,6 +250,8 @@ export interface TestData {
     }[];
     /** extracted dimension values, e.g. { priority: 'P1', severity: 'critical' } */
     meta: Record<string, string>;
+    /** Ready-made hrefs for meta keys whose link needed more than the displayed value (object meta + LinkTemplate). */
+    links?: Record<string, string>;
     outcome: Status;
     duration: number;
     results: ResultData[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reporting-labs",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "reportingLabs – beautiful, customizable single-file HTML test reports. One line of config. Playwright adapter included, more runners on the way.",
   "keywords": [
     "test-report",