presidium 3.3.2 → 3.4.0

package/GoogleChromeDevTools.js

@@ -12,7 +12,7 @@ function getId() {
  *
  * @docs
  * ```coffeescript [specscript]
- * sendRequestJSON(payload string) -> data Promise<Object>
+ * sendRequestJSON(payload object) -> data Promise<Object>
  * ```
  */
 async function sendRequestJSON(payload) {
@@ -23,13 +23,13 @@ async function sendRequestJSON(payload) {
 
   const handler = function (message) {
     const data = JSON.parse(message.toString('utf8'))
-    if (data.id == id) {
+    if (data.id == payload.id) {
       resolve(data)
     }
   }
 
   this.websocket.on('message', handler)
-  this.websocket.send(payload)
+  this.websocket.send(JSON.stringify(payload))
 
   const data = await promise
   this.websocket.removeListener('message', handler)
@@ -51,12 +51,12 @@ async function sendRequestJSON(payload) {
 async function _Method(method, { sessionId, ...params }) {
   const id = getId()
 
-  const payload = JSON.stringify({
+  const payload = {
     sessionId: sessionId ?? this.sessionId,
     id,
     method,
     params,
-  })
+  }
 
   const data = await sendRequestJSON.call(this, payload)
 
@@ -141,6 +141,33 @@ class GoogleChromeDevToolsPage {
     this.websocket = websocket
   }
 
+  /**
+   * @name Page.enable
+   *
+   * @docs
+   * ```coffeescript [specscript]
+   * Page.enable(options {
+   *   sessionId: string,
+   * }) -> data Promise<{}>
+   * ```
+   *
+   * Enables Page events for the current target.
+   *
+   * Arguments:
+   *   * `options`
+   *     * `sessionId` - the session ID.
+   *
+   * Return:
+   *   * `data` - promise of an empty object.
+   *
+   * ```javascript
+   * await googleChromeDevTools.Page.enable()
+   * ```
+   */
+  enable(options = {}) {
+    return _Method.call(this, 'Page.enable', options)
+  }
+
   /**
    * @name Page.navigate
    *
@@ -176,6 +203,98 @@ class GoogleChromeDevToolsPage {
   navigate(options = {}) {
     return _Method.call(this, 'Page.navigate', options)
   }
+
+  /**
+   * @name Page.handleJavaScriptDialog
+   *
+   * @docs
+   * ```coffeescript [specscript]
+   * Page.handleJavaScriptDialog(options {
+   *   sessionId: string,
+   *   accept: boolean,
+   *   promptText: string,
+   * }) -> data Promise<{}>
+   * ```
+   *
+   * Handles (accepts or dismisses) a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
+   *
+   * Arguments:
+   *   * `options`
+   *     * `sessionId` - the session ID.
+   *     * `accept` - whether to accept or dismiss the dialog.
+   *     * `promptText` - the text to enter into the dialog prompt before accepting.
+   *
+   * Return:
+   *   * `data` - promise of an empty object.
+   *
+   * ```javascript
+   * await googleChromeDevTools.Page.handleJavaScriptDialog({
+   *   url: 'http://localhost:3000/',
+   * })
+   * ```
+   */
+  handleJavaScriptDialog(options = {}) {
+    return _Method.call(this, 'Page.handleJavaScriptDialog', options)
+  }
+
+  /**
+   * @name Event: Page.javascriptDialogOpening
+   *
+   * @docs
+   * ```coffeescript [specscript]
+   * emit('Page.javascriptDialogOpening', data {
+   *   url: string,
+   *   frameId: string,
+   *   message: string,
+   *   type: 'alert'|'confirm'|'prompt'|'beforeunload',
+   *   hasBrowserHandler: boolean,
+   * })
+   * ```
+   *
+   * The `DOM.attributeModified` event. Emitted when an attribute of an element is modified.
+   *
+   * Event Data:
+   *   `data`
+   *     * `url` - the frame URL.
+   *     * `frameId` - the frame ID.
+   *     * `message` - message displayed by the dialog.
+   *     * `type` - the dialog type.
+   *     * `hasBrowserHandler` - whether the browser is capable of acting on the given dialog.
+   *
+   * ```javascript
+   * googleChromeDevTools.on('Page.javascriptDialogOpening', data => {
+   *   console.log('dialog opening', data)
+   * })
+   * ```
+   */
+
+  /**
+   * @name Event: Page.javascriptDialogClosed
+   *
+   * @docs
+   * ```coffeescript [specscript]
+   * emit('Page.javascriptDialogClosed', data {
+   *   frameId: string,
+   *   result: boolean,
+   *   userInput: string,
+   * })
+   * ```
+   *
+   * The `DOM.attributeModified` event. Emitted when an attribute of an element is modified.
+   *
+   * Event Data:
+   *   `data`
+   *     * `frameId` - the frame ID.
+   *     * `result` - whether the dialog was confirmed.
+   *     * `userInput` - the user input if the dialog was a prompt.
+   *
+   * ```javascript
+   * googleChromeDevTools.on('Page.javascriptDialogClosed', data => {
+   *   console.log('dialog closed', data)
+   * })
+   * ```
+   */
+
 }
 
 class GoogleChromeDevToolsDOM {
@@ -371,6 +490,7 @@ class GoogleChromeDevToolsDOM {
    * DOM.describeNode(options {
    *   sessionId: string,
    *   nodeId: string,
+   *   depth: number,
    * }) -> data Promise<{
    *   node: CDPDOM.Node,
    * }>
@@ -382,6 +502,7 @@ class GoogleChromeDevToolsDOM {
    *   * `options`
    *     * `sessionId` - the session ID.
    *     * `nodeId` - the ID of the node to describe.
+   *     * `depth` - the maximum depth of the subtree. Defaults to `1`. Use `-1` for the entire subtree.
    *
    * Return:
    *   * `data`
@@ -1052,6 +1173,7 @@ class GoogleChromeDevTools extends EventEmitter {
     })
     await this.googleChromeForTesting.init()
 
+    console.log('initializing websocket with devtoolsUrl:', this.googleChromeForTesting.devtoolsUrl)
     this.websocket = new WebSocket(this.googleChromeForTesting.devtoolsUrl, {
       offerPerMessageDeflate: false,
     })

package/GoogleChromeForTesting.js

@@ -267,8 +267,12 @@ class GoogleChromeForTesting {
     const devtoolsUrlPromise = new Promise(_resolve => {
       devtoolsUrlResolve = _resolve
     })
-    cmd.stderr.on('data', chunk => {
-      const line = chunk.toString('utf8').trim()
+
+    const rl = readline.createInterface({
+      input: cmd.stderr,
+    })
+
+    rl.on('line', line => {
       if (line.includes('DevTools listening on')) {
         const devtoolsUrl = line.replace('DevTools listening on ', '')
         devtoolsUrlResolve(devtoolsUrl)
@@ -288,6 +292,10 @@ class GoogleChromeForTesting {
       process.exit(1)
     })
 
+    cmd.on('exit', code => {
+      console.log(`${chromeFilepath} exited with code ${code}`)
+    })
+
     process.on('SIGTERM', () => {
       cmd.kill()
     })

package/package.json

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