Skip to content

util/network/http: Use cargo/1.2.3 user-agent header - #13548

Merged
bors merged 2 commits into
rust-lang:masterfrom
Turbo87:user-agent
Mar 9, 2024
Merged

util/network/http: Use cargo/1.2.3 user-agent header#13548
bors merged 2 commits into
rust-lang:masterfrom
Turbo87:user-agent

Conversation

@Turbo87

@Turbo87 Turbo87 commented Mar 6, 2024

Copy link
Copy Markdown
Member

... instead of cargo 1.2.3.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent#syntax declares that the product and product version are usually separated by a slash. This commit changes the cargo User-Agent header to follow that syntax instead of using whitespace for the separator.

@Turbo87
util/network/http: Use cargo/1.2.3 user-agent header
7eca372 
... instead of `cargo 1.2.3`.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent#syntax declares that the product and product version are usually separated by a slash. This commit changes the cargo `User-Agent` header to follow that syntax instead of using whitespace for the separator.
@rustbot

rustbot commented Mar 6, 2024

Copy link
Copy Markdown
Collaborator

r? @ehuss

rustbot has assigned @ehuss.
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

@rustbot rustbot added A-networking Area: networking issues, curl, etc. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 6, 2024
@Turbo87

Turbo87 commented Mar 6, 2024 •
edited
Loading

Copy link
Copy Markdown
Member Author

some more data:

weihanglo
weihanglo reviewed Mar 6, 2024
View reviewed changes

@weihanglo weihanglo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might also want to update here:

cargo/src/doc/src/reference/registry-web-api.md

Line 45 in b1b52aa

- `User-Agent`: The Cargo version such as `cargo 1.32.0 (8610973aa

Comment thread src/cargo/util/network/http.rs
@weihanglo

weihanglo commented Mar 6, 2024

Copy link
Copy Markdown
Member

I don't think we have any compatibility guarantee for the user agent header Cargo sends, and user agent parsing is notoriously imprecise. However, this could still potentially break data collections and analysis done by some proxy and private registry providers. Do you know any of them that we might want to contact in advance for this change?

@epage

epage commented Mar 6, 2024

Copy link
Copy Markdown
Contributor

Could post to build-integration as the people likely to be there are likely to be ones relying on this. There would also be custom registries.

@rustbot rustbot added the A-documenting-cargo-itself Area: Cargo's documentation label Mar 6, 2024
@Turbo87

Turbo87 commented Mar 6, 2024

Copy link
Copy Markdown
Member Author

You might also want to update here

✅

Do you know any of them that we might want to contact in advance for this change?

The only one I know is our cargo versions dashboard on DataDog, but I've already adjusted the parser there to allow both styles :)

weihanglo
weihanglo approved these changes Mar 6, 2024
View reviewed changes

@weihanglo weihanglo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going to merge this. It's always good to follow the specs!

@weihanglo

weihanglo commented Mar 6, 2024

Copy link
Copy Markdown
Member

@bors r+

@bors

bors commented Mar 6, 2024

Copy link
Copy Markdown
Contributor

📌 Commit c1f5fa6 has been approved by weihanglo

It is now in the queue for this repository.

@bors bors 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 Mar 6, 2024
@bors

bors commented Mar 6, 2024

Copy link
Copy Markdown
Contributor

⌛ Testing commit c1f5fa6 with merge 91fd2b8...

bors added a commit that referenced this pull request Mar 6, 2024
@bors
Auto merge of #13548 - Turbo87:user-agent, r=weihanglo
91fd2b8 
util/network/http: Use `cargo/1.2.3` user-agent header

... instead of `cargo 1.2.3`.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent#syntax declares that the product and product version are usually separated by a slash. This commit changes the cargo `User-Agent` header to follow that syntax instead of using whitespace for the separator.
@weihanglo

weihanglo commented Mar 6, 2024

Copy link
Copy Markdown
Member

Wait. Let me post it on Zulip first, as this doesn't seem to be really urgent.

@bors r-

@bors bors added S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Mar 6, 2024
@Turbo87

Turbo87 commented Mar 6, 2024

Copy link
Copy Markdown
Member Author

yeah, no urgency :)

@weihanglo

weihanglo commented Mar 6, 2024

Copy link
Copy Markdown
Member

Topic created:
https://rust-lang.zulipchat.com/#narrow/stream/334885-t-cargo.2Fbuild-integration/topic/Cargo.20HTTP.20User-Agent.20becomes.20.60cargo.2F1.2E76.2E0.60.20.28with.20slash.29

@bors

bors commented Mar 6, 2024

Copy link
Copy Markdown
Contributor

☀️ Try build successful - checks-actions
Build commit: 91fd2b8 (91fd2b8a655afe760e734a9977a81e0c3963acfa)

@weihanglo weihanglo added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. labels Mar 7, 2024
@weihanglo

weihanglo commented Mar 9, 2024

Copy link
Copy Markdown
Member

@bors r+

Thanks!

@bors

bors commented Mar 9, 2024

Copy link
Copy Markdown
Contributor

📌 Commit c1f5fa6 has been approved by weihanglo

It is now in the queue for this repository.

@bors bors removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 9, 2024
@bors bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Mar 9, 2024
@bors

bors commented Mar 9, 2024

Copy link
Copy Markdown
Contributor

⌛ Testing commit c1f5fa6 with merge d79fdf3...

@bors

bors commented Mar 9, 2024

Copy link
Copy Markdown
Contributor

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing d79fdf3 to master...

@bors
bors merged commit d79fdf3 into rust-lang:master Mar 9, 2024
@Turbo87
Turbo87 deleted the user-agent branch March 9, 2024 17:41
@weihanglo weihanglo mentioned this pull request Mar 12, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 12, 2024
@bors
Auto merge of rust-lang#122394 - weihanglo:update-cargo, r=weihanglo
a165f1f 
Update cargo

9 commits in a4c63fe5388beaa09e5f91196c86addab0a03580..7065f0ef4aa267a7455e1c478b5ccacb7baea59c
2024-03-06 22:15:17 +0000 to 2024-03-12 13:25:15 +0000
- chore: remove repetitive word (rust-lang/cargo#13575)
- refactor(lockfile): Make diffing/printing more reusable (rust-lang/cargo#13564)
- test: Add tests for using worktrees and sparse checkouts (rust-lang/cargo#13567)
- util/network/http: Use `cargo/1.2.3` user-agent header (rust-lang/cargo#13548)
- fix: Consistently compare MSRVs (rust-lang/cargo#13537)
- refactor(shell): Use alternate to close links (rust-lang/cargo#13562)
- fix(doc): Collapse down Generated statuses without --verbose (rust-lang/cargo#13557)
- doc: Add doc for -Zpublic-dependency (rust-lang/cargo#13556)
- docs: add link to the exported_private_dependencies lint (rust-lang/cargo#13547)

r? ghost
@rustbot rustbot added this to the 1.78.0 milestone Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@weihanglo weihanglo weihanglo approved these changes

Assignees

@ehuss ehuss

Labels

A-documenting-cargo-itself Area: Cargo's documentation A-networking Area: networking issues, curl, etc. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Milestone

1.78.0

Development

Successfully merging this pull request may close these issues.

6 participants

@Turbo87 @rustbot @weihanglo @epage @bors @ehuss