Skip to content

Commit

Permalink
chore(agnostify): Create Node and Web initializer.
Browse files Browse the repository at this point in the history
This PR splits `initialize.ts` into two files, one for web, and one for
Node. The Node initializer requires much more information as it needs to
know which browser(s) to download and where to store them, whereas the
web one does not.

A future PR that I'm working on will tidy up `src/common/Puppeteer.ts`
(as it contains a lot of Node specific logic around downloading and
installing browsers), but this change enables us to stop the browser
bundle attempting to use the `pkg-dir` dependency, which wouldn't work
within a browser, as well as keeping the size of the PRs down and
avoiding one mammoth PR.
  • Loading branch information
jackfranklin committed Oct 7, 2020
1 parent 3afe193 commit 745adea
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 4 deletions.
3 changes: 2 additions & 1 deletion src/common/Puppeteer.ts
Expand Up @@ -67,7 +67,8 @@ import { PUPPETEER_REVISIONS } from '../revisions.js';
* @public
*/
export class Puppeteer {
private _projectRoot: string;
// Will be undefined in a browser environment
private _projectRoot?: string;
private _isPuppeteerCore: boolean;
private _changedProduct = false;
private __productName: string;
Expand Down
9 changes: 7 additions & 2 deletions src/index.ts
Expand Up @@ -14,7 +14,12 @@
* limitations under the License.
*/

import { initializePuppeteer } from './initialize.js';
import { initializePuppeteerNode } from './initialize-node.js';
import { isNode } from './environment.js';
import { initializePuppeteerWeb } from './initialize-web.js';

const puppeteer = initializePuppeteer('puppeteer');
const initializeFunc = isNode
? initializePuppeteerNode
: initializePuppeteerWeb;
const puppeteer = initializeFunc('puppeteer');
export default puppeteer;
2 changes: 1 addition & 1 deletion src/initialize.ts → src/initialize-node.ts
Expand Up @@ -18,7 +18,7 @@ import { Puppeteer } from './common/Puppeteer.js';
import { PUPPETEER_REVISIONS } from './revisions.js';
import pkgDir from 'pkg-dir';

export const initializePuppeteer = (packageName: string): Puppeteer => {
export const initializePuppeteerNode = (packageName: string): Puppeteer => {
const puppeteerRootDirectory = pkgDir.sync(__dirname);

let preferredRevision = PUPPETEER_REVISIONS.chromium;
Expand Down
34 changes: 34 additions & 0 deletions src/initialize-web.ts
@@ -0,0 +1,34 @@
/**
* 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.
*/

import { Puppeteer } from './common/Puppeteer.js';

export const initializePuppeteerWeb = (packageName: string): Puppeteer => {
const isPuppeteerCore = packageName === 'puppeteer-core';

// puppeteer-core ignores environment variables
return new Puppeteer(
// Product root directory is undefined as we're not concerned about
// downloading and installing browsers in the web environment
undefined,
// Preferred revision is undefined as we will use the browser we are running in.
undefined,
isPuppeteerCore,
// Preferred product is undefined as we'll just use the browser we are
// running in.
undefined
);
};

0 comments on commit 745adea

Please sign in to comment.