Add workaround for optional Cookie.expired field

See ChromeDevTools/devtools-protocol#317 Resolves: #494
joffrey-bion · Feb 10, 2025 · ffdbaac · ffdbaac
1 parent dbeb9fc
commit ffdbaac
Show file tree

Hide file tree

Showing 8 changed files with 90 additions and 13 deletions.
diff --git a/api/chrome-devtools-kotlin.api b/api/chrome-devtools-kotlin.api
@@ -29141,8 +29141,8 @@ public final class org/hildan/chrome/devtools/domains/network/ContinueIntercepte
 
 public final class org/hildan/chrome/devtools/domains/network/Cookie {
 	public static final field Companion Lorg/hildan/chrome/devtools/domains/network/Cookie$Companion;
-	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;DIZZZLorg/hildan/chrome/devtools/domains/network/CookieSameSite;Lorg/hildan/chrome/devtools/domains/network/CookiePriority;Ljava/lang/Boolean;Lorg/hildan/chrome/devtools/domains/network/CookieSourceScheme;Ljava/lang/Integer;Lorg/hildan/chrome/devtools/domains/network/CookiePartitionKey;Ljava/lang/Boolean;)V
-	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;DIZZZLorg/hildan/chrome/devtools/domains/network/CookieSameSite;Lorg/hildan/chrome/devtools/domains/network/CookiePriority;Ljava/lang/Boolean;Lorg/hildan/chrome/devtools/domains/network/CookieSourceScheme;Ljava/lang/Integer;Lorg/hildan/chrome/devtools/domains/network/CookiePartitionKey;Ljava/lang/Boolean;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;IZZZLorg/hildan/chrome/devtools/domains/network/CookieSameSite;Lorg/hildan/chrome/devtools/domains/network/CookiePriority;Ljava/lang/Boolean;Lorg/hildan/chrome/devtools/domains/network/CookieSourceScheme;Ljava/lang/Integer;Lorg/hildan/chrome/devtools/domains/network/CookiePartitionKey;Ljava/lang/Boolean;)V
+	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;IZZZLorg/hildan/chrome/devtools/domains/network/CookieSameSite;Lorg/hildan/chrome/devtools/domains/network/CookiePriority;Ljava/lang/Boolean;Lorg/hildan/chrome/devtools/domains/network/CookieSourceScheme;Ljava/lang/Integer;Lorg/hildan/chrome/devtools/domains/network/CookiePartitionKey;Ljava/lang/Boolean;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Ljava/lang/String;
 	public final fun component10 ()Lorg/hildan/chrome/devtools/domains/network/CookieSameSite;
 	public final fun component11 ()Lorg/hildan/chrome/devtools/domains/network/CookiePriority;
@@ -29154,16 +29154,16 @@ public final class org/hildan/chrome/devtools/domains/network/Cookie {
 	public final fun component2 ()Ljava/lang/String;
 	public final fun component3 ()Ljava/lang/String;
 	public final fun component4 ()Ljava/lang/String;
-	public final fun component5 ()D
+	public final fun component5 ()Ljava/lang/Double;
 	public final fun component6 ()I
 	public final fun component7 ()Z
 	public final fun component8 ()Z
 	public final fun component9 ()Z
-	public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;DIZZZLorg/hildan/chrome/devtools/domains/network/CookieSameSite;Lorg/hildan/chrome/devtools/domains/network/CookiePriority;Ljava/lang/Boolean;Lorg/hildan/chrome/devtools/domains/network/CookieSourceScheme;Ljava/lang/Integer;Lorg/hildan/chrome/devtools/domains/network/CookiePartitionKey;Ljava/lang/Boolean;)Lorg/hildan/chrome/devtools/domains/network/Cookie;
-	public static synthetic fun copy$default (Lorg/hildan/chrome/devtools/domains/network/Cookie;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;DIZZZLorg/hildan/chrome/devtools/domains/network/CookieSameSite;Lorg/hildan/chrome/devtools/domains/network/CookiePriority;Ljava/lang/Boolean;Lorg/hildan/chrome/devtools/domains/network/CookieSourceScheme;Ljava/lang/Integer;Lorg/hildan/chrome/devtools/domains/network/CookiePartitionKey;Ljava/lang/Boolean;ILjava/lang/Object;)Lorg/hildan/chrome/devtools/domains/network/Cookie;
+	public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;IZZZLorg/hildan/chrome/devtools/domains/network/CookieSameSite;Lorg/hildan/chrome/devtools/domains/network/CookiePriority;Ljava/lang/Boolean;Lorg/hildan/chrome/devtools/domains/network/CookieSourceScheme;Ljava/lang/Integer;Lorg/hildan/chrome/devtools/domains/network/CookiePartitionKey;Ljava/lang/Boolean;)Lorg/hildan/chrome/devtools/domains/network/Cookie;
+	public static synthetic fun copy$default (Lorg/hildan/chrome/devtools/domains/network/Cookie;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;IZZZLorg/hildan/chrome/devtools/domains/network/CookieSameSite;Lorg/hildan/chrome/devtools/domains/network/CookiePriority;Ljava/lang/Boolean;Lorg/hildan/chrome/devtools/domains/network/CookieSourceScheme;Ljava/lang/Integer;Lorg/hildan/chrome/devtools/domains/network/CookiePartitionKey;Ljava/lang/Boolean;ILjava/lang/Object;)Lorg/hildan/chrome/devtools/domains/network/Cookie;
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getDomain ()Ljava/lang/String;
-	public final fun getExpires ()D
+	public final fun getExpires ()Ljava/lang/Double;
 	public final fun getHttpOnly ()Z
 	public final fun getName ()Ljava/lang/String;
 	public final fun getPartitionKey ()Lorg/hildan/chrome/devtools/domains/network/CookiePartitionKey;

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -145,6 +145,10 @@ tasks.dokkaHtml {
     dependsOn(generateProtocolApi)
 }
 
