Funzioni di libreria disponibili per gli script canary di Node.js utilizzando Playwright - Amazon CloudWatch

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Funzioni di libreria disponibili per gli script canary di Node.js utilizzando Playwright

Questa sezione descrive le funzioni di libreria disponibili per gli script Canary che utilizzano il runtime Node.js Playwright.

avvio

Questa funzione avvia un browser Chromium utilizzando una funzione di avvio Playwright e restituisce l'oggetto browser. Decomprime i file binari del browser e avvia il browser Chromium utilizzando le opzioni predefinite adatte per un browser headless. Per ulteriori informazioni sulla launch funzione, consultate la documentazione di Playwright. launch

Utilizzo

const browser = await synthetics.launch();

Arguments (Argomenti)

optionsoptions (opzionale) è un insieme di opzioni configurabili per il browser.

Valori restituiti

Promise <Browser> dove Browser è un'istanza del browser Playwright.

Se questa funzione viene richiamata nuovamente, un browser aperto in precedenza viene chiuso prima di avviare un nuovo browser. È possibile sovrascrivere i parametri di avvio utilizzati da CloudWatch Synthetics e passare parametri aggiuntivi all'avvio del browser. Ad esempio, il seguente frammento di codice avvia un browser con argomenti e un percorso eseguibile predefiniti, ma con un viewport di 800 x 600 pixel. Per ulteriori informazioni, consulta le opzioni di avvio di Playwright nella documentazione di Playwright.

const browser = await synthetics.launch({ defaultViewport: { "deviceScaleFactor": 1, "width": 800, "height": 600 }});

Puoi anche aggiungere o sostituire i flag Chromium trasmessi per impostazione predefinita al browser. Ad esempio, puoi disabilitare la sicurezza web aggiungendo un --disable-web-security flag agli argomenti nei parametri di avvio di CloudWatch Synthetics:

// This function adds the --disable-web-security flag to the launch parameters const defaultOptions = await synthetics.getDefaultLaunchOptions(); const launchArgs = [...defaultOptions.args, '--disable-web-security']; const browser = await synthetics.launch({ args: launchArgs });

Nuova pagina

La newPage() funzione crea e restituisce una nuova pagina Playwright. Synthetics configura automaticamente una connessione DevTools Chrome Protocol (CDP) per abilitare le acquisizioni di rete per la generazione di archivi HTTP (HAR).

Utilizzo

Utilizzalo newPage() in uno dei seguenti modi:

1. Creazione di una nuova pagina in un nuovo contesto del browser:

const page = await synthetics.newPage(browser);

2. Creazione di una nuova pagina in un contesto del browser specificato:

// Create a new browser context const browserContext = await browser.newContext(); // Create a new page in the specified browser context const page = await synthetics.newPage(browserContext)

Arguments (Argomenti)

Accetta l'istanza Playwright Browser o l'istanza BrowserContextPlaywright.

Valori restituiti

Promise dove Page è un'istanza di Playwright Page. <Page>

close

Chiude il browser attualmente aperto.

Utilizzo

await synthetics.close();

Si consiglia di chiudere il browser in un finally blocco dello script.

Arguments (Argomenti)

Nessuno

Valori restituiti

Restituisce Promise <void>utilizzata dalla funzione di avvio di Synthetics per avviare il browser.

getDefaultLaunchOpzioni

La getDefaultLaunchOptions() funzione restituisce le opzioni di avvio del browser utilizzate da CloudWatch Synthetics.

Utilizzo

const defaultOptions = await synthetics.getDefaultLaunchOptions();

Arguments (Argomenti)

Nessuno

Valori restituiti

Restituisce le opzioni di avvio di Playwright utilizzate dalla funzione Synthetics per avviare il launch browser.

executeStep

La executeStep funzione viene utilizzata per eseguire un passaggio in uno script Synthetics. In CloudWatch Synthetics, una fase di Synthetics è un modo per suddividere lo script canary in una serie di azioni chiaramente definite, che consentono di monitorare separatamente diverse parti del percorso applicativo. Per ogni passaggio, CloudWatch Synthetics esegue le seguenti operazioni:

  • Cattura automaticamente uno screenshot prima dell'inizio del passaggio e dopo il completamento di un passaggio. Puoi anche catturare schermate all'interno di un passaggio. Le schermate vengono acquisite per impostazione predefinita, ma possono essere disattivate utilizzando le configurazioni Synthetics. (Todo: Link)

  • Per ogni esecuzione di Canary viene creato un rapporto, che include un riepilogo, dei dettagli relativi all'esecuzione delle fasi, come la durata di una fase pass o fail lo stato URLs, la pagina di origine e di destinazione, le schermate associate, ecc. Quando scegli un'esecuzione nella console CloudWatch Synthetics, puoi visualizzare i dettagli di esecuzione di ogni passaggio nella scheda Step.

  • SuccessPercente le Duration CloudWatch metriche vengono emesse per ogni passaggio, consentendo agli utenti di monitorare la disponibilità e la latenza di ogni passaggio.

Utilizzo

await synthetics.executeStep("mystepname", async function () { await page.goto(url, { waitUntil: 'load', timeout: 30000 }); }
Nota

I passaggi devono essere eseguiti in sequenza. Assicurati di usarla solo se await promesse.

Arguments (Argomenti)

  • stepNamestring (required) (boolean) — Nome del passaggio Synthetics.

  • functionToExecutefunzione asincrona (obbligatoria) — La funzione che si desidera che Synthetics esegua. Questa funzione deve contenere la logica del passaggio.

  • stepConfigobject (opzionale): la configurazione del passaggio sovrascrive la configurazione globale di Synthetics per questo passaggio.

    • continueOnStepFailureboolean (opzionale) — Se continuare a eseguire lo script canary dopo questo passaggio non riesce.

    • screenshotOnStepStartboolean (opzionale) — Indica se fare uno screenshot all'inizio di questo passaggio.

    • screenshotOnStepSuccessboolean (opzionale) — Indica se fare uno screenshot se questo passaggio ha esito positivo.

    • screenshotOnStepFailureboolean (opzionale) — Indica se fare uno screenshot se questo passaggio fallisce.

  • page— oggetto della pagina Playwright (opzionale)

    Un oggetto di pagina Playwright. Synthetics utilizza questo oggetto pagina per acquisire schermate e. URLs Per impostazione predefinita, Synthetics utilizza la pagina Playwright creata quando viene chiamata synthetics.newPage() la funzione per acquisire dettagli della pagina come schermate e. URLs

Valori restituiti

Restituisce una Promise che si risolve con il valore restituito dalla funzione. functionToExecute Per uno script di esempio, consulta questa Codice di esempio per gli script canary guida.