Merge feature/fileexplorer-sourcecontrol-integration into main #3542

ssparach · 2024-08-05T18:34:56Z

Summary of the pull request

This PR adds the File Explorer Source Control Integration functionality to DevHome (as an experimental feature). This functionality allows a user to add a repository path inside DevHome for which the user can then view source control metadata (such as commit author, file status etc.) inside File Explorer

References and relevant issues

Detailed description of the pull request / Additional comments

Below is a brief summary of the changes made:

- DevHome Git Extension

Inbox extension that uses libgit2sharp to obtain information (such as last commit date, last commit author etc.)
GVFS repo compatibility: Use git.exe (if found on user machine) to obtain repository status for GVFS repos
Caching improvements for faster information retrieval

- File Explorer Source Control Integration Project

COM Server used to relay source control property information to File Explorer from the extensions
Also responsible for tracking the repositories added for this functionality and the source control extension assigned to obtain information

- DevHome.Customization

UX to add repositories inside Dev Home and choose source control extension

The PR also adds unit tests, logging and telemetry

Validation steps performed

MSIX build
Manual testing inside VM
Unit testing

PR checklist

Closes #xxx
Tests added/passed
Documentation updated

This reverts commit f30055f.

**Summary of the pull request** This PR contains implementation changes for the File Explorer Source Control Integration experimental feature. This feature will allow File Explorer to obtain property information from source control technologies for display (image attached below): **Detailed description of the pull request / Additional comments** This PR contains the following changes: - Reference official Dev Home SDK version (that defines APIs for File Explorer Source Control Integration) - Declare FileExplorerSourceControlIntegration as an experimental feature - The FileExplorerSourceControlIntegration project which creates a COM Server used to communicate information with File Explorer - The FileExplorerGitIntegration project which allows Dev Home to come with an inbox extension that understands git - Basic Unit Tests **Validation steps performed** SDK and MSIX local builds Tested Git Integration File Explorer behavior inside VM Related work items: #48431506

