Fluxos de usuários do Lighthouse

Teste a nova API Lighthouse para medir a performance e as práticas recomendadas em todo o fluxo do usuário.

Brendan Kenny

O Lighthouse é uma ferramenta fantástica para testar o desempenho e as práticas recomendadas durante o carregamento inicial da página. No entanto, é tradicionalmente difícil usar o Lighthouse para analisar outros aspectos da vida útil de uma página, como:

• A página é carregada com um cache quente
• Páginas com um service worker ativado
• Contabilização de possíveis interações do usuário

Isso significa que o Lighthouse pode perder informações vitais. As Core Web Vitals se baseiam em todos os carregamentos de página, não apenas naqueles com cache vazio. Além disso, métricas como Cumulative Layout Shift (CLS) são mensuráveis durante todo o tempo em que a página fica aberta.

O Lighthouse tem uma nova API de fluxo do usuário que permite realizar testes de laboratório a qualquer momento durante a vida útil de uma página. O Puppeteer é usado para criar scripts de carregamentos de páginas e acionar interações sintéticas do usuário, e o Lighthouse pode ser invocado de várias maneiras para capturar insights importantes durante essas interações. Isso significa que o desempenho pode ser medido durante o carregamento da página e durante as interações com a página. As verificações de acessibilidade podem ser feitas na CI, não apenas na visualização inicial, mas também no fluxo de finalização da compra para garantir que nada regresse.

Quase todos os scripts do Puppeteer escritos para garantir que um fluxo de usuário funcional agora podem ter o Lighthouse inserido em qualquer ponto para medir o desempenho e as práticas recomendadas. Este tutorial aborda os novos modos do Lighthouse, que podem medir diferentes partes dos fluxos de usuários: navegações, resumos e períodos.

Configuração

As APIs de fluxo do usuário ainda estão em visualização, mas estão disponíveis no Lighthouse. Para testar as demonstrações abaixo, você precisará da versão 14 ou posterior do Node. Crie um diretório vazio e execute nele:

# Default to ES modules.
echo '{"type": "module"}' > package.json

# Init npm project without the wizard.
npm init -y

# Dependencies for these examples.
npm install lighthouse puppeteer open

Navegações

A nova "navegação" do Lighthouse na verdade, nomeia o comportamento padrão do Lighthouse (até agora): analisar o carregamento a frio de uma página. Esse é o modo usado para monitorar o desempenho do carregamento de página, mas os fluxos de usuários também abrem a possibilidade de novos insights.

Para criar um script do Lighthouse para capturar um carregamento de página:

1. Use o puppeteer para abrir o navegador.
2. Inicie um fluxo de usuário do Lighthouse.
3. Acesse o URL de destino.

import fs from 'fs';
import open from 'open';
import puppeteer from 'puppeteer';
import {startFlow} from 'lighthouse/lighthouse-core/fraggle-rock/api.js';

async function captureReport() {
  const browser = await puppeteer.launch({headless: false});
  const page = await browser.newPage();

  const flow = await startFlow(page, {name: 'Single Navigation'});
  await flow.navigate('https://web.dev/performance-scoring/');

  await browser.close();

  const report = await flow.generateReport();
  fs.writeFileSync('flow.report.html', report);
  open('flow.report.html', {wait: false});
}

captureReport();

Esse é o fluxo mais simples. Quando aberto, o relatório mostra uma visualização resumida com apenas uma etapa. Ao clicar nessa etapa, um relatório do Lighthouse tradicional para a navegação será exibido.

Como é comum com o Lighthouse, essa página é carregada com qualquer cache ou armazenamento local limpo primeiro, mas os usuários reais que acessarem um site terão uma mistura de visitas com caches frios e mornos, e pode haver uma grande diferença de desempenho entre um carregamento a frio como este e um usuário que retorna à página com um cache ainda morno.

Como capturar uma carga quente

Você também pode adicionar uma segunda navegação a esse script, desta vez desativando a limpeza do cache e do armazenamento que o Lighthouse faz por padrão nas navegações. O próximo exemplo carrega um artigo no próprio web.dev para ver os benefícios do armazenamento em cache:

async function captureReport() {
  const browser = await puppeteer.launch({headless: false});
  const page = await browser.newPage();

  const testUrl = 'https://web.dev/performance-scoring/';
  const flow = await startFlow(page, {name: 'Cold and warm navigations'});
  await flow.navigate(testUrl, {
    stepName: 'Cold navigation'
  });
  await flow.navigate(testUrl, {
    stepName: 'Warm navigation',
    configContext: {
      settingsOverrides: {disableStorageReset: true},
    },
  });

  await browser.close();

  const report = await flow.generateReport();
  fs.writeFileSync('flow.report.html', report);
  open('flow.report.html', {wait: false});
}

captureReport();

O relatório de fluxo resultante será parecido com este:

A combinação de cargas a frio e morna oferece uma imagem mais completa do que os usuários reais estão tendo. Se você tem um site em que os usuários carregam muitas páginas na mesma visita, isso pode fornecer uma visão mais realista do que eles estão experimentando no campo.

Snapshots

Os snapshots são um novo modo que executa auditorias do Lighthouse em um único momento. Ao contrário de uma execução normal do Lighthouse, a página não é recarregada. Isso desbloqueia a capacidade de configurar uma página e testá-la em seu estado exato: com um menu suspenso aberto ou um formulário parcialmente preenchido, por exemplo.

