errorhandler_async_test.js | Explore in Territory

/**
 * @license
 * Copyright The Closure Library Authors.
 * SPDX-License-Identifier: Apache-2.0
 */

goog.module('goog.debug.ErrorHandlerAsyncTest');
goog.setTestOnly();

const ErrorHandler = goog.require('goog.debug.ErrorHandler');
const GoogPromise = goog.require('goog.Promise');
const Resolver = goog.require('goog.promise.Resolver');
const SafeScript = goog.require('goog.html.SafeScript');
const TagName = goog.require('goog.dom.TagName');
// const TestCase = goog.require('goog.testing.TestCase');
const testSuite = goog.require('goog.testing.testSuite');
const userAgent = goog.require('goog.userAgent');
const {getDomHelper} = goog.require('goog.dom');
const {newSafeScriptForTest} = goog.require('goog.html.testing');

/** @type {!Resolver} */
let resolver;

const testCase = {};

/** @suppress {globalThis} suppression added to enable type checking */
testCase.setUpPage = function() {
  resolver = GoogPromise.withResolver();

  /** @suppress {globalThis} suppression added to enable type checking */
  this.oldTimeout = window.setTimeout;
  /** @suppress {globalThis} suppression added to enable type checking */
  this.oldInterval = window.setInterval;
  /** @suppress {globalThis} suppression added to enable type checking */
  this.oldRequestAnimationFrame = window.requestAnimationFrame;

  // Whether requestAnimationFrame is available for testing.
  /** @suppress {globalThis} suppression added to enable type checking */
  this.testingReqAnimFrame = !!window.requestAnimationFrame;

  // Whether a rejection handler is available for testing.
  /** @suppress {globalThis} suppression added to enable type checking */
  this.testingUnhandledRejection = 'onunhandledrejection' in window &&
      // TODO(user): This test is very flaky in Firefox >= 71
      !(userAgent.GECKO && userAgent.isVersionOrHigher(71)) &&
      // TODO(user): Re-enable after resolving test failure.
      !(userAgent.SAFARI);

  /** @suppress {globalThis} suppression added to enable type checking */
  this.handler = new ErrorHandler(goog.bind(this.onException, this));
  this.handler.protectWindowSetTimeout();
  this.handler.protectWindowSetInterval();
  this.handler.protectWindowRequestAnimationFrame();
  this.handler.catchUnhandledRejections();
  if (this.testingUnhandledRejection) {
    this.setUpIframe();
    this.handler.catchUnhandledRejections(this.iframe.contentWindow);
  }

  /** @suppress {globalThis} suppression added to enable type checking */
  this.exceptions = [];
  /** @suppress {globalThis} suppression added to enable type checking */
  this.errors = 0;

  // Override the error event handler, since we are purposely throwing
  // exceptions from global functions, and expect them
  /** @suppress {globalThis} suppression added to enable type checking */
  this.oldWindowOnError = window.onerror;
  /** @suppress {globalThis} suppression added to enable type checking */
  window.onerror = goog.bind(this.onError, this);

  window.setTimeout(goog.bind(this.timeOut, this), 10);
  /** @suppress {globalThis} suppression added to enable type checking */
  this.intervalId = window.setInterval(goog.bind(this.interval, this), 20);

  if (this.testingReqAnimFrame) {
    window.requestAnimationFrame(goog.bind(this.animFrame, this));
  }

  if (this.testingUnhandledRejection) {
    this.async();
    this.iframeAsync();
    /** @suppress {globalThis} suppression added to enable type checking */
    this.iframeAsyncHit = true;
  }

  /** @suppress {globalThis} suppression added to enable type checking */
  this.promiseTimeout = 10000;  // 10s.
};

/** @suppress {globalThis} suppression added to enable type checking */
testCase.tearDownPage = function() {
  /** @suppress {globalThis} suppression added to enable type checking */
  window.setTimeout = this.oldTimeout;
  /** @suppress {globalThis} suppression added to enable type checking */
  window.setInterval = this.oldInterval;
  /** @suppress {globalThis} suppression added to enable type checking */
  window.requestAnimationFrame = this.oldRequestAnimationFrame;
  if (this.iframe) {
    document.body.removeChild(this.iframe);
  }
};

