@code-pushup/lighthouse-plugin 0.66.2 → 0.68.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/lighthouse-plugin",
-  "version": "0.66.2",
+  "version": "0.68.0",
   "license": "MIT",
   "description": "Code PushUp plugin for measuring web performance and quality with Lighthouse 🔥",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-lighthouse#readme",
@@ -36,8 +36,8 @@
   },
   "type": "module",
   "dependencies": {
-    "@code-pushup/models": "0.66.2",
-    "@code-pushup/utils": "0.66.2",
+    "@code-pushup/models": "0.68.0",
+    "@code-pushup/utils": "0.68.0",
     "ansis": "^3.3.0",
     "chrome-launcher": "^1.1.1",
     "lighthouse": "^12.0.0",

package/src/lib/runner/details/critical-request-chain.type.d.ts

@@ -0,0 +1,3 @@
+import type Details from 'lighthouse/types/lhr/audit-details';
+import type { AuditDetails } from '@code-pushup/models';
+export declare function parseCriticalRequestChainToAuditDetails(details: Details.CriticalRequestChain): AuditDetails;

package/src/lib/runner/details/critical-request-chain.type.js

@@ -0,0 +1,53 @@
+import { formatBytes, formatDuration } from '@code-pushup/utils';
+const DURATION_DECIMALS = 3;
+export function parseCriticalRequestChainToAuditDetails(details) {
+    const trees = chainsToTrees(details);
+    const table = longestChainToTable(details);
+    return { table, trees };
+}
+function longestChainToTable(details) {
+    const longestChain = {
+        duration: formatDuration(details.longestChain.duration, DURATION_DECIMALS),
+        transferSize: formatBytes(details.longestChain.transferSize),
+        length: details.longestChain.length,
+    };
+    return {
+        title: 'Longest chain',
+        columns: [
+            {
+                key: 'duration',
+                label: 'Duration',
+                align: 'right',
+            },
+            {
+                key: 'transferSize',
+                label: 'Transfer size',
+                align: 'right',
+            },
+            {
+                key: 'length',
+                label: 'Length',
+                align: 'right',
+            },
+        ],
+        rows: [longestChain],
+    };
+}
+function chainsToTrees(details) {
+    return Object.values(details.chains)
+        .map(chainToTreeNode)
+        .map(root => ({ type: 'basic', root }));
+}
+function chainToTreeNode(chain) {
+    return {
+        name: chain.request.url,
+        values: {
+            duration: formatDuration((chain.request.endTime - chain.request.startTime) * 1000, DURATION_DECIMALS),
+            transferSize: formatBytes(chain.request.transferSize),
+        },
+        ...(chain.children && {
+            children: Object.values(chain.children).map(chainToTreeNode),
+        }),
+    };
+}
+//# sourceMappingURL=critical-request-chain.type.js.map

package/src/lib/runner/details/critical-request-chain.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"critical-request-chain.type.js","sourceRoot":"","sources":["../../../../../../../packages/plugin-lighthouse/src/lib/runner/details/critical-request-chain.type.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEjE,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAE5B,MAAM,UAAU,uCAAuC,CACrD,OAAqC;IAErC,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC3C,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC1B,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAqC;IAChE,MAAM,YAAY,GAAG;QACnB,QAAQ,EAAE,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,EAAE,iBAAiB,CAAC;QAC1E,YAAY,EAAE,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC;QAC5D,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,MAAM;KACpC,CAAC;IAGF,OAAO;QACL,KAAK,EAAE,eAAe;QACtB,OAAO,EAAE;YACP;gBACE,GAAG,EAAE,UAA8B;gBACnC,KAAK,EAAE,UAAU;gBACjB,KAAK,EAAE,OAAO;aACf;YACD;gBACE,GAAG,EAAE,cAAkC;gBACvC,KAAK,EAAE,eAAe;gBACtB,KAAK,EAAE,OAAO;aACf;YACD;gBACE,GAAG,EAAE,QAA4B;gBACjC,KAAK,EAAE,QAAQ;gBACf,KAAK,EAAE,OAAO;aACf;SACF;QACD,IAAI,EAAE,CAAC,YAAY,CAAC;KACrB,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,OAAqC;IAC1D,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;SACjC,GAAG,CAAC,eAAe,CAAC;SACpB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,eAAe,CACtB,KAAgD;IAEhD,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG;QACvB,MAAM,EAAE;YACN,QAAQ,EAAE,cAAc,CACtB,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,EACxD,iBAAiB,CAClB;YACD,YAAY,EAAE,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;SACtD;QACD,GAAG,CAAC,KAAK,CAAC,QAAQ,IAAI;YACpB,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC;SAC7D,CAAC;KACH,CAAC;AACJ,CAAC"}

package/src/lib/runner/details/details.d.ts

@@ -3,7 +3,5 @@ import type Details from 'lighthouse/types/lhr/audit-details';
 import type { Result } from 'lighthouse/types/lhr/audit-result';
 import type { AuditDetails } from '@code-pushup/models';
 export declare function toAuditDetails<T extends FormattedIcu<Details>>(details: T | undefined): AuditDetails;
-export declare const unsupportedDetailTypes: Set<string>;
-export declare function logUnsupportedDetails(lhrAudits: Result[], { displayCount }?: {
-    displayCount?: number;
-}): void;
+export declare const unsupportedDetailTypes: Set<"debugdata" | "table" | "opportunity" | "list" | "criticalrequestchain" | "treemap-data" | "filmstrip" | "screenshot">;
+export declare function logUnsupportedDetails(lhrAudits: Result[]): void;

package/src/lib/runner/details/details.js

@@ -1,8 +1,10 @@
 import { bold, yellow } from 'ansis';
 import { ui } from '@code-pushup/utils';
 import { PLUGIN_SLUG } from '../constants.js';
+import { parseCriticalRequestChainToAuditDetails } from './critical-request-chain.type.js';
 import { parseOpportunityToAuditDetailsTable } from './opportunity.type.js';
 import { parseTableToAuditDetailsTable } from './table.type.js';
+import { parseTreemapDataToBasicTrees } from './treemap-data.type.js';
 export function toAuditDetails(details) {
     if (details == null) {
         return {};
@@ -15,26 +17,31 @@ export function toAuditDetails(details) {
         case 'opportunity':
             const opportunity = parseOpportunityToAuditDetailsTable(details);
             return opportunity ? { table: opportunity } : {};
+        case 'criticalrequestchain':
+            return parseCriticalRequestChainToAuditDetails(details);
+        case 'treemap-data':
+            const trees = parseTreemapDataToBasicTrees(details);
+            return { trees };
+        // TODO: add 'list' once array of tables supported in audit details
+        // TODO: add 'screenshot' and 'filmstrip' once images supported in audit details
     }
     return {};
 }
 // @TODO implement all details
 export const unsupportedDetailTypes = new Set([
+    'list',
     'debugdata',
-    'treemap-data',
     'screenshot',
     'filmstrip',
-    'criticalrequestchain',
 ]);
-export function logUnsupportedDetails(lhrAudits, { displayCount = 3 } = {}) {
+export function logUnsupportedDetails(lhrAudits) {
     const slugsWithDetailParsingErrors = [
         ...new Set(lhrAudits
-            .filter(({ details }) => unsupportedDetailTypes.has(details?.type))
+            .filter(({ details }) => details && unsupportedDetailTypes.has(details.type))
             .map(({ details }) => details?.type)),
     ];
     if (slugsWithDetailParsingErrors.length > 0) {
-        const postFix = (count) => count > displayCount ? ` and ${count - displayCount} more.` : '';
-        ui().logger.debug(`${yellow('⚠')} Plugin ${bold(PLUGIN_SLUG)} skipped parsing of unsupported audit details: ${bold(slugsWithDetailParsingErrors.slice(0, displayCount).join(', '))}${postFix(slugsWithDetailParsingErrors.length)}`);
+        ui().logger.debug(`${yellow('⚠')} Plugin ${bold(PLUGIN_SLUG)} skipped parsing of unsupported audit details: ${bold(slugsWithDetailParsingErrors.join(', '))}.`);
     }
 }
 //# sourceMappingURL=details.js.map

package/src/lib/runner/details/details.js.map

@@ -1 +1 @@
-{"version":3,"file":"details.js","sourceRoot":"","sources":["../../../../../../../packages/plugin-lighthouse/src/lib/runner/details/details.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAKrC,OAAO,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,mCAAmC,EAAE,MAAM,uBAAuB,CAAC;AAC5E,OAAO,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AAEhE,MAAM,UAAU,cAAc,CAC5B,OAAsB;IAEtB,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEzB,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,OAAO;YACV,MAAM,KAAK,GAAsB,6BAA6B,CAAC,OAAO,CAAC,CAAC;YACxE,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChC,KAAK,aAAa;YAChB,MAAM,WAAW,GACf,mCAAmC,CAAC,OAAO,CAAC,CAAC;YAC/C,OAAO,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACrD,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,8BAA8B;AAC9B,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC;IAC5C,WAAW;IACX,cAAc;IACd,YAAY;IACZ,WAAW;IACX,sBAAsB;CACvB,CAAC,CAAC;AAEH,MAAM,UAAU,qBAAqB,CACnC,SAAmB,EACnB,EAAE,YAAY,GAAG,CAAC,KAAgC,EAAE;IAEpD,MAAM,4BAA4B,GAAG;QACnC,GAAG,IAAI,GAAG,CACR,SAAS;aACN,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CACtB,sBAAsB,CAAC,GAAG,CAAC,OAAO,EAAE,IAAc,CAAC,CACpD;aACA,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CACvC;KACF,CAAC;IACF,IAAI,4BAA4B,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,EAAE,CAChC,KAAK,GAAG,YAAY,CAAC,CAAC,CAAC,QAAQ,KAAK,GAAG,YAAY,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CACf,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,CAC3B,WAAW,CACZ,kDAAkD,IAAI,CACrD,4BAA4B,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/D,GAAG,OAAO,CAAC,4BAA4B,CAAC,MAAM,CAAC,EAAE,CACnD,CAAC;IACJ,CAAC;AACH,CAAC"}
+{"version":3,"file":"details.js","sourceRoot":"","sources":["../../../../../../../packages/plugin-lighthouse/src/lib/runner/details/details.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAKrC,OAAO,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,uCAAuC,EAAE,MAAM,kCAAkC,CAAC;AAC3F,OAAO,EAAE,mCAAmC,EAAE,MAAM,uBAAuB,CAAC;AAC5E,OAAO,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AAEtE,MAAM,UAAU,cAAc,CAC5B,OAAsB;IAEtB,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEzB,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,OAAO;YACV,MAAM,KAAK,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAC;YACrD,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChC,KAAK,aAAa;YAChB,MAAM,WAAW,GAAG,mCAAmC,CAAC,OAAO,CAAC,CAAC;YACjE,OAAO,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,KAAK,sBAAsB;YACzB,OAAO,uCAAuC,CAAC,OAAO,CAAC,CAAC;QAC1D,KAAK,cAAc;YACjB,MAAM,KAAK,GAAG,4BAA4B,CAAC,OAAO,CAAC,CAAC;YACpD,OAAO,EAAE,KAAK,EAAE,CAAC;QAEnB,mEAAmE;QAEnE,gFAAgF;IAClF,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,8BAA8B;AAC9B,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAkB;IAC7D,MAAM;IACN,WAAW;IACX,YAAY;IACZ,WAAW;CACZ,CAAC,CAAC;AAEH,MAAM,UAAU,qBAAqB,CAAC,SAAmB;IACvD,MAAM,4BAA4B,GAAG;QACnC,GAAG,IAAI,GAAG,CACR,SAAS;aACN,MAAM,CACL,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,IAAI,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CACrE;aACA,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CACvC;KACF,CAAC;IACF,IAAI,4BAA4B,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5C,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CACf,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,CAC3B,WAAW,CACZ,kDAAkD,IAAI,CACrD,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,CACxC,GAAG,CACL,CAAC;IACJ,CAAC;AACH,CAAC"}

package/src/lib/runner/details/treemap-data.type.d.ts

@@ -0,0 +1,3 @@
+import type Details from 'lighthouse/types/lhr/audit-details';
+import type { BasicTree } from '@code-pushup/models';
+export declare function parseTreemapDataToBasicTrees(details: Details.TreemapData): BasicTree[];

package/src/lib/runner/details/treemap-data.type.js

@@ -0,0 +1,25 @@
+import { formatBytes } from '@code-pushup/utils';
+export function parseTreemapDataToBasicTrees(details) {
+    return details.nodes.map(node => ({
+        type: 'basic',
+        root: treemapNodeToBasicTreeNode(node),
+    }));
+}
+function treemapNodeToBasicTreeNode(node) {
+    return {
+        name: node.name,
+        values: {
+            resourceBytes: formatBytes(node.resourceBytes),
+            ...(node.unusedBytes != null && {
+                unusedBytes: formatBytes(node.unusedBytes),
+            }),
+            ...(node.duplicatedNormalizedModuleName && {
+                duplicatedNormalizedModuleName: node.duplicatedNormalizedModuleName,
+            }),
+        },
+        ...(node.children && {
+            children: node.children.map(treemapNodeToBasicTreeNode),
+        }),
+    };
+}
+//# sourceMappingURL=treemap-data.type.js.map

package/src/lib/runner/details/treemap-data.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"treemap-data.type.js","sourceRoot":"","sources":["../../../../../../../packages/plugin-lighthouse/src/lib/runner/details/treemap-data.type.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,UAAU,4BAA4B,CAC1C,OAA4B;IAE5B,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChC,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;KACvC,CAAC,CAAC,CAAC;AACN,CAAC;AAED,SAAS,0BAA0B,CAAC,IAAkB;IACpD,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,MAAM,EAAE;YACN,aAAa,EAAE,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC;YAC9C,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,IAAI;gBAC9B,WAAW,EAAE,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC;aAC3C,CAAC;YACF,GAAG,CAAC,IAAI,CAAC,8BAA8B,IAAI;gBACzC,8BAA8B,EAAE,IAAI,CAAC,8BAA8B;aACpE,CAAC;SACH;QACD,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI;YACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0BAA0B,CAAC;SACxD,CAAC;KACH,CAAC;AACJ,CAAC"}