Skip to content

rustdoc template font links only emit crossorigin when needed - #144467

Merged
bors merged 1 commit into
rust-lang:masterfrom
hydro-project:users/mingwes/rustdoc-fix-cors
Aug 5, 2025
Merged

rustdoc template font links only emit crossorigin when needed#144467
bors merged 1 commit into
rust-lang:masterfrom
hydro-project:users/mingwes/rustdoc-fix-cors

Conversation

@MingweiSamuel

@MingweiSamuelMingweiSamuel commented Jul 25, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

The crossorigin attribute may cause issues when the href is not actually cross-origin. Specifically, the tag causes the browser to send a preflight OPTIONS request to the server even if it is same-origin. Some temperamental servers may reject all CORS preflight requests even if they're actually same-origin, which causes a CORS error and prevents the fonts from loading, even later on.

This commit fixes that problem by not emitting crossorigin if the url appears to be relative to the same origin.

@rustbot

rustbot commented Jul 25, 2025

Copy link
Copy Markdown
Collaborator

r? @GuillaumeGomez

rustbot has assigned @GuillaumeGomez.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbotrustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Jul 25, 2025
GuillaumeGomez
GuillaumeGomez reviewed Jul 25, 2025
View reviewed changes
Comment threadsrc/librustdoc/html/templates/page.html Outdated
@GuillaumeGomez

GuillaumeGomez commented Jul 25, 2025

Copy link
Copy Markdown
Member

Seems ok to. Do you see any potential issue @notriddle?

lolbinarycat
lolbinarycat reviewed Jul 27, 2025
View reviewed changes
Comment threadsrc/librustdoc/html/layout.rs Outdated
@MingweiSamuel
MingweiSamuel marked this pull request as draft July 27, 2025 17:57
@rustbotrustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 27, 2025
@MingweiSamuel
MingweiSamuelforce-pushed the users/mingwes/rustdoc-fix-cors branch 2 times, most recently from 7db45e4 to 24eb433CompareJuly 28, 2025 16:40
@MingweiSamuelMingweiSamuel changed the title rustdoc layout template only emit crossorigin when neededrustdoc template font links only emit crossorigin when neededJul 28, 2025
@MingweiSamuel
MingweiSamuel marked this pull request as ready for review July 28, 2025 16:41
@rustbotrustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 28, 2025
@MingweiSamuel

MingweiSamuel commented Jul 28, 2025

Copy link
Copy Markdown
ContributorAuthor

Updated check should be a lot more robust, and adjusted naming/comments to discourage other [mis]usage

GuillaumeGomez
GuillaumeGomez reviewed Jul 28, 2025
View reviewed changes
Comment threadsrc/librustdoc/html/layout.rs
GuillaumeGomez
GuillaumeGomez reviewed Jul 29, 2025
View reviewed changes
Comment threadsrc/librustdoc/html/layout.rs Outdated
@MingweiSamuel

This comment was marked as outdated.

Sign in to view
MingweiSamuel
MingweiSamuel commented Jul 29, 2025
View reviewed changes
Comment threadsrc/librustdoc/html/layout.rs Outdated
@MingweiSamuel
MingweiSamuelforce-pushed the users/mingwes/rustdoc-fix-cors branch from f462760 to f10e91eCompareJuly 29, 2025 16:38
@MingweiSamuel

MingweiSamuel commented Jul 29, 2025

Copy link
Copy Markdown
ContributorAuthor

Alright I have made it even more robust based on https://url.spec.whatwg.org/#url-parsing scheme parsing 😅

https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=25c79375dd12bc846bb7999b2366062e

@MingweiSamuel

MingweiSamuel commented Aug 1, 2025

Copy link
Copy Markdown
ContributorAuthor

@GuillaumeGomez Can you take another look? Should properly handle all schemes based on the spec now

