zold 0.18.1 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 219994932a033cc330b4634c4a4d2345cc94ed3b1c5b0c9cbd30ec84ec09476c
-  data.tar.gz: b76b4323a3f3ba7f3c086c5efccca46d319fecaf82a16b5e66cbcb91f945ce40
+  metadata.gz: 2544c7f82192df9838d17ce34db7e71f43bf354f74a4021a6567e015feb88c78
+  data.tar.gz: b7d465bedb331452972844bcd7808182633ff9eabf3c7e1da795dc6d64c1483b
 SHA512:
-  metadata.gz: 0140be60b68cdcd39da884f1eac46712a402168a6a6a0bb5738a6484d070130d7cab6843f6e1b5bf9f631a80a94a46dfcb838d387a7026de854fdd01633596ab
-  data.tar.gz: 2228eb60ffc8cbcbf9561e44c9d06b8a6aa102dd8441e9e03ed6f73a4a415f94c8651d6e58e2d8edbadf59659a93af0973e1143c220d6c80d2fdb60bd17d79c3
+  metadata.gz: 8ae9482cf55549e0c5e44063369b5dede47e9550c995fc2d5cdb83fd89b315cbcfb0e41a2381ded0fcb60d230c91c6ec0cf4e87ce0d3d397983e670de183c06d
+  data.tar.gz: 054a46f86e5538edd0aaf7bf0f0b9fc116b83fb86d1810d8dfb11b7e4d49bd7e042acc07a3a0d5be34b44e262a4967dd18ba7129a65b23a0890def81196761de

data/.rubocop.yml

@@ -16,7 +16,7 @@ Layout/MultilineMethodCallIndentation:
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:
-  Max: 100
+  Max: 120
 Metrics/ClassLength:
   Max: 400
 Layout/EndOfLine:

data/lib/zold/commands/merge.rb

@@ -74,16 +74,10 @@ Available options:"
     private
 
     def merge(id, cps, opts)
+      start = Time.now
       cps = cps.all.sort_by { |c| c[:score] }.reverse
       patch = Patch.new(@wallets, log: @log)
       score = 0
-      cps.each_with_index do |c, idx|
-        wallet = Wallet.new(c[:path])
-        name = "#{c[:name]}/#{idx}/#{c[:score]}"
-        merge_one(opts, patch, wallet, name)
-        score += c[:score]
-      end
-      start = Time.now
       @wallets.acq(id) do |w|
         if w.exists?
           merge_one(opts, patch, w, 'localhost')
@@ -92,6 +86,12 @@ Available options:"
           @log.debug("Local copy of #{id} is absent, nothing to merge")
         end
       end
