Add comments linking to the steps of the specs in the checks on Location setters #25714

UxioAndrade · 2020-02-09T20:49:12Z

As stated in #23670 (comment), I added some comments to the checks on Location setters, so that it is easier to follow the steps in specs.

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

These changes do not require tests because I just added some comments


        only allow http/https protocols


        host or hostname: abort if url cannot be a base


        port: abort if url cannot have username/password/port


        pathname: terminate if cannot-be-a-base


        remove failure expectations


        link to cannot have a username password spec


        fix merge conflict


        add comments linking to steps of the specs

highfive · 2020-02-09T20:49:22Z

Thanks for the pull request, and welcome! The Servo team is excited to review your changes, and you should hear from @paulrouget (or someone else) soon.

highfive · 2020-02-09T20:49:23Z

Heads up! This PR modifies the following files:

@asajeffrey: components/script/dom/location.rs
@KiChjang: components/script/dom/location.rs

gterzian · 2020-02-10T04:22:08Z

Thanks! Could you please also squash into one commit?

paulrouget · 2020-02-10T04:44:03Z

components/script/dom/location.rs

@@ -242,7 +256,11 @@ impl LocationMethods for Location {
    // https://html.spec.whatwg.org/multipage/#dom-location-protocol
    fn SetProtocol(&self, value: USVString) -> ErrorResult {
        self.check_same_origin_domain()?;
-        self.set_url_component(value, UrlHelper::SetProtocol);
+        // Step 6: If copyURL's scheme is not an HTTP(S) scheme, then terminate these steps.
+        let scheme = value.split(':').next().unwrap();


Isn’t it dangerous to have unwrap() here?

Yes you're right, actually per Step 5 of the protocol setter spec, I think we should return a Error::Syntax here instead of unwrap, see https://html.spec.whatwg.org/multipage/history.html#dom-location-protocol

This would be using use crate::dom::bindings::error::Error;

Would my latest commit fix that?

Yes.

Please run ./mach fmt to fix https://community-tc.services.mozilla.com/tasks/VcHxks51RSywXhLH0W3dXg/runs/0/logs/https%3A%2F%2Fcommunity-tc.services.mozilla.com%2Fapi%2Fqueue%2Fv1%2Ftask%2FVcHxks51RSywXhLH0W3dXg%2Fruns%2F0%2Fartifacts%2Fpublic%2Flogs%2Flive.log

And please also squash...

UxioAndrade · 2020-02-10T08:55:18Z

Hi @gterzian should I squash all the commits or just the ones before I merged the master branch?

gterzian · 2020-02-10T10:07:34Z

I would say just one(and I think it will still automatically list @braddunbar as co-author, which would be a good thing).


        change scheme unwrap into syntax error

gterzian · 2020-02-10T15:47:18Z

components/script/dom/location.rs

@@ -216,7 +222,10 @@ impl LocationMethods for Location {
    // https://html.spec.whatwg.org/multipage/#dom-location-pathname
    fn SetPathname(&self, value: USVString) -> ErrorResult {
        self.check_same_origin_domain()?;
-        self.set_url_component(value, UrlHelper::SetPathname);
+        // Step 3: If copyURL's cannot-be-a-base-URL flag is set, terminate these steps.


Actually, can we put this comment, and all others, above the Ok(()) branch, because the comments all refer to the steps take when the condition is not met.

gterzian · 2020-02-10T15:48:32Z

components/script/dom/location.rs

+            }
+            Ok(())
+        } else {
+            Err(Error::Syntax)


Here we can put a comment for Step 5, throw a "SyntaxError" DOMException.

bors-servo · 2020-03-09T21:27:53Z

☔ The latest upstream changes (presumably #25931) made this pull request unmergeable. Please resolve the merge conflicts.

bors-servo · 2020-03-11T14:37:41Z

☔ The latest upstream changes (presumably #25947) made this pull request unmergeable. Please resolve the merge conflicts.

bors-servo · 2020-03-26T12:11:16Z

☔ The latest upstream changes (presumably #26039) made this pull request unmergeable. Please resolve the merge conflicts.

bors-servo · 2020-04-06T15:16:13Z

☔ The latest upstream changes (presumably #26119) made this pull request unmergeable. Please resolve the merge conflicts.

dralley · 2020-04-12T03:39:04Z

@UxioAndrade Are you planning on finishing up the PR?

bors-servo · 2020-04-19T19:28:36Z

☔ The latest upstream changes (presumably #26222) made this pull request unmergeable. Please resolve the merge conflicts.

jdm · 2020-04-20T15:01:18Z

Closing due to inactivity.


        Auto merge of #26231 - utsavoza:ugo/issue-23522/16-04-2020, r=gterzian

@UxioAndrade

Implement various checks on the Location setters Since there are no existing open PRs for the issue, I am raising one based on the work done by @UxioAndrade and @braddunbar in previous two PRs for the issue (#25714 and #23670) respectively. - [x] `./mach build -d` does not report any errors - [x] `./mach test-tidy` does not report any errors - [x] These changes fix #23522 - [x] There are tests for these changes


        Auto merge of #26231 - utsavoza:ugo/issue-23522/16-04-2020, r=gterzian

@UxioAndrade

Implement various checks on the Location setters Since there are no existing open PRs for the issue, I am raising one based on the work done by @UxioAndrade and @braddunbar in previous two PRs for the issue (#25714 and #23670) respectively. - [x] `./mach build -d` does not report any errors - [x] `./mach test-tidy` does not report any errors - [x] These changes fix #23522 - [x] There are tests for these changes


        Auto merge of #26231 - utsavoza:ugo/issue-23522/16-04-2020, r=gterzian

@UxioAndrade

Implement various checks on the Location setters Since there are no existing open PRs for the issue, I am raising one based on the work done by @UxioAndrade and @braddunbar in previous two PRs for the issue (#25714 and #23670) respectively. - [x] `./mach build -d` does not report any errors - [x] `./mach test-tidy` does not report any errors - [x] These changes fix #23522 - [x] There are tests for these changes


        Auto merge of #26231 - utsavoza:ugo/issue-23522/16-04-2020, r=gterzian

@UxioAndrade

Implement various checks on the Location setters Since there are no existing open PRs for the issue, I am raising one based on the work done by @UxioAndrade and @braddunbar in previous two PRs for the issue (#25714 and #23670) respectively. - [x] `./mach build -d` does not report any errors - [x] `./mach test-tidy` does not report any errors - [x] These changes fix #23522 - [x] There are tests for these changes

braddunbar and others added 8 commits Jun 29, 2019

only allow http/https protocols

Verified

This commit was signed with a verified signature.

braddunbar Brad Dunbar

GPG key ID: C32E3CC9B201C719 Learn about signing commits

9845249

host or hostname: abort if url cannot be a base

Verified

This commit was signed with a verified signature.

braddunbar Brad Dunbar

GPG key ID: C32E3CC9B201C719 Learn about signing commits

3c8df69

port: abort if url cannot have username/password/port

Verified

This commit was signed with a verified signature.

braddunbar Brad Dunbar

GPG key ID: C32E3CC9B201C719 Learn about signing commits

97e967c

pathname: terminate if cannot-be-a-base

Verified

This commit was signed with a verified signature.

braddunbar Brad Dunbar

GPG key ID: C32E3CC9B201C719 Learn about signing commits

3f2abcc

remove failure expectations

Verified

This commit was signed with a verified signature.

braddunbar Brad Dunbar

GPG key ID: C32E3CC9B201C719 Learn about signing commits

Loading status checks…

6c31813

link to cannot have a username password spec

Verified

This commit was signed with a verified signature.

braddunbar Brad Dunbar

GPG key ID: C32E3CC9B201C719 Learn about signing commits

Loading status checks…

05f7547

fix merge conflict

214fbc9

add comments linking to steps of the specs

Loading status checks…

ad31fde

highfive assigned paulrouget Feb 9, 2020

highfive added the S-awaiting-review label Feb 9, 2020

paulrouget reviewed Feb 10, 2020

View changes

paulrouget mentioned this pull request Feb 10, 2020

WIP: Devtools prompt #25266

Closed

change scheme unwrap into syntax error

Loading status checks…

ec77231

gterzian reviewed Feb 10, 2020

View changes

components/script/dom/location.rs

}

Ok(())

} else {

Err(Error::Syntax)

This comment has been minimized.

Sign in to view

gterzian Feb 10, 2020
Member

Here we can put a comment for Step 5, throw a "SyntaxError" DOMException.

jdm added S-needs-code-changes and removed S-awaiting-review labels Feb 10, 2020

highfive added the S-needs-rebase label Mar 9, 2020

jdm closed this Apr 20, 2020

utsavoza mentioned this pull request Apr 20, 2020

Implement various checks on the Location setters #26231

Merged

4 of 4 tasks complete

servo / servo

Add comments linking to the steps of the specs in the checks on Location setters #25714

Add comments linking to the steps of the specs in the checks on Location setters #25714

UxioAndrade commented Feb 9, 2020 •

edited by jdm

highfive commented Feb 9, 2020

highfive commented Feb 9, 2020

gterzian commented Feb 10, 2020

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

UxioAndrade commented Feb 10, 2020

gterzian commented Feb 10, 2020

This comment has been minimized.

This comment has been minimized.

bors-servo commented Mar 9, 2020

bors-servo commented Mar 11, 2020

bors-servo commented Mar 26, 2020

bors-servo commented Apr 6, 2020

dralley commented Apr 12, 2020

bors-servo commented Apr 19, 2020

jdm commented Apr 20, 2020

servo / servo

Join GitHub today

Add comments linking to the steps of the specs in the checks on Location setters #25714

Add comments linking to the steps of the specs in the checks on Location setters #25714

Conversation

UxioAndrade commented Feb 9, 2020 • edited by jdm

highfive commented Feb 9, 2020

highfive commented Feb 9, 2020

gterzian commented Feb 10, 2020

This comment has been minimized.

paulrouget Feb 10, 2020

This comment has been minimized.

gterzian Feb 10, 2020 • edited

This comment has been minimized.

UxioAndrade Feb 10, 2020

This comment has been minimized.

gterzian Feb 10, 2020

UxioAndrade commented Feb 10, 2020

gterzian commented Feb 10, 2020

This comment has been minimized.

gterzian Feb 10, 2020

This comment has been minimized.

gterzian Feb 10, 2020

bors-servo commented Mar 9, 2020

bors-servo commented Mar 11, 2020

bors-servo commented Mar 26, 2020

bors-servo commented Apr 6, 2020

dralley commented Apr 12, 2020

bors-servo commented Apr 19, 2020

jdm commented Apr 20, 2020

UxioAndrade commented Feb 9, 2020 •

edited by jdm

gterzian Feb 10, 2020 •

edited