Add dependency name in the logs (#676)

In certain cases, it's unclear which package causes an error during shard installation.
The log output now indicates the package context for each message.

```
Fetching https://github.com/sija/retriable.cr.git
[retriable] git config --get remote.origin.mirror
[nbchannel] git fetch --all --quiet
[splay_tree_map] git fetch --all --quiet
```

Author: miry

spec/integration/install_spec.cr

@@ -925,7 +925,8 @@ describe "install" do
       with_shard(metadata) do
         stdout = run "shards install --no-color -v"
         assert_installed "noshardyml", "0.2.0"
-        stdout.should contain(%(D: Missing "shard.yml" for "noshardyml" at tag v0.1.0))
+        stdout.should contain(%(D: [noshardyml] git ls-tree -r --full-tree --name-only refs/tags/v0.1.0 -- shard.yml))
+        stdout.should contain(%(D: [noshardyml] Missing "shard.yml" for "noshardyml" at tag v0.1.0))
       end
     end
 

src/commands/prune.cr

@@ -13,11 +13,14 @@ module Shards
           next unless File.directory?(path)
 
           if locks.shards.none? { |d| d.name == name }
-            Log.debug { "rm -rf '#{Process.quote(path)}'" }
-            Shards::Helpers.rm_rf(path)
+            Log.with_context do
+              Log.context.set package: name
+              Log.debug { "rm -rf '#{Process.quote(path)}'" }
+              Shards::Helpers.rm_rf(path)
 
-            Shards.info.installed.delete(name)
-            Log.info { "Pruned #{File.join(File.basename(Shards.install_path), name)}" }
+              Shards.info.installed.delete(name)
+              Log.info { "Pruned #{File.join(File.basename(Shards.install_path), name)}" }
+            end
           end
         end
 

src/logger.cr

@@ -30,8 +30,9 @@ module Shards
 
   FORMATTER = ::Log::Formatter.new do |entry, io|
     message = entry.message
-
+    package_name = entry.context[:package]?
     if @@colors
+      io << "[" << package_name.colorize(:blue).to_s << "] " if package_name && entry.severity <= ::Log::Severity::Debug
       io << if color = LOGGER_COLORS[entry.severity]?
         if idx = message.index(' ')
           message[0...idx].colorize(color).to_s + message[idx..-1]
@@ -42,7 +43,9 @@ module Shards
         message
       end
     else
-      io << entry.severity.label[0] << ": " << message
+      io << entry.severity.label[0] << ": "
+      io << "[" << package_name << "] " if package_name && entry.severity <= ::Log::Severity::Debug
+      io << message
     end
   end
 end

src/molinillo_solver.cr

@@ -61,7 +61,10 @@ module Shards
         end
         spawn do
           begin
-            dep.resolver.update_local_cache if dep.resolver.is_a? GitResolver
+            Log.with_context do
+              Log.context.set package: dep.name
+              dep.resolver.update_local_cache if dep.resolver.is_a? GitResolver
+            end
             ch.send(nil)
           rescue ex : Exception
             ch.send(ex)
@@ -81,9 +84,12 @@ module Shards
       prefetch_local_caches(deps)
 
       deps.each do |dep|
-        if lock = lock_index[dep.name]?
-          next unless dep.matches?(lock.version)
-          add_lock(base, lock_index, dep)
+        Log.with_context do
+          Log.context.set package: dep.name
+          if lock = lock_index[dep.name]?
+            next unless dep.matches?(lock.version)
+            add_lock(base, lock_index, dep)
+          end
         end
       end
     end
@@ -170,20 +176,23 @@ module Shards
     @specs = Hash({String, Version}, Spec).new
 
     def search_for(dependency : R) : Array(S)
-      check_single_resolver_by_name dependency.resolver
-
-      @search_results[{dependency.name, dependency.requirement}] ||= begin
-        resolver = dependency.resolver
-        versions = Versions.sort(versions_for(dependency, resolver)).reverse
-        result = versions.map do |version|
-          @specs[{dependency.name, version}] ||= begin
-            resolver.spec(version).tap do |spec|
-              spec.version = version
+      Log.with_context do
+        Log.context.set package: dependency.name
+        check_single_resolver_by_name dependency.resolver
+
+        @search_results[{dependency.name, dependency.requirement}] ||= begin
+          resolver = dependency.resolver
+          versions = Versions.sort(versions_for(dependency, resolver)).reverse
+          result = versions.map do |version|
+            @specs[{dependency.name, version}] ||= begin
+              resolver.spec(version).tap do |spec|
+                spec.version = version
+              end
             end
           end
-        end
 
-        result
+          result
+        end
       end
     end
 

src/package.cr

@@ -58,15 +58,19 @@ module Shards
     end
 
     def install
-      cleanup_install_directory
+      Log.with_context do
+        Log.context.set package: name
+
+        cleanup_install_directory
 
-      # install the shard:
-      resolver.install_sources(version, install_path)
+        # install the shard:
+        resolver.install_sources(version, install_path)
 
-      # link the project's lib path as the shard's lib path, so the dependency
-      # can access transitive dependencies:
-      unless resolver.is_a?(PathResolver)
-        install_lib_path
+        # link the project's lib path as the shard's lib path, so the dependency
+        # can access transitive dependencies:
+        unless resolver.is_a?(PathResolver)
+          install_lib_path
+        end
       end
 
       Shards.info.installed[name] = self
@@ -111,24 +115,27 @@ module Shards
 
       Dir.mkdir_p(Shards.bin_path)
 
-      spec.executables.each do |name|
-        exe_name = find_executable_file(Path[install_path], name)
-        unless exe_name
-          raise Shards::Error.new("Could not find executable #{name.inspect} for #{@name.inspect}")
-        end
-        Log.debug { "Install #{exe_name}" }
-        source = File.join(install_path, exe_name)
-        destination = File.join(Shards.bin_path, File.basename(exe_name))
-
-        if File.exists?(destination)
-          next if File.same?(destination, source)
-          File.delete(destination)
-        end
-
-        begin
-          File.link(source, destination)
-        rescue File::Error
-          FileUtils.cp(source, destination)
+      Log.with_context do
+        Log.context.set package: name
+        spec.executables.each do |name|
+          exe_name = find_executable_file(Path[install_path], name)
+          unless exe_name
+            raise Shards::Error.new("Could not find executable #{name.inspect} for #{@name.inspect}")
+          end
+          Log.debug { "Install #{exe_name}" }
+          source = File.join(install_path, exe_name)
+          destination = File.join(Shards.bin_path, File.basename(exe_name))
+
+          if File.exists?(destination)
+            next if File.same?(destination, source)
+            File.delete(destination)
+          end
+
+          begin
+            File.link(source, destination)
+          rescue File::Error
+            FileUtils.cp(source, destination)
+          end
         end
       end
     end