record_store 6.1.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6686f890657b7a250384d189c2c377519616711a8295f510bbb140abaefde22
-  data.tar.gz: 00066a49bd826aded557ba3c0a6cb60216ce53feb0c33efd89de9ae7792a5d7c
+  metadata.gz: 6476b30f3ef1df05642b1645783e2186e8ca6a3f489d99c4724fb252d6b26b97
+  data.tar.gz: 84ddb2d0e34076198bc1df633ab51714253c8c4ced05ef8b5b60eb777714eacb
 SHA512:
-  metadata.gz: 642f48f0c639da2f9c3f5cb16bc3265504c647797586bbc6d7aa06f3667dbfaefe8977a4744f8a390ffd7bb45b2567e0964e8e719793182bbca05ccb9143d1e2
-  data.tar.gz: 34e8d630d6b53dc22370f1472cd292b218e79136772151c403b46cc4eb027aa9377beebd17524dac6b37d47645ed7597a756f40f78511ebf0f5678ea9a61c74d
+  metadata.gz: '01136420252835b0ce65abf03d0466f88f879cf52c55f1db5e3db0753121bd55610c78fec31ee552b0d95c02b1922e8aefd4d91679872b1f16af16188fff0cde'
+  data.tar.gz: 512eb4f464314c298c07367e52dc9a3e6cec126da174f19c52cd4d32c12be7ab1d1a565c653b6f853a346582db9076e078ee530914272c1fbf6317306c911176

data/.rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml

@@ -671,7 +671,7 @@ Style/LineEndConcatenation:
 Style/MethodCallWithoutArgsParentheses:
   Enabled: true
 
-Style/MethodMissingSuper:
+Lint/MissingSuper:
   Enabled: true
 
 Style/MissingRespondToMissing:
@@ -964,7 +964,7 @@ Lint/UselessAccessModifier:
 Lint/UselessAssignment:
   Enabled: true
 
-Lint/UselessComparison:
+Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: true
 
 Lint/UselessElseWithoutRescue:

data/.travis.yml

@@ -1,7 +1,7 @@
 cache: bundler
 language: ruby
 rvm:
-  - 2.4.3
+  - 2.6.4
 
 before_install:
   - gem update --system

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## 6.3.0
+- Support for configurable number of threads via environment variable [FEATURE]
+
+## 6.2.1
+- Improved error reporting after timeouts [FEATURE]
+
+## 6.2.0
+- Add validation for non-terminal conflict with wildcard [FEATURE]
+
+## 6.1.2
+- Retry on connection errors [FEATURE]
+
+## 6.1.1
+- Emit messages when waiting for rate-limit to elapse for DNSimple and NS1 providers, so deployment does not timeout [BUGFIX]
+
 ## 6.1.0
 - sort zone files [FEATURE]
 - CLI support for specifying zones for validate_authority [FEATURE]

data/README.md

@@ -112,6 +112,10 @@ Changesets are how Record Store knows what updates to make. A `Changeset` is gen
 
 When running `bin/record-store apply`, a `Changeset` is generated by comparing the current records in a zone's YAML file with the records the provider defines. A zone's YAML file is always considered the primary source of truth.
 
+### Parallelism
+
+Record store attempts to parallelize some of the bulk zone fetching operations. It does so by spawning multiple threads (default: 10). This value can be configured by setting the RECORD_STORE_MAX_THREADS environment variable to a positive integer value.
+
 ----
 
 # Development

data/dev.yml

@@ -2,7 +2,7 @@
 name: recordstore
 
 up:
-  - ruby: 2.5.0
+  - ruby: 2.6.4
   - bundler
 
 commands:

data/lib/record_store/provider.rb

@@ -52,6 +52,10 @@ module RecordStore
         false
       end
 
+      def empty_non_terminal_over_wildcard?
+        true
+      end
+
       def build_zone(zone_name:, config:)
         zone = Zone.new(name: zone_name)
         zone.records = retrieve_current_records(zone: zone_name)
@@ -128,6 +132,37 @@ module RecordStore
 
         dns.getresource(zone_name, Resolv::DNS::Resource::IN::SOA).mname.to_s
       end
+
+      def retry_on_connection_errors(
+        max_timeouts: 5,
+        max_conn_resets: 5,
+        delay: 1,
+        backoff_multiplier: 2,
+        max_backoff: 10
+      )
+        waiter = BackoffWaiter.new(
+          "Waiting to retry after a connection reset",
+          initial_delay: delay,
+          multiplier: backoff_multiplier,
+          max_delay: max_backoff,
+        )
+
+        loop do
+          begin
+            return yield
+          rescue Net::OpenTimeout, Errno::ETIMEDOUT
+            raise if max_timeouts <= 0
+            max_timeouts -= 1
+
+            $stderr.puts("Retrying after a connection timeout")
+          rescue Errno::ECONNRESET
+            raise if max_conn_resets <= 0
+            max_conn_resets -= 1
+
+            waiter.wait
+          end
+        end
+      end
     end
   end
 end

