html2rss 0.20.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e4867b7a4906d0e4bb9d6cb9facfe96da516175a82fe10824e9ed579cf4aa3d
-  data.tar.gz: 53a8f699b87817b2b62cbe5d5d1761f33004f0b3be1ddb6c7e2428d449923a7c
+  metadata.gz: 3eb20836fb55a5e33d114634c7c20bf2a65afd1a923af1bba82896797fdb099d
+  data.tar.gz: 97c00923e0ca5744cf82f22d54aa428cc784cba3e259bbcdcd9252928f9bc3c0
 SHA512:
-  metadata.gz: a38e85afebf7bd17739915cf9f59846a76212690dc5309a02f37b24f4910247a1e34e3c3eeede165f52ea8c77dff39de472a65b5b5d3b6d8b99c02a19f6dfb0a
-  data.tar.gz: e3a0ad5868a070adf65a0cd78b560d196df7ed932fa424372397f906e0e2afc362eeb0afa864ddcb9bef10cf344efc2f6d9505c8515be502df342fc2a0975252
+  metadata.gz: 36431edafddcca32a53f562a75fbcd77fae969ca8c8fa7c2b6de77f121add2ee3c34c2b6e2e7b57109742780d62eeddde823b1a9bf8f4c1aaeed08a0ae4e5c90
+  data.tar.gz: d3eafa9cbbecc5ccaded7b21508e0af1c43337999cb5651f2d879df5217c1aa1f3e5484bcfd6354037d709715db1cc106f2946dd592745c0ac58252bcdd26ac8

data/lib/html2rss/config/class_methods.rb

@@ -132,10 +132,7 @@ module Html2rss
       def default_config
         {
           strategy: default_strategy_name,
-          request: {
-            max_redirects: RequestService::Policy::DEFAULTS[:max_redirects],
-            max_requests: RequestService::Policy::DEFAULTS[:max_requests]
-          },
+          request: default_request_config,
           channel: { time_zone: 'UTC' },
           headers: RequestHeaders.browser_defaults,
           stylesheets: Html2rss.configuration.stylesheets || []
@@ -149,6 +146,14 @@ module Html2rss
 
       private
 
+      def default_request_config
+        {
+          max_redirects: RequestService::Policy::DEFAULTS[:max_redirects],
+          max_requests: RequestService::Policy::DEFAULTS[:max_requests],
+          total_timeout_seconds: RequestService::Policy::DEFAULTS[:total_timeout_seconds]
+        }
+      end
+
       def resolve_effective_config(config, params:)
         effective_config = HashUtil.deep_symbolize_keys(config, context: 'config')
         resolved_params = parameter_defaults(effective_config)

data/lib/html2rss/config/validator.rb

@@ -80,6 +80,7 @@ module Html2rss
       RequestConfig = Dry::Schema.Params do
         optional(:max_redirects).filled(:integer, gteq?: 0)
         optional(:max_requests).filled(:integer, gt?: 0)
+        optional(:total_timeout_seconds).filled(:integer, gt?: 0)
         optional(:browserless).hash(BrowserlessRequestConfig)
         optional(:botasaurus).hash(BotasaurusRequestConfig)
       end

data/lib/html2rss/config.rb

@@ -31,7 +31,8 @@ module Html2rss
       @request_controls = request_controls.with_effective_values(
         strategy: validated_config[:strategy],
         max_redirects: validated_config.dig(:request, :max_redirects),
-        max_requests: validated_config.dig(:request, :max_requests)
+        max_requests: validated_config.dig(:request, :max_requests),
+        total_timeout_seconds: validated_config.dig(:request, :total_timeout_seconds)
       )
     end
 
@@ -41,6 +42,8 @@ module Html2rss
     def max_redirects = request_controls.max_redirects
     # @return [Integer, nil] configured request budget
     def max_requests = request_controls.max_requests
+    # @return [Integer, nil] configured request timeout
+    def total_timeout_seconds = request_controls.total_timeout_seconds
     # @return [Array<Hash>] stylesheet definitions
     def stylesheets = config[:stylesheets]
 

data/lib/html2rss/request_controls.rb

@@ -7,7 +7,7 @@ module Html2rss
     # Request-control keys accepted at the top level of feed config.
     TOP_LEVEL_KEYS = %i[strategy].freeze
     # Request-control keys accepted under the nested `request` config.
-    REQUEST_KEYS = %i[max_redirects max_requests].freeze
+    REQUEST_KEYS = %i[max_redirects max_requests total_timeout_seconds].freeze
 
     ##
     # @param config [Hash{Symbol => Object}] raw config input
@@ -20,6 +20,7 @@ module Html2rss
         strategy: config[:strategy],
         max_redirects: request_value_for(config, :max_redirects),
         max_requests: request_value_for(config, :max_requests),
+        total_timeout_seconds: request_value_for(config, :total_timeout_seconds),
         explicit_keys: explicit_keys_for(config)
       )
     end