+tasks.apiDump {
+    dependsOn(generateProtocolApi)
+}
+
 changelog {
     githubUser = github.user
     futureVersionTag = project.version.toString()

diff --git a/...tlin-generator/src/main/kotlin/org/hildan/chrome/devtools/protocol/generator/Generator.kt b/...tlin-generator/src/main/kotlin/org/hildan/chrome/devtools/protocol/generator/Generator.kt
@@ -3,12 +3,11 @@ package org.hildan.chrome.devtools.protocol.generator
 import com.squareup.kotlinpoet.FileSpec
 import org.hildan.chrome.devtools.protocol.json.ChromeProtocolDescriptor
 import org.hildan.chrome.devtools.protocol.json.TargetType
-import org.hildan.chrome.devtools.protocol.json.pullNestedEnumsToTopLevel
 import org.hildan.chrome.devtools.protocol.model.ChromeDPDomain
 import org.hildan.chrome.devtools.protocol.model.toChromeDPDomain
 import org.hildan.chrome.devtools.protocol.names.Annotations
 import org.hildan.chrome.devtools.protocol.names.ExtDeclarations
-import java.nio.file.Files
+import org.hildan.chrome.devtools.protocol.preprocessing.preprocessed
 import java.nio.file.Path
 import kotlin.io.path.*
 
@@ -31,7 +30,7 @@ class Generator(
         generatedSourcesDir.deleteRecursively()
         generatedSourcesDir.createDirectories()
 
-        val domains = loadProtocolDomains()
+        val domains = readProtocolDomains()
         domains.forEach(::generateDomainFiles)
 
         val domainsByName = domains.associateBy { it.names.domainName }
@@ -52,12 +51,12 @@ class Generator(
         generateChildSessionsFiles(childTargets = targets.filterNot { it.kotlinName == "Browser" })
     }
 
-    private fun loadProtocolDomains(): List<ChromeDPDomain> {
+    private fun readProtocolDomains(): List<ChromeDPDomain> {
         val descriptors = protocolFiles.map { ChromeProtocolDescriptor.fromJson(it.readText()) }
         if (descriptors.distinctBy { it.version }.size > 1) {
             error("Some descriptors have differing versions: ${descriptors.map { it.version }}")
         }
-        return descriptors.flatMap { it.domains }.map { it.pullNestedEnumsToTopLevel().toChromeDPDomain() }
+        return descriptors.flatMap { it.domains }.preprocessed().map { it.toChromeDPDomain() }
     }
 
     private fun generateDomainFiles(domain: ChromeDPDomain) {

diff --git a/...hrome/devtools/protocol/json/EnumFixer.kt → ...tools/protocol/preprocessing/EnumFixer.kt b/...hrome/devtools/protocol/json/EnumFixer.kt → ...tools/protocol/preprocessing/EnumFixer.kt
@@ -1,5 +1,6 @@
-package org.hildan.chrome.devtools.protocol.json
+package org.hildan.chrome.devtools.protocol.preprocessing
 
+import org.hildan.chrome.devtools.protocol.json.*
 import org.hildan.chrome.devtools.protocol.names.*
 
 // Workaround for https://github.com/ChromeDevTools/devtools-protocol/issues/244

diff --git a/...tor/src/main/kotlin/org/hildan/chrome/devtools/protocol/preprocessing/JsonPreProcessor.kt b/...tor/src/main/kotlin/org/hildan/chrome/devtools/protocol/preprocessing/JsonPreProcessor.kt
@@ -0,0 +1,43 @@
+package org.hildan.chrome.devtools.protocol.preprocessing
+
+import org.hildan.chrome.devtools.protocol.json.JsonDomain
+import org.hildan.chrome.devtools.protocol.json.JsonDomainParameter
+import org.hildan.chrome.devtools.protocol.json.JsonDomainType
+
+/**
+ * Pre-processes the list of domains from the JSON definitions to work around some issues in the definitions themselves.
+ */
+internal fun List<JsonDomain>.preprocessed(): List<JsonDomain> = this
+    // Workaround for https://github.com/ChromeDevTools/devtools-protocol/issues/317
+    .transformDomainTypeProperty("Network", "Cookie", "expires") { it.copy(optional = true) }
+    // Workaround for https://github.com/ChromeDevTools/devtools-protocol/issues/244
+    .map { it.pullNestedEnumsToTopLevel() }
+
+private fun List<JsonDomain>.transformDomainTypeProperty(
+    domain: String,
+    type: String,
+    property: String,
+    transform: (JsonDomainParameter) -> JsonDomainParameter,
+): List<JsonDomain> = transformDomain(domain) { d ->
+    d.transformType(type) { t ->
+        t.transformProperty(property, transform)
+    }
+}
+
+private fun List<JsonDomain>.transformDomain(
+    name: String,
+    transform: (JsonDomain) -> JsonDomain,
+): List<JsonDomain> = transformIf({ it.domain == name }) { transform(it) }
+
+private fun JsonDomain.transformType(
+    name: String,
+    transform: (JsonDomainType) -> JsonDomainType,
+): JsonDomain = copy(types = types.transformIf({ it.id == name }) { transform(it) })
+
+private fun JsonDomainType.transformProperty(
+    name: String,
+    transform: (JsonDomainParameter) -> JsonDomainParameter,
+): JsonDomainType = copy(properties = properties.transformIf({ it.name == name }) { transform(it) })
+
+private fun <T> List<T>.transformIf(predicate: (T) -> Boolean, transform: (T) -> T): List<T> =
+    map { if (predicate(it)) transform(it) else it }
diff --git a/src/commonMain/kotlin/org/hildan/chrome/devtools/extensions/CrossDomainExtensions.kt b/src/commonMain/kotlin/org/hildan/chrome/devtools/extensions/CrossDomainExtensions.kt
@@ -20,7 +20,9 @@ suspend fun PageSession.clickOnElement(
     clickDuration: Duration = 100.milliseconds,
     mouseButton: MouseButton = MouseButton.left,
 ) {
-    val box = dom.getBoxModel(selector) ?: error("Cannot click on element, no node found using selector '$selector'")
+    val box = dom.getBoxModel(selector)
+        ?: error("Cannot click on element, no node found using selector '$selector'. " +
+                     "If the node might appear later, use PageSession.dom.awaitNodeBySelector(...) first.")
     val elementCenter = box.content.center
 
     input.dispatchMouseClick(

diff --git a/src/jvmTest/kotlin/IntegrationTestBase.kt b/src/jvmTest/kotlin/IntegrationTestBase.kt
@@ -1,13 +1,15 @@
 import io.ktor.client.*
 import io.ktor.client.plugins.websocket.*
 import kotlinx.coroutines.*
+import kotlinx.coroutines.flow.first
 import kotlinx.serialization.*
 import kotlinx.serialization.json.*
 import org.hildan.chrome.devtools.domains.accessibility.*
 import org.hildan.chrome.devtools.domains.backgroundservice.*
 import org.hildan.chrome.devtools.domains.dom.*
 import org.hildan.chrome.devtools.domains.domdebugger.*
 import org.hildan.chrome.devtools.domains.runtime.*
+import org.hildan.chrome.devtools.extensions.clickOnElement
 import org.hildan.chrome.devtools.protocol.*
 import org.hildan.chrome.devtools.protocol.json.*
 import org.hildan.chrome.devtools.sessions.*
@@ -291,6 +293,27 @@ abstract class IntegrationTestBase {
         }
     }
 
+    @OptIn(ExperimentalChromeApi::class)
+    @Test
+    open fun missingExpiresInCookie() {
+        runBlockingWithTimeout {
+            chromeWebSocket().use { browser ->
+                browser.newPage().use { page ->
+                    page.goto("https://x.com")
+                    page.network.enable()
+                    coroutineScope {
+                        launch {
+                            // ensures we don't crash on deserialization
+                            page.network.responseReceivedExtraInfoEvents().first()
+                        }
+                        page.dom.awaitNodeBySelector("a[href=\"/login\"]")
+                        page.clickOnElement("a[href=\"/login\"]")
+                    }
+                }
+            }
+        }
+    }
+
     protected fun runBlockingWithTimeout(block: suspend CoroutineScope.() -> Unit) = runBlocking {
         withTimeout(1.minutes, block)
     }

diff --git a/src/jvmTest/kotlin/ZenikaIntegrationTests.kt b/src/jvmTest/kotlin/ZenikaIntegrationTests.kt
@@ -2,6 +2,7 @@ import org.testcontainers.containers.*
 import org.testcontainers.junit.jupiter.*
 import org.testcontainers.junit.jupiter.Container
 import org.testcontainers.utility.*
+import kotlin.test.Ignore
 
 @Testcontainers
 class ZenikaIntegrationTests : LocalIntegrationTestBase() {
@@ -23,4 +24,8 @@ class ZenikaIntegrationTests : LocalIntegrationTestBase() {
 
     override val wsConnectUrl: String
         get() = "http://localhost:${zenikaChrome.firstMappedPort}"
+
+    @Ignore("The Zenika container seems out of data and still treats cookiePartitionKey as a string instead of object")
+    override fun missingExpiresInCookie() {
+    }
 }