/** Sets up iframe for catchUnhandledRejection iframe testing. */
testCase.setUpIframe = function() {
  const dom = getDomHelper();
  const iframe = dom.createElement(TagName.IFRAME);
  dom.appendChild(document.body, iframe);

  const iframeDom = getDomHelper(iframe.contentDocument.head);
  const scriptEl = iframeDom.createElement(TagName.SCRIPT);
  scriptEl.textContent = SafeScript.unwrapTrustedScript(newSafeScriptForTest(`
    async function iframeAsync() {
      const p = Promise.resolve();
      await p;
      throw iframeAsync;
    }`));
  iframeDom.appendChild(iframe.contentDocument.head, scriptEl);

  /** @suppress {globalThis} suppression added to enable type checking */
  this.iframe = iframe;
  /** @suppress {globalThis} suppression added to enable type checking */
  this.iframeAsync = this.iframe.contentWindow['iframeAsync'];
};

/** @suppress {globalThis} suppression added to enable type checking */
testCase.onException = function(e) {
  this.exceptions.push(e);
  if (this.timeoutHit && this.intervalHit &&
      (!this.testingReqAnimFrame || this.animFrameHit) &&
      (!this.testingUnhandledRejection ||
       this.asyncHit && this.iframeAsyncHit)) {
    resolver.resolve();
  }
};

/** @suppress {globalThis} suppression added to enable type checking */
testCase.onError = function(msg, url, line) {
  this.errors++;
  return true;
};

testCase.timeOut = function() {
  /** @suppress {globalThis} suppression added to enable type checking */
  this.timeoutHit = true;
  throw testCase.timeOut;
};

/** @suppress {globalThis} suppression added to enable type checking */
testCase.interval = function() {
  /** @suppress {globalThis} suppression added to enable type checking */
  this.intervalHit = true;
  window.clearTimeout(this.intervalId);
  throw testCase.interval;
};

testCase.animFrame = function() {
  /** @suppress {globalThis} suppression added to enable type checking */
  this.animFrameHit = true;
  throw testCase.animFrame;
};

/** Test uncaught errors in async/await */
testCase.async = async function() {
  /** @suppress {globalThis} suppression added to enable type checking */
  this.asyncHit = true;
  const p = Promise.resolve();
  await p;
  throw testCase.async;
};

/** Test uncaught errors in async/await in iframe */
testCase.iframeAsync = undefined;  // Initialized in setUpIframe.

testCase.testResults = function() {
  return resolver.promise.then(function() {
    let animFrameHit;
    let asyncHit;
    let iframeAsyncHit;
    let intervalHit;
    let timeoutHit;

    for (let i = 0; i < this.exceptions.length; ++i) {
      switch (this.exceptions[i]) {
        case this.timeOut:
          timeoutHit = true;
          break;
        case this.interval:
          intervalHit = true;
          break;
        case this.animFrame:
          animFrameHit = true;
          break;
        case this.async:
          asyncHit = true;
          break;
        case this.iframeAsync:
          iframeAsyncHit = true;
          break;
      }
    }

    assertTrue('timeout exception not received', timeoutHit);
    assertTrue('timeout not called', this.timeoutHit);
    assertTrue('interval exception not received', intervalHit);
    assertTrue('interval not called', this.intervalHit);
    if (this.testingReqAnimFrame) {
      assertTrue('anim frame exception not received', animFrameHit);
      assertTrue('animFrame not called', this.animFrameHit);
    }
    if (this.testingUnhandledRejection) {
      assertTrue('Unhandled Rejection exception not received', asyncHit);
      assertTrue(
          'Unhandled Rejection exception from iframe not received',
          iframeAsyncHit);
    }

    if (!userAgent.WEBKIT) {
      let expectedRethrownCount = 2;
      if (this.testingReqAnimFrame) expectedRethrownCount++;
      if (this.testingUnhandledRejection) expectedRethrownCount++;
      assertEquals(
          `${expectedRethrownCount} exceptions should have been rethrown`,
          expectedRethrownCount, this.errors);
    }
  }, null, this);
};

testSuite(testCase);
chromium/third_party/google-closure-library/closure/goog/debug/errorhandler_async_test.js
