Add WSL extension to Dev Home #3365
Conversation
bbonaby
requested review from
AmelBawa-msft,
EricJohnson327,
SohamDas2021,
dhoehna,
huzaifa-d,
jsidewhite,
kanismohammed,
krschau,
safmswork,
sshilov7 and
vineeththomasalex
extensions/WSLExtension/DistributionDefinitions/DistributionDefinitionHelper.cs
Outdated
Show resolved
Hide resolved
tools/SetupFlow/DevHome.SetupFlow/Views/Environments/SelectEnvironmentProviderView.xaml
Show resolved
Hide resolved
extensions/WSLExtension/Models/WslInstallDistributionOperation.cs
Outdated
Show resolved
Hide resolved
extensions/WSLExtension/DistributionDefinitions/DistributionDefinitionHelper.cs
Outdated
Show resolved
Hide resolved
extensions/WSLExtension/DistributionDefinitions/DistributionDefinitionHelper.cs
Show resolved
Hide resolved
extensions/WSLExtension/DistributionDefinitions/DistributionDefinitionHelper.cs
Outdated
Show resolved
Hide resolved
extensions/WSLExtension/Models/WslInstallDistributionOperation.cs
Outdated
Show resolved
Hide resolved
extensions/WSLExtension/DistributionDefinitions/DistributionDefinition.yaml
Outdated
Show resolved
Hide resolved
extensions/WSLExtension/Models/RegisterAndInstallDistributionSession.cs
Outdated
Show resolved
Hide resolved
| xmlns:converters="using:CommunityToolkit.WinUI.Converters"> | ||
|
|
||
| <!--- Data templates for custom adaptive card renders can go here --> | ||
| <converters:EmptyObjectToObjectConverter x:Key="EmptyObjectToObjectConverter" NotEmptyValue="Visible" EmptyValue="Collapsed"/> |
There was a problem hiding this comment.
NIT: rename the key name to EmptyObjectToVisibilityConverter
|
|
||
| // Launch terminal with specific profile and log the user into their home directory in the login shell | ||
| // Note: this opens a new terminal window in the UI | ||
| public static string LaunchDistributionInTerminalWithProfile { get; } = "--profile {0} -- wsl --shell-type login --cd ~ --distribution {1}"; |
There was a problem hiding this comment.
NIT for this and the other strings. Explain what the placeholders are for. This way calling code does not need to look at the string.
Another option is to remove the properties all together and change these into methods. Then, the code can describe the format with parameters.
There was a problem hiding this comment.
I don't think it would make sense to make them into methods, because in the future when the WSL team provides us with apis then we'd need to remove/change those methods. Today we're using wsl.exe under the hood, but I've made it in a way where, when we get new apis, only the body of the methods that use these strings need to change, not the method themselves.
Ultimately if you typed in wsl --help in your command line window you'll see what these commands are used for but I can add it to the comments if you feel strongly about it.
extensions/WSLExtension/DistributionDefinitions/DistributionDefinition.yaml
Outdated
Show resolved
Hide resolved
extensions/WSLExtension/DistributionDefinitions/DistributionDefinitionHelper.cs
Show resolved
Hide resolved
extensions/WSLExtension/DistributionDefinitions/DistributionDefinitionHelper.cs
Outdated
Show resolved
Hide resolved
extensions/WSLExtension/DistributionDefinitions/DistributionDefinitionHelper.cs
Show resolved
Hide resolved
extensions/WSLExtension/Models/RegisterAndInstallDistributionSession.cs
Outdated
Show resolved
Hide resolved
|
Please run through all your examples with text scaling set to 200%. |
|
@dhoehna , just confirmed at 225%, everything still looks good with no issues. |
|
Just popping in to say thank you for this :) |
Summary of the pull request
This PR adds the WSL extension to Dev Home. We'd like to thank @crramirez for allowing us to use his original Dev Home WSL extension as a base for this official extension.
Now on to changes:
- Added the WSLExtension project under the extensions folder
- Added the COM extension guid information to the appxmanifest file
- Added the WSL extension guid to the set for internal guids in the extensions library so it can be enabled/disabled.
- Added template specifically for settings cards used in environment creation to allow for bigger icons.
- Added template in environment project to allow a single button to be shown when there are no launch operations available.
WSL extension architecture:
First thing to note, is that the WSL API surface is very limited and so we will be working with the WSL team to provide us with a APIs in the future to perform all WSL tasks. Until then our approach here will be to use a mix of calling wsl.exe (the only way to interact with wsl through code) and reading from the registry. There are technically a small number of apis listed here: Wslapi.h header - Win32 apps | Microsoft Learn, but it is very limited and won't be updated like how wsl.exe is continuously being updated, so we won't be using those.
Sequence diagram that shows flow for retrieving registered WSL distributions (Click the <--> button for a larger view) :
sequenceDiagram DevHome->>+WslProvider: Requests for list of Dev Home compute system SDK objects WslProvider->>+WslManager: Requests for a list of WslComputeSystem objects WslManager->>+DistributionDefinitionHelper: Requests for all distribution definitions the helper knows about DistributionDefinitionHelper->>+DistributionDefinitionHelper: Uses web and local yaml to build definition objects for each distribution. DistributionDefinitionHelper->>+WslManager: Returns dictionary of distribution definition objects WslManager->>+WslservicesMediator: caches definition objects and requests a list of all WslRegisteredDistribution objects on the machine WslservicesMediator->>+WslManager: Reads registry and returns a WslRegisteredDistribution object for each registered distribution it finds WslManager-->>-WslManager: Fills out each WslRegisteredDistribution object with additional metadata if the object has a corresponding Distribution definition. E.g adding logos/Publisher info to the WslRegisteredDistribution object. WslManager-->>-WslProvider: Creates list of Dev Home compute system SDK objects that represent a registered WSL distribution and returns the list WslProvider-->>-DevHome: Returns list of compute systemsSequence diagram that shows flow for creating/installing a WSL distribution (Click the <--> button for a larger view):
sequenceDiagram DevHome->>+WslProvider: Requests creation adaptive card session WslProvider->>+WslManager: Requests for all available distribution definition objects WslManager->>+WslProvider: Returns filtered list of definition objects. Anyones that are already registered are removed. WslProvider->>+WslProvider: Creates a new adaptive card session for creation with this list of available distributions. WslProvider->>+DevHome: Returns adaptive card session DevHome->>+RegisterAndInstallDistributionSession: requests initial creation adaptive card RegisterAndInstallDistributionSession->>+DevHome: Returns adaptive card with list of single select settings cards DevHome->>+RegisterAndInstallDistributionSession: User selects a card and selects next button, invoking the sessions OnAction method RegisterAndInstallDistributionSession->>+DevHome: Returns Review page adaptive card DevHome->>+RegisterAndInstallDistributionSession: User selects 'Create environment' button, invoking the sessions OnAction method RegisterAndInstallDistributionSession->>+DevHome: Raises session ended event with user input json in payload which contains distribution to install DevHome->>+WslProvider: Requests to create a new compute system with the returned input payload WslProvider->>+DevHome: Returns CreateComputeSystemOperation Dev Home SDK object (WslInstallDistributionOperation) DevHome->>+WslInstallDistributionOperation: Starts operation WslInstallDistributionOperation->>+WslManager: Requests to install Wsl distribution WslManager-->>+WslservicesMediator: Requests to install Wsl distribution WslservicesMediator-->>-WslservicesMediator: Initiates wsl.exe --install with distribution name and returns loop Check if distribution installed. Timeout in 10 minutes WslInstallDistributionOperation-->>+WslManager: Request for registered distribution with user provided distribution name. Break when found end WslInstallDistributionOperation-->>-DevHome: Creates and returns a new compute system that contains information on the newly registered distributionVideos:
Video of me creating a WSL compute system:
creating.ubuntu.distribution.mp4
Video of me launching a WSL compute system:
ubuntu.launch.mp4
Video of me Terminating all sessions a WSL compute system:
ubuntu.terminate.mp4
Video of me Deleting a WSL compute system:
debian.delete.mp4
References and relevant issues
Detailed description of the pull request / Additional comments
Validation steps performed
Confirmed that the Hyper-v environment and dev box environment are still working as intended. Also confirmed no regressions in other parts of Dev Home.
PR checklist