Avoid PATH overflow from SetupPython calls (#11215)

mmisol · web-flow · commit 4c6d2325087f · 2020-10-29T09:07:18.000-04:00
Calling Installer.SetupPython from Python.Included makes sure Python is
installed and also adds the install location to the PATH env variable.
The location is added to the PATH even if it was already there, so this
can potentially lead to an env variable overflow with the message
'Environment variable name or value is too long', after which the only
way to get CPython3 back to work would be to restart Dynamo.

The problem is avoided by remembering if Python was setup using a local
field. This should reduce the number of calls to a maximum of 2, which
is not the best (1 would be) but is far from resulting in an overflow.
diff --git a/src/Libraries/DSCPython/CPythonEvaluator.cs b/src/Libraries/DSCPython/CPythonEvaluator.cs
@@ -178,7 +178,7 @@ public static object EvaluatePythonScript(
                 return null;
             }
 
-            Python.Included.Installer.SetupPython().Wait();
+            InstallPython();
 
             if (!PythonEngine.IsInitialized)
             {
@@ -246,6 +246,21 @@ public static object EvaluatePythonScript(
             }
         }
 
+        private static bool isPythonInstalled = false;
+        /// <summary>
+        /// Makes sure Python is installed on the system and it's location added to the path.
+        /// NOTE: Calling SetupPython multiple times will add the install location to the path many times,
+        /// potentially causing the environment variable to overflow.
+        /// </summary>
+        private static void InstallPython()
+        {
+            if (!isPythonInstalled)
+            {
+                Python.Included.Installer.SetupPython().Wait();
+                isPythonInstalled = true;
+            }
+        }
+
         /// <summary>
         /// Creates and initializaes the global Python scope.
         /// </summary>
diff --git a/src/PythonMigrationViewExtension/MigrationAssistant/ScriptMigrator.cs b/src/PythonMigrationViewExtension/MigrationAssistant/ScriptMigrator.cs
@@ -19,7 +19,7 @@ internal static class ScriptMigrator
         /// <returns></returns>
         internal static string MigrateCode(string code)
         {
-            Installer.SetupPython().Wait();
+            InstallPython();
 
             if (!PythonEngine.IsInitialized)
             {
@@ -70,6 +70,21 @@ internal static string MigrateCode(string code)
             }
         }
 
+        private static bool isPythonInstalled = false;
+        /// <summary>
+        /// Makes sure Python is installed on the system and it's location added to the path.
+        /// NOTE: Calling SetupPython multiple times will add the install location to the path many times,
+        /// potentially causing the environment variable to overflow.
+        /// </summary>
+        private static void InstallPython()
+        {
+            if (!isPythonInstalled)
+            {
+                Installer.SetupPython().Wait();
+                isPythonInstalled = true;
+            }
+        }
+
         private static string Get2To3MigrationScript(Assembly asm)
         {
             return GetEmbeddedScript(asm, "Dynamo.PythonMigration.MigrationAssistant.migrate_2to3.py");

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ internal static class ScriptMigrator`
`19`	`19`	`/// <returns></returns>`
`20`	`20`	`internal static string MigrateCode(string code)`
`21`	`21`	`{`
`22`		`- Installer.SetupPython().Wait();`
	`22`	`+ InstallPython();`
`23`	`23`
`24`	`24`	`if (!PythonEngine.IsInitialized)`
`25`	`25`	`{`
`@@ -70,6 +70,21 @@ internal static string MigrateCode(string code)`
`70`	`70`	`}`
`71`	`71`	`}`
`72`	`72`
	`73`	`+ private static bool isPythonInstalled = false;`
	`74`	`+ /// <summary>`
	`75`	`+ /// Makes sure Python is installed on the system and it's location added to the path.`
	`76`	`+ /// NOTE: Calling SetupPython multiple times will add the install location to the path many times,`
	`77`	`+ /// potentially causing the environment variable to overflow.`
	`78`	`+ /// </summary>`
	`79`	`+ private static void InstallPython()`
	`80`	`+ {`
	`81`	`+ if (!isPythonInstalled)`
	`82`	`+ {`
	`83`	`+ Installer.SetupPython().Wait();`
	`84`	`+ isPythonInstalled = true;`
	`85`	`+ }`
	`86`	`+ }`
	`87`	`+`
`73`	`88`	`private static string Get2To3MigrationScript(Assembly asm)`
`74`	`89`	`{`
`75`	`90`	`return GetEmbeddedScript(asm, "Dynamo.PythonMigration.MigrationAssistant.migrate_2to3.py");`