chromium-bidi 0.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,245 @@
+# WebDriver BiDi for Chromium
+
+This is an implementation of the
+[WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) protocol for Chromium,
+implemented as a JavaScript layer translating between BiDi and CDP, running
+inside a Chrome tab.
+
+Current status can be checked here:
+[Chromium BiDi progress](https://docs.google.com/spreadsheets/d/1acM-kHlubpwnW1mFboS9hePawq3u1kf21oQzD16q-Ao/edit?usp=sharing&resourcekey=0-PuLHQYLmDJUOXH_mFO-QiA)
+.
+
+# Setup
+
+This is a Node.js project, so install dependencies as usual:
+
+```sh
+npm install
+```
+
+# Starting the Server
+
+```sh
+npm run server
+```
+
+This will run the server on port 8080. Use the `PORT` environment variable
+or `--port=...` argument to run it on another port:
+
+```sh
+PORT=8081 npm run server
+npm run server -- --port=8081
+```
+
+Use the `DEBUG` environment variable to see debug info:
+
+```sh
+DEBUG=* npm run server
+```
+
+Use the CLI argument `--headless=false` to run browser in headful mode:
+
+```sh
+npm run server -- --headless=false
+```
+
+## Starting on Linux and Mac
+
+TODO: verify if it works on Windows.
+
+You can also run the server by using script `./runBiDiServer.sh`. It will write
+output to the file `log.txt`:
+
+```sh
+./runBiDiServer.sh --port=8081 --headless=false
+```
+
+# Running
+
+## Unit tests
+
+Running:
+
+```sh
+npm run unit
+```
+
+## e2e tests
+
+The e2e tests are written using Python, in order to learn how to eventually do
+this in web-platform-tests.
+
+### Installation
+
+Python 3.6+ and some dependencies are required:
+
+```sh
+python3 -m pip install --user -r tests/requirements.txt
+```
+
+### Running
+
+The e2e tests require BiDi server running on the same host. By default, tests
+try to connect to the port `8080`. The server can be run from the project root:
+
+```sh
+npm run e2e
+```
+
+Use the `PORT` environment variable to connect to another port:
+
+```sh
+PORT=8081 npm run e2e
+```
+
+## Examples
+
+The examples are stored in the `/examples` folder and are intended to show who
+the BiDi protocol can be used. Examples are based on
+[Puppeteer's examples](https://github.com/puppeteer/puppeteer/tree/main/examples)
+.
+
+### Instalation
+
+The examples are written using Python, to align with e2e test. Python 3.6+ and
+some dependencies are required:
+
+```sh
+python3 -m pip install --user -r tests/requirements.txt
+```
+
+### Running
+
+The examples require BiDi server running on the same host on the port `8080`.
+The server can be run from the project root:
+
+```sh
+npm run server
+```
+
+After running server, examples can be simply run:
+
+```sh
+python3 examples/cross-browser.py
+```
+
+## WPT
+
+WPT is added as
+a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). To get
+run WPT tests:
+
+### Check out WPT and setup
+
+#### 1. Check out WPT
+
+```sh
+git submodule init
+git submodule update
+```
+
+#### 2. Go to the WPT folder
+
+```sh
+cd wpt
+```
+
+#### 3. Set up virtualenv
+
+Follow the [_System
+Setup_](https://web-platform-tests.org/running-tests/from-local-system.html#system-setup)
+instructions.
+
+#### 4. Setup `hosts` file
+
+Follow
+the [`hosts` File Setup](https://web-platform-tests.org/running-tests/from-local-system.html#hosts-file-setup)
+instructions.
+
+##### On Linux, macOS or other UNIX-like system
+
+```sh
+./wpt make-hosts-file | sudo tee -a /etc/hosts
+```
+
+##### And on **Windows**
+
+This must be run in a PowerShell session with Administrator privileges:
+
+```sh
+python wpt make-hosts-file | Out-File $env:SystemRoot\System32\drivers\etc\hosts -Encoding ascii -Append
+```
+
+If you are behind a proxy, you also need to make sure the domains above are
+excluded from your proxy lookups.
+
+#### 5. Set the `WPT_BROWSER_PATH` environment variable to a Chrome, Edge or Chromium binary to launch. For example, on macOS:
+
+```sh
+export WPT_BROWSER_PATH="/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary"
+export WPT_BROWSER_PATH="/Applications/Microsoft Edge Canary.app/Contents/MacOS/Microsoft Edge Canary"
+export WPT_BROWSER_PATH="/Applications/Chromium.app/Contents/MacOS/Chromium"
+```
+
+### Run WPT tests
+
+#### 1. Build ChromeDriver BiDi
+
+```sh
+npm run build
+```
+
+#### 2. Run
+
+```sh
+./wpt/wpt run \
+  --webdriver-binary ./runBiDiServer.sh \
+  --binary "$WPT_BROWSER_PATH" \
+  --manifest ./wpt/MANIFEST.json \
+  --metadata ./wpt-metadata \
+  chromium \
+  webdriver/tests/bidi/
+```
+
+### Update WPT expectations if needed
+
+#### 1. Run WPT tests with custom `log-wptreport`:
+
+```sh
+./wpt/wpt run \
+  --webdriver-binary ./runBiDiServer.sh \
+  --binary "$WPT_BROWSER_PATH" \
+  --manifest ./wpt/MANIFEST.json \
+  --metadata ./wpt-metadata \
+  --log-wptreport wptreport.json \
+  chromium \
+  webdriver/tests/bidi/
+```
+
+#### 2. Update expectations based on the previous test run:
+
+```sh
+./wpt/wpt update-expectations \
+  --product chromium \
+  --manifest ./wpt/MANIFEST.json \
+  --metadata ./wpt-metadata \
+  ./wptreport.json
+```
+
+# How does it work?
+
+The architecture is described in the
+[WebDriver BiDi in Chrome Context implementation plan](https://docs.google.com/document/d/1VfQ9tv0wPSnb5TI-MOobjoQ5CXLnJJx9F_PxOMQc8kY)
+.
+
+There are 2 main modules:
+
+1. backend WS server in `src`. It runs webSocket server, and for each ws
+   connection runs an instance of browser with BiDi Mapper.
+2. front-end BiDi Mapper in `src/bidiMapper`. Gets BiDi commands from the
+   backend, and map them to CDP commands.
+
+## Contributing
+
+The BiDi commands are processed in the `src/bidiMapper/commandProcessor.ts`. To
+add a new command, add it to `_processCommand`, write and call processor for it.

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "chromium-bidi",
+  "version": "0.0.0",
+  "description": "An implementation of the WebDriver BiDi protocol for Chromium implemented as a JavaScript layer translating between BiDi and CDP, running inside a Chrome tab.",
+  "main": "index.ts",
+  "scripts": {
+    "unit": "cross-env TS_NODE_PROJECT='src/tsconfig.json' mocha",
+    "e2e": "npm run server-no-build & npm run e2e-only",
+    "e2e-only": "python3 -m pytest --rootdir=tests",
+    "server": "npm run build && npm run server-no-build --",
+    "server-no-build": "node ./src/.build/bidiServer/index.js",
+    "build": "npm run prettier && npm run clean && npm run build-mapper && npm run build-server",
+    "build-mapper": "rollup --config src/bidiMapper/rollup.config.js",
+    "build-server": "tsc -b src/tsconfig.json",
+    "clean": "rimraf ./src/.build",
+    "prettier": "npx prettier --write . "
+  },
+  "author": "The Chromium Authors",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "argparse": "^2.0.1",
+    "chai-exclude": "^2.1.0",
+    "debug": "^4.3.1",
+    "puppeteer": "^13.4.0",
+    "ts-node": "^9.1.1",
+    "tslib": "^2.3.1",
+    "websocket": "^1.0.34",
+    "ws": "^7.4.5"
+  },
+  "files": [
+    "src/.build/"
+  ],
+  "devDependencies": {
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.0.4",
+    "@rollup/plugin-typescript": "^8.2.5",
+    "@types/argparse": "^2.0.10",
+    "@types/chai": "^4.2.21",
+    "@types/chai-as-promised": "^7.1.4",
+    "@types/debug": "^4.1.6",
+    "@types/mocha": "^8.2.2",
+    "@types/sinon": "^10.0.2",
+    "@types/websocket": "^1.0.4",
+    "@types/ws": "^7.4.4",
+    "chai": "^4.3.4",
+    "chai-as-promised": "^7.1.1",
+    "cross-env": "^7.0.3",
+    "devtools-protocol": "^0.0.900357",
+    "mocha": "^9.0.1",
+    "prettier": "2.3.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.47.0",
+    "rollup-plugin-node-polyfills": "^0.2.1",
+    "rollup-plugin-string": "^3.0.0",
+    "sinon": "^11.1.1",
+    "typescript": "^4.3.5"
+  }
+}