Syntheticモニタリングのベストプラクティスガイド

/**
 * Script Name: Best Practices - Chrome 100
 * Author: New Relic
 * Version: 1.3
 * Purpose: best practices example
 * Reference: https://docs.newrelic.com/docs/synthetics/synthetic-monitoring/scripting-monitors/synthetic-scripted-browser-reference-monitor-versions-chrome-100/
 */

// -------------------- CONSTANTS
const SCRIPT_NAME = "Best Practices - Chrome 100" // name to record in script log
const IMPLICIT_TIMEOUT = 3000                     // default implicit timeout is 10 seconds
                                                  // 4 seconds x 14 findElement operations = 42 seconds
                                                  // assuming all operations time out
const PAGE_LOAD_TIMEOUT = 60000                   // default page load timeout is 60 seconds
                                                  // fail early to prevent long duration timeouts
const SCRIPT_TIMEOUT = 20000                      // default script timeout is 30 seconds
const USER_AGENT = "default"                      // set the user agent for Chrome
const PROTOCOL = "https://"                       // set the protocol
const USERNAME = ""                               // username:
const PASSWORD = ""                               // password@
const DOMAIN = "newrelic.com"                     // your domain
const PATH = ""                                   // path to main page
const CHECK = "Why New Relic?"                    // text to match on page
const AUTH = USERNAME + PASSWORD
const MAIN_URL = PROTOCOL + AUTH + DOMAIN + PATH

// -------------------- DEPENDENCIES
var assert = require("assert")

// -------------------- CONFIGURATION
await $webDriver.manage().setTimeouts({
  implicit: IMPLICIT_TIMEOUT,  // sets element load timeout
  pageLoad: PAGE_LOAD_TIMEOUT, // sets page load timeout
  script: SCRIPT_TIMEOUT       // sets script timeout
})

// -------------------- VARIABLES
var By = $selenium.By
var loc = {
  main: By.id("main-content"),
  nav: By.className("js-header-site-nav"),
  why: By.xpath("/html/body/div[2]/main/article/div[7]/div[1]/div[2]/div[1]/div/div/div/h2"),
  platform: By.css("#header-main > nav > ul > li:nth-child(1)"),
  p: [
    { service: 'apm',     selector: By.xpath("//*[@id='header-main']/nav/ul/li[1]/div/div/div/div/div[2]/div/ul/li[1]/a/div") },
    { service: 'k8s',     selector: By.xpath("//*[@id='header-main']/nav/ul/li[1]/div/div/div/div/div[2]/div/ul/li[2]/a/div") },
    { service: 'infra',   selector: By.xpath("//*[@id='header-main']/nav/ul/li[1]/div/div/div/div/div[3]/div/ul/li[1]/a/small") },
    { service: 'logs',    selector: By.xpath("//*[@id='header-main']/nav/ul/li[1]/div/div/div/div/div[3]/div/ul/li[2]/a/div") },
    { service: 'network', selector: By.xpath("//*[@id='header-main']/nav/ul/li[1]/div/div/div/div/div[4]/div/ul/li[1]/a/small") },
    { service: 'browser', selector: By.xpath("//*[@id='header-main']/nav/ul/li[1]/div/div/div/div/div[4]/div/ul/li[2]/a/small") }
  ]
}

// -------------------- FUNCTIONS
// for backwards compatibility with legacy runtimes
async function waitForAndFindElement(locator, timeout) {
  const element = await $webDriver.wait(
    $selenium.until.elementLocated(locator),
    timeout,
    "Timed-out waiting for element to be located using: " + locator
  )
  await $webDriver.wait(
    $selenium.until.elementIsVisible(element),
    timeout,
    "Timed-out waiting for element to be visible using ${element}"
  )
  return await $webDriver.findElement(locator)
}

// -------------------- START OF SCRIPT
console.log("Starting synthetics script: " + SCRIPT_NAME)

// confirm timeouts are set
const {implicit, pageLoad, script} = await $webDriver.manage().getTimeouts()
console.log("Timeouts are set to:")
console.log("  IMPLICIT: " + implicit / 1000 + "s")
console.log("  PAGE LOAD: " + pageLoad / 1000 + "s")
console.log("  SCRIPT: " + script / 1000 + "s")

// Setting User Agent is not then-able, so we do this first (if defined and not default)
if (USER_AGENT && 0 !== USER_AGENT.trim().length && USER_AGENT != "default") {
  $headers.add("User-Agent", USER_AGENT)
  console.log("Setting User-Agent to " + USER_AGENT)
}

// if an error happens at any step, script execution is halted and a failed result is returned
console.log("1. GET main page")
console.log("URI: " + MAIN_URL)
await $webDriver.get(MAIN_URL)

console.log("2. waitForAndFindElement: " + loc.main)
await waitForAndFindElement(loc.main, IMPLICIT_TIMEOUT)

console.log("3. waitForAndFindElement: " + loc.nav)
await waitForAndFindElement(loc.nav, IMPLICIT_TIMEOUT)

console.log("4. waitForAndFindElement: " + loc.why)
const textBlock = await waitForAndFindElement(loc.why, IMPLICIT_TIMEOUT)

console.log("5. getText: " + CHECK)
const text = await textBlock.getText()

console.log("6. assert.equal: " + text)
assert.equal(text, CHECK, "validation text not found")

console.log("7. waitForAndFindElement: " + loc.platform)
const platformMenu = await waitForAndFindElement(loc.platform, IMPLICIT_TIMEOUT)

console.log("8. hover over Platform menu")
await $webDriver.actions().move(platformMenu).perform()

console.log("9. take screenshot")
await $webDriver.takeScreenshot()

console.log("10. verify platform services")
loc.p.forEach(async function (nr, i) {
  let n = i + 1
  try{
    // verify each asset has loaded
    console.log("  " + n + ". " + nr.service)
    await $webDriver.findElement(nr.selector)
  }catch(exception){
    console.error("Failure in Step 10." + n)
    throw exception
  }
})