Skip to content

Replace winreg with windows-registry - #3896

Merged
djc merged 1 commit into
rust-lang:masterfrom
InfyniteHeap:change-dependency
Sep 26, 2024
Merged

Replace winreg with windows-registry#3896
djc merged 1 commit into
rust-lang:masterfrom
InfyniteHeap:change-dependency

Conversation

@InfyniteHeap

@InfyniteHeapInfyniteHeap commented Jun 20, 2024•
edited
Loading

Copy link
Copy Markdown

Closes#3779.

APIs provided by winreg crate is not safe, simple and abstract enough. Besides that, it probably also contains protential bugs. Because of that, it is better to replace it with windows-registry crate, which is officially published and maintained by Microsoft.

InfyniteHeap
InfyniteHeap commented Jun 20, 2024
View reviewed changes
Comment threadsrc/cli/self_update/windows.rs
rami3l
rami3l reviewed Jun 20, 2024
View reviewed changes
Comment threadsrc/cli/self_update/windows.rs Outdated
rami3l
rami3l reviewed Jun 20, 2024
View reviewed changes
Comment threadsrc/cli/self_update/windows.rs Outdated
rami3l
rami3l reviewed Jun 20, 2024
View reviewed changes
Comment threadsrc/cli/self_update/test.rs Outdated
@rami3lrami3l changed the title Change dependency to windows-registryReplace winreg with windows-registryJun 20, 2024
@InfyniteHeap
InfyniteHeap marked this pull request as ready for review June 20, 2024 16:04
djc
djc reviewed Jun 20, 2024
View reviewed changes

@djcdjc left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I haven't done a complete review yet, because I think there's a bunch of stuff left to clean up. The core change looks great though, thanks for working on this!

Comment threadCargo.toml Outdated
Comment threadCargo.toml Outdated
Comment threadsrc/cli/self_update/test.rs Outdated
Comment threadsrc/cli/self_update/test.rs Outdated
Comment threadsrc/cli/self_update/test.rs Outdated
Comment threadsrc/cli/self_update/windows.rs Outdated
Comment threadsrc/cli/self_update/windows.rs Outdated
Comment threadsrc/cli/self_update/windows.rs Outdated
Comment threadsrc/cli/self_update/windows.rs Outdated
Comment threadsrc/cli/self_update/windows.rs Outdated
@InfyniteHeap
InfyniteHeap deleted the change-dependency branch June 21, 2024 03:30
@InfyniteHeap
InfyniteHeap restored the change-dependency branch June 21, 2024 03:31
@InfyniteHeap
InfyniteHeap requested review from djc and rami3lJune 21, 2024 06:32
djc
djc reviewed Jun 21, 2024
View reviewed changes

@djcdjc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall a really nice improvement!

Comment threadsrc/cli/self_update/windows.rs Outdated
Comment threadsrc/cli/self_update/windows.rs Outdated
rami3l
rami3l reviewed Jun 21, 2024
View reviewed changes
Comment threadtests/suite/cli_paths.rs Outdated
@rami3lrami3l mentioned this pull request Jun 21, 2024
Closed
@djc

djc commented Jun 22, 2024

Copy link
Copy Markdown
Contributor

Sorry, but it turns out I had to make some changes to registry-related API in #3893. Hopefully it won't be too hard to rebase on top of my changes.

@InfyniteHeap

InfyniteHeap commented Jun 22, 2024

Copy link
Copy Markdown
Author

Sorry, but it turns out I had to make some changes to registry-related API in #3893. Hopefully it won't be too hard to rebase on top of my changes.

Oh, I think I'd better replace dependency from scratch lest appear some unexpect problems.😅

@InfyniteHeap

InfyniteHeap commented Jun 22, 2024

Copy link
Copy Markdown
Author

This PR will keep closed until windows-registry updates.

@rami3l

rami3l commented Jun 29, 2024•
edited
Loading

Copy link
Copy Markdown
Member

@InfyniteHeap FYI microsoft/windows-rs#3119 has been closed, so you might restart your work on this one!

@InfyniteHeap

InfyniteHeap commented Jun 29, 2024

Copy link
Copy Markdown
Author

@InfyniteHeap FYI microsoft/windows-rs#3119 has been closed, so you might restart your work on this one!

Sounds great! I'll restart my work when new version of windows-registry is published on crates.io! :)

rami3l
rami3l reviewed Jul 5, 2024
View reviewed changes
Comment threadsrc/cli/self_update/windows.rs
InfyniteHeap
InfyniteHeap commented Sep 22, 2024
View reviewed changes
Comment threadsrc/cli/self_update/windows.rs Outdated
InfyniteHeap
InfyniteHeap commented Sep 22, 2024
View reviewed changes
Comment threadsrc/cli/self_update/windows.rs
InfyniteHeap
InfyniteHeap commented Sep 22, 2024
View reviewed changes
Comment threadsrc/cli/self_update/windows.rs Outdated
rami3l
rami3l reviewed Sep 22, 2024
View reviewed changes