…ntrol extensions inside Dev Home (#2984) * changes to write/read data (extension information + root path) from json * address PR comments * revert line endings * address PR comments

* fix * move nullable property in csproj * fix format

* declare appextension for git, find all source control extensions, UI changes, SDK changes, get extension information to use for mapping * changes to map extension to registered root paths, add validation to git implementation * changes after testing * use serilog in validation code * reorder using * use published SDK version * address PR feedback * address PR feedback * address PR feedback * Minor cleanup of RepositoryTracking.cs --------- Co-authored-by: Ryan Shepherd <[email protected]>

* basic remove UI * address feedback

* detect git and invoke functionality * address PR comments * address PR feedback * address style comments

* WARP SPEED COMMIT HISTORY. Rooted out and worked around a major bottleneck inside LibGit2Sharp * Better status * Introduce RepositoryWrapper to lock access to Repository * Update unit test to reflect new repo status * Check cache before calling Repository.IsValid

…inside Dev Home (#3484) * proposed telemetry changes for add/remove repository * remove unrequired using statements * address PR feedback * address PR feedback * adjust comment * add count of repos tracked inside Dev Home to event

… flavors in appxmanifest

* reset branch to 548d868 * Revert "reset branch to 548d868" This reverts commit f30055f. * Merged PR 10695071: Move to feature branch in preparation for GitHub **Summary of the pull request** This PR contains implementation changes for the File Explorer Source Control Integration experimental feature. This feature will allow File Explorer to obtain property information from source control technologies for display (image attached below): **Detailed description of the pull request / Additional comments** This PR contains the following changes: - Reference official Dev Home SDK version (that defines APIs for File Explorer Source Control Integration) - Declare FileExplorerSourceControlIntegration as an experimental feature - The FileExplorerSourceControlIntegration project which creates a COM Server used to communicate information with File Explorer - The FileExplorerGitIntegration project which allows Dev Home to come with an inbox extension that understands git - Basic Unit Tests **Validation steps performed** SDK and MSIX local builds Tested Git Integration File Explorer behavior inside VM Related work items: #48431506 * Mapping of extensions to repository paths in DevHome core (#3230) * declare appextension for git, find all source control extensions, UI changes, SDK changes, get extension information to use for mapping * changes to map extension to registered root paths, add validation to git implementation * changes after testing * use serilog in validation code * reorder using * use published SDK version * address PR feedback * address PR feedback * address PR feedback * Minor cleanup of RepositoryTracking.cs --------- Co-authored-by: Ryan Shepherd <[email protected]> * save state * save state * save state * save state * save state * implement button actions * changes * address PR feedback * address PR feedback * rebased user branch, made fixes, validated functionality on VM * cleanup UI changes, tested on VM * fix proj references to match dev home feed and unblock PR pipeline --------- Co-authored-by: Ryan Shepherd <[email protected]>

* fix class ids * remaining modifications for ClassId change

krschau · 2024-08-05T20:51:40Z

.../GitExtension/FileExplorerGitIntegration.UnitTest/FileExplorerGitIntegration.UnitTest.csproj

@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk">


Can you do a Control+K+D in visual studio on the new csproj files? Standard is 2 space indents, not 4.

krschau · 2024-08-05T20:51:59Z

.../GitExtension/FileExplorerGitIntegration.UnitTest/FileExplorerGitIntegration.UnitTest.csproj

+ <PackageReference Include="MSTest.TestFramework" Version="2.2.10" />
+ </ItemGroup>
+ <ItemGroup>
+ <ProjectReference Include="..\FileExplorerGitIntegration\FileExplorerGitIntegration.csproj" />


Would be great if you could add the new projects to the architecture diagram here: https://github.com/microsoft/devhome/blob/main/docs/architecture.md

krschau · 2024-08-05T20:53:25Z

extensions/GitExtension/FileExplorerGitIntegration/FileExplorerGitIntegration.csproj

+ </None>
+ </ItemGroup>
+
+ <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">


Also add a "Debug_FailFast" group here

krschau · 2024-08-05T20:57:30Z

DevHome.sln

@@ -163,6 +163,16 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "WSLExtension", "WSLExtensio
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WSLExtension", "extensions\WSLExtension\WSLExtension.csproj", "{B6153EEA-EADE-4BAA-B47D-6B48205C6696}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FileExplorerGitIntegration", "extensions\GitExtension\FileExplorerGitIntegration\FileExplorerGitIntegration.csproj", "{5366F178-AD59-475C-B78D-2E6483313F9E}"


(not about this file) This change seems to introduce files with both crlf and lf line endings. Might be a good idea to change everything to CRLF before merging.

krschau · 2024-08-05T21:02:43Z

extensions/GitExtension/FileExplorerGitIntegration/Models/RepositoryWrapper.cs

+ private GitDetect _gitDetect = new();
+ private bool _gitInstalled;


Can be readonly (I opened the branch in VS, I'm not that good at noticing 🙂)

krschau · 2024-08-05T21:03:12Z

extensions/GitExtension/FileExplorerGitIntegration/Models/RepositoryWrapper.cs

+ private readonly List<GitStatusEntry> _untracked = new();
+ private readonly List<GitStatusEntry> _modified = new();
+ private readonly List<GitStatusEntry> _missing = new();
+ private readonly List<GitStatusEntry> _ignored = new();


krschau · 2024-08-05T21:05:53Z

extensions/GitExtension/FileExplorerGitIntegration/Program.cs

+public sealed class Program
+{
+ [MTAThread]
+ public static void Main([System.Runtime.InteropServices.WindowsRuntime.ReadOnlyArray] string[] args)


Please include fixes from #3445

krschau · 2024-08-05T21:08:26Z

src/Package-Can.appxmanifest

@@ -128,6 +142,20 @@
 </uap3:Properties>
 </uap3:AppExtension>
 </uap3:Extension>
+ <uap3:Extension Category="windows.appExtension">
+ <uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID3" PublicFolder="Public" DisplayName="ms-resource:AppDisplayNameGitExt" Description="ms-resource:AppDescriptionGitExt">


Need to change the Id, we already have PG-SP-ID3 (same for other two appxmanifests)

Suggested change

<uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID3" PublicFolder="Public" DisplayName="ms-resource:AppDisplayNameGitExt" Description="ms-resource:AppDescriptionGitExt">

<uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID4" PublicFolder="Public" DisplayName="ms-resource:AppDisplayNameGitExt" Description="ms-resource:AppDescriptionGitExt">

krschau · 2024-08-05T21:11:18Z

tools/Customization/DevHome.Customization/Views/FileExplorerPage.xaml

+ xmlns:converters="using:CommunityToolkit.WinUI.Converters" 
+ xmlns:viewmodels="using:DevHome.Customization.ViewModels" 
+ xmlns:ctControls="using:CommunityToolkit.WinUI.Controls"


Don't need these 3.

krschau · 2024-08-05T21:12:37Z

tools/Customization/DevHome.FileExplorerSourceControlIntegration/Program.cs

+public sealed class Program
+{
+ [MTAThread]
+ public static void Main([System.Runtime.InteropServices.WindowsRuntime.ReadOnlyArray] string[] args)


Same comment about #3445

ssparach and others added 17 commits July 31, 2024 13:29

reset branch to 548d868

e7e1313

Revert "reset branch to 548d868"

3da425c

This reverts commit f30055f.

Data storage (i.e. extension and registered root path) for version co…

a85702b

…ntrol extensions inside Dev Home (#2984) * changes to write/read data (extension information + root path) from json * address PR comments * revert line endings * address PR comments

CI Build Fix (#3169)

4b582d6

* fix * move nullable property in csproj * fix format

Update internal interface usage for FileExplorer integration (#3151)

6e3f0b7

Temporary UI to unblock removal of registered repositories (#3402)

b74a32d

* basic remove UI * address feedback

Detect/install command-line git and invoke (#3419)

1b1dc2b

* detect git and invoke functionality * address PR comments * address PR feedback * address style comments

Use installed Git command line for fetching repo status (#3509)

c6d0099

build fixes after rebase

ce7aa4c

fix stylecop errors and make additions required for different package…

e7bc4e1

… flavors in appxmanifest

remove unused references, clean documentation change in feature branch

2e12cdf

Fix duplicate class ids (#3535)

1d1395c

* fix class ids * remaining modifications for ClassId change

ssparach changed the title ~~Feature/fileexplorer sourcecontrol integration~~ Merge feature/fileexplorer sourcecontrol integration into main Aug 5, 2024

ssparach changed the title ~~Merge feature/fileexplorer sourcecontrol integration into main~~ Merge feature/fileexplorer-sourcecontrol-integration into main Aug 5, 2024

Merge branch 'main' into feature/fileexplorer-sourcecontrol-integration

a1d7652

ssparach marked this pull request as ready for review August 5, 2024 19:37

ssparach requested a review from DefaultRyan August 5, 2024 19:37

krschau reviewed Aug 5, 2024

View reviewed changes

fix build

fbacaaa

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge feature/fileexplorer-sourcecontrol-integration into main #3542

Merge feature/fileexplorer-sourcecontrol-integration into main #3542

ssparach commented Aug 5, 2024 •

edited

Loading

krschau Aug 5, 2024

krschau Aug 5, 2024

krschau Aug 5, 2024

krschau Aug 5, 2024

krschau Aug 5, 2024

krschau Aug 5, 2024

krschau Aug 5, 2024

krschau Aug 5, 2024

krschau Aug 5, 2024

krschau Aug 5, 2024

		private GitDetect _gitDetect = new();
		private bool _gitInstalled;

	<uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID3" PublicFolder="Public" DisplayName="ms-resource:AppDisplayNameGitExt" Description="ms-resource:AppDescriptionGitExt">
	<uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID4" PublicFolder="Public" DisplayName="ms-resource:AppDisplayNameGitExt" Description="ms-resource:AppDescriptionGitExt">

Merge feature/fileexplorer-sourcecontrol-integration into main #3542

Are you sure you want to change the base?

Merge feature/fileexplorer-sourcecontrol-integration into main #3542

Conversation

ssparach commented Aug 5, 2024 • edited Loading

Summary of the pull request

References and relevant issues

Detailed description of the pull request / Additional comments

- DevHome Git Extension

- File Explorer Source Control Integration Project

- DevHome.Customization

Validation steps performed

PR checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ssparach commented Aug 5, 2024 •

edited

Loading