Add logging of Alire interactions

Author: eliericha

source/ada/lsp-alire.adb

@@ -19,6 +19,7 @@ with Ada.Streams;
 with GNAT.OS_Lib;
 with GNATCOLL.VFS;
 
+with LSP.GNATCOLL_Tracers;
 with VSS.Stream_Element_Vectors;
 with VSS.Strings.Conversions;
 with VSS.Strings.Converters.Decoders;
@@ -34,27 +35,30 @@ with Spawn.String_Vectors;
 
 package body LSP.Alire is
 
+   Trace : constant GNATCOLL_Tracers.Tracer :=
+     GNATCOLL_Tracers.Create ("ALS.ALIRE");
+
    Fallback_Msg : constant VSS.Strings.Virtual_String :=
      "falling back to other methods to load a project";
 
    type Process_Listener is limited
-     new Spawn.Process_Listeners.Process_Listener with record
+     new Spawn.Process_Listeners.Process_Listener
+   with record
       Process : Spawn.Processes.Process;
       Stdout  : VSS.Stream_Element_Vectors.Stream_Element_Vector;
       Stderr  : VSS.Stream_Element_Vectors.Stream_Element_Vector;
       Error   : Integer := 0;  --  Error_Occurred argument
       Text    : VSS.Strings.Virtual_String;  --  Stdout as a text
-     end record;
+   end record;
 
-   overriding procedure Standard_Output_Available
-     (Self : in out Process_Listener);
+   overriding
+   procedure Standard_Output_Available (Self : in out Process_Listener);
 
-   overriding procedure Standard_Error_Available
-     (Self : in out Process_Listener);
+   overriding
+   procedure Standard_Error_Available (Self : in out Process_Listener);
 