@rami3lrami3l left a comment •
edited
Loading

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.

This PR is getting even clearer than the previous iteration, modulo some eventual rebases (esp. after @kennykerr's possible API adjustments). Good job!

PS: As a favor, please consider listing @ChrisDenton as a co-author of some (or all) of your commits when applicable :)

djc
djc approved these changes Sep 22, 2024
View reviewed changes

@djcdjc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks good to me, thanks for all the work!

@kennykerr

kennykerr commented Sep 22, 2024

Copy link
Copy Markdown
Contributor

I could implement Deref in place of as_wide and that would provide all of this directly.

@rami3l

rami3l commented Sep 22, 2024

Copy link
Copy Markdown
Member

Current status: Waiting for a new upstream release to ship microsoft/windows-rs#3148...

@kennykerrkennykerr mentioned this pull request Sep 23, 2024
Merged
@kennykerr

kennykerr commented Sep 23, 2024

Copy link
Copy Markdown
Contributor

Here's the Deref implementation for HSTRING. microsoft/windows-rs#3291

djc
djc reviewed Sep 24, 2024
View reviewed changes

@djcdjc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@kennykerr what's the rationale for using all-uppercase names for stuff like HSTRING and HRESULT? Are you trying to match the upstream names exactly? It looks rather unidiomatic.

Comment threadsrc/cli/self_update/windows.rs Outdated
Comment threadsrc/cli/self_update/windows.rs Outdated
Comment threadsrc/cli/self_update/windows.rs Outdated
Comment threadsrc/cli/self_update/windows.rs
Comment threadsrc/cli/self_update/windows.rs Outdated
@kennykerr

kennykerr commented Sep 24, 2024

Copy link
Copy Markdown
Contributor

what's the rationale for using all-uppercase names for stuff like HSTRING and HRESULT? Are you trying to match the upstream names exactly? It looks rather unidiomatic.

There are countless identifiers in the Windows API. It's just not very practical to come up with different names - it has been attempted. It also makes it a lot harder to cross-reference documentation and source code for equivalent types.

@InfyniteHeap

InfyniteHeap commented Sep 24, 2024

Copy link
Copy Markdown
Author

What about these changes?

djc
djc approved these changes Sep 24, 2024
View reviewed changes

@djcdjc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this is looking great. @InfyniteHeap and @kennykerr thanks for all the work! Would be nice to get that windows-registry release out so that we can move forward with this.

@kennykerrkennykerr mentioned this pull request Sep 24, 2024
Merged
@kennykerr

kennykerr commented Sep 24, 2024

Copy link
Copy Markdown
Contributor

Coming up: microsoft/windows-rs#3293

@InfyniteHeap
InfyniteHeap marked this pull request as ready for review September 25, 2024 05:05
@kennykerr

kennykerr commented Sep 25, 2024

Copy link
Copy Markdown
Contributor

Version 0.3.0 of the windows-registry crate has been published. https://github.com/microsoft/windows-rs/releases/tag/0.60.0

@djc

djc commented Sep 25, 2024

Copy link
Copy Markdown
Contributor

Can you squash all of your changes into a single commit?

@InfyniteHeap

InfyniteHeap commented Sep 25, 2024

Copy link
Copy Markdown
Author

Can you squash all of your changes into a single commit?

I've done this.

@kennykerrkennykerr mentioned this pull request Sep 25, 2024
Closed
rami3l
rami3l approved these changes Sep 26, 2024
View reviewed changes

@rami3lrami3l left a comment •
edited
Loading

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.

LGTM, and thanks for your work @InfyniteHeap!

PS: You may proceed with cleanup PRs such as the one discussed in #3896 (comment) shortly after.

@djc
djc added this pull request to the merge queue Sep 26, 2024
Merged via the queue into rust-lang:master with commit bce3ed6Sep 26, 2024
@InfyniteHeap
InfyniteHeap deleted the change-dependency branch September 26, 2024 07:47
@InfyniteHeapInfyniteHeap mentioned this pull request Sep 26, 2024
Merged
@rami3lrami3l mentioned this pull request Oct 6, 2024
Closed
3 tasks
@coderabbitaicoderabbitaiBot mentioned this pull request Jun 6, 2026
Merged
@rami3lrami3l mentioned this pull request Aug 21, 2026
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ChrisDentonChrisDentonChrisDenton left review comments
@djcdjcdjc approved these changes
@rami3lrami3lrami3l approved these changes
@kennykerrkennykerrAwaiting requested review from kennykerr

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

rustup fails to open non-existing windows registry path

5 participants

@InfyniteHeap@djc@rami3l@kennykerr@ChrisDenton