presidium 3.2.0 → 3.3.0

package/GoogleChromeDevTools.js

@@ -849,24 +849,20 @@ class GoogleChromeDevToolsRuntime {
  * Supported platforms:
  *   * `mac-arm64`
  *   * `linux64`
+ *   * `win64`
  *
  * ## Further Installation
  * Some further installation may be required for Linux platforms.
  *
- * ### Install headless dependencies for Amazon Linux 2023
+ * ### Install headless dependencies for Amazon Linux 2023 / Red Hat
  * ```sh
  * sudo dnf install -y cairo pango nss nspr atk at-spi2-atk cups-libs libdrm libxkbcommon libXcomposite libXdamage libXfixes libXrandr mesa-libgbm alsa-lib
  * ```
  *
- * ### Install headless dependencies for Ubuntu
+ * ### Install headless dependencies for Ubuntu / Debian
  * ```sh
  * sudo apt-get update && sudo apt-get install -y libcairo2 libpango-1.0-0 libnss3 libnspr4 libatk1.0-0 libatk-bridge2.0-0 libatspi2.0-0 libcups2 libdrm-dev libxkbcommon0 libxcomposite1 libxdamage1 libxfixes3 libxrandr2 libgbm-dev libasound2-dev
- *
- * # disable AppArmor unprivileged security restriction
- * echo "kernel.apparmor_restrict_unprivileged_userns=0" | sudo tee /etc/sysctl.d/60-apparmor-namespace.conf
- * sudo sysctl -p /etc/sysctl.d/60-apparmor-namespace.conf
  * ```
- *
  */
 class GoogleChromeDevTools extends EventEmitter {
   constructor(options = {}) {
@@ -921,7 +917,11 @@ class GoogleChromeDevTools extends EventEmitter {
       offerPerMessageDeflate: false,
     })
     this.websocket.on('error', error => {
-      throw error
+      if (this.closed && error.code == 'ECONNRESET') {
+        console.error('Reset after close:', error)
+      } else {
+        throw error
+      }
     })
 
     this.websocket.on('message', message => {
@@ -995,10 +995,37 @@ class GoogleChromeDevTools extends EventEmitter {
    * ```
    */
   close() {
+    this.closed = true
     this.websocket.sendClose()
-    this.websocket.close()
-    this.googleChromeForTesting.close()
+    this.websocket.on('close', () => {
+      this.googleChromeForTesting.cmd.on('close', () => {
+        this.emit('close')
+      })
+      this.googleChromeForTesting.close()
+    })
   }
+
+  /**
+   * @name Event: close
+   *
+   * @docs
+   * ```coffeescript [specscript]
+   * emit('close')
+   * ```
+   *
+   * The `close` event. Emitted when the websocket connection to the DevTools server is closed and the Google Chrome for Testing process is terminated.
+   *
+   * Event Data:
+   *   * (none)
+   *
+   * ```javascript
+   * googleChromeForTesting.on('close', () => {
+   *   console.log('WebSocket connection closed and Google Chrome for Testing process terminated.')
+   * })
+   * ```
+   */
+
 }
 
+
 module.exports = GoogleChromeDevTools

package/GoogleChromeForTesting.js

@@ -18,7 +18,7 @@ async function getChromeVersions() {
   return data
 }
 
-function updateConsoleLog(message) {
+function updateConsoleLog(message, platform) {
   readline.cursorTo(process.stdout, 0, undefined);
   readline.clearLine(process.stdout, 0);
   process.stdout.write(message);
@@ -33,7 +33,11 @@ function getPlatform() {
 
   if (platform == 'mac') {
     platform = `${platform}-${arch}`
-  } else {
+  }
+  else if (platform == 'win32') {
+    platform = `win${arch.slice(1)}`
+  }
+  else {
     platform = `${platform}${arch.slice(1)}`
   }
 
@@ -58,13 +62,26 @@ async function getChromeUrl() {
 }
 
 async function installChrome() {
+  const platform = getPlatform()
+  const delimiter = platform.startsWith('win') ? '\\' : '/'
   const url = await getChromeUrl.call(this)
-  let filepath = `${this.chromeDir}/${url.replace('https://storage.googleapis.com/chrome-for-testing-public/', '')}`
-  if (!filepath.startsWith('/')) {
+
+  let filepath = `${this.chromeDir}${delimiter}${url.replace('https://storage.googleapis.com/chrome-for-testing-public/', '')}`
+  if (platform.startsWith('win')) {
+    filepath = filepath.replace(/\//g, '\\')
+    if (!filepath.startsWith(`${__dirname[0]}:`)) {
+      filepath = path.join(process.cwd(), filepath)
+    }
+  } else if (!filepath.startsWith('/')) {
     filepath = path.join(process.cwd(), filepath)
   }
-  let parentDir = `${filepath.split('/').slice(0, -1).join('/')}`
-  if (!parentDir.startsWith('/')) {
+
+  let parentDir = `${filepath.split(delimiter).slice(0, -1).join(delimiter)}`
+  if (platform.startsWith('win')) {
+    if (!filepath.startsWith(`${__dirname[0]}:`)) {
+      parentDir = path.join(process.cwd(), parentDir)
+    }
+  } else if (!parentDir.startsWith('/')) {
     parentDir = path.join(process.cwd(), parentDir)
   }
   await fs.promises.mkdir(parentDir, { recursive: true })
@@ -81,9 +98,9 @@ async function installChrome() {
   response.on('data', chunk => {
     downloadedLength += chunk.length
     if (downloadedLength == contentLength) {
-      updateConsoleLog(`Downloading ${url} (${downloadedLength} / ${contentLength} bytes)\n`)
+      updateConsoleLog(`Downloading ${url} (${downloadedLength} / ${contentLength} bytes)\n`, platform)
     } else {
-      updateConsoleLog(`Downloading ${url} (${downloadedLength} / ${contentLength} bytes)`)
+      updateConsoleLog(`Downloading ${url} (${downloadedLength} / ${contentLength} bytes)`, platform)
     }
 
     fileStream.write(chunk)
@@ -98,10 +115,11 @@ async function installChrome() {
   })
   await promise
 
+  console.log('Extracting', filepath)
   try {
     await extract(filepath, { dir: parentDir })
-  } catch {
-    await sleep(100)
+  } catch (_error) {
+    await sleep(1000)
     await extract(filepath, { dir: parentDir })
   }
 }
@@ -114,13 +132,15 @@ async function getChromeFilepath() {
 
   try {
     for await (const filepath of walk(parentDir)) {
-      console.log(filepath)
       if (platform.startsWith('mac') && filepath.endsWith('Google Chrome for Testing')) {
         return filepath
       }
       if (platform.startsWith('linux') && filepath.endsWith('chrome')) {
         return filepath
       }
+      if (platform.startsWith('win') && filepath.endsWith('chrome.exe')) {
+        return filepath
+      }
     }
   } catch (error) {
     if (error.code == 'ENOENT') {
@@ -173,6 +193,7 @@ async function getChromeFilepath() {
  * Supported platforms:
  *   * `mac-arm64`
  *   * `linux64`
+ *   * `win64`
  *
  * ## Further Installation
  * Some further installation may be required for Linux platforms.
@@ -185,10 +206,6 @@ async function getChromeFilepath() {
  * ### Install headless dependencies for Ubuntu / Debian
  * ```sh
  * sudo apt-get update && sudo apt-get install -y libcairo2 libpango-1.0-0 libnss3 libnspr4 libatk1.0-0 libatk-bridge2.0-0 libatspi2.0-0 libcups2 libdrm-dev libxkbcommon0 libxcomposite1 libxdamage1 libxfixes3 libxrandr2 libgbm-dev libasound2-dev
- *
- * # disable AppArmor unprivileged security restriction
- * echo "kernel.apparmor_restrict_unprivileged_userns=0" | sudo tee /etc/sysctl.d/60-apparmor-namespace.conf
- * sudo sysctl -p /etc/sysctl.d/60-apparmor-namespace.conf
  * ```
  */
 class GoogleChromeForTesting {
@@ -236,6 +253,7 @@ class GoogleChromeForTesting {
       `--user-data-dir=${this.userDataDir}`,
       ...this.headless ? ['--headless'] : [],
       ...this.useMockKeychain ? ['--use-mock-keychain'] : [],
+      '--no-sandbox',
     ])
     cmd.stdout.pipe(process.stdout)
     cmd.stderr.pipe(process.stderr)
@@ -288,6 +306,18 @@ class GoogleChromeForTesting {
    * ```coffeescript [specscript]
    * close() -> undefined
    * ```
+   *
+   * Terminates the Google Chrome for Testing process.
+   *
+   * Arguments:
+   *   * (none)
+   *
+   * Return:
+   *   * `undefined`
+   *
+   * ```javascript
+   * googleChromeForTesting.close()
+   * ```
    */
   close() {
     this.cmd.kill('SIGKILL')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presidium",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "A library for creating web services",
   "author": "Richard Tong",
   "license": "MIT",