1.39

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Install latest nightly
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+          toolchain: nightly
           override: true
           components: rustfmt, clippy
 

.gitignore

@@ -2,3 +2,7 @@ target
 Cargo.lock
 driver
 tarpaulin-report.html
+/.idea/
+/playwright-rust-randall.iml
+/scripts/scripts.iml
+/src/api/generated.rs

.rustfmt.toml

@@ -1,4 +1,4 @@
-edition = "2018"
+edition = "2021"
 unstable_features = true
 fn_single_line = true
 trailing_comma = "Never"

Cargo.toml

@@ -8,7 +8,7 @@ documentation = "https://docs.rs/playwright/"
 repository = "https://github.com/octaltree/playwright-rust"
 categories = ["web-programming"]
 keywords = ["testing", "headless", "web", "browser", "automation"]
-edition = "2018"
+edition = "2021"
 build = "src/build.rs"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -20,23 +20,24 @@ reqwest = { version = "0.11.4", features = ["blocking"] }
 log = "0.4.14"
 serde = { version = "1.0.126", features = ["derive"] }
 serde_json = "1.0.66"
-zip = "0.5.13"
+zip = "0.6.4"
 thiserror = "1.0.26"
 strong = { version = "0.3.4", features = ["serde", "shorthand"] }
 tokio = { version = "1.9.0", features = ["sync", "rt-multi-thread", "macros"] }
 actix-rt = { version = "2.2.0", optional = true }
 async-std = { version = "1.9.0", features = ["attributes"], optional = true }
-dirs = "3.0.2"
+dirs = "5.0.0"
 paste = "1.0.5"
-base64 = "0.13.0"
+base64 = "0.21.0"
 itertools = "0.10.1"
 chrono = { version = "0.4.19", optional = true, features = ["serde"] }
 tokio-stream = { version = "0.1.7", features = ["sync"] }
 futures = "0.3.16"
-serde_with = { version = "1.9.4", default-features = false, features = ["macros"] }
+serde_with = { version = "2.3.2", default-features = false, features = ["macros"] }
+parking_lot = "0.12.1"
 
 [dev-dependencies]
-env_logger = "0.9.0"
+env_logger = "0.10.0"
 tempdir = "0.3.7"
 tide = "0.16.0"
 warp = "0.3.1"

scripts/Cargo.toml

@@ -8,14 +8,20 @@ edition = "2018"
 [dependencies]
 anyhow = "1.0.41"
 case = "1.0.0"
+itertools = "0.10.3"
 proc-macro2 = "1.0.27"
 quote = "1.0.9"
 serde = { version = "1.0.126", features = ["derive"] }
 serde_json = "1.0.64"
+serde_yaml = "0.9.2"
 
 [[bin]]
-name = "gen"
-path = "src/gen.rs"
+name = "generate_api"
+path = "src/generate_api.rs"
+
+[[bin]]
+name = "generate_protocol"
+path = "src/generate_protocol.rs"
 
 [[bin]]
 name = "diff"

scripts/Makefile

@@ -1,9 +1,25 @@
-../src/api/generated.rs: ../src/api/api.json
-	rustfmt --emit stdout <(cargo run --bin gen < $^)| tail +3 > $@
-	sed -i 's/\[actionability\](.\/actionability.md)/[actionability](https:\/\/playwright.dev\/docs\/actionability\/)/g' $@
+.PHONY: clean nop
+nop:
+
+SRC=$(shell find src)
+
+clean_driver:
+	rm -r /tmp/build-playwright-rust
+	rm -r ~/.cache/ms-playwright/playwright-rust
 
 ../src/api/api.json: ../src/build.rs
 	cd .. && cargo run print-api-json |jq > src/api/api.json
 
+../src/protocol/protocol.yml: ../src/api/api.json
+	cp ~/.cache/ms-playwright/playwright-rust/driver/package/protocol.yml $@
+
+../src/api/generated.rs: ../src/api/api.json ${SRC}
+	cargo run --bin generate_api < $< > $@
+	rustfmt +nightly --config-path ../.rustfmt.toml $@
+
+../src/protocol/generated.rs: ../src/protocol/protocol.yml ${SRC}
+	cat $<| sed 's#null#"null"#'| cargo run --bin generate_protocol > $@
+	rustfmt +nightly --config-path ../.rustfmt.toml $@
+
 diff:
-	cargo run --bin diff <(git show master:src/api/api.json) <(git show HEAD:src/api/api.json)
+	cargo run --bin diff <(git show master:src/api/api.json) ../src/api/api.json

scripts/driver_commit.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+# find commit corresponding to the driver
+# use in latest main of playwright
+
+function check(){
+  [ `same_protocol` -ne 0 ] || [ `same_api` -ne 0 ]
+}
+
+function same_protocol(){
+  diff ~/.cache/ms-playwright/playwright-rust/driver/package/protocol.yml packages/playwright-core/src/protocol/protocol.yml| wc -l
+}
+
+function same_api(){
+  API_JSON_MODE=1 node utils/doclint/generateApiJson.js > ./output/api.json
+  diff ~/.cache/ms-playwright/playwright-rust/driver/package/api.json output/api.json| wc -l
+}
+
+while check; do
+  git checkout HEAD~
+done

scripts/src/api.rs

