Merge pull request #196 from unity/open-latency

Optimize latency when opening a file with Visual Studio

Author: sailro

.yamato/CI.yml

@@ -10,17 +10,17 @@ editors:
 platforms:
   - name: win
     type: Unity::VM
-    image: scripting/scripting-bokken-images:latest
+    image: package-ci/win10:v4
     flavor: b1.large
     envsetup: echo
   - name: mac
     type: Unity::VM::osx
-    image: package-ci/mac:stable
+    image: package-ci/macos-13:v4
     flavor: m1.mac
     envsetup: echo
   - name: linux
     type: Unity::VM
-    image: package-ci/ubuntu:stable
+    image: package-ci/ubuntu-22.04:v4
     flavor: b1.large
     envsetup: npm config set prefix '~/npm-global'
 
@@ -113,7 +113,7 @@ run_vetting_test_project_{{ editor.version }}:
   name: Run vetting tests on {{ editor.version }}
   agent:
     type: Unity::VM
-    image: package-ci/ubuntu:stable
+    image: package-ci/ubuntu-22.04:v4
     flavor: b1.large
   variables:
     PATH: /home/bokken/bin:/home/bokken/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/sbin:/home/bokken/.npm-global/bin::/home/bokken/npm-global/bin
@@ -203,7 +203,7 @@ publish_release:
 {% endfor %}
   agent:
     type: Unity::VM
-    image: package-ci/win10:stable
+    image: package-ci/win10:v4
     flavor: b1.large
   variables:
     UPMCI_ENABLE_PACKAGE_SIGNING: 1

Packages/com.unity.ide.visualstudio/Editor/VisualStudioEditor.cs

@@ -228,7 +228,27 @@ public bool OpenProject(string path, int line, int column)
 			if (!IsProjectGeneratedFor(path, generator, out var missingFlag))
 				Debug.LogWarning($"You are trying to open {path} outside a generated project. This might cause problems with IntelliSense and debugging. To avoid this, you can change your .csproj preferences in Edit > Preferences > External Tools and enable {GetProjectGenerationFlagDescription(missingFlag)} generation.");
 
-			var solution = GetOrGenerateSolutionFile(generator);
+			if (!generator.HasSolutionBeenGenerated())
+			{
+				// If no solution has been generated, run a sync before opening the solution
+				generator.Sync();
+				return OpenFromInstallation(installation, path, line, column);
+			}
+			else
+			{
+				// Else chances are high that the solution is up-to-date, proactively open the solution for better latency
+				var result = OpenFromInstallation(installation, path, line, column);
+				
+				// But run a sync to make sure everything is up-to-date. Best case we'll do nothing (apart from checking compilation objects), worst case VS will reload touched projects.
+				generator.Sync();
+
+				return result;
+			}
+		}
+
+		private static bool OpenFromInstallation(IVisualStudioInstallation installation, string path, int line, int column)
+		{
+			var solution = installation.ProjectGenerator.SolutionFile();
 			return installation.Open(path, line, column, solution);
 		}
 
@@ -291,11 +311,5 @@ private static bool IsProjectGeneratedFor(string path, IGenerator generator, out
 			missingFlag = flag;
 			return false;
 		}
-
-		private static string GetOrGenerateSolutionFile(IGenerator generator)
-		{
-			generator.Sync();
-			return generator.SolutionFile();
-		}
 	}
 }