-   overriding procedure Error_Occurred
-     (Self  : in out Process_Listener;
-      Error : Integer);
+   overriding
+   procedure Error_Occurred (Self : in out Process_Listener; Error : Integer);
 
    procedure Start_Alire
      (ALR      : String;
@@ -71,9 +75,9 @@ package body LSP.Alire is
    -- Error_Occurred --
    --------------------
 
-   overriding procedure Error_Occurred
-     (Self  : in out Process_Listener;
-      Error : Integer) is
+   overriding
+   procedure Error_Occurred (Self : in out Process_Listener; Error : Integer)
+   is
    begin
       Self.Error := Error;
    end Error_Occurred;
@@ -83,9 +87,9 @@ package body LSP.Alire is
    ---------------
 
    procedure Determine_Alire_Project
-     (Root        : String;
-      Error       : out VSS.Strings.Virtual_String;
-      Project     : out VSS.Strings.Virtual_String)
+     (Root    : String;
+      Error   : out VSS.Strings.Virtual_String;
+      Project : out VSS.Strings.Virtual_String)
    is
       use type GNAT.OS_Lib.String_Access;
       use type VSS.Strings.Virtual_String;
@@ -100,12 +104,13 @@ package body LSP.Alire is
         VSS.Regular_Expressions.To_Regular_Expression
           (" +Project_File: ([^\n]+)");
 
-      Lines    : VSS.String_Vectors.Virtual_String_Vector;
+      Lines : VSS.String_Vectors.Virtual_String_Vector;
    begin
       Project.Clear;
 
       if ALR = null then
-         Error := "Alire executable ('alr') not found in PATH: " & Fallback_Msg;
+         Error :=
+           "Alire executable ('alr') not found in PATH: " & Fallback_Msg;
          return;
       end if;
 
@@ -142,8 +147,9 @@ package body LSP.Alire is
       for Line of Lines loop
          declare
             --  We should keep copy of regexp subject string while we have a match
-            Match : constant VSS.Regular_Expressions.Regular_Expression_Match :=
-            Crate_Pattern.Match (Line);
+            Match :
+              constant VSS.Regular_Expressions.Regular_Expression_Match :=
+                Crate_Pattern.Match (Line);
          begin
             if Match.Has_Match then
                Project := Match.Captured (1);
@@ -156,8 +162,9 @@ package body LSP.Alire is
       --  Next check if there is a Project_File line, take the first one.
       for Line of Lines loop
          declare
-            Match : constant VSS.Regular_Expressions.Regular_Expression_Match
-              := Project_Pattern.Match (Line, Anchored);
+            Match :
+              constant VSS.Regular_Expressions.Regular_Expression_Match :=
+                Project_Pattern.Match (Line, Anchored);
          begin
             if Match.Has_Match then
                Project := Match.Captured (1);
@@ -167,7 +174,8 @@ package body LSP.Alire is
       end loop;
 
       if Project.Is_Empty then
-         Error.Append ("No project file could be determined from the output of `alr show`:");
+         Error.Append
+           ("No project file could be determined from the output of `alr show`:");
          for Line of Lines loop
             Error.Append (Line);
          end loop;
@@ -194,7 +202,7 @@ package body LSP.Alire is
         VSS.Regular_Expressions.To_Regular_Expression
           ("export ([^=]+)=""([^\n]+)""");
 
-      Lines    : VSS.String_Vectors.Virtual_String_Vector;
+      Lines : VSS.String_Vectors.Virtual_String_Vector;
    begin
 
       if ALR = null then
@@ -211,15 +219,18 @@ package body LSP.Alire is
 
       for Line of Lines loop
          declare
-            Match : constant VSS.Regular_Expressions.Regular_Expression_Match
-              := Export_Pattern.Match (Line, Anchored);
+            Match :
+              constant VSS.Regular_Expressions.Regular_Expression_Match :=
+                Export_Pattern.Match (Line, Anchored);
          begin
             if Match.Has_Match then
                Environment.Insert
-                 (Key   => VSS.Strings.Conversions.To_UTF_8_String
-                             (Match.Captured (1)),
-                  Value => VSS.Strings.Conversions.To_UTF_8_String
-                             (Match.Captured (2)));
+                 (Key   =>
+                    VSS.Strings.Conversions.To_UTF_8_String
+                      (Match.Captured (1)),
+                  Value =>
+                    VSS.Strings.Conversions.To_UTF_8_String
+                      (Match.Captured (2)));
             end if;
          end;
       end loop;
@@ -241,18 +252,24 @@ package body LSP.Alire is
       use type Spawn.Process_Exit_Status;
       use type Spawn.Process_Status;
 
-      Item     : aliased Process_Listener;
-      Process  : Spawn.Processes.Process renames Item.Process;
-      Options  : Spawn.String_Vectors.UTF_8_String_Vector;
-      Decoder  : VSS.Strings.Converters.Decoders.Virtual_String_Decoder;
-      Text     : VSS.Strings.Virtual_String;
+      Item    : aliased Process_Listener;
+      Process : Spawn.Processes.Process renames Item.Process;
+      Options : Spawn.String_Vectors.UTF_8_String_Vector;
+      Decoder : VSS.Strings.Converters.Decoders.Virtual_String_Decoder;
+      Text    : VSS.Strings.Virtual_String;
    begin
       Options.Append (Option_1);
       Options.Append (Option_2);
       Process.Set_Arguments (Options);
       Process.Set_Working_Directory (Root);
       Process.Set_Program (ALR);
       Process.Set_Listener (Item'Unchecked_Access);
+
+      if Trace.Is_Active then
+         Trace.Trace
+           ("(in " & Root & ") " & ALR & " " & Option_1 & " " & Option_2);
+      end if;
+
       Process.Start;
 
       loop
@@ -261,6 +278,21 @@ package body LSP.Alire is
          exit when Item.Process.Status = Spawn.Not_Running;
       end loop;
 
+      if Trace.Is_Active then
+         Trace.Trace
+           ("Alire exit code "
+            & Item.Process.Exit_Code'Image
+            & " with output:");
+
+         if not Item.Stdout.Is_Empty then
+            Trace.Trace (Item.Stdout);
+         end if;
+
+         if not Item.Stderr.Is_Empty then
+            Trace.Trace (Item.Stderr);
+         end if;
+      end if;
+
       Decoder.Initialize ("utf-8");
 
       --  Decode output and check errors
@@ -309,15 +341,15 @@ package body LSP.Alire is
                  (GNAT.OS_Lib.Errno_Message (Item.Error)));
          end if;
       end if;
+
    end Start_Alire;
 
    ------------------------------
    -- Standard_Error_Available --
    ------------------------------
 
-   overriding procedure Standard_Error_Available
-     (Self : in out Process_Listener)
-   is
+   overriding
+   procedure Standard_Error_Available (Self : in out Process_Listener) is
       use type Ada.Streams.Stream_Element_Count;
 
       Data    : Ada.Streams.Stream_Element_Array (1 .. 256);
@@ -338,9 +370,8 @@ package body LSP.Alire is
    -- Standard_Output_Available --
    -------------------------------
 
-   overriding procedure Standard_Output_Available
-     (Self : in out Process_Listener)
-   is
+   overriding
+   procedure Standard_Output_Available (Self : in out Process_Listener) is
       use type Ada.Streams.Stream_Element_Count;
 
       Data    : Ada.Streams.Stream_Element_Array (1 .. 256);
@@ -364,10 +395,9 @@ package body LSP.Alire is
    function Is_Alire_Crate
      (Client : LSP.Ada_Client_Capabilities.Client_Capability) return Boolean
    is
-      Alire_TOML  : constant GNATCOLL.VFS.Virtual_File :=
-                      (if Client.Root.Is_Empty then GNATCOLL.VFS.No_File
-                       else Client.Root_Directory.Create_From_Dir
-                         ("alire.toml"));
+      Alire_TOML : constant GNATCOLL.VFS.Virtual_File :=
+        (if Client.Root.Is_Empty then GNATCOLL.VFS.No_File
+         else Client.Root_Directory.Create_From_Dir ("alire.toml"));
    begin
       return Alire_TOML.Is_Regular_File;
    end Is_Alire_Crate;
@@ -379,7 +409,8 @@ package body LSP.Alire is
    function Should_Setup_Alire_Env
      (Client : LSP.Ada_Client_Capabilities.Client_Capability) return Boolean is
    begin
-      return Is_Alire_Crate (Client)
+      return
+        Is_Alire_Crate (Client)
         and Spawn.Environments.System_Environment.Value ("ALIRE") /= "True";
    end Should_Setup_Alire_Env;