chore: move code to src/ and emit with TypeScript (#5568)

This updates our `tsconfig.json` so it emits our JavaScript files as well as type checking them. We compile into `./lib` which we then ship in our npm package. The source code has moved from `./lib` into `./src`. Because the `src/` directory is exclusively JS files, this change is a no-op in terms of code functionality but is the first step towards being able to replace `src/X.js` with `src/X.ts` in a way that allows us to migrate incrementally. The `lib` directory is gitignored, and the `src` directory is npmignored. On `npm publish` we will now run `npm run tsc` in order to generate the outputted code.
puppeteer · Apr 2, 2020 · 7a2a41f · 7a2a41f
1 parent c82b556
commit 7a2a41f
Show file tree

Hide file tree

Showing 41 changed files with 15,214 additions and 23 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -7,3 +7,4 @@ node6/*
 node6-test/*
 node6-testrunner/*
 experimental/
+lib/
diff --git a/.gitignore b/.gitignore
@@ -12,6 +12,6 @@
 package-lock.json
 yarn.lock
 /node6
-/lib/protocol.d.ts
 /utils/browser/puppeteer-web.js
 /index.d.ts
+/lib
diff --git a/.npmignore b/.npmignore
@@ -43,3 +43,6 @@ experimental
 
 # exclude types, see https://github.com/puppeteer/puppeteer/issues/3878
 /index.d.ts
+
+# don't expose src/ as we ship the generated code in lib/
+/src
diff --git a/install.js b/install.js
@@ -14,6 +14,45 @@
  * limitations under the License.
  */
 
+const fs = require('fs');
+const path = require('path');
+const child_process = require('child_process');
+const {promisify} = require('util');
+
+const fsAccess = promisify(fs.access);
+const exec = promisify(child_process.exec);
+
+const fileExists = async filePath => fsAccess(filePath).then(() => true).catch(() => false);
+
+/*
+ * Now Puppeteer is built with TypeScript, we need to ensure that
+ * locally we have the generated output before trying to install.
+ *
+ * For users installing puppeteer this is fine, they will have the
+ * generated lib/ directory as we ship it when we publish to npm.
+ *
+ * However, if you're cloning the repo to contribute, you won't have the
+ * generated lib/ directory so this script checks if we need to run
+ * TypeScript first to ensure the output exists and is in the right
+ * place.
+ */
+async function compileTypeScript() {
+  return exec('npm run tsc').catch(err => {
+    console.error('Error running TypeScript', err);
+    process.exit(1);
+  });
+}
+
+async function ensureLibDirectoryExists() {
+  const libPath = path.join(__dirname, 'lib');
+  const libExists = await fileExists(libPath);
+  if (libExists) return;
+
+  logPolitely('Compiling TypeScript before install...');
+  await compileTypeScript();
+}
+
+
 /**
  * This file is part of public API.
  *
@@ -29,6 +68,8 @@ const supportedProducts = {
 };
 
 async function download() {
+  await ensureLibDirectoryExists();
+
   const downloadHost = process.env.PUPPETEER_DOWNLOAD_HOST || process.env.npm_config_puppeteer_download_host || process.env.npm_package_config_puppeteer_download_host;
   const puppeteer = require('./index');
   const product = process.env.PUPPETEER_PRODUCT || process.env.npm_config_puppeteer_product || process.env.npm_package_config_puppeteer_product || 'chrome';
@@ -53,7 +94,6 @@ async function download() {
 
     // Do nothing if the revision is already downloaded.
     if (revisionInfo.local) {
-      generateProtocolTypesIfNecessary(false /* updated */, product);
       logPolitely(`${supportedProducts[product]} is already in ${revisionInfo.folderPath}; skipping download.`);
       return;
     }