@@ -0,0 +1,214 @@
+pub mod types;
+
+use serde::{Deserialize, Deserializer, Serialize};
+
+#[derive(Debug, Deserialize)]
+#[serde(transparent)]
+pub struct Api(pub Vec<Interface>);
+
+#[derive(Debug, Deserialize)]
+pub struct Interface {
+    pub name: String,
+    // langs
+    //#[serde(default)]
+    // pub comment: String,
+    pub spec: Vec<SpecNode>,
+    pub members: Vec<Member>,
+    pub extends: Option<String>
+}
+
+/// ex. {"name": "toMatchSnapshot#2", "alias": "toMatchSnapshot", "overloadIndex": 1}
+#[derive(Debug, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Member {
+    pub kind: Kind,
+    pub name: String,
+    pub alias: String,
+    pub experimental: bool,
+    pub since: String,
+    pub overload_index: usize,
+    pub required: bool,
+    #[serde(rename = "async")]
+    pub is_async: bool,
+    pub args: Vec<Arg>,
+    #[serde(rename = "type")]
+    pub ty: Type,
+    // langs
+    // paramOrOption null
+    #[serde(default)]
+    #[serde(deserialize_with = "string_as_bool")]
+    pub deprecated: bool,
+    //#[serde(default)]
+    // pub comment: String,
+    pub spec: Vec<SpecNode>
+}
+
+fn string_as_bool<'de, D>(deserializer: D) -> Result<bool, D::Error>
+    where
+        D: Deserializer<'de>,
+{
+    let s = <String as Deserialize>::deserialize(deserializer);
+    Ok(match s {
+        Err(_) => false,
+        _ => true
+    })
+}
+
+
+#[derive(Debug, Deserialize, PartialEq, Eq, Clone, Copy)]
+#[serde(rename_all = "camelCase")]
+pub enum Kind {
+    Event,
+    Method,
+    Property
+}
+
+#[derive(Debug, PartialEq, Deserialize, Serialize, Eq, Clone)]
+pub struct Type {
+    pub name: String,
+    #[serde(default)]
+    pub expression: Option<String>,
+    #[serde(default)]
+    pub properties: Vec<Arg>,
+    #[serde(default)]
+    pub templates: Vec<Type>,
+    #[serde(default)]
+    pub union: Vec<Type>
+}
+
+#[derive(Debug, PartialEq, Deserialize, Serialize, Eq, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct Arg {
+    pub name: String,
+    pub kind: ArgKind,
+    pub alias: String,
+    #[serde(rename = "type")]
+    pub ty: Type,
+    pub langs: Langs,
+    // experimental
+    // paramOrOption
+    pub since: String,
+    pub overload_index: usize,
+    // pub comment: String,
+    #[serde(default)]
+    pub spec: Vec<SpecNode>,
+    pub required: bool,
+    #[serde(default)]
+    #[serde(deserialize_with = "string_as_bool")]
+    pub deprecated: bool,
+    #[serde(rename = "async")]
+    pub is_async: bool
+}
+
+#[derive(Debug, Deserialize, Serialize, PartialEq, Eq, Clone, Copy)]
+#[serde(rename_all = "camelCase")]
+pub enum ArgKind {
+    Property
+}
+
+#[derive(Debug, Deserialize, Serialize, PartialEq, Eq, Clone)]
+#[serde(tag = "type")]
+#[serde(rename_all = "camelCase")]
+pub enum SpecNode {
+    Text {
+        text: String
+    },
+    Code {
+        #[serde(rename = "codeLang")]
+        lang: String,
+        lines: Vec<String>
+    },
+    Li {
+        #[serde(rename = "liType")]
+        li_type: LiType,
+        text: String
+    },
+    Note {
+        #[serde(rename = "noteType")]
+        note_type: NoteType,
+        text: String
+    }
+}
+
+#[derive(Debug, Deserialize, Serialize, PartialEq, Eq, Clone, Copy)]
+#[serde(rename_all = "camelCase")]
+pub enum LiType {
+    Bullet,
+    Ordinal
+}
+
+#[derive(Debug, Deserialize, Serialize, PartialEq, Eq, Clone, Copy)]
+#[serde(rename_all = "camelCase")]
+pub enum NoteType {
+    #[serde(rename = "caution Discouraged")]
+    CautionDiscouraged,
+    Caution,
+    Note,
+    Warning
+}
+
+#[derive(Debug, Deserialize, Serialize, PartialEq, Eq, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct Langs {
+    pub only: Option<Vec<String>>
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::fs;
+
+    #[test]
+    fn all_api_types() {
+        let mut types = Vec::new();
+        fn add<'a>(dest: &mut Vec<&'a Type>, t: &'a Type) {
+            let Type {
+                name,
+                expression: _,
+                properties,
+                templates,
+                union
+            }: &Type = t;
+            dest.push(t);
+            for arg in properties {
+                add(dest, &arg.ty);
+            }
+            for ty in templates {
+                add(dest, ty);
+            }
+            for ty in union {
+                add(dest, ty);
+            }
+        }
+        let s = fs::read_to_string("../src/api/api.json").unwrap();
+        let api: Api = serde_json::from_str(&s).unwrap();
+        for interface in &api.0 {
+            for member in &interface.members {
+                for arg in &member.args {
+                    add(&mut types, &arg.ty);
+                }
+                add(&mut types, &member.ty);
+            }
+        }
+        println!("{}", serde_json::to_string(&types).unwrap());
+    }
+
+    #[test]
+    fn parse() {
+        let xs:Vec<SpecNode> = serde_json::from_str(r#"
+            [{
+            "type": "text",
+            "text": "Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page."
+          },
+          {
+            "type": "note",
+            "noteType": "note",
+            "text": "The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Playwright will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`."
+          },
+          {
+            "type": "text",
+            "text": "An example of dumping the entire accessibility tree:"
+          }]
+            "#).unwrap();
+    }
+}