data/lib/record_store/provider/dnsimple.rb

@@ -12,21 +12,29 @@ module RecordStore
         true
       end
 
+      def empty_non_terminal_over_wildcard?
+        false
+      end
+
       # returns an array of Record objects that match the records which exist in the provider
       def retrieve_current_records(zone:, stdout: $stdout)
-        session.zones.all_records(account_id, zone).data.map do |record|
-          begin
-            build_from_api(record, zone)
-          rescue StandardError
-            stdout.puts "Cannot build record: #{record}"
-            raise
-          end
-        end.compact
+        retry_on_connection_errors do
+          session.zones.all_records(account_id, zone).data.map do |record|
+            begin
+              build_from_api(record, zone)
+            rescue StandardError
+              stdout.puts "Cannot build record: #{record}"
+              raise
+            end
+          end.compact
+        end
       end
 
       # Returns an array of the zones managed by provider as strings
       def zones
-        session.zones.all_zones(account_id).data.map(&:name)
+        retry_on_connection_errors do
+          session.zones.all_zones(account_id).data.map(&:name)
+        end
       end
 
       private

data/lib/record_store/provider/dnsimple/patch_api_header.rb

@@ -1,15 +1,17 @@
+require_relative '../provider_utils/waiter'
+
 # Patch Dnsimple client method which retrieves headers for API rate limit dynamically
 module Dnsimple
   class Client
     def execute(method, path, data = nil, options = {})
       response = request(method, path, data, options)
-      rate_limit_sleep(response.headers["x-ratelimit-reset"].to_i, response.headers["x-ratelimit-remaining"].to_i)
+      rate_limit_sleep(response.headers['x-ratelimit-reset'].to_i, response.headers['x-ratelimit-remaining'].to_i)
 
       case response.code
       when 200..299
         response
       when 401
-        raise AuthenticationFailed, response["message"]
+        raise AuthenticationFailed, response['message']
       when 404
         raise NotFoundError, response
       else
@@ -22,9 +24,10 @@ module Dnsimple
     def rate_limit_sleep(rate_limit_reset, rate_limit_remaining)
       rate_limit_reset_in = [0, rate_limit_reset - Time.now.to_i].max
       rate_limit_periods = rate_limit_remaining + 1
-      wait_time = rate_limit_reset_in / rate_limit_periods.to_f
+      sleep_time = rate_limit_reset_in / rate_limit_periods.to_f
 
-      sleep(wait_time) if wait_time > 0
+      rate_limit = RateLimitWaiter.new('DNSimple')
+      rate_limit.wait(sleep_time)
     end
   end
 end

data/lib/record_store/provider/ns1.rb

@@ -60,14 +60,18 @@ module RecordStore
 
       # Returns an array of the zones managed by provider as strings
       def zones
-        client.zones.map { |zone| zone['zone'] }
+        retry_on_connection_errors do
+          client.zones.map { |zone| zone['zone'] }
+        end
       end
 
       private
 
       # Fetches simplified records for the provided zone
       def records_for_zone(zone)
-        client.zone(zone)['records']
+        retry_on_connection_errors do
+          client.zone(zone)['records']
+        end
       end
 
       # Creates a new record to the zone. It is expected this call modifies external state.

data/lib/record_store/provider/ns1/patch_api_header.rb

@@ -1,11 +1,22 @@
 require 'net/http'
+require_relative '../provider_utils/waiter'
 
 # Patch the method which retrieves headers for API rate limit dynamically
 module NS1::Transport
   class NetHttp
+    X_RATELIMIT_PERIOD = 'x-ratelimit-period'.freeze
+    X_RATELIMIT_REMAINING = 'x-ratelimit-remaining'.freeze
+
     def process_response(response)
-      sleep(response.to_hash["x-ratelimit-period"].first.to_i /
-        [1, response.to_hash["x-ratelimit-remaining"].first.to_i].max.to_f)
+      response_hash = response.to_hash
+
+      if response_hash.key?(X_RATELIMIT_PERIOD) && response_hash.key?(X_RATELIMIT_REMAINING)
+        sleep_time = response_hash[X_RATELIMIT_PERIOD].first.to_i /
+                     [1, response_hash[X_RATELIMIT_REMAINING].first.to_i].max.to_f
+
+        rate_limit = RateLimitWaiter.new('NS1')
+        rate_limit.wait(sleep_time)
+      end
 
       body = JSON.parse(response.body)
       case response

data/lib/record_store/provider/provider_utils/waiter.rb

