/**
 * 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 { debug } from '../common/Debug.js' ; import * as childProcess from 'child_process' ; import * as fs from 'fs' ; import * as path from 'path' ; import * as readline from 'readline' ; import removeFolder from 'rimraf' ; import { promisify } from 'util' ; import { assert } from '../common/assert.js' ; import { helper , debugError } from '../common/helper.js' ; import { LaunchOptions } from './LaunchOptions.js' ; import { Connection } from '../common/Connection.js' ; import { NodeWebSocketTransport as WebSocketTransport } from '../node/NodeWebSocketTransport.js' ; import { PipeTransport } from './PipeTransport.js' ; import { Product } from '../common/Product.js' ; import { TimeoutError } from '../common/Errors.js' ; const removeFolderAsync = promisify ( removeFolder ) ; const renameAsync = promisify ( fs . rename ) ; const unlinkAsync = promisify ( fs . unlink ) ; const debugLauncher = debug ( 'puppeteer:launcher' ) ; const PROCESS_ERROR_EXPLANATION = `Puppeteer was unable to kill the process which ran the browser binary.
This means that, on future Puppeteer launches, Puppeteer might not be able to launch the browser.
Please check your open processes and ensure that the browser processes that Puppeteer launched have been killed.
If you think this is a bug, please report it on the Puppeteer issue tracker.` ; export class BrowserRunner { private _product : Product ; private _executablePath : string ; private _processArguments : string [ ] ; private _userDataDir : string ; private _isTempUserDataDir ? : boolean ; proc = null ; connection = null ; private _closed = true ; private _listeners = [ ] ; private _processClosing : Promise < void > ; constructor ( product , executablePath , processArguments , userDataDir , isTempUserDataDir ? ) { this . _product = product ; this . _executablePath = executablePath ; this . _processArguments = processArguments ; this . _userDataDir = userDataDir ; this . _isTempUserDataDir = isTempUserDataDir ; } start ( options ) { const { handleSIGINT , handleSIGTERM , handleSIGHUP , dumpio , env , pipe } = options ; let stdio ; if ( pipe ) { if ( dumpio ) stdio = [ 'ignore' , 'pipe' , 'pipe' , 'pipe' , 'pipe' ] ; else stdio = [ 'ignore' , 'ignore' , 'ignore' , 'pipe' , 'pipe' ] ; } else { if ( dumpio ) stdio = [ 'pipe' , 'pipe' , 'pipe' ] ; else stdio = [ 'pipe' , 'ignore' , 'pipe' ] ; } assert ( ! this . proc , 'This process has previously been started.' ) ; debugLauncher ( `Calling ${ this . _executablePath } ${ this . _processArguments . join ( ' ' ) }` ) ; this . proc = childProcess . spawn ( this . _executablePath , this . _processArguments , { detached : process . platform !== 'win32' , env , stdio , } ) ; if ( dumpio ) { this . proc . stderr . pipe ( process . stderr ) ; this . proc . stdout . pipe ( process . stdout ) ; } this . _closed = false ; this . _processClosing = new Promise ( ( fulfill , reject ) => { this . proc . once ( 'exit' , async ( ) => { this . _closed = true ; if ( this . _isTempUserDataDir ) { try { await removeFolderAsync ( this . _userDataDir ) ; fulfill ( ) ; } catch ( error ) { console . error ( error ) ; reject ( error ) ; } } else { if ( this . _product === 'firefox' ) { try { await unlinkAsync ( path . join ( this . _userDataDir , 'user.js' ) ) ; const prefsBackupPath = path . join ( this . _userDataDir , 'prefs.js.puppeteer' ) ; if ( fs . existsSync ( prefsBackupPath ) ) { const prefsPath = path . join ( this . _userDataDir , 'prefs.js' ) ; await unlinkAsync ( prefsPath ) ; await renameAsync ( prefsBackupPath , prefsPath ) ; } } catch ( error ) { console . error ( error ) ; reject ( error ) ; } } fulfill ( ) ; } } ) ; } ) ; this . _listeners = [ helper . addEventListener ( process , 'exit' , this . kill . bind ( this ) ) , ] ; if ( handleSIGINT ) this . _listeners . push ( helper . addEventListener ( process , 'SIGINT' , ( ) => { this . kill ( ) ; process . exit ( 130 ) ; } ) ) ; if ( handleSIGTERM ) this . _listeners . push ( helper . addEventListener ( process , 'SIGTERM' , this . close . bind ( this ) ) ) ; if ( handleSIGHUP ) this . _listeners . push ( helper . addEventListener ( process , 'SIGHUP' , this . close . bind ( this ) ) ) ; } close ( ) { if ( this . _closed ) return Promise . resolve ( ) ; if ( this . _isTempUserDataDir && this . _product !== 'firefox' ) { this . kill ( ) ; } else if ( this . connection ) { this . connection . send ( 'Browser.close' ) . catch ( ( error ) => { debugError ( error ) ; this . kill ( ) ; } ) ; } helper . removeEventListeners ( this . _listeners ) ; return this . _processClosing ; } kill ( ) { if ( this . proc && this . proc . pid && ! this . proc . killed ) { try { this . proc . kill ( 'SIGKILL' ) ; } catch ( error ) { throw new Error ( `${ PROCESS_ERROR_EXPLANATION }\nError cause: ${ error . stack }` ) ; } } try { if ( this . _isTempUserDataDir ) { removeFolder . sync ( this . _userDataDir ) ; } } catch ( error ) { } helper . removeEventListeners ( this . _listeners ) ; } async setupConnection ( options ) { const { usePipe , timeout , slowMo , preferredRevision } = options ; if ( ! usePipe ) { const browserWSEndpoint = await waitForWSEndpoint ( this . proc , timeout , preferredRevision ) ; const transport = await WebSocketTransport . create ( browserWSEndpoint ) ; this . connection = new Connection ( browserWSEndpoint , transport , slowMo ) ; } else { const { 3 : pipeWrite , 4 : pipeRead } = this . proc . stdio ; const transport = new PipeTransport ( pipeWrite as NodeJS . WritableStream , pipeRead as NodeJS . ReadableStream ) ; this . connection = new Connection ( '' , transport , slowMo ) ; } return this . connection ; } } function waitForWSEndpoint ( browserProcess , timeout , preferredRevision ) { return new Promise ( ( resolve , reject ) => { const rl = readline . createInterface ( { input : browserProcess . stderr } ) ; let stderr = '' ; const listeners = [ helper . addEventListener ( rl , 'line' , onLine ) , helper . addEventListener ( rl , 'close' , ( ) => onClose ( ) ) , helper . addEventListener ( browserProcess , 'exit' , ( ) => onClose ( ) ) , helper . addEventListener ( browserProcess , 'error' , ( error ) => onClose ( error ) ) , ] ; const timeoutId = timeout ? setTimeout ( onTimeout , timeout ) : 0 ; param { ! Error = } error function onClose ( error ? ) { cleanup ( ) ; reject ( new Error ( [ 'Failed to launch the browser process!' + ( error ? ' ' + error . message : '' ) , stderr , '' , 'TROUBLESHOOTING: https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md' , '' , ] . join ( '\n' ) ) ) ; } function onTimeout ( ) { cleanup ( ) ; reject ( new TimeoutError ( `Timed out after ${ timeout } ms while trying to connect to the browser! Only Chrome at revision r${ preferredRevision } is guaranteed to work.` ) ) ; } function onLine ( line ) { stderr += line + '\n' ; const match = line . match ( /^DevTools listening on (ws:\/\/.*)$/ ) ; if ( ! match ) return ; cleanup ( ) ; resolve ( match [ 1 ] ) ; } function cleanup ( ) { if ( timeoutId ) clearTimeout ( timeoutId ) ; helper . removeEventListeners ( listeners ) ; } } ) ; }