Neste exemplo, suponha que você queira conferir se uma nova interface para "Configurações avançadas" no Squoosh foi aprovada nas verificações automáticas do Lighthouse. Essas configurações só ficam visíveis se uma imagem tiver sido carregada e o menu de opções for aberto para mostrar as configurações avançadas.

Esse processo pode ser programado com o Puppeteer, e é possível capturar um snapshot do Lighthouse em cada etapa:

async function captureReport() {
  const browser = await puppeteer.launch({headless: false});
  const page = await browser.newPage();

  const flow = await startFlow(page, {name: 'Squoosh snapshots'});

  await page.goto('https://squoosh.app/', {waitUntil: 'networkidle0'});

  // Wait for first demo-image button, then open it.
  const demoImageSelector = 'ul[class*="demos"] button';
  await page.waitForSelector(demoImageSelector);
  await flow.snapshot({stepName: 'Page loaded'});
  await page.click(demoImageSelector);

  // Wait for advanced settings button in UI, then open them.
  const advancedSettingsSelector = 'form label[class*="option-reveal"]';
  await page.waitForSelector(advancedSettingsSelector);
  await flow.snapshot({stepName: 'Demo loaded'});
  await page.click(advancedSettingsSelector);

  await flow.snapshot({stepName: 'Advanced settings opened'});

  browser.close();

  const report = await flow.generateReport();
  fs.writeFileSync('flow.report.html', report);
  open('flow.report.html', {wait: false});
}

captureReport();

O relatório resultante mostra que os resultados em geral são bons, mas pode haver alguns critérios de acessibilidade que precisem ser verificados manualmente:

Períodos

Uma das maiores diferenças entre os resultados de desempenho em campo (como no CrUX) e no laboratório (como no Lighthouse) é a falta de entradas do usuário. É aqui que um período, o último modo de fluxo do usuário, pode ajudar.

Um período realiza as auditorias do Lighthouse durante um período, que pode ou não incluir uma navegação. Essa é uma ótima maneira de capturar o que está acontecendo com uma página durante as interações. Por exemplo, o Lighthouse mede a CLS durante o carregamento da página por padrão, mas, no campo, ela é medida desde a navegação inicial até a página ser fechada. Se as interações do usuário forem o gatilho da CLS, isso é algo que o Lighthouse anteriormente não poderia detectar e ajudar a corrigir.

Para demonstrar isso, veja um site de teste que simula a injeção de anúncios em um artigo durante a rolagem sem que tenha sido reservado espaço. Em uma longa série de cartões, um quadrado vermelho ocasional é adicionado quando seu slot entra na janela de visualização. Como o espaço não foi reservado para esses quadrados vermelhos, os cards abaixo deles são deslocados, causando mudanças de layout.

Uma navegação normal do Lighthouse terá um CLS de 0. No entanto, após a rolagem, a página terá mudanças de layout problemáticas e o valor da CLS aumentará.

O script a seguir produzirá um Relatório de fluxo do usuário com as duas ações para mostrar a diferença.

async function captureReport() {
  const browser = await puppeteer.launch({headless: false});
  const page = await browser.newPage();
  // Get a session handle to be able to send protocol commands to the page.
  const session = await page.target().createCDPSession();

  const testUrl = 'https://pie-charmed-treatment.glitch.me/';
  const flow = await startFlow(page, {name: 'CLS during navigation and on scroll'});

  // Regular Lighthouse navigation.
  await flow.navigate(testUrl, {stepName: 'Navigate only'});

  // Navigate and scroll timespan.
  await flow.startTimespan({stepName: 'Navigate and scroll'});
  await page.goto(testUrl, {waitUntil: 'networkidle0'});
  // We need the ability to scroll like a user. There's not a direct puppeteer function for this, but we can use the DevTools Protocol and issue a Input.synthesizeScrollGesture event, which has convenient parameters like repetitions and delay to somewhat simulate a more natural scrolling gesture.
  // https://chromedevtools.github.io/devtools-protocol/tot/Input/#method-synthesizeScrollGesture
  await session.send('Input.synthesizeScrollGesture', {
    x: 100,
    y: 600,
    yDistance: -2500,
    speed: 1000,
    repeatCount: 2,
    repeatDelayMs: 250,
  });
  await flow.endTimespan();

  await browser.close();

  const report = await flow.generateReport();
  fs.writeFileSync('flow.report.html', report);
  open('flow.report.html', {wait: false});
}

captureReport();

Isso gera um relatório comparando uma navegação normal com um período que contém uma navegação e uma rolagem posteriores:

Avaliando cada etapa, a etapa somente navegação mostra um CLS de 0. Ótimo site!

No entanto, a opção "Navegar e rolar" conta uma história diferente. Atualmente, apenas o tempo total de bloqueio e a Cumulative Layout Shift estão disponíveis para períodos, mas o conteúdo de carregamento lento nesta página claramente compensa o CLS do site.

Antes, o Lighthouse não era capaz de identificar esse comportamento problemático de CLS, embora quase certamente isso aparecesse na experiência de usuários reais. O teste de desempenho em interações com script melhora significativamente a fidelidade do laboratório.

Preciso de feedback

As novas APIs de fluxo de usuário do Lighthouse podem fazer muitas coisas novas, mas ainda pode ser complicado medir os tipos de cenários que seus usuários encontram.

Entre em contato com qualquer dúvida nos fóruns de discussão do Lighthouse e registre bugs ou sugestões no Issue Tracker.