@MingweiSamuel@GuillaumeGomez
rustdoc font links only emit crossorigin when needed
f516d4c
The `crossorigin` attribute may cause issues when the href is not actuall across origins. Specifically, the tag causes the browser to send a preflight OPTIONS request to the href even if it is same-origin.
Some tempermental servers may reject all CORS preflect requests even if they're actually same-origin, which causes a CORS error and prevents the fonts from loading, even later on.
This commit fixes that problem by not emitting `crossorigin` if the url looks like a domain-relative url.
Co-authored-by: Guillaume Gomez <guillaume1.gomez@gmail.com>
@MingweiSamuel
MingweiSamuelforce-pushed the users/mingwes/rustdoc-fix-cors branch from 89df295 to f516d4cCompareAugust 1, 2025 21:42
@MingweiSamuel

MingweiSamuel commented Aug 1, 2025

Copy link
Copy Markdown
ContributorAuthor

Alright I have added the unit tests (though I am unsure how to run them locally)

@GuillaumeGomez

GuillaumeGomez commented Aug 1, 2025

Copy link
Copy Markdown
Member

You can run unit tests in rustdoc like this: x.py test src/librustdoc --stage 1 (--stage 1 is to prevent building more than necessary).

GuillaumeGomez
GuillaumeGomez reviewed Aug 2, 2025
View reviewed changes
Comment threadsrc/librustdoc/html/layout/tests.rs
@GuillaumeGomez

GuillaumeGomez commented Aug 2, 2025

Copy link
Copy Markdown
Member

Just one last nit and we're there. :)

@MingweiSamuel
MingweiSamuelforce-pushed the users/mingwes/rustdoc-fix-cors branch from f516d4c to 340984bCompareAugust 2, 2025 17:26
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@MingweiSamuel

MingweiSamuel commented Aug 2, 2025

Copy link
Copy Markdown
ContributorAuthor

Hmm 😅

@GuillaumeGomez

GuillaumeGomez commented Aug 2, 2025

Copy link
Copy Markdown
Member

Arf, sorry about that. I definitely don't like this approach but if it's the one enforced in the project...

@MingweiSamuel
MingweiSamuelforce-pushed the users/mingwes/rustdoc-fix-cors branch from 340984b to f516d4cCompareAugust 4, 2025 15:27
@GuillaumeGomez

GuillaumeGomez commented Aug 4, 2025

Copy link
Copy Markdown
Member

@bors r+ rollup

@bors

bors commented Aug 4, 2025

Copy link
Copy Markdown
Collaborator

