Lookup WSL distros in the registry #10967

zadjii-msft · 2021-08-17T18:14:45Z

This PR converts the WSL distro generator to use the registry to lookup
WSL distros instead of trying to parse the results of wsl.exe.
wsl.exe sometimes takes a very long time to launch the WSL service,
which means that on the first launch of the Terminal, WSL distros can
sometimes be missing entirely!

References

Also related is When WSL is slow to respond, and a WSL profile is default, we throw a weird error message #6160, but I feel that deserves a separate PR for
warning when the default profile is a dynamic profile who's source
indicated it was gone.

PR Checklist

Closes Slow loading time on first use #9905
Closes WSL terminal not available sometimes in "New Tab" dropdown on start-up #7199
I work here
Tests added/passed
Requires documentation to be updated

Detailed Description of the Pull Request / Additional comments

This is maybe a little BODGY, but hey we get tons of reports of this
root cause.

Validation Steps Performed

Ran it locally, it did well. Ran a wsl --shutdown, then booted the
terminal - seemed to do well. I never was able to repro the slowness
myself, but I'd suspect this'll fix it.

github-actions · 2021-08-17T18:17:21Z

@check-spelling-bot Report

Unrecognized words, please review:

lpc
lpcb
lpft
Lxss
recieves

Previously acknowledged words that are now absent

LPCCH lpcs SPACEBAR Unregister xIcon yIcon

To accept these unrecognized words as correct (and remove the previously acknowledged and now absent words), run the following commands

... in a clone of the [email protected]:microsoft/terminal.git repository
on the dev/migrie/b/9905-7199-6160 branch:

