Skip to content
Permalink
Browse files

chore(agnostic): ship CJS and ESM builds (#6095)

* chore(agnostic): ship CJS and ESM builds

For our work to enable Puppeteer in other environments (e.g. a browser)
we need to ship an ESM build. This commit changes our config to ship to
`lib/cjs` and `lib/esm` accordingly. The majority of our code stays the
same, with one small fix for the CJS build to ensure that we ship a
version that lets you `require('puppeteer')` rather than have to
`require('puppeteer').default`. We do this with the `cjs-entry.js` which
is what the `main` field in our `package.json` points to.

We also swap to `read-pkg-up` to find the `package.json` file. This is
because the folder structure of `lib/` does not match `src/` now we ship
to `cjs` and `esm`, so you cannot rely on exact paths. This module works
up from the file to find the nearest `package.json` so it will always
find Puppeteer's `package.json`.

Note that we *do not* point any users to the ESM build. We happen to
ship those files so people who know about them can get at them but it's
not expected (nor will we actively support) that people will rely on
them. The CommonJS build is considered our main build.

We may make breaking changes to the structure of the ESM build which we
will do without requiring new major versions. For example the ESM build
currently ships all files that the CJS build does, but given we are
working on the ESM build being able to run in the browser this may
change over time.

Long term once the Node versions catch up we can ditch CJS and ship
exclusively ESM but we are not there yet.
  • Loading branch information
jackfranklin committed Jun 25, 2020
1 parent 46fc6ca commit 1c0009d2c08b3e08cae379f347c39c02e34c95f5
Showing with 66 additions and 25 deletions.
  1. +1 −1 api-extractor.json
  2. +29 −0 cjs-entry.js
  3. +7 −3 package.json
  4. +3 −1 scripts/test-install.sh
  5. +2 −3 src/common/Puppeteer.ts
  6. +12 −13 src/index.ts
  7. +1 −1 src/initialize.ts
  8. +7 −0 tsconfig-esm.json
  9. +1 −1 tsconfig.json
  10. +3 −2 utils/doclint/cli.js
@@ -1,6 +1,6 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/lib/api-docs-entry.d.ts",
"mainEntryPointFilePath": "<projectFolder>/lib/cjs/api-docs-entry.d.ts",
"bundledPackages": [ ],

"apiReport": {
@@ -0,0 +1,29 @@
/**
* Copyright 2020 Google Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/**
* We use `export default puppeteer` in `src/index.ts` to expose the library But
* TypeScript in CJS mode compiles that to `exports.default = `. This means that
* our CJS Node users would have to use `require('puppeteer').default` which
* isn't very nice.
*
* So instead we expose this file as our entry point. This requires the compiled
* Puppeteer output and re-exports the `default` export via `module.exports.`
* This means that we can publish to CJS and ESM whilst maintaining the expected
* import behaviour for CJS and ESM users.
*/
const puppeteerExport = require('./lib/cjs/index');
module.exports = puppeteerExport.default;
@@ -2,7 +2,7 @@
"name": "puppeteer",
"version": "4.0.0-post",
"description": "A high-level API to control headless Chrome over the DevTools Protocol",
"main": "lib/index.js",
"main": "./cjs-entry.js",
"repository": "github:puppeteer/puppeteer",
"engines": {
"node": ">=10.18.1"
@@ -28,7 +28,9 @@
"lint": "npm run eslint && npm run tsc && npm run doc",
"doc": "node utils/doclint/cli.js",
"clean-lib": "rm -rf lib",
"tsc": "npm run clean-lib && tsc --version && tsc -p . && cp src/protocol.d.ts lib/",
"tsc": "npm run clean-lib && tsc --version && npm run tsc-cjs && npm run tsc-esm",
"tsc-cjs": "tsc -p . && cp src/protocol.d.ts lib/cjs",
"tsc-esm": "tsc --build tsconfig-esm.json && cp src/protocol.d.ts lib/esm",
"apply-next-version": "node utils/apply_next_version.js",
"update-protocol-d-ts": "node utils/protocol-types-generator update",
"compare-protocol-d-ts": "node utils/protocol-types-generator compare",
@@ -41,7 +43,8 @@
"lib/",
"index.js",
"install.js",
"typescript-if-required.js"
"typescript-if-required.js",
"cjs-entry.js"
],
"author": "The Chromium Authors",
"license": "Apache-2.0",
@@ -53,6 +56,7 @@
"mitt": "^2.0.1",
"progress": "^2.0.1",
"proxy-from-env": "^1.0.0",
"read-pkg-up": "^7.0.1",
"rimraf": "^3.0.2",
"tar-fs": "^2.0.0",
"unbzip2-stream": "^1.3.3",
@@ -4,14 +4,16 @@ set -e
# Pack the module into a tarball
npm pack
tarball="$(realpath puppeteer-*.tgz)"
cd "$(mktemp -d)"
TMPDIR="$(mktemp -d)"
cd $TMPDIR
# Check we can install from the tarball.
# This emulates installing from npm and ensures that:
# 1. we publish the right files in the `files` list from package.json
# 2. The install script works and correctly exits without errors
# 3. Requiring Puppeteer from Node works.
npm install --loglevel silent "${tarball}"
node --eval="require('puppeteer')"
ls $TMPDIR/node_modules/puppeteer/.local-chromium/

# Again for Firefox
TMPDIR="$(mktemp -d)"
@@ -23,6 +23,7 @@ import { ProductLauncher } from '../node/Launcher';
import { BrowserFetcher, BrowserFetcherOptions } from '../node/BrowserFetcher';
import { puppeteerErrors, PuppeteerErrors } from './Errors';
import { ConnectionTransport } from './ConnectionTransport';
import readPkgUp from 'read-pkg-up';

import { devicesMap } from './DeviceDescriptors';
import { DevicesMap } from './DeviceDescriptors';
@@ -172,9 +173,7 @@ export class Puppeteer {
this._lazyLauncher.product !== this._productName ||
this._changedProduct
) {
// @ts-ignore
// eslint-disable-next-line @typescript-eslint/no-var-requires
const packageJson = require('../../package.json');
const { packageJson } = readPkgUp.sync({ cwd: __dirname });
switch (this._productName) {
case 'firefox':
this._preferredRevision = packageJson.puppeteer.firefox_revision;
@@ -14,21 +14,20 @@
* limitations under the License.
*/

import { initializePuppeteer } from './initialize';
import { initializePuppeteer, InitOptions } from './initialize';
import * as path from 'path';
import readPkgUp from 'read-pkg-up';

const packageJsonResult = readPkgUp.sync({
cwd: __dirname,
});
const packageJson = packageJsonResult.packageJson as unknown;

const rootDir = path.dirname(packageJsonResult.path);

const puppeteer = initializePuppeteer({
packageJson: require(path.join(__dirname, '..', 'package.json')),
rootDirectory: path.join(__dirname, '..'),
packageJson: packageJson as InitOptions['packageJson'],
rootDirectory: rootDir,
});

/*
* Has to be CJS here rather than ESM such that the output file ends with
* module.exports = puppeteer.
*
* If this was export default puppeteer the output would be:
* exports.default = puppeteer
* And therefore consuming via require('puppeteer') would break / require the user
* to access require('puppeteer').default;
*/
export = puppeteer;
export default puppeteer;
@@ -22,7 +22,7 @@ const api = require('./api');
import { helper } from './common/helper';
import { Puppeteer } from './common/Puppeteer';

interface InitOptions {
export interface InitOptions {
packageJson: {
puppeteer: {
chromium_revision: string;
@@ -0,0 +1,7 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"outDir": "./lib/esm",
"module": "ES2015",
},
}
@@ -2,7 +2,7 @@
"compilerOptions": {
"allowJs": true,
"checkJs": true,
"outDir": "./lib",
"outDir": "./lib/cjs",
"target": "ESNext",
"moduleResolution": "node",
"module": "CommonJS",
@@ -71,8 +71,9 @@ async function run() {

const jsSources = [
...(await Source.readdir(path.join(PROJECT_DIR, 'lib'))),
...(await Source.readdir(path.join(PROJECT_DIR, 'lib', 'common'))),
...(await Source.readdir(path.join(PROJECT_DIR, 'lib', 'node'))),
...(await Source.readdir(path.join(PROJECT_DIR, 'lib', 'cjs'))),
...(await Source.readdir(path.join(PROJECT_DIR, 'lib', 'cjs', 'common'))),
...(await Source.readdir(path.join(PROJECT_DIR, 'lib', 'cjs', 'node'))),
];
const allSrcCode = [...jsSources, ...tsSourcesNoDefinitions];
messages.push(...(await checkPublicAPI(page, mdSources, allSrcCode)));

0 comments on commit 1c0009d

Please sign in to comment.
You can’t perform that action at this time.