+      cps.each_with_index do |c, idx|
+        wallet = Wallet.new(c[:path])
+        name = "#{c[:name]}/#{idx}/#{c[:score]}"
+        merge_one(opts, patch, wallet, name)
+        score += c[:score]
+      end
       modified = @wallets.acq(id, exclusive: true) { |w| patch.save(w.path, overwrite: true) }
       if modified
         @log.info("#{cps.count} copies with the total score of #{score} successfully merged \

data/lib/zold/commands/node.rb

@@ -136,6 +136,9 @@ module Zold
         o.integer '--queue-limit',
           'The maximum number of wallets to be accepted via PUSH and stored in the queue (default: 4096)',
           default: 4096
+        o.integer '--gc-age',
+          'Maximum time in seconds to keep an empty and unused wallet on the disk',
+          default: 60 * 60 * 24 * 10
         o.string '--expose-version',
           "The version of the software to expose in JSON (default: #{VERSION})",
           default: VERSION
@@ -360,12 +363,10 @@ module Zold
         @log.info('Metronome hasn\'t been started because of --no-metronome')
         return metronome
       end
-      # This was a good idea to spread wallets among other nodes,
-      # but with the growing number of wallets it's obvious that this
-      # doesn't make a lot of sense. We better focus of HungryWallets
-      # implementation, where wallets are being pulled if they are missed.
-      # require_relative 'routines/spread'
-      # metronome.add(Routines::Spread.new(opts, @wallets, @remotes, log: @log))
+      require_relative 'routines/spread'
+      metronome.add(Routines::Spread.new(opts, @wallets, @remotes, log: @log))
+      require_relative 'routines/gc'
+      metronome.add(Routines::Gc.new(opts, @wallets, log: @log))
       unless opts['standalone']
         require_relative 'routines/reconnect'
         metronome.add(Routines::Reconnect.new(opts, @remotes, farm, network: opts['network'], log: @log))

data/lib/zold/commands/routines/gc.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require_relative '../../log'
+require_relative '../remove'
+
+# Gargage collecting. It goes through the list of all wallets and removes
+# those that are older than 10 days and don't have any transactions inside.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+module Zold
+  # Routines module
+  module Routines
+    # Garbage collector
+    class Gc
+      def initialize(opts, wallets, log: Log::NULL)
+        @opts = opts
+        @wallets = wallets
+        @log = log
+      end
+
+      def exec(_ = 0)
+        sleep(60) unless @opts['routine-immediately']
+        cmd = Remove.new(wallets: @wallets, log: @log)
+        args = ['remove']
+        seen = 0
+        removed = 0
+        @wallets.all.each do |id|
+          seen += 1
+          next unless @wallets.acq(id) { |w| w.txns.empty? && w.mtime < Time.now - @opts['gc-age'] }
+          cmd.run(args + [id.to_s])
+          removed += 1
+        end
+        @log.info("Removed #{removed} empty+old wallets out of #{seen} total")
+      end
+    end
+  end
+end

data/lib/zold/version.rb

@@ -25,6 +25,6 @@
 # Copyright:: Copyright (c) 2018 Yegor Bugayenko
 # License:: MIT
 module Zold
-  VERSION = '0.18.1'
+  VERSION = '0.18.2'
   PROTOCOL = 2
 end

data/lib/zold/wallets.rb

@@ -72,7 +72,10 @@ module Zold
     end
 
     def count
-      Zold::DirItems.new(@dir).fetch(recursive: false).count
+      Zold::DirItems.new(@dir)
+        .fetch(recursive: false)
+        .select { |f| f.end_with?(Wallet::EXT) }
+        .count
     end
   end
 end

data/test/commands/routines/test_gc.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require_relative '../../test__helper'
+require_relative '../../fake_home'
+require_relative '../../../lib/zold/wallets'
+require_relative '../../../lib/zold/commands/routines/gc.rb'
+
+# Gc test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+class TestGc < Zold::Test
+  def test_collects_garbage
+    FakeHome.new(log: test_log).run do |home|
+      wallets = home.wallets
+      home.create_wallet
+      opts = { 'routine-immediately' => true, 'gc-age' => 0 }
+      assert_equal(1, wallets.count)
+      routine = Zold::Routines::Gc.new(opts, wallets, log: test_log)
+      routine.exec
+      assert_equal(0, wallets.count)
+    end
+  end
+
+  def test_doesnt_touch_non_empty_wallets
+    FakeHome.new(log: test_log).run do |home|
+      wallets = home.wallets
+      wallet = home.create_wallet
+      amount = Zold::Amount.new(zld: 39.99)
+      key = Zold::Key.new(file: 'fixtures/id_rsa')
+      wallet.sub(amount, "NOPREFIX@#{Zold::Id.new}", key)
+      opts = { 'routine-immediately' => true, 'gc-age' => 0 }
+      routine = Zold::Routines::Gc.new(opts, wallets, log: test_log)
+      routine.exec
+      assert_equal(1, wallets.count)
+    end
+  end
+
+  def test_doesnt_touch_fresh_wallets
+    FakeHome.new(log: test_log).run do |home|
+      wallets = home.wallets
+      home.create_wallet
+      opts = { 'routine-immediately' => true, 'gc-age' => 60 * 60 }
+      routine = Zold::Routines::Gc.new(opts, wallets, log: test_log)
+      routine.exec
+      assert_equal(1, wallets.count)
+    end
+  end
+end

data/test/test_wallets.rb

@@ -71,10 +71,15 @@ class TestWallets < Zold::Test
   def test_count_wallets
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do
-        5.times { |i| FileUtils.touch("wallet_#{i}") }
+        5.times { |i| FileUtils.touch("wallet_#{i}#{Zold::Wallet::EXT}") }
         wallets = Zold::Wallets.new(Dir.pwd)
         assert_equal(5, wallets.count)
       end
     end
+    FakeHome.new(log: test_log).run do |home|
+      wallets = home.wallets
+      home.create_wallet
+      assert_equal(1, wallets.count)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zold
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.18.2
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -576,6 +576,7 @@ files:
 - lib/zold/commands/push.rb
 - lib/zold/commands/remote.rb
 - lib/zold/commands/remove.rb
+- lib/zold/commands/routines/gc.rb
 - lib/zold/commands/routines/reconnect.rb
 - lib/zold/commands/routines/spread.rb
 - lib/zold/commands/show.rb
@@ -625,6 +626,7 @@ files:
 - lib/zold/wallets.rb
 - resources/remotes
 - resources/root.pub
+- test/commands/routines/test_gc.rb
 - test/commands/routines/test_reconnect.rb
 - test/commands/routines/test_spread.rb
 - test/commands/test_alias.rb
@@ -701,7 +703,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: |-
-  Thanks for installing Zold 0.18.1!
+  Thanks for installing Zold 0.18.2!
     Study our White Paper: https://papers.zold.io/wp.pdf
     Read our blog posts: https://blog.zold.io
     Try online wallet at: https://wts.zold.io
@@ -733,6 +735,7 @@ test_files:
 - features/gem_package.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
+- test/commands/routines/test_gc.rb
 - test/commands/routines/test_reconnect.rb
 - test/commands/routines/test_spread.rb
 - test/commands/test_alias.rb