@@ -78,7 +118,7 @@ async function download() {
       logPolitely(`${supportedProducts[product]} (${revisionInfo.revision}) downloaded to ${revisionInfo.folderPath}`);
       localRevisions = localRevisions.filter(revision => revision !== revisionInfo.revision);
       const cleanupOldVersions = localRevisions.map(revision => browserFetcher.remove(revision));
-      Promise.all([...cleanupOldVersions, generateProtocolTypesIfNecessary(true /* updated */, product)]);
+      Promise.all([...cleanupOldVersions]);
     }
 
     /**
@@ -118,18 +158,6 @@ async function download() {
     return `${Math.round(mb * 10) / 10} Mb`;
   }
 
-  function generateProtocolTypesIfNecessary(updated, product) {
-    if (product !== 'chrome')
-      return;
-    const fs = require('fs');
-    const path = require('path');
-    if (!fs.existsSync(path.join(__dirname, 'utils', 'protocol-types-generator')))
-      return;
-    if (!updated && fs.existsSync(path.join(__dirname, 'lib', 'protocol.d.ts')))
-      return;
-    return require('./utils/protocol-types-generator');
-  }
-
   function getFirefoxNightlyVersion(host) {
     const https = require('https');
     const promise = new Promise((resolve, reject) => {

diff --git a/package.json b/package.json
@@ -16,16 +16,19 @@
     "funit": "PUPPETEER_PRODUCT=firefox node test/test.js",
     "debug-unit": "node --inspect-brk test/test.js",
     "test-doclint": "node utils/doclint/check_public_api/test/test.js && node utils/doclint/preprocessor/test.js",
-    "test": "npm run lint --silent && npm run coverage && npm run test-doclint && npm run test-types && node utils/testrunner/test/test.js",
+    "test": "npm run tsc && npm run lint --silent && npm run coverage && npm run test-doclint && npm run test-types && node utils/testrunner/test/test.js",
+    "prepublishOnly": "npm run tsc",
+    "dev-install": "npm run tsc && node install.js",
     "install": "node install.js",
     "lint": "([ \"$CI\" = true ] && eslint --quiet -f codeframe . || eslint .) && npm run tsc && npm run doc",
     "doc": "node utils/doclint/cli.js",
     "coverage": "cross-env COVERAGE=true npm run unit",
-    "tsc": "tsc --version && tsc -p .",
+    "tsc": "tsc --version && tsc -p . && cp src/protocol.d.ts lib/ && cp src/externs.d.ts lib/",
     "apply-next-version": "node utils/apply_next_version.js",
     "bundle": "npx browserify -r ./index.js:puppeteer -o utils/browser/puppeteer-web.js",
     "test-types": "node utils/doclint/generate_types && tsc --version && tsc -p utils/doclint/generate_types/test/",
-    "unit-bundle": "node utils/browser/test.js"
+    "unit-bundle": "node utils/browser/test.js",
+    "update-protocol-d-ts": "node utils/protocol-types-generator"
   },
   "author": "The Chromium Authors",
   "license": "Apache-2.0",

diff --git a/lib/.eslintrc.js → src/.eslintrc.js b/lib/.eslintrc.js → src/.eslintrc.js
diff --git a/lib/Accessibility.js → src/Accessibility.js b/lib/Accessibility.js → src/Accessibility.js
diff --git a/lib/Browser.js → src/Browser.js b/lib/Browser.js → src/Browser.js
diff --git a/lib/BrowserFetcher.js → src/BrowserFetcher.js b/lib/BrowserFetcher.js → src/BrowserFetcher.js
diff --git a/lib/Connection.js → src/Connection.js b/lib/Connection.js → src/Connection.js
diff --git a/lib/Coverage.js → src/Coverage.js b/lib/Coverage.js → src/Coverage.js
diff --git a/lib/DOMWorld.js → src/DOMWorld.js b/lib/DOMWorld.js → src/DOMWorld.js
diff --git a/lib/DeviceDescriptors.js → src/DeviceDescriptors.js b/lib/DeviceDescriptors.js → src/DeviceDescriptors.js
diff --git a/lib/Dialog.js → src/Dialog.js b/lib/Dialog.js → src/Dialog.js
diff --git a/lib/EmulationManager.js → src/EmulationManager.js b/lib/EmulationManager.js → src/EmulationManager.js
diff --git a/lib/Errors.js → src/Errors.js b/lib/Errors.js → src/Errors.js
diff --git a/lib/Events.js → src/Events.js b/lib/Events.js → src/Events.js
diff --git a/lib/ExecutionContext.js → src/ExecutionContext.js b/lib/ExecutionContext.js → src/ExecutionContext.js
diff --git a/lib/FrameManager.js → src/FrameManager.js b/lib/FrameManager.js → src/FrameManager.js
diff --git a/lib/Input.js → src/Input.js b/lib/Input.js → src/Input.js
diff --git a/lib/JSHandle.js → src/JSHandle.js b/lib/JSHandle.js → src/JSHandle.js
diff --git a/lib/Launcher.js → src/Launcher.js b/lib/Launcher.js → src/Launcher.js
diff --git a/lib/LifecycleWatcher.js → src/LifecycleWatcher.js b/lib/LifecycleWatcher.js → src/LifecycleWatcher.js
diff --git a/lib/Multimap.js → src/Multimap.js b/lib/Multimap.js → src/Multimap.js
diff --git a/lib/NetworkManager.js → src/NetworkManager.js b/lib/NetworkManager.js → src/NetworkManager.js
diff --git a/lib/Page.js → src/Page.js b/lib/Page.js → src/Page.js
@@ -30,7 +30,6 @@ const {Worker: PuppeteerWorker} = require('./Worker');
 const {createJSHandle} = require('./JSHandle');
 const {Accessibility} = require('./Accessibility');
 const {TimeoutSettings} = require('./TimeoutSettings');
-
 const writeFileAsync = helper.promisify(fs.writeFile);
 
 class Page extends EventEmitter {

diff --git a/lib/PipeTransport.js → src/PipeTransport.js b/lib/PipeTransport.js → src/PipeTransport.js
diff --git a/lib/Puppeteer.js → src/Puppeteer.js b/lib/Puppeteer.js → src/Puppeteer.js
diff --git a/lib/Target.js → src/Target.js b/lib/Target.js → src/Target.js
diff --git a/lib/TaskQueue.js → src/TaskQueue.js b/lib/TaskQueue.js → src/TaskQueue.js
diff --git a/lib/TimeoutSettings.js → src/TimeoutSettings.js b/lib/TimeoutSettings.js → src/TimeoutSettings.js
diff --git a/lib/Tracing.js → src/Tracing.js b/lib/Tracing.js → src/Tracing.js
diff --git a/lib/USKeyboardLayout.js → src/USKeyboardLayout.js b/lib/USKeyboardLayout.js → src/USKeyboardLayout.js
diff --git a/lib/WebSocketTransport.js → src/WebSocketTransport.js b/lib/WebSocketTransport.js → src/WebSocketTransport.js
diff --git a/lib/Worker.js → src/Worker.js b/lib/Worker.js → src/Worker.js
diff --git a/lib/api.js → src/api.js b/lib/api.js → src/api.js
diff --git a/lib/externs.d.ts → src/externs.d.ts b/lib/externs.d.ts → src/externs.d.ts
diff --git a/lib/helper.js → src/helper.js b/lib/helper.js → src/helper.js