📌 Commit f516d4c has been approved by GuillaumeGomez

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 4, 2025
samueltardieu added a commit to samueltardieu/rust that referenced this pull request Aug 4, 2025
@samueltardieu
Rollup merge ofrust-lang#144467- hydro-project:users/mingwes/rustdo…
4004dd4
…c-fix-cors, r=GuillaumeGomez
rustdoc template font links only emit `crossorigin` when needed
The `crossorigin` attribute may cause issues when the href is not actually cross-origin. Specifically, the tag causes the browser to send a preflight OPTIONS request to the server even if it is same-origin. Some temperamental servers may reject all CORS preflight requests even if they're actually same-origin, which causes a CORS error and prevents the fonts from loading, even later on.
This commit fixes that problem by not emitting `crossorigin` if the url appears to be relative to the same origin.
@samueltardieusamueltardieu mentioned this pull request Aug 4, 2025
Closed
bors added a commit that referenced this pull request Aug 4, 2025
@bors
Auto merge of#144929- samueltardieu:rollup-n2c14p7, r=samueltardieu
5bd6cac
Rollup of 18 pull requests
Successful merges:
- #144467 (rustdoc template font links only emit `crossorigin` when needed)
- #144548 (Rehome 21 `tests/ui/issues/` tests to other subdirectories under `tests/ui/`)
- #144596 (libtest: print the type of test being run)
- #144741 (fix: Error on illegal `[const]`s inside blocks within legal positions)
- #144776 (`Printer` cleanups)
- #144779 (Implement debugging output of the bootstrap Step graph into a DOT file)
- #144813 (Add a tidy check to prevent adding UI tests directly under `tests/ui/`)
- #144817 (Properly reject tail calls to `&FnPtr` or `&FnDef`)
- #144852 (Rename `rust_panic_without_hook` to `resume_unwind` )
- #144866 (Remove `SHOULD_EMIT_LINTS` in favor of `should_emit`)
- #144867 (Use `as_array` in PartialEq for arrays)
- #144872 (Document Poisoning in `LazyCell` and `LazyLock`)
- #144877 (coverage: Various small cleanups)
- #144887 (`rust-analyzer` subtree update)
- #144890 (Add `InterpCx::project_fields`)
- #144894 (Delete `tests/ui/threads-sendsync/tcp-stress.rs`)
- #144905 (rustc-dev-guide subtree update)
- #144920 (Dont print arg span in MIR dump for tail call)
r? `@ghost`
`@rustbot` modify labels: rollup
@samueltardieusamueltardieu mentioned this pull request Aug 5, 2025
Merged
bors added a commit that referenced this pull request Aug 5, 2025
@bors
Auto merge of#144934- samueltardieu:rollup-25jvb9g, r=samueltardieu
0f35336
Rollup of 17 pull requests
Successful merges:
- #144467 (rustdoc template font links only emit `crossorigin` when needed)
- #144548 (Rehome 21 `tests/ui/issues/` tests to other subdirectories under `tests/ui/`)
- #144741 (fix: Error on illegal `[const]`s inside blocks within legal positions)
- #144776 (`Printer` cleanups)
- #144779 (Implement debugging output of the bootstrap Step graph into a DOT file)
- #144813 (Add a tidy check to prevent adding UI tests directly under `tests/ui/`)
- #144817 (Properly reject tail calls to `&FnPtr` or `&FnDef`)
- #144852 (Rename `rust_panic_without_hook` to `resume_unwind` )
- #144866 (Remove `SHOULD_EMIT_LINTS` in favor of `should_emit`)
- #144867 (Use `as_array` in PartialEq for arrays)
- #144872 (Document Poisoning in `LazyCell` and `LazyLock`)
- #144877 (coverage: Various small cleanups)
- #144887 (`rust-analyzer` subtree update)
- #144890 (Add `InterpCx::project_fields`)
- #144894 (Delete `tests/ui/threads-sendsync/tcp-stress.rs`)
- #144905 (rustc-dev-guide subtree update)
- #144920 (Dont print arg span in MIR dump for tail call)
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 2e97165 into rust-lang:masterAug 5, 2025
20 checks passed
@rustbotrustbot added this to the 1.91.0 milestone Aug 5, 2025
rust-timer added a commit that referenced this pull request Aug 5, 2025
@rust-timer
Unrolled build for#144467
3696338
Rollup merge of #144467 - hydro-project:users/mingwes/rustdoc-fix-cors, r=GuillaumeGomez
rustdoc template font links only emit `crossorigin` when needed
The `crossorigin` attribute may cause issues when the href is not actually cross-origin. Specifically, the tag causes the browser to send a preflight OPTIONS request to the server even if it is same-origin. Some temperamental servers may reject all CORS preflight requests even if they're actually same-origin, which causes a CORS error and prevents the fonts from loading, even later on.
This commit fixes that problem by not emitting `crossorigin` if the url appears to be relative to the same origin.
@KobzolKobzol mentioned this pull request Aug 5, 2025
Closed
@samueltardieusamueltardieu mentioned this pull request Aug 5, 2025
Closed
github-actionsBot pushed a commit to rust-lang/rustc-dev-guide that referenced this pull request Aug 7, 2025
@bors
Auto merge of #144934 - samueltardieu:rollup-25jvb9g, r=samueltardieu
811f376
Rollup of 17 pull requests
Successful merges:
- rust-lang/rust#144467 (rustdoc template font links only emit `crossorigin` when needed)
- rust-lang/rust#144548 (Rehome 21 `tests/ui/issues/` tests to other subdirectories under `tests/ui/`)
- rust-lang/rust#144741 (fix: Error on illegal `[const]`s inside blocks within legal positions)
- rust-lang/rust#144776 (`Printer` cleanups)
- rust-lang/rust#144779 (Implement debugging output of the bootstrap Step graph into a DOT file)
- rust-lang/rust#144813 (Add a tidy check to prevent adding UI tests directly under `tests/ui/`)
- rust-lang/rust#144817 (Properly reject tail calls to `&FnPtr` or `&FnDef`)
- rust-lang/rust#144852 (Rename `rust_panic_without_hook` to `resume_unwind` )
- rust-lang/rust#144866 (Remove `SHOULD_EMIT_LINTS` in favor of `should_emit`)
- rust-lang/rust#144867 (Use `as_array` in PartialEq for arrays)
- rust-lang/rust#144872 (Document Poisoning in `LazyCell` and `LazyLock`)
- rust-lang/rust#144877 (coverage: Various small cleanups)
- rust-lang/rust#144887 (`rust-analyzer` subtree update)
- rust-lang/rust#144890 (Add `InterpCx::project_fields`)
- rust-lang/rust#144894 (Delete `tests/ui/threads-sendsync/tcp-stress.rs`)
- rust-lang/rust#144905 (rustc-dev-guide subtree update)
- rust-lang/rust#144920 (Dont print arg span in MIR dump for tail call)
r? `@ghost`
`@rustbot` modify labels: rollup
github-actionsBot pushed a commit to rust-lang/rust-analyzer that referenced this pull request Aug 11, 2025
@bors
Auto merge of #144934 - samueltardieu:rollup-25jvb9g, r=samueltardieu
6e3ab74
Rollup of 17 pull requests
Successful merges:
- rust-lang/rust#144467 (rustdoc template font links only emit `crossorigin` when needed)
- rust-lang/rust#144548 (Rehome 21 `tests/ui/issues/` tests to other subdirectories under `tests/ui/`)
- rust-lang/rust#144741 (fix: Error on illegal `[const]`s inside blocks within legal positions)
- rust-lang/rust#144776 (`Printer` cleanups)
- rust-lang/rust#144779 (Implement debugging output of the bootstrap Step graph into a DOT file)
- rust-lang/rust#144813 (Add a tidy check to prevent adding UI tests directly under `tests/ui/`)
- rust-lang/rust#144817 (Properly reject tail calls to `&FnPtr` or `&FnDef`)
- rust-lang/rust#144852 (Rename `rust_panic_without_hook` to `resume_unwind` )
- rust-lang/rust#144866 (Remove `SHOULD_EMIT_LINTS` in favor of `should_emit`)
- rust-lang/rust#144867 (Use `as_array` in PartialEq for arrays)
- rust-lang/rust#144872 (Document Poisoning in `LazyCell` and `LazyLock`)
- rust-lang/rust#144877 (coverage: Various small cleanups)
- rust-lang/rust#144887 (`rust-analyzer` subtree update)
- rust-lang/rust#144890 (Add `InterpCx::project_fields`)
- rust-lang/rust#144894 (Delete `tests/ui/threads-sendsync/tcp-stress.rs`)
- rust-lang/rust#144905 (rustc-dev-guide subtree update)
- rust-lang/rust#144920 (Dont print arg span in MIR dump for tail call)
r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes
@lolbinarycatlolbinarycatlolbinarycat approved these changes

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Milestone

1.91.0

Development

Successfully merging this pull request may close these issues.

6 participants

@MingweiSamuel@rustbot@GuillaumeGomez@rust-log-analyzer@bors@lolbinarycat