@code-pushup/lighthouse-plugin 0.55.0 → 0.57.0

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

@@ -1,8 +1,8 @@
 import type { Config } from 'lighthouse';
 import type { Result } from 'lighthouse/types/lhr/audit-result';
 import type { AuditOutputs } from '@code-pushup/models';
-import type { LighthouseOptions } from '../types';
-import type { LighthouseCliFlags } from './types';
+import type { LighthouseOptions } from '../types.js';
+import type { LighthouseCliFlags } from './types.js';
 export declare function normalizeAuditOutputs(auditOutputs: AuditOutputs, flags?: LighthouseOptions): AuditOutputs;
 export declare class LighthouseAuditParsingError extends Error {
     constructor(slug: string, error: Error);

package/src/lib/runner/utils.js

@@ -0,0 +1,98 @@
+import { bold } from 'ansis';
+import log from 'lighthouse-logger';
+import desktopConfig from 'lighthouse/core/config/desktop-config.js';
+import experimentalConfig from 'lighthouse/core/config/experimental-config.js';
+import perfConfig from 'lighthouse/core/config/perf-config.js';
+import { formatReportScore, importModule, readJsonFile, ui, } from '@code-pushup/utils';
+import { logUnsupportedDetails, toAuditDetails } from './details/details.js';
+export function normalizeAuditOutputs(auditOutputs, flags = { skipAudits: [] }) {
+    const toSkip = new Set(flags.skipAudits ?? []);
+    return auditOutputs.filter(({ slug }) => !toSkip.has(slug));
+}
+export class LighthouseAuditParsingError extends Error {
+    constructor(slug, error) {
+        super(`\nAudit ${bold(slug)} failed parsing details: \n${error.message}`);
+    }
+}
+function formatBaseAuditOutput(lhrAudit) {
+    const { id: slug, score, numericValue, displayValue, scoreDisplayMode, } = lhrAudit;
+    return {
+        slug,
+        score: score ?? 1,
+        value: numericValue ?? score ?? 0,
+        displayValue: displayValue ??
+            (scoreDisplayMode === 'binary'
+                ? score === 1
+                    ? 'passed'
+                    : 'failed'
+                : score
+                    ? `${formatReportScore(score)}%`
+                    : undefined),
+    };
+}
+function processAuditDetails(auditOutput, details) {
+    try {
+        const parsedDetails = toAuditDetails(details);
+        return Object.keys(parsedDetails).length > 0
+            ? { ...auditOutput, details: parsedDetails }
+            : auditOutput;
+    }
+    catch (error) {
+        throw new LighthouseAuditParsingError(auditOutput.slug, error);
+    }
+}
+export function toAuditOutputs(lhrAudits, { verbose = false } = {}) {
+    if (verbose) {
+        logUnsupportedDetails(lhrAudits);
+    }
+    return lhrAudits.map(audit => {
+        const auditOutput = formatBaseAuditOutput(audit);
+        return audit.details == null
+            ? auditOutput
+            : processAuditDetails(auditOutput, audit.details);
+    });
+}
+export function determineAndSetLogLevel({ verbose, quiet, } = {}) {
+    // eslint-disable-next-line functional/no-let
+    let logLevel = 'info';
+    // set logging preferences
+    if (verbose) {
+        logLevel = 'verbose';
+    }
+    else if (quiet) {
+        logLevel = 'silent';
+    }
+    log.setLevel(logLevel);
+    return logLevel;
+}
+export async function getConfig(options = {}) {
+    const { configPath: filepath, preset } = options;
+    if (filepath != null) {
+        if (filepath.endsWith('.json')) {
+            // Resolve the config file path relative to where cli was called.
+            return readJsonFile(filepath);
+        }
+        else if (/\.(ts|js|mjs)$/.test(filepath)) {
+            return importModule({ filepath, format: 'esm' });
+        }
+        else {
+            ui().logger.info(`Format of file ${filepath} not supported`);
+        }
+    }
+    else if (preset != null) {
+        switch (preset) {
+            case 'desktop':
+                return desktopConfig;
+            case 'perf':
+                return perfConfig;
+            case 'experimental':
+                return experimentalConfig;
+            default:
+                // as preset is a string literal the default case here is normally caught by TS and not possible to happen. Now in reality it can happen and preset could be a string not included in the literal.
+                // Therefore, we have to use `as string`. Otherwise, it will consider preset as type never
+                ui().logger.info(`Preset "${preset}" is not supported`);
+        }
+    }
+    return undefined;
+}
+//# sourceMappingURL=utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../packages/plugin-lighthouse/src/lib/runner/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAE7B,OAAO,GAAG,MAAM,mBAAmB,CAAC;AACpC,OAAO,aAAa,MAAM,0CAA0C,CAAC;AACrE,OAAO,kBAAkB,MAAM,+CAA+C,CAAC;AAC/E,OAAO,UAAU,MAAM,uCAAuC,CAAC;AAI/D,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,EAAE,GACH,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAG7E,MAAM,UAAU,qBAAqB,CACnC,YAA0B,EAC1B,QAA2B,EAAE,UAAU,EAAE,EAAE,EAAE;IAE7C,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;IAC/C,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,OAAO,2BAA4B,SAAQ,KAAK;IACpD,YAAY,IAAY,EAAE,KAAY;QACpC,KAAK,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,8BAA8B,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF;AAED,SAAS,qBAAqB,CAAC,QAAgB;IAC7C,MAAM,EACJ,EAAE,EAAE,IAAI,EACR,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,gBAAgB,GACjB,GAAG,QAAQ,CAAC;IACb,OAAO;QACL,IAAI;QACJ,KAAK,EAAE,KAAK,IAAI,CAAC;QACjB,KAAK,EAAE,YAAY,IAAI,KAAK,IAAI,CAAC;QACjC,YAAY,EACV,YAAY;YACZ,CAAC,gBAAgB,KAAK,QAAQ;gBAC5B,CAAC,CAAC,KAAK,KAAK,CAAC;oBACX,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,QAAQ;gBACZ,CAAC,CAAC,KAAK;oBACL,CAAC,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,GAAG;oBAChC,CAAC,CAAC,SAAS,CAAC;KACnB,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAC1B,WAAwB,EACxB,OAA8B;IAE9B,IAAI,CAAC;QACH,MAAM,aAAa,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QAC9C,OAAO,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC;YAC1C,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,OAAO,EAAE,aAAa,EAAE;YAC5C,CAAC,CAAC,WAAW,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,2BAA2B,CAAC,WAAW,CAAC,IAAI,EAAE,KAAc,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,SAAmB,EACnB,EAAE,OAAO,GAAG,KAAK,KAA4B,EAAE;IAE/C,IAAI,OAAO,EAAE,CAAC;QACZ,qBAAqB,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC3B,MAAM,WAAW,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAEjD,OAAO,KAAK,CAAC,OAAO,IAAI,IAAI;YAC1B,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,mBAAmB,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC;AASD,MAAM,UAAU,uBAAuB,CAAC,EACtC,OAAO,EACP,KAAK,MAIH,EAAE;IACJ,6CAA6C;IAC7C,IAAI,QAAQ,GAAuB,MAAM,CAAC;IAC1C,0BAA0B;IAC1B,IAAI,OAAO,EAAE,CAAC;QACZ,QAAQ,GAAG,SAAS,CAAC;IACvB,CAAC;SAAM,IAAI,KAAK,EAAE,CAAC;QACjB,QAAQ,GAAG,QAAQ,CAAC;IACtB,CAAC;IAED,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEvB,OAAO,QAAQ,CAAC;AAClB,CAAC;AAMD,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,UAAyB,EAAE;IAE3B,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAEjD,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,iEAAiE;YACjE,OAAO,YAAY,CAAS,QAAQ,CAAC,CAAC;QACxC,CAAC;aAAM,IAAI,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3C,OAAO,YAAY,CAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,QAAQ,gBAAgB,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;SAAM,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QAC1B,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,SAAS;gBACZ,OAAO,aAAa,CAAC;YACvB,KAAK,MAAM;gBACT,OAAO,UAAoB,CAAC;YAC9B,KAAK,cAAc;gBACjB,OAAO,kBAA4B,CAAC;YACtC;gBACE,kMAAkM;gBAClM,0FAA0F;gBAC1F,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,MAAgB,oBAAoB,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/src/lib/types.d.ts

@@ -1,6 +1,6 @@
 import type { CliFlags } from 'lighthouse';
-import type { ExcludeNullFromPropertyTypes } from '@code-pushup/utils';
-export type LighthouseOptions = ExcludeNullFromPropertyTypes<Partial<Omit<CliFlags, '_' | 'precomputedLanternDataPath' | 'enableErrorReporting' | 'list-all-audits' | 'list-locales' | 'list-trace-categories' | 'chromeIgnoreDefaultFlags' | 'onlyCategories' | 'onlyAudits' | 'skipAudits'>>> & {
+import type { ExcludeNullableProps } from '@code-pushup/utils';
+export type LighthouseOptions = ExcludeNullableProps<Partial<Omit<CliFlags, '_' | 'precomputedLanternDataPath' | 'enableErrorReporting' | 'list-all-audits' | 'list-locales' | 'list-trace-categories' | 'chromeIgnoreDefaultFlags' | 'onlyCategories' | 'onlyAudits' | 'skipAudits'>>> & {
     onlyGroups?: string | string[];
     onlyAudits?: string | string[];
     skipAudits?: string | string[];

package/src/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/src/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/plugin-lighthouse/src/lib/types.ts"],"names":[],"mappings":""}

package/src/lib/utils.d.ts

@@ -1,5 +1,5 @@
 import type { Audit, CategoryRef, Group } from '@code-pushup/models';
-import type { LighthouseCliFlags } from './runner';
+import type { LighthouseCliFlags } from './runner/types.js';
 export type LighthouseGroupSlugs = 'performance' | 'accessibility' | 'best-practices' | 'seo' | 'pwa';
 export declare function lighthouseGroupRef(groupSlug: LighthouseGroupSlugs, weight?: number): CategoryRef;
 export declare function lighthouseAuditRef(auditSlug: string, weight?: number): CategoryRef;

package/src/lib/utils.js

@@ -0,0 +1,77 @@
+import { filterItemRefsBy, toArray } from '@code-pushup/utils';
+import { LIGHTHOUSE_PLUGIN_SLUG } from './constants.js';
+export function lighthouseGroupRef(groupSlug, weight = 1) {
+    return {
+        plugin: LIGHTHOUSE_PLUGIN_SLUG,
+        slug: groupSlug,
+        type: 'group',
+        weight,
+    };
+}
+export function lighthouseAuditRef(auditSlug, weight = 1) {
+    return {
+        plugin: LIGHTHOUSE_PLUGIN_SLUG,
+        slug: auditSlug,
+        type: 'audit',
+        weight,
+    };
+}
+export class AuditsNotImplementedError extends Error {
+    constructor(auditSlugs) {
+        super(`audits: "${auditSlugs.join(', ')}" not implemented`);
+    }
+}
+export function validateAudits(audits, onlyAudits) {
+    const missingAudtis = toArray(onlyAudits).filter(slug => !audits.some(audit => audit.slug === slug));
+    if (missingAudtis.length > 0) {
+        throw new AuditsNotImplementedError(missingAudtis);
+    }
+    return true;
+}
+export class CategoriesNotImplementedError extends Error {
+    constructor(categorySlugs) {
+        super(`categories: "${categorySlugs.join(', ')}" not implemented`);
+    }
+}
+export function validateOnlyCategories(groups, onlyCategories) {
+    const missingCategories = toArray(onlyCategories).filter(slug => groups.every(group => group.slug !== slug));
+    if (missingCategories.length > 0) {
+        throw new CategoriesNotImplementedError(missingCategories);
+    }
+    return true;
+}
+export function filterAuditsAndGroupsByOnlyOptions(audits, groups, options) {
+    const { onlyAudits = [], skipAudits = [], onlyCategories = [], } = options ?? {};
+    // category wins over audits
+    if (onlyCategories.length > 0) {
+        validateOnlyCategories(groups, onlyCategories);
+        const categorySlugs = new Set(onlyCategories);
+        const filteredGroups = groups.filter(({ slug }) => categorySlugs.has(slug));
+        const auditSlugsFromRemainingGroups = new Set(filteredGroups.flatMap(({ refs }) => refs.map(({ slug }) => slug)));
+        return {
+            audits: audits.filter(({ slug }) => auditSlugsFromRemainingGroups.has(slug)),
+            groups: filteredGroups,
+        };
+    }
+    else if (onlyAudits.length > 0 || skipAudits.length > 0) {
+        validateAudits(audits, onlyAudits);
+        validateAudits(audits, skipAudits);
+        const onlyAuditSlugs = new Set(onlyAudits);
+        const skipAuditSlugs = new Set(skipAudits);
+        const filterAudits = ({ slug }) => !(
+        // audit is NOT in given onlyAuditSlugs
+        ((onlyAudits.length > 0 && !onlyAuditSlugs.has(slug)) ||
+            // audit IS in given skipAuditSlugs
+            (skipAudits.length > 0 && skipAuditSlugs.has(slug))));
+        return {
+            audits: audits.filter(filterAudits),
+            groups: filterItemRefsBy(groups, filterAudits),
+        };
+    }
+    // return unchanged
+    return {
+        audits,
+        groups,
+    };
+}
+//# sourceMappingURL=utils.js.map

package/src/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../packages/plugin-lighthouse/src/lib/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAUxD,MAAM,UAAU,kBAAkB,CAChC,SAA+B,EAC/B,MAAM,GAAG,CAAC;IAEV,OAAO;QACL,MAAM,EAAE,sBAAsB;QAC9B,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,OAAO;QACb,MAAM;KACP,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,SAAiB,EAAE,MAAM,GAAG,CAAC;IAC9D,OAAO;QACL,MAAM,EAAE,sBAAsB;QAC9B,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,OAAO;QACb,MAAM;KACP,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IAClD,YAAY,UAAoB;QAC9B,KAAK,CAAC,YAAY,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,UAAU,cAAc,CAAC,MAAe,EAAE,UAAoB;IAClE,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAC9C,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CACnD,CAAC;IACF,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,yBAAyB,CAAC,aAAa,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,OAAO,6BAA8B,SAAQ,KAAK;IACtD,YAAY,aAAuB;QACjC,KAAK,CAAC,gBAAgB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACrE,CAAC;CACF;AAED,MAAM,UAAU,sBAAsB,CACpC,MAAe,EACf,cAAiC;IAEjC,MAAM,iBAAiB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAC9D,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAC3C,CAAC;IACF,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,6BAA6B,CAAC,iBAAiB,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAMD,MAAM,UAAU,kCAAkC,CAChD,MAAe,EACf,MAAe,EACf,OAAuB;IAKvB,MAAM,EACJ,UAAU,GAAG,EAAE,EACf,UAAU,GAAG,EAAE,EACf,cAAc,GAAG,EAAE,GACpB,GAAG,OAAO,IAAI,EAAE,CAAC;IAElB,4BAA4B;IAC5B,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,sBAAsB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAE/C,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAY,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CACzD,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CACxB,CAAC;QACF,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAC3C,cAAc,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CACnE,CAAC;QACF,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CACjC,6BAA6B,CAAC,GAAG,CAAC,IAAI,CAAC,CACxC;YACD,MAAM,EAAE,cAAc;SACvB,CAAC;IACJ,CAAC;SAAM,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1D,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACnC,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACnC,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,YAAY,GAAG,CAAC,EAAE,IAAI,EAAuB,EAAE,EAAE,CACrD,CAAC;QACC,uCAAuC;QACvC,CACE,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACpD,mCAAmC;YACnC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CACpD,CACF,CAAC;QACJ,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;YACnC,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,YAAY,CAAC;SAC/C,CAAC;IACJ,CAAC;IACD,mBAAmB;IACnB,OAAO;QACL,MAAM;QACN,MAAM;KACP,CAAC;AACJ,CAAC"}