Guide de migration Lighthouse v3

Ce guide s'adresse aux utilisateurs de Lighthouse v2 qui:

• Exécutez Lighthouse à partir de Node ou de la ligne de commande.
• Utilisez la sortie JSON de Lighthouse.

Si ce n'est pas le cas, votre workflow pour exécuter Lighthouse est à peu près le même. Pour en savoir plus sur les nouvelles fonctionnalités et les modifications, consultez Annonce de Lighthouse 3.0.

Modifications apportées aux invocations

Lighthouse calcule désormais les performances simulées par défaut, et les paramètres de limitation ont été fortement modifiés.

Options de la CLI

Scénario	Options v2	Options v3
Limitation 3G des outils de développement	Aucune (comportement par défaut)	--throttling-method=devtools
Aucune limitation	--disable-network-throttling --disable-cpu-throttling	--throttling-method=provided
Limitation de bande passante réseau, pas de limitation du processeur	--disable-cpu-throttling	--throttling-method=devtools --throttling.cpuSlowdownMultiplier=1
Effectuer des audits de performances	--perf	--preset=perf
Effectuer des audits de contenu mixte	--mixed-content	--preset=mixed-content

Module de nœud

Dans Lighthouse v3, le module Node accepte les mêmes options de configuration que la CLI. Il s'agit d'un changement majeur dans le sens où de nombreuses options étaient ignorées dans la version 2, alors qu'elles affecteront désormais le fonctionnement de Lighthouse.

const fs = require('fs');
const lighthouse = require('lighthouse');
async function run() {
  // `onlyCategories` was previously only available as a config setting.
  // `output` was previously only available in CLI.
  const flags = {onlyCategories: ['performance'], output: 'html'};
  const html = (await lighthouse('https://google.com/', flags)).report;
  fs.writeFileSync('report.html', html);
}

Modifications de la sortie

Nouveau format de niveau supérieur dans la sortie JSON

L'objet JSON renvoyé par Lighthouse v3 contient désormais trois propriétés de niveau supérieur:

• lhr : résultats des audits. Abréviation de "Résultats Lighthouse". Il s'agissait essentiellement de l'objet de niveau supérieur dans la version 2, mais la version 3 introduit également des modifications destructives de la forme de cet objet. Consultez la section Modifications apportées à l'objet "results".
• artifacts : données collectées dans Chrome lors de l'audit. Cette information était auparavant mélangée aux propriétés de la LHR.
• report : rapport HTML/JSON/CSV au format chaîne.

Modifications apportées à l'objet "results"

Comme indiqué dans la section Nouveau format de premier niveau dans la sortie JSON, les résultats des audits ne sont plus disponibles via la propriété lhr. Dans la version 2, le contenu de cet objet était essentiellement la sortie JSON de premier niveau. Cependant, la forme de cet objet a changé dans la version 3. Le tableau ci-dessous liste toutes les modifications.

• Si une ligne contient une valeur dans les colonnes v2 et v3, cela signifie que vous devez remplacer toute référence à la propriété v2 dans votre code par l'équivalent v3.
• Lorsqu'une ligne ne comporte aucune valeur dans la colonne v3, la colonne Notes décrit les options disponibles.
• Notez que des éléments tels que ID représentent du texte d'espace réservé.

Propriété v2	Équivalent v3	Remarques
initialUrl	requestedUrl
url	finalUrl
generatedTime	fetchedTime
reportCategories	categories	Le tableau a été remplacé par un objet à clé.
reportGroups	categoryGroups
audits.ID.name	audits.ID.id
audits.ID.description	audits.ID.title
audits.ID.helpText	audits.ID.description
audits.ID.scoringMode	audits.ID.scoreDisplayMode	Les valeurs possibles ont été étendues à numeric|binary|manual|informative|not-applicable|error.
audits.ID.score	audits.ID.score	Les scores sont toujours des nombres compris entre 0 et 1 (et non entre 0 et 100) lorsque scoreDisplayMode est numérique ou binaire. Les scores sont toujours null pour les autres modes d'affichage, car il n'y a pas de notion de réussite/échec.
audits.ID.displayValue	audits.ID.displayValue	Peut désormais être un tableau d'arguments de style printf pour l'interpolation de chaînes.
audits.ID.debugString	audits.ID.explanation audits.ID.errorMessage audits.ID.warnings	Les valeurs debugString ont été converties en l'une des trois propriétés ci-dessus en fonction de leur intention.
audits.ID.details	audits.ID.details	La structure des détails a été modifiée pour être plus facile à utiliser. Chaque entrée de .items est un objet avec des clés fiables au lieu de any[].
audits.ID.error	audits.ID.scoreDisplayMode === 'error'
audits.ID.notApplicable	audits.ID.scoreDisplayMode === 'not-applicable'
audits.ID.informative	audits.ID.scoreDisplayMode === 'informative'
audits.ID.manual	audits.ID.scoreDisplayMode === 'manual'
audits.ID.extendedInfo		Supprimé. Utilisez details à la place.