Added WebDriver DeleteCookies Function #23006

aditj · 2019-03-09T08:55:36Z

This change adds DeleteCookies function of the webdriver crate to the servo webdriver server.
See spec

./mach build -d does not report any errors
./mach test-tidy does not report any errors
These changes fix part of #8623 (GitHub issue number if applicable)

There are tests for these changes OR
These changes do not require tests because ___

This change is

highfive · 2019-03-09T08:55:42Z

Heads up! This PR modifies the following files:

@asajeffrey: components/webdriver_server/lib.rs
@jgraham: components/webdriver_server/lib.rs

jdm

Good start! We need to make some changes to fully match the specification, however.

jdm · 2019-03-14T16:12:51Z

components/net/resource_thread.rs

@@ -236,6 +236,10 @@ impl ResourceChannelManager {
                    http_state,
                ),
            },
+            CoreResourceMsg::DeleteCookies() => {
+                http_state.cookie_jar.write().unwrap().clear_storage();


According to https://w3c.github.io/webdriver/#dfn-delete-cookies (which is invoked from https://w3c.github.io/webdriver/#dfn-delete-all-cookies) this can delete more cookies than we want. We will want a message that includes the list of cookies to delete and the URL associated with the deletion request.

According to https://w3c.github.io/webdriver/#dfn-delete-cookies (which is invoked from https://w3c.github.io/webdriver/#dfn-delete-all-cookies) this can delete more cookies than we want. We will want a message that includes the list of cookies to delete and the URL associated with the deletion request.

I think we dont need to give a list of cookies and the URL associated since the spec we need to delete all the cookies pertaining to a particular document. (I dont find the need of a URL)

You're right about one part; https://w3c.github.io/webdriver/#dfn-associated-cookies means that we do not need to create a list of cookies to delete ahead of time. However, https://w3c.github.io/webdriver/#dfn-delete-cookies means that we some way of indexing into the cookie storage (see how CookieStorage::cookies_for_url does that).

We still need to accept a URL in this message and use that to clear only the cookies for that document.

jdm · 2019-03-14T16:12:51Z

components/webdriver_server/lib.rs

@@ -970,6 +970,13 @@ impl Handler {
        }
    }

+    fn handle_delete_cookies(&self) -> WebDriverResult<WebDriverResponse> {
+        let (sender,_) = ipc::channel().unwrap();


We should wait for the response from the receiver that's created here and return any error that occurs.

jdm · 2019-03-14T16:12:51Z

components/net/cookie_storage.rs

@@ -83,7 +83,9 @@ impl CookieStorage {
            Ok(None)
        }
    }
