From f0623bf4999fb2cb01d7997352f5af46dfc66efe Mon Sep 17 00:00:00 2001 From: Christian Biesinger Date: Wed, 26 Apr 2023 14:27:28 -0400 Subject: [PATCH 1/6] Add WebDriver commands --- spec/index.bs | 239 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 237 insertions(+), 2 deletions(-) diff --git a/spec/index.bs b/spec/index.bs index 5d85f73f..c5c5fc3e 100644 --- a/spec/index.bs +++ b/spec/index.bs @@ -29,6 +29,17 @@ spec: ecma262; urlPrefix: https://tc39.github.io/ecma262/ spec: credential-management-1; urlPrefix: https://w3c.github.io/webappsec-credential-management/ type: dfn text: same-origin with its ancestors; url: same-origin-with-its-ancestors +spec: webdriver; urlPrefix: https://w3c.github.io/webdriver/ + type: dfn + text: extension command; url: dfn-extension-commands + text: getting a property; url: dfn-getting-properties + text: invalid argument; url: dfn-invalid-argument + text: no such alert; url: dfn-no-such-alert + text: remote end steps; url: dfn-remote-end-steps + text: success; url: dfn-success + text: undefined; url: dfn-undefined + text: WebDriver error; url: dfn-error + text: WebDriver error code; url: dfn-error-code 
@@ -442,7 +453,7 @@ NOTE: The {{CredentialRequestOptions/mediation}} flag is currently not used.
 The {{CredentialRequestOptions/signal}} is used as an abort signal for the
 requests.
 
-

