Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Fonctions de bibliothèque disponibles pour les scripts Canary Node.js à l'aide de Playwright

Cette section décrit les fonctions de bibliothèque disponibles pour les scripts Canary à l'aide du moteur d'exécution Node.js Playwright.

lancer

Cette fonction lance un navigateur Chromium à l'aide d'une fonction de lancement Playwright et renvoie l'objet du navigateur. Il décompresse les fichiers binaires du navigateur et lance le navigateur Chromium en utilisant les options par défaut adaptées à un navigateur sans tête. Pour plus d'informations sur cette launch fonction, consultez launchla documentation du dramaturge.

Utilisation

const browser = await synthetics.launch();

Arguments

optionsoptions (facultatif) est un ensemble d'options configurables pour le navigateur.

Renvoie

Promise <Browser> où Browser est une instance du navigateur Playwright.

Si cette fonction est appelée à nouveau, le navigateur précédemment ouvert est fermé avant d'en lancer un nouveau. Vous pouvez remplacer les paramètres de lancement utilisés par CloudWatch Synthetics et transmettre des paramètres supplémentaires lors du lancement du navigateur. Par exemple, l'extrait de code suivant lance un navigateur avec des arguments par défaut et un chemin exécutable par défaut, mais avec une fenêtre d'affichage de 800 x 600 pixels. Pour plus d'informations, consultez les options de lancement de Playwright dans la documentation de Playwright.

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

Vous pouvez également ajouter ou remplacer les drapeaux Chromium transmis par défaut au navigateur. Par exemple, vous pouvez désactiver la sécurité Web en ajoutant un --disable-web-security indicateur aux arguments dans les paramètres de lancement de 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
  });

Nouvelle page

La newPage() fonction crée et renvoie une nouvelle page Playwright. Synthetics configure automatiquement une connexion au protocole DevTools Chrome (CDP) pour permettre les captures réseau pour la génération d'archives HTTP (HAR).

Utilisation

newPage()À utiliser de l'une des manières suivantes :

1. Création d'une nouvelle page dans un nouveau contexte de navigateur :

const page = await synthetics.newPage(browser);

2. Création d'une nouvelle page dans un contexte de navigateur spécifique :

// 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

Accepte l'instance Playwright Browser ou Playwright BrowserContext.

Renvoie

Promesse <Page>où Page est une instance de Playwright Page.

close

Ferme le navigateur actuellement ouvert.

Utilisation

await synthetics.close();

Il est recommandé de fermer le navigateur dans un finally bloc de votre script.

Arguments

Aucun

Renvoie

Renvoie la promesse <void>utilisée par la fonction de lancement de Synthetics pour lancer le navigateur.

getDefaultLaunchDes options

La getDefaultLaunchOptions() fonction renvoie les options de lancement du navigateur utilisées par CloudWatch Synthetics.

Utilisation

const defaultOptions = await synthetics.getDefaultLaunchOptions();

Arguments

Aucun

Renvoie

Renvoie les options de lancement de Playwright utilisées par la fonction launch Synthetics pour lancer le navigateur.

executeStep

La executeStep fonction est utilisée pour exécuter une étape dans un script Synthetics. Dans CloudWatch Synthetics, une étape Synthetics permet de décomposer votre script Canary en une série d'actions clairement définies, ce qui vous permet de suivre séparément les différentes étapes du parcours de votre application. Pour chaque étape, CloudWatch Synthetics effectue les opérations suivantes :

Utilisation

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

Arguments

Renvoie

Renvoie une promesse qui se résout avec la valeur renvoyée par la functionToExecute fonction. Pour un exemple de script, consultez Exemple de code pour les scripts Canary ce guide.