wslc-wip 0.17.2 → 0.17.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffab59f2ac2df1c7a566825b0ee97eeff0b515396b42f3b95b1067b361d3aa8c
-  data.tar.gz: 9500d0b3842aa86f2aaabdc41b89986cad0c66fa0b765b130c6b37679212b985
+  metadata.gz: c00368614ae5c01c7f514957368d9533f2faf9be114cfd17c676fc70ebfec138
+  data.tar.gz: 86d094ead585366c91633a963d0436a0c68af10f5bda3dace5ab46485f714a4a
 SHA512:
-  metadata.gz: 96991898c1e0b423ad14151ee6b7db24bc38c8ea84b7f5213c69d14d83786288faa5b2d1f71c94382611c0f4c569aa939333e66a3e050095b45a1d50b6ef4bb6
-  data.tar.gz: 963d62e619fab36835541421ce7f1642a98e063ba916a0c466311d6138ddce53bf6cae3660dbdadd779272defe81898fa153d9be17a661c11be4c93bff8179e5
+  metadata.gz: 99cd7c6e59ccd6b64667ab7a179c240d96577f24296a93b801484f994570d6262ccc30d1535853a6cd7b4fb2a31f5e8145fa227aa637d7d9960f0aa794756a67
+  data.tar.gz: 13a319d2b312f709a5937711bb65d69a560e098bed809e3f5f76fc83bae419983f5f4dbb0ae541e5afa3c93b9a7fd290b9c963378b6f405cd4bb0ceb3900e274

data/lib/wip/build_context.rb

@@ -14,37 +14,39 @@ module Wip
       @ignore = ignore || DockerIgnore.load(@root.join('.dockerignore'))
     end
 
-    def stage
+    # on_progress fires once per file copied, as `|count, total|` — so a caller
+    # can show that staging a large context (thousands of small files can take
+    # tens of seconds) is still moving instead of looking hung.
+    def stage(on_progress: nil)
       return yield @root.to_s if @ignore.empty?
 
       Dir.mktmpdir('wip-build-context-') do |dir|
-        copy_included_files(Pathname(dir))
+        copy_included_files(Pathname(dir), on_progress)
         yield dir
       end
     end
 
     private
 
-    def copy_included_files(destination)
-      each_included_file do |relative_path|
+    def copy_included_files(destination, on_progress)
+      files = included_files
+      files.each_with_index do |relative_path, index|
         target = destination.join(relative_path)
         FileUtils.mkdir_p(target.dirname)
         # Keep links as links. Dereferencing a link here could copy arbitrary
         # host files outside the build context (for example, ~/.ssh/id_rsa)
         # into the staged directory and expose them to the image build.
         FileUtils.copy_entry(@root.join(relative_path), target, false, false, false)
+        on_progress&.call(index + 1, files.size)
       end
     end
 
-    def each_included_file
-      Dir.glob('**/*', File::FNM_DOTMATCH, base: @root.to_s).each do |entry|
-        next if %w[. ..].include?(entry)
+    def included_files
+      Dir.glob('**/*', File::FNM_DOTMATCH, base: @root.to_s).select do |entry|
+        next false if %w[. ..].include?(entry)
 
         path = @root.join(entry)
-        next unless path.file? || path.symlink?
-        next if @ignore.ignored?(entry)
-
-        yield entry
+        (path.file? || path.symlink?) && !@ignore.ignored?(entry)
       end
     end
   end

data/lib/wip/cli.rb

@@ -71,9 +71,13 @@ module Wip
       settings = load_config.command('build') || {}
       context = settings['context'] || '.'
       warn "wip: staging build context (#{context})"
-      BuildContext.new(context).stage do |staged_context|
+      progress = StagingProgress.new
+      BuildContext.new(context).stage(on_progress: progress.method(:tick)) do |staged_context|
+        progress.finish
         execute(builder.build(settings: settings.merge('context' => staged_context), extra: extra))
       end
+    ensure
+      progress&.finish
     end
 
     desc 'up', 'Start the configured container and its dependencies, creating them if necessary'

data/lib/wip/staging_progress.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Wip
+  # Prints a self-overwriting "copying build context files: N/total" line, at
+  # most every half second, while a slow, silent step (staging a large build
+  # context file by file can take tens of seconds) is still moving — so it
+  # doesn't read as hung.
+  class StagingProgress
+    def initialize(out: $stderr, interval: 0.5)
+      @out = out
+      @interval = interval
+      # Backdated so the very first tick always prints immediately, rather
+      # than waiting a full interval before the first sign of life.
+      @last = Process.clock_gettime(Process::CLOCK_MONOTONIC) - interval
+      @printed = false
+    end
+
+    def tick(count, total)
+      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      return if now - @last < @interval && count != total
+
+      @last = now
+      @printed = true
+      @out.print "\rwip: copying build context files: #{count}/#{total}"
+    end
+
+    # Idempotent: a caller can't know in advance whether tick ever fired.
+    def finish
+      return unless @printed
+
+      @printed = false
+      @out.puts
+    end
+  end
+end

data/lib/wip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wip
-  VERSION = '0.17.2'
+  VERSION = '0.17.3'
 end

data/lib/wip.rb

@@ -9,6 +9,7 @@ require_relative 'wip/environment'
 require_relative 'wip/dotenv_loader'
 require_relative 'wip/docker_ignore'
 require_relative 'wip/build_context'
+require_relative 'wip/staging_progress'
 require_relative 'wip/command_resolver'
 require_relative 'wip/error_interpreter'
 require_relative 'wip/command_builder'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wslc-wip
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.17.3
 platform: ruby
 authors:
 - Wip contributors
@@ -52,6 +52,7 @@ files:
 - lib/wip/errors.rb
 - lib/wip/initializer.rb
 - lib/wip/resource_monitor.rb
+- lib/wip/staging_progress.rb
 - lib/wip/sync_settings.rb
 - lib/wip/variable_interpolation.rb
 - lib/wip/version.rb