update_files() {
perl -e '
my @expect_files=qw('".github/actions/spelling/expect/alphabet.txt
.github/actions/spelling/expect/expect.txt
.github/actions/spelling/expect/web.txt"');
@ARGV=@expect_files;
my @stale=qw('"$patch_remove"');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
next if /^(?:$re)(?:(?:\r|\n)*$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spelling/expect/68294f863d2adfafd6937324486b499fea73b8ab.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
}

comment_json=$(mktemp)
curl -L -s -S \
  --header "Content-Type: application/json" \
  "https://api.github.com/repos/microsoft/terminal/issues/comments/900526429" > "$comment_json"
comment_body=$(mktemp)
jq -r .body < "$comment_json" > $comment_body
rm $comment_json

patch_remove=$(perl -ne 'next unless s{^</summary>(.*)</details>$}{$1}; print' < "$comment_body")
  

patch_add=$(perl -e '$/=undef;
$_=<>;
s{<details>.*}{}s;
s{^#.*}{};
s{\n##.*}{};
s{(?:^|\n)\s*\*}{}g;
s{\s+}{ }g;
print' < "$comment_body")
  
update_files
rm $comment_body
git add -u

✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

⚠️ The command is written for posix shells. You can copy the contents of each perl command excluding the outer ' marks and dropping any '"/"' quotation mark pairs into a file and then run perl file.pl from the root of the repository to run the code. Alternatively, you can manually insert the items...

If the listed items are:

... misspelled, then please correct them instead of using the command.
... names, please add them to .github/actions/spelling/allow/names.txt.
... APIs, you can add them to a file in .github/actions/spelling/allow/.
... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

🗜️ If you see a bunch of garbage

If it relates to a ...

well-formed pattern

See if there's a pattern that would match it.

If not, try writing one and adding it to a patterns/{file}.txt.

Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

Note that patterns can't match multiline strings.

binary-ish string

Please add a file path to the excludes.txt file instead of just accepting the garbage.

File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

github-actions · 2021-08-17T18:54:36Z

@check-spelling-bot Report

Unrecognized words, please review:

lpc
lpcb
lpft
Lxss
recieves

Previously acknowledged words that are now absent

LPCCH lpcs SPACEBAR Unregister xIcon yIcon

To accept these unrecognized words as correct (and remove the previously acknowledged and now absent words), run the following commands

... in a clone of the [email protected]:microsoft/terminal.git repository
on the dev/migrie/b/9905-7199-6160 branch:

update_files() {
perl -e '
my @expect_files=qw('".github/actions/spelling/expect/alphabet.txt
.github/actions/spelling/expect/expect.txt
.github/actions/spelling/expect/web.txt"');
@ARGV=@expect_files;
my @stale=qw('"$patch_remove"');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
next if /^(?:$re)(?:(?:\r|\n)*$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spelling/expect/68294f863d2adfafd6937324486b499fea73b8ab.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
}

comment_json=$(mktemp)
curl -L -s -S \
  --header "Content-Type: application/json" \
  "https://api.github.com/repos/microsoft/terminal/issues/comments/900550860" > "$comment_json"
comment_body=$(mktemp)
jq -r .body < "$comment_json" > $comment_body
rm $comment_json

patch_remove=$(perl -ne 'next unless s{^</summary>(.*)</details>$}{$1}; print' < "$comment_body")
  

patch_add=$(perl -e '$/=undef;
$_=<>;
s{<details>.*}{}s;
s{^#.*}{};
s{\n##.*}{};
s{(?:^|\n)\s*\*}{}g;
s{\s+}{ }g;
print' < "$comment_body")
  
update_files
rm $comment_body
git add -u

✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

⚠️ The command is written for posix shells. You can copy the contents of each perl command excluding the outer ' marks and dropping any '"/"' quotation mark pairs into a file and then run perl file.pl from the root of the repository to run the code. Alternatively, you can manually insert the items...

If the listed items are:

... misspelled, then please correct them instead of using the command.
... names, please add them to .github/actions/spelling/allow/names.txt.
... APIs, you can add them to a file in .github/actions/spelling/allow/.
... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

🗜️ If you see a bunch of garbage

If it relates to a ...

well-formed pattern

See if there's a pattern that would match it.

If not, try writing one and adding it to a patterns/{file}.txt.

Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

Note that patterns can't match multiline strings.

binary-ish string

Please add a file path to the excludes.txt file instead of just accepting the garbage.

File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

lhecker · 2021-08-17T19:41:40Z

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

+        {
+            std::vector<std::wstring> names{};
+            names.reserve(guidStrings.size());
+            if (_getWslNames(wslRootKey, guidStrings, names))


I believe it would be better to use exception handling as opposed to using booleans.

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

DHowett · 2021-08-19T17:38:31Z

Notes from looking at the registry keys:

In the future (i will file) we can use the PackageFamilyName value to generate a better icon by default (!) for distros that came from packages
I was going to say "let's understand State, which is one of the values in the distro key" but then i decided eh, it will be fine

…9-6160

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

DHowett · 2021-08-23T16:22:07Z

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

+            *valueLengthNeededWithNull = (length / sizeof(wchar_t));
+            // If you add one for another trailing null, then there'll actually
+            // be _two_ trailing nulls in the buffer.
+            return status == ERROR_MORE_DATA ? ERROR_SUCCESS : status;


I'm not sure these are HRESULTs

(I am also not certain I understand how this function works/what it is expecting)

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

ghost · 2021-08-23T20:51:45Z

Hello @DHowett!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

miniksa

Approve with comments. Unmark automerge so you can see them before it rockets off.

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

miniksa · 2021-08-23T21:49:01Z

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

+// - <none>
+// Return Value:
+// - the HKEY if it exists and we can read it, else nullptr
+static HKEY openWslRegKey()


You can't have these return the wil::unique_hkey straight up?

+1 for returning RAII wrappers.

My preferred API surface when smart wrappers is involved -- and this extends to WRL::ComPtr and all similar variants -- is this:

smart_wrapper_thing GetAThing(); // produce shared wrapper thing GetAThing(); // produce dumb thing, see note 1 void TakeAThingOptional(thing*); // consume only -- non-owning and non-shared -- optional void TakeAThing(thing&); // consume only -- non-owning and non-shared -- required

Of course, ref vs pointer is a decision you can make for the specific type. HKEY is by nature optional.

Putting the smart_wrapper into the consuming contract forces the caller to have that type (bad) and implies some ownership semantics (dependent on the type).

(1) In general, a function that returns a smart wrapper is subject to the same restrictions as one that returns the thing directly (like HKEY openWslRegKey): it must ensure that if an exception is encountered before the smart wrapper is populated, it does not leak the resource. Registry functions don't throw, so the need for returning a smart wrapper is reduced. That makes HKEY open... okay in my book so long as we make sure to cover the error conditions.

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

lhecker · 2021-08-23T22:46:26Z

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

+// - <none>
+// Return Value:
+// - the HKEY if it exists and we can read it, else nullptr
+static HKEY openWslRegKey()


+1 for returning RAII wrappers.

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp

DHowett

I think I have to block because Leonard pointed out a logic error?

lhecker

LBTM

DHowett

@zadjii-msft I asked Leonard to block it so I could approve, leaving you with two once you dismiss his. For timezone purposes, it's likely easier on you to dismiss his when you've fixed it 😄

This PR converts the WSL distro generator to use the registry to lookup WSL distros instead of trying to parse the results of `wsl.exe`. `wsl.exe` sometimes takes a very long time to launch the WSL service, which means that on the first launch of the Terminal, WSL distros can sometimes be missing entirely! ## References * Also related is #6160, but I feel that deserves a separate PR for warning when the default profile is a dynamic profile who's source indicated it was gone. ## PR Checklist * [x] Closes #9905 * [x] Closes #7199 * [x] I work here * [ ] Tests added/passed * [ ] Requires documentation to be updated ## Detailed Description of the Pull Request / Additional comments This is maybe a little BODGY, but hey we get tons of reports of this root cause. ## Validation Steps Performed Ran it locally, it did well. Ran a `wsl --shutdown`, then booted the terminal - seemed to do well. I never was able to repro the slowness myself, but I'd suspect this'll fix it.

ghost · 2021-08-31T17:04:18Z

🎉Windows Terminal Preview v1.10.2383.0 has been released which incorporates this pull request.:tada:

Handy links:

ghost · 2021-08-31T17:10:03Z

🎉Windows Terminal Preview v1.11.2421.0 has been released which incorporates this pull request.:tada:

Handy links:

zadjii-msft added 4 commits August 17, 2021 10:55

stash the old code

3edf8a4

This will enumerate the WSLs in the registry

9d7f035

the whole thing

dd0b2ad

gotta have that #bodgy

4a1aba6

that's what I get for committing without building

d6f4197

lhecker reviewed Aug 17, 2021

View reviewed changes

DHowett reviewed Aug 17, 2021

View reviewed changes

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp Outdated Show resolved Hide resolved

DHowett requested changes Aug 17, 2021

View reviewed changes

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp Outdated Show resolved Hide resolved

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp Outdated Show resolved Hide resolved

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Aug 17, 2021

zadjii-msft mentioned this pull request Aug 17, 2021

When WSL is slow to respond, and a WSL profile is default, we throw a weird error message #6160

Open

zadjii-msft added 3 commits August 19, 2021 16:26

The absolute easiest nits

c48714e

nits from review

3509dcd

Merge remote-tracking branch 'origin/main' into dev/migrie/b/9905-719…

3befbd4

…9-6160

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Aug 23, 2021

This comment has been minimized.

Sign in to view

spel

52e2c24

This comment has been minimized.

Sign in to view

DHowett reviewed Aug 23, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

ghost requested review from miniksa, carlos-zamora, leonMSFT and PankajBhojwani August 23, 2021 20:51

DHowett added the AutoMerge Marked for automatic merge by the bot when requirements are met label Aug 23, 2021

miniksa removed the AutoMerge Marked for automatic merge by the bot when requirements are met label Aug 23, 2021

miniksa approved these changes Aug 23, 2021

View reviewed changes

lhecker reviewed Aug 23, 2021

View reviewed changes

src/cascadia/TerminalSettingsModel/WslDistroGenerator.cpp Outdated Show resolved Hide resolved

lhecker reviewed Aug 23, 2021

View reviewed changes

DHowett requested changes Aug 24, 2021

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Aug 24, 2021

lhecker requested changes Aug 24, 2021

View reviewed changes

DHowett approved these changes Aug 24, 2021

View reviewed changes

zadjii-msft added 2 commits August 24, 2021 04:51

logic errors

86f3033

wil helpers too

b852754

zadjii-msft requested a review from lhecker August 24, 2021 10:30

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Aug 24, 2021

lhecker approved these changes Aug 24, 2021

View reviewed changes

DHowett added the AutoMerge Marked for automatic merge by the bot when requirements are met label Aug 24, 2021

ghost merged commit f9a844d into main Aug 24, 2021

ghost deleted the dev/migrie/b/9905-7199-6160 branch August 24, 2021 13:10

zadjii-msft mentioned this pull request Aug 24, 2021

[megathread] Deleting profiles is often confusing #9997

Open

13 tasks

WSLUser mentioned this pull request Aug 30, 2021

Add WSL distro default desktop wallpapers as default background #6105

Closed

This was referenced Aug 31, 2021

WSL terminal not available sometimes in "New Tab" dropdown on start-up #7199

Closed

Slow loading time on first use #9905

Closed

zadjii-msft mentioned this pull request Nov 9, 2021

wsl.exe attempts to load despite Windows Subsystem for Linux being disabled #11716

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Lookup WSL distros in the registry #10967

Lookup WSL distros in the registry #10967

zadjii-msft commented Aug 17, 2021 •

edited by DHowett

Loading

github-actions bot commented Aug 17, 2021 •

edited

Loading

github-actions bot commented Aug 17, 2021 •

edited

Loading

lhecker Aug 17, 2021

DHowett commented Aug 19, 2021

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.

DHowett Aug 23, 2021

DHowett Aug 23, 2021

This comment has been minimized.

ghost commented Aug 23, 2021

miniksa left a comment

miniksa Aug 23, 2021

lhecker Aug 23, 2021

DHowett Aug 24, 2021

lhecker Aug 23, 2021

DHowett left a comment

lhecker left a comment

DHowett left a comment

ghost commented Aug 31, 2021

ghost commented Aug 31, 2021

Lookup WSL distros in the registry #10967

Lookup WSL distros in the registry #10967

Conversation

zadjii-msft commented Aug 17, 2021 • edited by DHowett Loading

References

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

github-actions bot commented Aug 17, 2021 • edited Loading

@check-spelling-bot Report

Unrecognized words, please review:

github-actions bot commented Aug 17, 2021 • edited Loading

@check-spelling-bot Report

Unrecognized words, please review:

lhecker Aug 17, 2021

Choose a reason for hiding this comment

DHowett commented Aug 19, 2021

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.

DHowett Aug 23, 2021

Choose a reason for hiding this comment

DHowett Aug 23, 2021

Choose a reason for hiding this comment

This comment has been minimized.

ghost commented Aug 23, 2021

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

miniksa left a comment

Choose a reason for hiding this comment

miniksa Aug 23, 2021

Choose a reason for hiding this comment

lhecker Aug 23, 2021

Choose a reason for hiding this comment

DHowett Aug 24, 2021

Choose a reason for hiding this comment

lhecker Aug 23, 2021

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

lhecker left a comment

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

ghost commented Aug 31, 2021

ghost commented Aug 31, 2021

zadjii-msft commented Aug 17, 2021 •

edited by DHowett

Loading

github-actions bot commented Aug 17, 2021 •

edited

Loading

github-actions bot commented Aug 17, 2021 •

edited

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.