chore: remove src/api.ts (#6191)

Now the async hooks helper is gone api.ts was only used by the coverage
tools and by doclint.

DocLint is nearing the end of its lifespan with the TSDoc work, so I
focused on how best to define a list of modules for the coverage
tooling. They define an object of classes, and the path to that module.
They need the full path because we also check if the module exports any
events that need to be emitted - the coverage tool asserts that the
emitting of those events is also tested.

It's not _great_ that DocLint relies on a constant defined in the
coverage utils, but it should only be this way for a short period of
time and no one is actively working on DocLint (bar the effort to remove
it) so I don't think this is worth worrying about.

This change also broke the DocLint tests; based on the fact that DocLint is on its way out it doesn't feel worth fixing the tests, so this commit also removes them.

.travis.yml

@@ -65,7 +65,6 @@ jobs:
       script:
         - npm run compare-protocol-d-ts
         - npm run lint
-        - npm run test-doclint
         - npm run ensure-new-docs-up-to-date
 
     # This bot runs separately as it changes package.json to test puppeteer-core

package.json

@@ -13,8 +13,7 @@
     "assert-unit-coverage": "cross-env COVERAGE=1 mocha --config mocha-config/coverage-tests.js",
     "funit": "PUPPETEER_PRODUCT=firefox npm run unit",
     "debug-unit": "node --inspect-brk test/test.js",
-    "test-doclint": "mocha --config mocha-config/doclint-tests.js",
-    "test": "npm run tsc && npm run lint --silent && npm run unit-with-coverage && npm run test-doclint && npm run test-types",
+    "test": "npm run tsc && npm run lint --silent && npm run unit-with-coverage && npm run test-types",
     "prepare": "node typescript-if-required.js",
     "prepublishOnly": "npm run tsc",
     "dev-install": "npm run tsc && node install.js",

test/coverage-utils.js

@@ -34,13 +34,43 @@ const path = require('path');
 const fs = require('fs');
 
 /**
- * @param {Map<string, boolean>} apiCoverage
- * @param {Object} events
- * @param {string} className
- * @param {!Object} classType
+ * This object is also used by DocLint to know which classes to check are
+ * documented. It's a pretty hacky solution but DocLint is going away soon as
+ * part of the TSDoc migration.
  */
-function traceAPICoverage(apiCoverage, events, className, classType) {
-  className = className.substring(0, 1).toLowerCase() + className.substring(1);
+const MODULES_TO_CHECK_FOR_COVERAGE = {
+  Accessibility: '../src/common/Accessibility',
+  Browser: '../src/common/Browser',
+  BrowserContext: '../src/common/Browser',
+  BrowserFetcher: '../src/node/BrowserFetcher',
+  CDPSession: '../src/common/Connection',
+  ConsoleMessage: '../src/common/ConsoleMessage',
+  Coverage: '../src/common/Coverage',
+  Dialog: '../src/common/Dialog',
+  ElementHandle: '../src/common/JSHandle',
+  ExecutionContext: '../src/common/ExecutionContext',
+  EventEmitter: '../src/common/EventEmitter',
+  FileChooser: '../src/common/FileChooser',
+  Frame: '../src/common/FrameManager',
+  JSHandle: '../src/common/JSHandle',
+  Keyboard: '../src/common/Input',
+  Mouse: '../src/common/Input',
+  Page: '../src/common/Page',
+  Puppeteer: '../src/common/Puppeteer',
+  HTTPRequest: '../src/common/HTTPRequest',
+  HTTPResponse: '../src/common/HTTPResponse',
+  SecurityDetails: '../src/common/SecurityDetails',
+  Target: '../src/common/Target',
+  TimeoutError: '../src/common/Errors',
+  Touchscreen: '../src/common/Input',
+  Tracing: '../src/common/Tracing',
+  WebWorker: '../src/common/WebWorker',
+};
+
+function traceAPICoverage(apiCoverage, className, modulePath) {
+  const loadedModule = require(modulePath);
+  const classType = loadedModule[className];
+
   if (!classType || !classType.prototype) {
     console.error(
       `Coverage error: could not find class for ${className}. Is src/api.ts up to date?`
@@ -63,8 +93,14 @@ function traceAPICoverage(apiCoverage, events, className, classType) {
     });
   }
 
-  if (events[classType.name]) {
-    for (const event of Object.values(events[classType.name])) {
+  /**
+   * If classes emit events, those events are exposed via an object in the same
+   * module named XEmittedEvents, where X is the name of the class. For example,
+   * the Page module exposes PageEmittedEvents.
+   */
+  const eventsName = `${className}EmittedEvents`;
+  if (loadedModule[eventsName]) {
+    for (const event of Object.values(loadedModule[eventsName])) {
       if (typeof event !== 'symbol')
         apiCoverage.set(`${className}.emit(${JSON.stringify(event)})`, false);
     }
@@ -108,10 +144,11 @@ const trackCoverage = () => {
 
   return {
     beforeAll: () => {
-      const api = require('../src/api');
-      const events = require('../src/common/Events');
-      for (const [className, classType] of Object.entries(api))
-        traceAPICoverage(coverageMap, events, className, classType);
+      for (const [className, moduleFilePath] of Object.entries(
+        MODULES_TO_CHECK_FOR_COVERAGE
+      )) {
+        traceAPICoverage(coverageMap, className, moduleFilePath);
+      }
     },
     afterAll: () => {
       writeCoverage(coverageMap);
@@ -122,4 +159,5 @@ const trackCoverage = () => {
 module.exports = {
   trackCoverage,
   getCoverageResults,
+  MODULES_TO_CHECK_FOR_COVERAGE,
 };

utils/doclint/check_public_api/index.js

@@ -18,6 +18,9 @@ const jsBuilder = require('./JSBuilder');
 const mdBuilder = require('./MDBuilder');
 const Documentation = require('./Documentation');
 const Message = require('../Message');
+const {
+  MODULES_TO_CHECK_FOR_COVERAGE,
+} = require('../../../test/coverage-utils');
 
 const EXCLUDE_PROPERTIES = new Set([
   'Browser.create',
@@ -39,10 +42,7 @@ const EXCLUDE_PROPERTIES = new Set([
 module.exports = async function lint(page, mdSources, jsSources) {
   const mdResult = await mdBuilder(page, mdSources);
   const jsResult = await jsBuilder(jsSources);
-  const jsDocumentation = filterJSDocumentation(
-    jsSources,
-    jsResult.documentation
-  );
+  const jsDocumentation = filterJSDocumentation(jsResult.documentation);
   const mdDocumentation = mdResult.documentation;
 
   const jsErrors = jsResult.errors;
@@ -124,14 +124,11 @@ function checkSorting(doc) {
 }
 
 /**
- * @param {!Array<!Source>} jsSources
  * @param {!Documentation} jsDocumentation
  * @returns {!Documentation}
  */
-function filterJSDocumentation(jsSources, jsDocumentation) {
-  const apijs = jsSources.find((source) => source.name() === 'api.js');
-  let includedClasses = null;
-  if (apijs) includedClasses = new Set(Object.keys(require(apijs.filePath())));
+function filterJSDocumentation(jsDocumentation) {
+  const includedClasses = new Set(Object.keys(MODULES_TO_CHECK_FOR_COVERAGE));
   // Filter private classes and methods.
   const classes = [];
   for (const cls of jsDocumentation.classesArray) {