-
+    pub fn clear_storage(&mut self) {
+        self.cookies_map.clear();


According to https://w3c.github.io/webdriver/#dfn-delete-cookies we should set the cookie expiry time to the past, rather than deleting the actual stored cookie.

Okay I'll try to implement that :)

@jdm a little help , what should I assign the value of cookie's expiry_time variable to?

Try now().to_timespec() - Duration::seconds(1)?

I dont think we need it in timespec since the type of expiry_time is Tm.

jdm · 2019-03-14T16:12:51Z

components/script/script_thread.rs

@@ -1840,6 +1840,9 @@ impl ScriptThread {
            WebDriverScriptCommand::AddCookie(params, reply) => {
                webdriver_handlers::handle_add_cookie(&*documents, pipeline_id, params, reply)
            },
+            WebDriverScriptCommand::DeleteCookies(reply) => {
+                webdriver_handlers::handle_delete_cookies(&*documents,reply)


We should pass pipeline_id in order to choose a particular document.

Okay I'll delete cookies of a particular document.
But I think this discussion is worth a read.

jdm · 2019-03-14T16:12:51Z

components/script/webdriver_handlers.rs

@@ -356,6 +356,17 @@ pub fn handle_add_cookie(
        .unwrap();
 }

+pub fn handle_delete_cookies(documents: &Documents,reply: IpcSender<Result<(),()>>) {
+    for (id, document) in documents.iter() {


We will want to:

choose a particular document

get all of its cookies

send a message deleting those cookies for this document's URL

@jdm is the algorithm compliant now?

servo-wpt-sync · 2019-03-15T23:09:31Z

Error syncing changes upstream. Logs saved in error-snapshot-1552691546047.

servo-wpt-sync · 2019-03-15T23:14:38Z

Error syncing changes upstream. Logs saved in error-snapshot-1552691852886.

jdm · 2019-04-08T17:15:23Z

Unfortunately something went wrong with the last rebase (or merge), so we will need to figure out how to extract the actual changes from this PR's list of commits.

CYBAI · 2019-04-16T08:11:03Z

If it's hard to rebase, I'd suggest

cherry-pick the commit for this PR into a new branch based on latest master
rename aditj-patch-7 to a temp name
rename the new branch to aditj-patch-7

Then you should be able to have a clean branch 🤔 After confirming the new branch works fine, then you can remove the old branch which you renamed at step 2.

aditj · 2019-04-17T09:42:01Z

If it's hard to rebase, I'd suggest

cherry-pick the commit for this PR into a new branch based on latest master

rename aditj-patch-7 to a temp name

rename the new branch to aditj-patch-7

Then you should be able to have a clean branch After confirming the new branch works fine, then you can remove the old branch which you renamed at step 2.

Its a merge commit,cherry-pick isn't working :(

jdm · 2019-04-18T14:39:06Z

@aditj In that case, I recommend taking the output of https://patch-diff.githubusercontent.com/raw/servo/servo/pull/23006.diff, saving it, then running git reset --hard 04c93c511b021a1e76512f997992667540657c4e, followed by git apply 23006.diff, committing the changes, then force pushing your branch.

aditj · 2019-04-18T15:17:19Z

@aditj In that case, I recommend taking the output of https://patch-diff.githubusercontent.com/raw/servo/servo/pull/23006.diff, saving it, then running git reset --hard 04c93c511b021a1e76512f997992667540657c4e, followed by git apply 23006.diff, committing the changes, then force pushing your branch.

Thanks @jdm ! I didnt know such a tool existed 😄 , I'll try it!

aditj · 2019-04-18T15:27:11Z

@jdm I (and git) can't find that commit id , where did you get it from?

jdm · 2019-04-18T15:47:29Z

@aditj That was the most recent commit from master. If you git fetch from servo/servo, you should be able to use it.


        Add webdriver deletecookies function

aditj · 2019-04-19T07:47:37Z

@aditj That was the most recent commit from master. If you git fetch from servo/servo, you should be able to use it.

I think it looks clean now :D
Thanks a lot @jdm and @CYBAI !

jdm · 2019-04-19T13:48:26Z

@bors-servo r+

bors-servo · 2019-04-19T13:48:27Z

📌 Commit 64961cc has been approved by jdm

bors-servo · 2019-04-19T13:48:31Z

⌛ Testing commit 64961cc with merge 53b752b...


        Auto merge of #23006 - aditj:aditj-patch-7, r=jdm

Added WebDriver DeleteCookies Function  This change adds DeleteCookies function of the webdriver crate to the servo webdriver server. See [spec](https://w3c.github.io/webdriver/#delete-all-cookies) ---  - [x] `./mach build -d` does not report any errors - [X] `./mach test-tidy` does not report any errors - [X] These changes fix part of #8623 (GitHub issue number if applicable)  - [X] There are tests for these changes OR - [ ] These changes do not require tests because ___    --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/23006)

bors-servo · 2019-04-19T16:42:11Z

☀️ Test successful - android-mac, arm32, arm64, linux-rel-css, linux-rel-wpt, mac-rel-css1, mac-rel-css2, mac-rel-wpt1, mac-rel-wpt2, mac-rel-wpt3, mac-rel-wpt4, magicleap, status-taskcluster
Approved by: jdm
Pushing 53b752b to master...

highfive assigned emilio Mar 9, 2019

highfive added the S-awaiting-review label Mar 9, 2019

aditj force-pushed the aditj:aditj-patch-7 branch 11 times, most recently from 3b7c38c to 841e71a Mar 9, 2019

jdm requested changes Mar 14, 2019

View changes

jdm added S-needs-code-changes and removed S-awaiting-review labels Mar 14, 2019

jdm assigned jdm and unassigned emilio Mar 14, 2019

aditj force-pushed the aditj:aditj-patch-7 branch from 841e71a to 328dbd6 Mar 14, 2019

highfive added S-awaiting-review and removed S-needs-code-changes labels Mar 14, 2019

aditj force-pushed the aditj:aditj-patch-7 branch 5 times, most recently from 289142a to a3b1ab7 Mar 14, 2019

aditj force-pushed the aditj:aditj-patch-7 branch from a3b1ab7 to 4f34cb5 Mar 15, 2019

jdm added the S-needs-code-changes label Apr 8, 2019

aditj force-pushed the aditj:aditj-patch-7 branch from c35438b to 8aa20ba Apr 12, 2019

highfive added S-awaiting-review and removed S-needs-code-changes labels Apr 12, 2019

aditj force-pushed the aditj:aditj-patch-7 branch 2 times, most recently from 1589f5b to 2f70220 Apr 12, 2019

jdm removed the S-awaiting-review label Apr 16, 2019

aditj force-pushed the aditj:aditj-patch-7 branch from 2f70220 to d0024fb Apr 17, 2019

highfive added the S-awaiting-review label Apr 17, 2019

Add webdriver deletecookies function

Loading status checks…

64961cc

aditj force-pushed the aditj:aditj-patch-7 branch from d0024fb to 64961cc Apr 19, 2019

CYBAI removed the S-needs-rebase label Apr 19, 2019

highfive added S-awaiting-merge and removed S-awaiting-review labels Apr 19, 2019

highfive removed the S-awaiting-merge label Apr 19, 2019

Ms2ger mentioned this pull request Apr 19, 2019

Implement all webdriver commands. #8623

Open

servo / servo

Added WebDriver DeleteCookies Function #23006

Added WebDriver DeleteCookies Function #23006

aditj commented Mar 9, 2019 •

edited

highfive commented Mar 9, 2019

jdm left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

servo-wpt-sync commented Mar 15, 2019

servo-wpt-sync commented Mar 15, 2019

jdm commented Apr 8, 2019

CYBAI commented Apr 16, 2019

aditj commented Apr 17, 2019

jdm commented Apr 18, 2019

aditj commented Apr 18, 2019

aditj commented Apr 18, 2019

jdm commented Apr 18, 2019

aditj commented Apr 19, 2019

jdm commented Apr 19, 2019

bors-servo commented Apr 19, 2019

bors-servo commented Apr 19, 2019

bors-servo commented Apr 19, 2019

servo / servo

Join GitHub today

Added WebDriver DeleteCookies Function #23006

Added WebDriver DeleteCookies Function #23006

Conversation

aditj commented Mar 9, 2019 • edited

highfive commented Mar 9, 2019

jdm left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

servo-wpt-sync commented Mar 15, 2019

servo-wpt-sync commented Mar 15, 2019

jdm commented Apr 8, 2019

CYBAI commented Apr 16, 2019

aditj commented Apr 17, 2019

jdm commented Apr 18, 2019

aditj commented Apr 18, 2019

aditj commented Apr 18, 2019

jdm commented Apr 18, 2019

aditj commented Apr 19, 2019

jdm commented Apr 19, 2019

bors-servo commented Apr 19, 2019

bors-servo commented Apr 19, 2019

bors-servo commented Apr 19, 2019

aditj commented Mar 9, 2019 •

edited