@@ -47,11 +48,13 @@ module Html2rss
     # @param strategy [Symbol, nil] effective request strategy
     # @param max_redirects [Integer, nil] effective redirect limit
     # @param max_requests [Integer, nil] effective request budget
+    # @param total_timeout_seconds [Integer, nil] effective request timeout
     # @param explicit_keys [Array<Symbol>] controls explicitly supplied by the caller
-    def initialize(strategy: nil, max_redirects: nil, max_requests: nil, explicit_keys: [])
+    def initialize(strategy: nil, max_redirects: nil, max_requests: nil, total_timeout_seconds: nil, explicit_keys: [])
       @strategy = strategy
       @max_redirects = max_redirects
       @max_requests = max_requests
+      @total_timeout_seconds = total_timeout_seconds
       @explicit_keys = explicit_keys.map(&:to_sym).uniq.freeze
       freeze
     end
@@ -68,6 +71,10 @@ module Html2rss
     # @return [Integer, nil] effective request budget
     attr_reader :max_requests
 
+    ##
+    # @return [Integer, nil] effective request timeout
+    attr_reader :total_timeout_seconds
+
     ##
     # @param name [Symbol, String] request control name
     # @return [Boolean] whether the control was explicitly supplied
@@ -79,12 +86,14 @@ module Html2rss
     # @param strategy [Symbol, nil] validated request strategy
     # @param max_redirects [Integer, nil] validated redirect limit
     # @param max_requests [Integer, nil] validated request budget
+    # @param total_timeout_seconds [Integer, nil] validated request timeout
     # @return [RequestControls] controls updated with validated effective values
-    def with_effective_values(strategy:, max_redirects:, max_requests:)
+    def with_effective_values(strategy:, max_redirects:, max_requests:, total_timeout_seconds:)
       self.class.new(
         strategy:,
         max_redirects:,
         max_requests:,
+        total_timeout_seconds:,
         explicit_keys:
       )
     end
@@ -98,6 +107,7 @@ module Html2rss
       config[:strategy] = strategy if explicit?(:strategy)
       apply_request_value(config, :max_redirects, max_redirects)
       apply_request_value(config, :max_requests, max_requests)
+      apply_request_value(config, :total_timeout_seconds, total_timeout_seconds)
       config
     end
 

data/lib/html2rss/request_service/policy.rb

@@ -30,9 +30,9 @@ module Html2rss
 
       # Default policy values used when request controls are not explicitly set.
       DEFAULTS = {
-        connect_timeout_seconds: 5,
-        read_timeout_seconds: 10,
-        total_timeout_seconds: 30,
+        connect_timeout_seconds: Integer(ENV.fetch('HTML2RSS_CONNECT_TIMEOUT_SECONDS', 5)),
+        read_timeout_seconds: Integer(ENV.fetch('HTML2RSS_READ_TIMEOUT_SECONDS', 10)),
+        total_timeout_seconds: Integer(ENV.fetch('HTML2RSS_TOTAL_TIMEOUT_SECONDS', 30)),
         max_redirects: 3,
         max_response_bytes: 5_242_880,
         max_decompressed_bytes: 10_485_760,

data/lib/html2rss/request_session/runtime_policy.rb

@@ -11,7 +11,8 @@ module Html2rss
       def self.from_config(config)
         RequestService::Policy.new(
           max_requests: effective_max_requests_for(config),
-          max_redirects: config.max_redirects
+          max_redirects: config.max_redirects,
+          total_timeout_seconds: config.total_timeout_seconds || RequestService::Policy::DEFAULTS[:total_timeout_seconds]
         )
       end
 

data/lib/html2rss/version.rb

@@ -4,6 +4,6 @@
 # The Html2rss namespace.
 module Html2rss
   # Current application version.
-  VERSION = '0.20.0'
+  VERSION = '0.20.1'
   public_constant :VERSION
 end

data/schema/html2rss-config.schema.json

@@ -379,6 +379,13 @@
           },
           "exclusiveMinimum": 0
         },
+        "total_timeout_seconds": {
+          "type": "integer",
+          "not": {
+            "type": "null"
+          },
+          "exclusiveMinimum": 0
+        },
         "browserless": {
           "type": "object",
           "properties": {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html2rss
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.20.1
 platform: ruby
 authors:
 - Gil Desmarais
@@ -390,7 +390,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/html2rss/html2rss/releases/tag/v0.20.0
+  changelog_uri: https://github.com/html2rss/html2rss/releases/tag/v0.20.1
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: