fix the new deviceid tests Make sure we return an empty string if caching fails but don't error our code refactor the caching code slightly for simplicity

Author: marcpopMSFT

src/Cli/dotnet/Telemetry/DevDeviceIDGetter.cs

@@ -18,7 +18,15 @@ public static string GetDeviceId()
                 deviceId = Guid.NewGuid().ToString("D").ToLowerInvariant();
 
                 // Cache the new device Id
-                CacheDeviceId(deviceId);
+                try
+                {
+                    CacheDeviceId(deviceId);
+                }
+                catch
+                {
+                    // If caching fails, return empty string to avoid sending a non-stored id
+                    deviceId = ""
+                }
             }
 
             return deviceId;
@@ -92,14 +100,25 @@ private static void CacheDeviceId(string deviceId)
                     cacheFilePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), ".cache", "deviceid");
                 }
 
-                File.WriteAllText(cacheFilePath, deviceId);
+                CreateDirectoryAndWriteToFile(cacheFilePath, deviceId);
             }
             else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
             {
                 // Cache device Id in macOS cache file
                 string cacheFilePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), "Library", "Application Support", "Microsoft", "DeveloperTools", "deviceid");
-                File.WriteAllText(cacheFilePath, deviceId);
+
+                CreateDirectoryAndWriteToFile(cacheFilePath, deviceId);
+            }
+        }
+
+        private static void CreateDirectoryAndWriteToFile(string filePath, string content)
+        {
+            string directory = Path.GetDirectoryName(filePath);
+            if (!Directory.Exists(directory))
+            {
+                Directory.CreateDirectory(directory);
             }
+            File.WriteAllText(filePath, content);
         }
     }
 }

src/Cli/dotnet/Telemetry/TelemetryCommonProperties.cs

@@ -43,7 +43,7 @@ public TelemetryCommonProperties(
         private const string ProductVersion = "Product Version";
         private const string TelemetryProfile = "Telemetry Profile";
         private const string CurrentPathHash = "Current Path Hash";
-        private const string DeviceId = "DeviceId";
+        private const string DeviceId = "devdeviceid";
         private const string MachineId = "Machine ID";
         private const string MachineIdOld = "Machine ID Old";
         private const string DockerContainer = "Docker Container";

src/Tests/dotnet.Tests/TelemetryCommonPropertiesTests.cs

@@ -37,7 +37,7 @@ public void TelemetryCommonPropertiesShouldReturnHashedMachineId()
         public void TelemetryCommonPropertiesShouldReturnDevDeviceId()
         {
             var unitUnderTest = new TelemetryCommonProperties(getDeviceId: () => "plaintext", userLevelCacheWriter: new NothingCache());
-            unitUnderTest.GetTelemetryCommonProperties()["DevDeviceId"].Should().Be("plaintext");
+            unitUnderTest.GetTelemetryCommonProperties()["devdeviceid"].Should().Be("plaintext");
         }
 
         [Fact]
@@ -52,8 +52,8 @@ public void TelemetryCommonPropertiesShouldReturnNewGuidWhenCannotGetMacAddress(
         [Fact]
         public void TelemetryCommonPropertiesShouldReturnNewGuidWhenCannotDevDeviceId()
         {
-            var unitUnderTest = new TelemetryCommonProperties(getDeviceId: () => null, userLevelCacheWriter: new NothingCache());
-            var assignedMachineId = unitUnderTest.GetTelemetryCommonProperties()["DevDeviceId"];
+            var unitUnderTest = new TelemetryCommonProperties(userLevelCacheWriter: new NothingCache());
+            var assignedMachineId = unitUnderTest.GetTelemetryCommonProperties()["devdeviceid"];
 
             Guid.TryParse(assignedMachineId, out var _).Should().BeTrue("it should be a guid");
         }