@@ -0,0 +1,41 @@
+class Waiter
+  def initialize(message = nil)
+    @message = message || 'Waiting'
+  end
+
+  attr_accessor :message
+
+  def wait(sleep_time)
+    while sleep_time > 0
+      wait_time = [10, sleep_time].min
+      puts "#{message} (#{sleep_time}s left)" if wait_time > 1
+      sleep(wait_time)
+      sleep_time -= wait_time
+    end
+  end
+end
+
+class RateLimitWaiter < Waiter
+  def initialize(provider)
+    super("Waiting on #{provider} rate-limit")
+  end
+end
+
+class BackoffWaiter < Waiter
+  def initialize(message, initial_delay:, multiplier:, max_delay: nil)
+    super(message)
+
+    @initial_delay = @current_delay = initial_delay
+    @multiplier = multiplier
+    @max_delay = max_delay
+  end
+
+  def reset
+    @current_delay = @initial_delay
+  end
+
+  def wait
+    super(@current_delay)
+    @current_delay = [@current_delay * @multiplier, @max_delay].compact.min
+  end
+end

data/lib/record_store/record.rb

@@ -112,6 +112,10 @@ module RecordStore
       "[#{type}Record] #{fqdn} #{ttl} IN #{type} #{rdata_txt}"
     end
 
+    def wildcard?
+      fqdn.match?(/^\*\./)
+    end
+
     protected
 
     def validate_label_length

data/lib/record_store/version.rb

@@ -1,3 +1,3 @@
 module RecordStore
-  VERSION = '6.1.0'.freeze
+  VERSION = '6.3.0'.freeze
 end

data/lib/record_store/zone.rb

@@ -18,6 +18,7 @@ module RecordStore
     validate :validate_cname_records_dont_point_to_root
     validate :validate_same_ttl_for_records_sharing_fqdn_and_type
     validate :validate_provider_can_handle_zone_records
+    validate :validate_no_empty_non_terminal
     validate :validate_can_handle_alias_records
 
     class << self
@@ -44,13 +45,18 @@ module RecordStore
         end
       end
 
-      MAX_PARALLEL_THREADS = 10
+      DEFAULT_MAX_PARALLEL_THREADS = 10
+
+      def max_parallel_threads
+        (ENV['RECORD_STORE_MAX_THREADS'] || DEFAULT_MAX_PARALLEL_THREADS).to_i
+      end
+
       def modified(verbose: false) # rubocop:disable Lint/UnusedMethodArgument
         modified_zones = []
         mutex = Mutex.new
         zones = all
 
-        (1..MAX_PARALLEL_THREADS).map do
+        (1..max_parallel_threads).map do
           Thread.new do
             current_zone = nil
             while zones.any?
@@ -258,6 +264,28 @@ module RecordStore
       end
     end
 
+    def validate_no_empty_non_terminal
+      return unless config.empty_non_terminal_over_wildcard?
+
+      wildcards = records.select(&:wildcard?).map(&:fqdn).uniq
+      wildcards.each do |wildcard|
+        suffix = wildcard[1..-1]
+
+        terminal_records = records.map(&:fqdn)
+          .select { |record| record.match?(/^([a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_])#{Regexp.escape(suffix)}$/) }
+        next unless terminal_records.any?
+
+        intermediate_records = records.map(&:fqdn)
+          .select { |record| record.match?(/^([a-zA-Z0-9\-_]+)#{Regexp.escape(suffix)}$/) }
+        terminal_records.each do |terminal_record|
+          non_terminal = terminal_record.partition('.').last
+          errors.add(:records, "found empty non-terminal #{non_terminal} "\
+                     "(caused by existing records #{wildcard} and #{terminal_record})")\
+            unless intermediate_records.include?(non_terminal)
+        end
+      end
+    end
+
     def validate_can_handle_alias_records
       return unless records.any? { |record| record.is_a?(Record::ALIAS) }
       return if config.supports_alias?

data/lib/record_store/zone/config.rb

@@ -24,6 +24,10 @@ module RecordStore
         end
       end
 
+      def empty_non_terminal_over_wildcard?
+        valid_providers? && providers.any? { |provider| Provider.const_get(provider).empty_non_terminal_over_wildcard? }
+      end
+
       def to_hash
         config_hash = {
           providers: providers,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: record_store
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.3.0
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -362,6 +362,7 @@ files:
 - lib/record_store/provider/ns1/client.rb
 - lib/record_store/provider/ns1/patch_api_header.rb
 - lib/record_store/provider/oracle_cloud_dns.rb
+- lib/record_store/provider/provider_utils/waiter.rb
 - lib/record_store/record.rb
 - lib/record_store/record/a.rb
 - lib/record_store/record/aaaa.rb