Mount: Remove tracing on TryAttach

Allow the caller to determine how to handle the error. This is because a command line error may fail due to permissions and be retried successfully by the service.
microsoft · Oct 25, 2018 · f2c63e8 · f2c63e8
1 parent 9b2d5a8
commit f2c63e8
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 7 deletions.
diff --git a/GVFS/GVFS.Platform.Windows/ProjFSFilter.cs b/GVFS/GVFS.Platform.Windows/ProjFSFilter.cs
@@ -47,7 +47,7 @@ private enum ProjFSInboxStatus
 
         public string DriverLogFolderName { get; } = ProjFSFilter.ServiceName;
 
-        public static bool TryAttach(ITracer tracer, string enlistmentRoot, out string errorMessage)
+        public static bool TryAttach(string enlistmentRoot, out string errorMessage)
         {
             errorMessage = null;
             try
@@ -56,22 +56,19 @@ public static bool TryAttach(ITracer tracer, string enlistmentRoot, out string e
                 if (!NativeMethods.GetVolumePathName(enlistmentRoot, volumePathName, GVFSConstants.MaxPath))
                 {
                     errorMessage = "Could not get volume path name";
-                    tracer.RelatedError($"{nameof(TryAttach)}:{errorMessage}");
                     return false;
                 }
 
                 uint result = NativeMethods.FilterAttach(DriverName, volumePathName.ToString(), null);
                 if (result != OkResult && result != NameCollisionErrorResult)
                 {
                     errorMessage = string.Format("Attaching the filter driver resulted in: {0}", result);
-                    tracer.RelatedError(errorMessage);
                     return false;
                 }
             }
             catch (Exception e)
             {
                 errorMessage = string.Format("Attaching the filter driver resulted in: {0}", e.Message);
-                tracer.RelatedError(errorMessage);
                 return false;
             }
 
@@ -373,7 +370,7 @@ public bool IsReady(JsonTracer tracer, string enlistmentRoot, out string error)
             return
                 IsServiceRunning(tracer) &&
                 IsNativeLibInstalled(tracer, new PhysicalFileSystem()) &&
-                TryAttach(tracer, enlistmentRoot, out error);
+                TryAttach(enlistmentRoot, out error);
         }
 
         private static bool IsInboxAndEnabled()

diff --git a/GVFS/GVFS.Service/Handlers/EnableAndAttachProjFSHandler.cs b/GVFS/GVFS.Service/Handlers/EnableAndAttachProjFSHandler.cs
@@ -130,7 +130,7 @@ public void Run()
 
             if (!string.IsNullOrEmpty(this.request.EnlistmentRoot))
             {
-                if (!ProjFSFilter.TryAttach(this.tracer, this.request.EnlistmentRoot, out errorMessage))
+                if (!ProjFSFilter.TryAttach(this.request.EnlistmentRoot, out errorMessage))
                 {
                     state = NamedPipeMessages.CompletionState.Failure;
                     this.tracer.RelatedError("Unable to attach filter to volume. Enlistment root: {0} \nError: {1} ", this.request.EnlistmentRoot, errorMessage);

diff --git a/GVFS/GVFS/CommandLine/MountVerb.cs b/GVFS/GVFS/CommandLine/MountVerb.cs
@@ -117,7 +117,14 @@ protected override void Execute(GVFSEnlistment enlistment)
 
                 if (!GVFSPlatform.Instance.KernelDriver.IsReady(tracer, enlistment.EnlistmentRoot, out errorMessage))
                 {
-                    tracer.RelatedInfo($"{nameof(MountVerb)}.{nameof(this.Execute)}: Enabling and attaching ProjFS through service");
+                    tracer.RelatedEvent(
+                        EventLevel.Informational,
+                            $"{nameof(MountVerb)}_{nameof(this.Execute)}_EnablingKernelDriverViaService",
+                            new EventMetadata
+                            {
+                                { "KernelDriver.IsReady_Error", errorMessage },
+                                { TracingConstants.MessageKey.InfoMessage, "Service will retry" }
+                            });
 
                     if (!this.ShowStatusWhileRunning(
                         () => { return this.TryEnableAndAttachPrjFltThroughService(enlistment.EnlistmentRoot, out errorMessage); },