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

/**
 * Script Name: scripted browser - next gen runtime
 * Author: New Relic
 * Version: 1.0
 * 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 = "scripted browser - next gen runtime" // name to record in script log
const DEFAULT_TIMEOUT = 10000                             // default is 10 seconds to locate page loc
const PAGE_LOAD_TIMEOUT = 60000                           // a negative value defaults to 180 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/page
const CHECK = "Correlate issues across your entire stack" // text to match on page

const AUTH = USERNAME + PASSWORD
const FULL_URL = PROTOCOL + AUTH + DOMAIN + PATH

// -------------------- CONFIGURATION
var assert = require("assert")
// script-wide timeout (ms) for functions: waitForAndFindElement and waitForPendingRequests
// better to fail early if it is expected to take less time than the DEFAULT_TIMEOUT
// in order to release the heavy worker thread on the minion for the next job
$webDriver.manage().setTimeouts({pageLoad: DEFAULT_TIMEOUT})  // sets element load timeout
$webDriver.manage().setTimeouts({pageLoad: PAGE_LOAD_TIMEOUT}) // sets page load timeout

// -------------------- VARIABLES
var By = $selenium.By
var btnPath = "#main-content > article > div.r08-media-playlist.js-r08-media-playlist.r08-media-playlist--margin-64 > div.r08-media-playlist__tablist > "
var loc = {
  main: By.id("main-content"),
  nav: By.className("header-site-nav"),
  issues: By.xpath("//*[@id='main-content']/article/div[11]/div/div[2]/div/div/div/ul/li[1]"),
  what_you_get: [
    { service: 'apm',        selector: By.css(btnPath + "button:nth-child(2)")  },
    { service: 'pixie',      selector: By.css(btnPath + "button:nth-child(3)")  },
    { service: 'codestream', selector: By.css(btnPath + "button:nth-child(4)")  },
    { service: 'ml',         selector: By.css(btnPath + "button:nth-child(5)")  },
    { service: 'logs',       selector: By.css(btnPath + "button:nth-child(6)")  },
    { service: 'errors',     selector: By.css(btnPath + "button:nth-child(7)")  },
    { service: 'infra',      selector: By.css(btnPath + "button:nth-child(8)")  },
    { service: 'npm',        selector: By.css(btnPath + "button:nth-child(9)")  },
    { service: 'browser',    selector: By.css(btnPath + "button:nth-child(10)") },
    { service: 'synthetics', selector: By.css(btnPath + "button:nth-child(11)") },
    { service: 'aiops',      selector: By.css(btnPath + "button:nth-child(12)") }
  ]
}

// -------------------- FUNCTIONS
// for backwards compatibility with legacy runtimes
async function waitForAndFindElement(locator, timeout) {
  const webElement = await $webDriver.wait(
    $selenium.until.elementLocated(locator),
    timeout,
    "Timed-out waiting for element to be located using: " + locator
  )
  await $webDriver.wait(
    $selenium.until.elementIsVisible(webElement),
    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)
console.log("Default timeout is set to " + DEFAULT_TIMEOUT / 1000 + " seconds")
console.log("URI: " + FULL_URL)

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

// Get browser capabilities and do nothing with it, so that we start with a then-able command
$webDriver
  .getCapabilities()
  .then(function () {})
  // Step 1
  // if an error happens at any step, script execution is halted and a failed result is returned
  .then(function () {
    console.log("1. first step")
    return $webDriver.get(FULL_URL)
  })
  // Step 2
  .then(function () {
    console.log("2. waitForAndFindElement: ", loc.main.value)
    // verify id for main has loaded
    return waitForAndFindElement(loc.main, DEFAULT_TIMEOUT)
  })
  // Step 3
  .then(function () {
    console.log("3. waitForAndFindElement: ", loc.nav.value)
    // verify site nav has loaded
    return waitForAndFindElement(loc.nav, DEFAULT_TIMEOUT)
  })
  // Step 4
  .then(function () {
    console.log("4. findElement: ", loc.issues.value)
    return $webDriver.findElement(loc.issues, DEFAULT_TIMEOUT)  })
  // Step 5
  .then(function (el) {
    console.log("5. getText")
    return el.getText()
  })
  // Step 6
  .then(function (text) {
    console.log("6. assert.equal: " + text + " == " + CHECK)
    assert.equal(text, CHECK, "validation text not found")
  })
  // Step 7 (if assert is equal)
  .then(function () {
    console.log("7. verify what_you_get:")
    // loop through the what_you_get array
    // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach
    loc.what_you_get.forEach(function (nr, i, arr) {
      let n = i+1
      console.log("  " + n + ". " + nr.service)
      // verify each asset has loaded
      return $webDriver.findElement(nr.selector, DEFAULT_TIMEOUT).catch(function (err) {
        console.error("Failure in Step 7." + n)
        throw err
      })
    })
  })