+

 When the {{IdentityCredential}}'s
 \[[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors)
 algorithm is invoked, the user agent MUST execute the following steps. This returns an
@@ -454,7 +465,8 @@ algorithm is invoked, the user agent MUST execute the following steps. This retu
 
           Issue: Support choosing accounts from multiple [=IDP=]s, as described [here](https://github.com/fedidcg/FedCM/issues/319).
     1. Run {{WindowOrWorkerGlobalScope/setTimeout()}} passing a [=task=] which throws a
-        {{NetworkError}}, after a timeout of 60 seconds.
+        {{NetworkError}}, after a timeout of 60 seconds, unless this promise rejection
+        delay was disabled by [=setdelayenabled|user agent automation=].
 
         Issue: Do not use {{WindowOrWorkerGlobalScope/setTimeout()}} directly, as that is not correct. See the relevant
         [issue](https://github.com/fedidcg/FedCM/issues/389).
@@ -1358,6 +1370,229 @@ occur when there is access to the [=current settings object=]. The [=internal me
 modified by this specification do not have such access since they are invoked [=in parallel=]
 by {{CredentialsContainer}}'s Request a `Credential` abstract operation.
 
+
+# User Agent Automation # {#automation}
+
+
+For the purposes of user agent automation and website testing, this document
+defines the below [[WebDriver2]] [=extension commands=].
+
+## WebDriver extension commands ## {#webdriver-commands}
+
+These WebDriver [=extension commands=] allow automated interactions with any
+active FedCM dialogs.
+
+

+    
+        
+            
+                
+                
+            
+        
+        
+            
+                
+                
+            
+        
+    
HTTP MethodURI Template
POST`/session/{session id}/fedcm/canceldialog`

+

+
+The [=remote end steps=] are:
+
+1. If |parameters| is not a JSON [[ECMASCRIPT#sec-json-object|Object]], return a
+    [=WebDriver error=] with [=WebDriver error code=] [=invalid argument=].
+
+1. If no FedCM dialog is currently open, return a [=WebDriver error=] with
+    [=WebDriver error code=] [=no such alert=].
+
+1. Close the dialog and continue the [=create an IdentityCredential=] algorithm
+    as if the user had canceled the dialog without choosing an account.
+
+1. Return [=success=] with data `null`.
+
+

+    
+        
+            
+                
+                
+            
+        
+        
+            
+                
+                
+            
+        
+    
HTTP MethodURI Template
POST`/session/{session id}/fedcm/selectaccount`

+

+
+The [=remote end steps=] are:
+
+1. If |parameters| is not a JSON [[ECMASCRIPT#sec-json-object|Object]], return a
+    [=WebDriver error=] with [=WebDriver error code=] [=invalid argument=].
+
+1. If no FedCM dialog is currently open, return a [=WebDriver error=] with
+    [=WebDriver error code=] [=no such alert=].
+
+1. Let |accountIndex| be the result of [=getting a property=] named `"accountIndex"`
+    from |parameters|.
+
+1. If |accountIndex| is [=undefined=] or is not in the range from 0 to the
+    number of accounts that the user can choose from in the current flow,
+    return a [=WebDriver error=] with [=WebDriver error code=] [=invalid
+    argument=].
+
+1. Close the dialog and continue the [=create an IdentityCredential=] algorithm
+    as if the user had selected the account indicated by |accountIndex| and
+    [=request permission to sign-up|granted permission to sign-up=], if applicable.
+
+1. Return [=success=] with data `null`.
+
+
+

+    
+        
+            
+                
+                
+            
+        
+        
+            
+                
+                
+            
+        
+    
HTTP MethodURI Template
GET`/session/{session id}/fedcm/accountlist`

+

+
+The [=remote end steps=] are:
+
+1. If no FedCM dialog is currently open, return a [=WebDriver error=] with
+    [=WebDriver error code=] [=no such alert=].
+
+1. Let |accounts| be the list of accounts that the user can or could choose
+    from in the current flow.
+
+1. Let |list| be an empty list.
+
+1. For each |account| in |accounts|:
+    1. Let |accountState| be the result of running the [=compute account state=]
+        algorithm given |account|
+    1. Append an object to |list| with the following properties:
+        1. `accountId` set to the account's {{IdentityProviderAccount/id}}
+        1. `email` set to the account's {{IdentityProviderAccount/email}}
+        1. `name` set to the account's {{IdentityProviderAccount/name}}
+        1. `givenName` set to the account's {{IdentityProviderAccount/given_name}},
+            if present
+        1. `pictureUrl` set to the account's {{IdentityProviderAccount/picture}},
+            if present.
+        1. `idpConfigUrl` set to the {{IdentityProviderConfig/configURL}} of the
+            IDP this account belongs to
+        1. `loginState` to `"SignUp"` if |accountState|'s {{AccountState/registration
+            state}} is {{unregistered}} and `"SignIn"` otherwise
+        1. `termsOfServiceUrl` to the {{IdentityProviderClientMetadata/terms_of_service_url}}
+            if one was provided and the `loginState` is `"SignUp"`
+        1. `privacyPolicyUrl` to the {{IdentityProviderClientMetadata/privacy_policy_url}}
+            if one was provided and the `loginState` is `"SignUp"`
+
+1. Return [=success=] with data |list|.
+
+

+    
+        
+            
+                
+                
+            
+        
+        
+            
+                
+                
+            
+        
+    
HTTP MethodURI Template
GET`/session/{session id}/fedcm/gettitle`

+

+
+Note: This command lets automation verify that the
+    [https://github.com/fedidcg/FedCM/blob/main/proposals/context-api.md](context API)
+    was applied properly
+
+The [=remote end steps=] are:
+
+1. If no FedCM dialog is currently open, return a [=WebDriver error=] with
+    [=WebDriver error cset asdf  sdzf aasfgode=] [=no such alert=].
+
+1. Let |data| be a dictionary with an object with properties as follows:
+    1. `title` set to the title of the open dialog
+    1. `subtitle` set to the subtitle of the open dialog, if there is one
+
+1. Return [=success=] with data |data|.
+
+
+

+    
+        
+            
+                
+                
+            
+        
+        
+            
+                
+                
+            
+        
+    
HTTP MethodURI Template
POST`/session/{session id}/fedcm/setdelayenabled`

+

+
+The [=remote end steps=] are:
+
+1. If |parameters| is not a JSON [[ECMASCRIPT#sec-json-object|Object]], return a
+     [=WebDriver error=] with [=WebDriver error code=] [=invalid argument=].
+
+1. Let |enabled| be the result of [=getting a property=] named `"enabled"` from
+    |parameters|.
+
+1. If |enabled| is [=undefined=] or is not a boolean, return a [=WebDriver error=]
+    with [=WebDriver error code=] [=invalid argument=].
+
+1. If |enabled| is false, disables the [=promise rejection delay=]; otherwise,
+    re-enables it.
+
+1. Return [=success=] with data `null`.
+
+
+

+    
+        
+            
+                
+                
+            
+        
+        
+            
+                
+                
+            
+        
+    
HTTP MethodURI Template
POST`/session/{session id}/fedcm/resetcooldown`

+

+
+The [=remote end steps=] are:
+
+1. If the user agent uses a cooldown delay, which disables the API for an
+    amount of time after the user dismissed the dialog, then this command
+    resets that cooldown such that the next FedCM call can succeed again.
+
+1. Return [=success=] with data `null`.
+
 
 # Security # {#security}
 

From 4edb03ba83d5bd28e8246977838d70e3327cd9b6 Mon Sep 17 00:00:00 2001
From: Christian Biesinger 
Date: Mon, 1 May 2023 18:25:42 -0400
Subject: [PATCH 2/6] review comments

---
 spec/index.bs | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/spec/index.bs b/spec/index.bs
index c5c5fc3e..d2f85f8f 100644
--- a/spec/index.bs
+++ b/spec/index.bs
@@ -1375,13 +1375,11 @@ by {{CredentialsContainer}}'s Request a `Credential` abstract
 
 
 For the purposes of user agent automation and website testing, this document
-defines the below [[WebDriver2]] [=extension commands=].
-
-## WebDriver extension commands ## {#webdriver-commands}
-
-These WebDriver [=extension commands=] allow automated interactions with any
+defines the below [[WebDriver2]] [=extension commands=] to interact with any
 active FedCM dialogs.
 
+## Cancel dialog ## {#webdriver-canceldialog}
+
 

     
@@ -1401,9 +1399,6 @@ active FedCM dialogs.
 
 The [=remote end steps=] are:
 
-1. If |parameters| is not a JSON [[ECMASCRIPT#sec-json-object|Object]], return a
-    [=WebDriver error=] with [=WebDriver error code=] [=invalid argument=].
-
 1. If no FedCM dialog is currently open, return a [=WebDriver error=] with
     [=WebDriver error code=] [=no such alert=].
 
@@ -1412,6 +1407,8 @@ The [=remote end steps=] are:
 
 1. Return [=success=] with data `null`.
 
+## Select account ## {#webdriver-selectaccount}
+
 

     

         

@@ -1451,6 +1448,7 @@ The [=remote end steps=] are:
 
 1. Return [=success=] with data `null`.
 
+## Account list ## {#webdriver-accountlist}
 
 

     

         

@@ -1501,6 +1499,8 @@ The [=remote end steps=] are:
 
 1. Return [=success=] with data |list|.
 
+## Get title ## {#webdriver-gettitle}
+
 

     

@@ -1525,7 +1525,7 @@ Note: This command lets automation verify that the
 The [=remote end steps=] are:
 
 1. If no FedCM dialog is currently open, return a [=WebDriver error=] with
-    [=WebDriver error cset asdf  sdzf aasfgode=] [=no such alert=].
+    [=WebDriver error=] [=no such alert=].
 
 1. Let |data| be a dictionary with an object with properties as follows:
     1. `title` set to the title of the open dialog
@@ -1533,6 +1533,7 @@ The [=remote end steps=] are:
 
 1. Return [=success=] with data |data|.
 
+## Set delay enabled ## {#webdriver-setdelayenabled}
 
 

     

         

@@ -1545,7 +1546,7 @@ The [=remote end steps=] are:
         
-                
+                

             

                 POST`/session/{session id}/fedcm/setdelayenabled``/session/{session id}/fedcm/``setdelayenabled`
             

         
     

@@ -1567,6 +1568,7 @@ The [=remote end steps=] are:
 
 1. Return [=success=] with data `null`.
 
+## Reset cooldown ## {#webdriver-resetcooldown}
 
 

     

From ea16de215fe0bd139b1bcdd18ce5222faa5c6666 Mon Sep 17 00:00:00 2001
From: Christian Biesinger 
Date: Mon, 8 May 2023 12:10:56 -0400
Subject: [PATCH 3/6] review comments

---
 spec/index.bs | 49 ++++++++++++++++++++++---------------------------
 1 file changed, 22 insertions(+), 27 deletions(-)

diff --git a/spec/index.bs b/spec/index.bs
index d2f85f8f..8c63e680 100644
--- a/spec/index.bs
+++ b/spec/index.bs
@@ -31,15 +31,9 @@ spec: credential-management-1; urlPrefix: https://w3c.github.io/webappsec-creden
         text: same-origin with its ancestors; url: same-origin-with-its-ancestors
 spec: webdriver; urlPrefix: https://w3c.github.io/webdriver/
     type: dfn
-        text: extension command; url: dfn-extension-commands
         text: getting a property; url: dfn-getting-properties
-        text: invalid argument; url: dfn-invalid-argument
         text: no such alert; url: dfn-no-such-alert
-        text: remote end steps; url: dfn-remote-end-steps
-        text: success; url: dfn-success
-        text: undefined; url: dfn-undefined
-        text: WebDriver error; url: dfn-error
-        text: WebDriver error code; url: dfn-error-code
+        text: error code; url: dfn-error-code
 
 
 
@@ -48,6 +42,7 @@ spec:infra; type:dfn; text:user agent
 spec:html; type:dfn; for:environment settings object; text:global object
 spec:html; type:dfn; for:html-origin-def; text:origin
 spec:webidl; type:dfn; text:resolve
+spec:webdriver2; type:dfn; text:error