maxmustermann/PowerToys
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[PT Run] EnvironmentHelper: Adding logging and error handling (#13205)

Browse source 
* Add error handling and logging

* improvements

* fix typos

* comment updates

* fix typos
This commit is contained in:
Heiko 2021-09-16 12:17:33 +02:00 committed by GitHub
parent 881b1da6a7
commit 9fb663210d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
src/modules/launcher/PowerLauncher/Helper/EnvironmentHelper.cs
View file

@ -51,7 +51,29 @@ namespace PowerLauncher.Helper
foreach (KeyValuePair<string, string> kv in environment)
{
Environment.SetEnvironmentVariable(kv.Key, kv.Value, EnvironmentVariableTarget.Process);
// Initialize variables for length of environment variable name and value. Using this variables prevent us from null value exceptions.
int varNameLength = kv.Key == null ? 0 : kv.Key.Length;
int varValueLength = kv.Value == null ? 0 : kv.Value.Length;
// The name of environment variables must not be null, empty or have a length of zero.
// But if the value of the environment variable is null or empty then the variable is explicit defined for deletion. => Here we don't need to check anything.
if (!string.IsNullOrEmpty(kv.Key) & varNameLength > 0)
{
try
{
Environment.SetEnvironmentVariable(kv.Key, kv.Value, EnvironmentVariableTarget.Process);
}
catch (ArgumentException ex)
{
// The dotnet method <see cref="System.Environment.SetEnvironmentVariable"/> has it's own internal method to check the input parameters. Here we catch the exceptions that we don't check before updating the environment variable and log it to avoid crashes of PT Run.
Log.Exception($"Unexpected exception while updating the environment variable [{kv.Key}] for the PT Run process. (The variable value has a length of [{varValueLength}].)", ex, typeof(PowerLauncher.Helper.EnvironmentHelper));
}
}
else
{
// Log the error when variable value is null, empty or has a length of zero.
Log.Error($"Failed to update the environment variable [{kv.Key}] for the PT Run process. Their name is null or empty. (The variable value has a length of [{varValueLength}].)", typeof(PowerLauncher.Helper.EnvironmentHelper));
}
}
}