rspec-rewind 0.1.0 → 1.0.0

data/sig/rspec/rewind.rbs

@@ -2,18 +2,35 @@ module RSpec
   module Rewind
     VERSION: String
     EVENT_SCHEMA_VERSION: Integer
+    PUBLIC_API: Array[untyped]
+    INTERNAL_API: Array[untyped]
 
     class << self
       def configuration: () -> Configuration
       def configure: () { (Configuration) -> void } -> void
       def reset_configuration!: () -> Configuration
       def install!: () -> bool?
+      def installed?: () -> bool
+      def auto_install_disabled?: () -> bool
+      def close_reporter: () -> void
+      def prepare_suite!: () -> void
+      def publish_retry_summary: () -> void
+      def enforce_flaky_threshold!: () -> void
+      def threshold_exceeded?: (Integer count) -> bool
+      def warn_on_retry_gem_conflict: () -> nil
     end
 
     module Backoff
       def self.fixed: (Numeric seconds) -> untyped
       def self.linear: (step: Numeric, ?max: Numeric?) -> untyped
-      def self.exponential: (base: Numeric, ?factor: Numeric, ?max: Numeric?, ?jitter: Numeric) -> untyped
+      def self.exponential: (base: Numeric, ?factor: Numeric, ?max: Numeric?, ?jitter: Numeric, ?rng: untyped, ?min_factor: Numeric) -> untyped
+    end
+
+    module ConfigurationValidation
+    end
+
+    module FailureFingerprint
+      def self.build: (Exception?) -> String?
     end
 
     class Configuration
@@ -24,11 +41,37 @@ module RSpec
       attr_reader retry_if: untyped?
       attr_reader retry_callback: untyped?
       attr_reader flaky_callback: untyped?
+      attr_reader not_retried_callback: untyped?
+      attr_reader before_retry: untyped?
+      attr_reader after_retry: untyped?
       attr_reader verbose: bool
       attr_reader display_retry_failure_messages: bool
+      attr_reader display_retry_backtrace_top: bool
       attr_reader clear_lets_on_failure: bool
+      attr_reader reset_failure_policy: Symbol
       attr_reader retry_budget: RetryBudget
       attr_reader flaky_reporter: FlakyReporter::NullReporter | FlakyReporter::JsonlReporter | untyped
+      attr_reader flaky_report_path: String?
+      attr_reader retry_if_mode: Symbol
+      attr_reader retry_on_default: Symbol
+      attr_reader report_retry_events: bool
+      attr_reader strict_callbacks: bool
+      attr_reader strict_callable_arity: bool
+      attr_reader strict_matcher_validation: bool
+      attr_reader retry_summary: RetrySummary
+      attr_reader display_retry_summary: bool
+      attr_reader fail_on_flaky: bool
+      attr_reader max_flaky_examples: Integer?
+      attr_reader freeze_configuration_at_suite_start: bool
+      attr_reader warn_on_delay_conflict: bool
+      attr_reader detect_retry_gem_conflicts: bool
+      attr_reader metadata_report_keys: Array[Symbol]
+      attr_reader max_retries: Integer?
+      attr_reader max_elapsed_time: Float?
+      attr_reader max_total_sleep: Float?
+      attr_reader sleeper: untyped
+      attr_reader clock: untyped
+      attr_reader dry_run: bool
 
       def initialize: () -> void
       def default_retries=: (untyped) -> Integer
@@ -38,12 +81,62 @@ module RSpec
       def retry_if=: (untyped?) -> untyped?
       def retry_callback=: (untyped?) -> untyped?
       def flaky_callback=: (untyped?) -> untyped?
+      def not_retried_callback=: (untyped?) -> untyped?
+      def before_retry=: (untyped?) -> untyped?
+      def after_retry=: (untyped?) -> untyped?
+      def retry_summary=: (untyped) -> untyped
       def verbose=: (bool) -> bool
       def display_retry_failure_messages=: (bool) -> bool
+      def display_retry_backtrace_top=: (bool) -> bool
+      def display_retry_summary=: (bool) -> bool
+      def fail_on_flaky=: (bool) -> bool
+      def max_flaky_examples=: (untyped?) -> Integer?
+      def freeze_configuration_at_suite_start=: (bool) -> bool
+      def warn_on_delay_conflict=: (bool) -> bool
+      def detect_retry_gem_conflicts=: (bool) -> bool
       def clear_lets_on_failure=: (bool) -> bool
+      def reset_failure_policy=: (Symbol | String) -> Symbol
       def retry_budget=: (RetryBudget | untyped) -> RetryBudget
       def flaky_reporter=: (FlakyReporter::NullReporter | FlakyReporter::JsonlReporter | untyped?) -> FlakyReporter::NullReporter | FlakyReporter::JsonlReporter | untyped
       def flaky_report_path=: (String?) -> FlakyReporter::NullReporter | FlakyReporter::JsonlReporter
+      def retry_if_mode=: (Symbol | String) -> Symbol
+      def retry_on_default=: (Symbol | String) -> Symbol
+      def report_retry_events=: (bool) -> bool
+      def strict_callbacks=: (bool) -> bool
+      def strict_callable_arity=: (bool) -> bool
+      def strict_matcher_validation=: (bool) -> bool
+      def metadata_report_keys=: (untyped) -> Array[Symbol]
+      def max_retries=: (untyped?) -> Integer?
+      def max_elapsed_time=: (untyped?) -> Float?
+      def max_total_sleep=: (untyped?) -> Float?
+      def sleeper=: (untyped?) -> untyped?
+      def clock=: (untyped?) -> untyped?
+      def dry_run=: (bool) -> bool
+      def snapshot: () -> Configuration
+    end
+
+    class FlakyThresholdExceeded < ::StandardError
+    end
+
+    class RetrySummary
+      attr_reader retry_events: Integer
+      attr_reader flaky_examples: Integer
+      attr_reader not_retried_events: Integer
+      attr_reader reset_failed_events: Integer
+      attr_reader sleep_seconds: Float
+
+      def initialize: () -> void
+      def record: (Event event) -> untyped
+      def reset!: () -> void
+      def to_message: (budget: untyped) -> String
+    end
+
+    class BudgetDecision < ::Struct
+      attr_accessor allowed: bool
+      attr_accessor limit: Integer?
+      attr_accessor used: Integer
+      attr_accessor remaining: Integer | Float
+      def allowed?: () -> bool
     end
 
     class RetryBudget
@@ -52,8 +145,23 @@ module RSpec
 
       def initialize: (untyped) -> void
       def consume!: () -> bool
+      def consume: () -> BudgetDecision
       def remaining: () -> Integer | Float
       def unlimited?: () -> bool
+      def reset!: () -> void
+    end
+
+    class FileRetryBudget
+      attr_reader limit: Integer
+      attr_reader path: String
+
+      def initialize: (limit: untyped, path: String) -> void
+      def consume!: () -> bool
+      def consume: () -> BudgetDecision
+      def used: () -> Integer
+      def remaining: () -> Integer
+      def unlimited?: () -> bool
+      def reset!: () -> void
     end
 
     class FlakyReporter
@@ -62,28 +170,53 @@ module RSpec
 
       class NullReporter
         def record: (Event event) -> void
+        def flush: () -> void
+        def close: () -> void
       end
 
       class JsonlReporter
+        attr_reader path: String
         def initialize: (String path) -> void
         def record: (Event event) -> void
+        def flush: () -> void
+        def close: () -> void
       end
     end
 
-    class Event < ::Struct
-      attr_accessor schema_version: Integer
-      attr_accessor status: Symbol
-      attr_accessor retry_reason: Symbol?
-      attr_accessor example_id: String
-      attr_accessor description: String
-      attr_accessor location: String
-      attr_accessor attempt: Integer
-      attr_accessor retries: Integer
-      attr_accessor exception_class: String?
-      attr_accessor exception_message: String?
-      attr_accessor duration: Numeric
-      attr_accessor sleep_seconds: Numeric
-      attr_accessor timestamp: String
+    class Event
+      attr_reader schema_version: Integer
+      attr_reader status: Symbol
+      attr_reader retry_reason: Symbol?
+      attr_reader decision_reason: Symbol?
+      attr_reader example_id: String
+      attr_reader description: String
+      attr_reader location: String
+      attr_reader attempt: Integer
+      attr_reader retries: Integer
+      attr_reader max_attempts: Integer?
+      attr_reader exception_class: String?
+      attr_reader exception_message: String?
+      attr_reader exception_backtrace_top: String?
+      attr_reader failure_fingerprint: String?
+      attr_reader duration: Numeric
+      attr_reader total_duration: Numeric?
+      attr_reader attempt_durations: Array[Numeric]?
+      attr_reader first_failure_duration: Numeric?
+      attr_reader sleep_seconds: Numeric
+      attr_reader scheduled_sleep_seconds: Numeric?
+      attr_reader actual_sleep_seconds: Numeric?
+      attr_reader sleep_total: Numeric?
+      attr_reader timestamp: String
+      attr_reader budget_limit: Integer?
+      attr_reader budget_used: Integer?
+      attr_reader budget_remaining: Integer | Float | nil
+      attr_reader matched_retry_on: String?
+      attr_reader matched_skip_retry_on: String?
+      attr_reader matcher_error: String?
+      attr_reader metadata: Hash[Symbol, untyped]?
+
+      def initialize: (**untyped) -> void
+      def to_h: () -> Hash[Symbol, untyped]
     end
 
     class ExampleContext
@@ -97,35 +230,108 @@ module RSpec
       def run_with_rewind: (?Hash[Symbol | String, untyped]) -> void
     end
 
+    class RetryDecisionResult < ::Struct
+      attr_accessor allowed: bool
+      attr_accessor reason: Symbol
+      attr_accessor matched_retry_on: String?
+      attr_accessor matched_skip_retry_on: String?
+      attr_accessor matcher_error: String?
+      def allowed?: () -> bool
+    end
+
+    class RetryContext < ::Struct
+      attr_accessor attempt: Integer?
+      attr_accessor retries: Integer?
+      attr_accessor metadata: Hash[Symbol, untyped]?
+      attr_accessor budget_remaining: Integer | Float | nil
+      attr_accessor failure_fingerprint: String?
+      attr_accessor elapsed_time: Numeric?
+      attr_accessor sleep_total: Numeric?
+    end
+
     class RetryDecision
-      def initialize: (exception: Exception?, example: untyped, retry_on: untyped, skip_retry_on: untyped, retry_if: untyped?) -> void
+      def initialize: (
+        exception: Exception?,
+        example: untyped,
+        retry_on: untyped,
+        skip_retry_on: untyped,
+        retry_if: untyped?,
+        ?retry_on_default: Symbol,
+        ?context: RetryContext?,
+        ?strict_callable_arity: bool
+      ) -> void
       def retry?: () -> bool
+      def decision: () -> RetryDecisionResult
     end
 
     class RetryPolicy
       def initialize: (example: untyped, configuration: Configuration, metadata: Hash[Symbol, untyped]?) -> void
       def retry_allowed?: (exception: Exception, retry_on: untyped, skip_retry_on: untyped, retry_if: untyped?) -> bool
+      def decision: (
+        exception: Exception,
+        retry_on: untyped,
+        skip_retry_on: untyped,
+        retry_if: untyped?,
+        ?retry_number: Integer?,
+        ?resolved_retries: Integer?,
+        ?budget_remaining: Integer | Float | nil,
+        ?elapsed_time: Numeric?,
+        ?sleep_total: Numeric?
+      ) -> RetryDecisionResult
     end
 
     class RetryCountResolver
       ENV_RETRIES_KEY: String
+      ENV_DISABLE_KEY: String
 
       def initialize: (configuration: Configuration, metadata: Hash[Symbol, untyped]?) -> void
       def resolve: (explicit_retries: untyped) -> Integer
     end
 
     class RetryDelayResolver
-      def initialize: (configuration: Configuration, metadata: Hash[Symbol, untyped]?, example: untyped) -> void
-      def resolve: (retry_number: Integer, backoff: untyped, wait: untyped, exception: Exception) -> Float
+      class DelayContext < ::Struct
+        attr_accessor retry_number: Integer
+        attr_accessor resolved_retries: Integer?
+        attr_accessor metadata: Hash[Symbol, untyped]?
+        attr_accessor previous_sleep_seconds: Numeric
+        attr_accessor failure_fingerprint: String?
+      end
+
+      def initialize: (configuration: Configuration, metadata: Hash[Symbol, untyped]?, example: untyped, ?warn: untyped) -> void
+      def resolve: (
+        retry_number: Integer,
+        backoff: untyped,
+        wait: untyped,
+        exception: Exception,
+        ?resolved_retries: Integer?,
+        ?previous_sleep_seconds: Numeric,
+        ?failure_fingerprint: String?
+      ) -> Float
     end
 
     class AttemptRunner
+      def initialize: (?clock: untyped?) -> void
       def run: (run_target: untyped, exception_source: untyped) -> [Exception?, Float, bool]
     end
 
     class FlakyTransition
       def initialize: (event_builder: untyped, notifier: untyped) -> void
-      def perform: (attempt: Integer, retries: Integer, duration: Numeric) -> void
+      def perform: (
+        attempt: Integer,
+        retries: Integer,
+        duration: Numeric,
+        exception: Exception?,
+        ?total_duration: Numeric?,
+        ?attempt_durations: Array[Numeric]?,
+        ?first_failure_duration: Numeric?,
+        ?sleep_total: Numeric,
+        ?budget_decision: BudgetDecision?
+      ) -> void
+    end
+
+    class SleepMeasurement < ::Struct
+      attr_accessor scheduled: Numeric
+      attr_accessor actual: Numeric
     end
 
     class RetryTransition
@@ -135,7 +341,8 @@ module RSpec
         event_builder: untyped,
         notifier: untyped,
         state_resetter: untyped,
-        sleep: untyped
+        sleep: untyped,
+        ?clock: untyped?
       ) -> void
       def perform: (
         retry_number: Integer,
@@ -144,10 +351,34 @@ module RSpec
         exception: Exception,
         backoff: untyped,
         wait: untyped,
-        example_source: untyped
+        example_source: untyped,
+        ?total_duration: Numeric?,
+        ?attempt_durations: Array[Numeric]?,
+        ?sleep_total: Numeric,
+        ?failure_fingerprint: String?,
+        ?budget_decision: BudgetDecision?,
+        ?policy_decision: RetryDecisionResult?
+      ) -> SleepMeasurement
+      def publish_not_retried: (
+        retry_number: Integer,
+        resolved_retries: Integer,
+        duration: Numeric,
+        exception: Exception,
+        decision: RetryGateDecision,
+        ?total_duration: Numeric?,
+        ?attempt_durations: Array[Numeric]?,
+        ?sleep_total: Numeric
       ) -> void
     end
 
+    class RetryGateDecision < ::Struct
+      attr_accessor allowed: bool
+      attr_accessor reason: Symbol
+      attr_accessor policy_decision: RetryDecisionResult?
+      attr_accessor budget_decision: BudgetDecision?
+      def allowed?: () -> bool
+    end
+
     class RetryGate
       def initialize: (configuration: Configuration, retry_policy: RetryPolicy, debug: untyped) -> void
       def allow?: (
@@ -157,8 +388,33 @@ module RSpec
         retry_on: untyped,
         skip_retry_on: untyped,
         retry_if: untyped?,
-        example_id: String
+        example_id: String,
+        ?elapsed_time: Numeric?,
+        ?sleep_total: Numeric?
       ) -> bool
+      def decision: (
+        exception: Exception,
+        retry_number: Integer,
+        resolved_retries: Integer,
+        retry_on: untyped,
+        skip_retry_on: untyped,
+        retry_if: untyped?,
+        example_id: String,
+        ?elapsed_time: Numeric?,
+        ?sleep_total: Numeric?
+      ) -> RetryGateDecision
+    end
+
+    class RSpecAdapter
+      def clear_exception: (untyped) -> void
+      def clear_execution_result: (untyped) -> void
+      def clear_lets: (untyped) -> void
+    end
+
+    class ExampleStateResetter
+      attr_reader last_exception: StandardError?
+      def initialize: (configuration: Configuration, ?adapter: RSpecAdapter) -> void
+      def reset: (untyped) -> bool
     end
 
     class RunnerLogger
@@ -175,7 +431,8 @@ module RSpec
         attempt_runner: AttemptRunner,
         retry_gate: RetryGate,
         retry_transition: RetryTransition,
-        flaky_transition: FlakyTransition
+        flaky_transition: FlakyTransition,
+        ?clock: untyped?
       ) -> void
       def run: (
         retries: untyped,
@@ -203,8 +460,17 @@ module RSpec
       ) -> void
     end
 
+    class RunnerComponentFactory
+      def build: (
+        example: untyped,
+        configuration: Configuration,
+        context: ExampleContext,
+        logger: RunnerLogger
+      ) -> RunnerComponents
+    end
+
     class Runner
-      def initialize: (example: untyped, configuration: Configuration) -> void
+      def initialize: (example: untyped, configuration: Configuration, ?component_factory: RunnerComponentFactory) -> void
       def run: (?retries: untyped, ?backoff: untyped, ?wait: untyped, ?retry_on: untyped, ?skip_retry_on: untyped, ?retry_if: untyped) -> void
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rewind
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -43,13 +43,17 @@ files:
 - README.md
 - lib/rspec-rewind.rb
 - lib/rspec/rewind.rb
+- lib/rspec/rewind/api.rb
 - lib/rspec/rewind/attempt_runner.rb
 - lib/rspec/rewind/backoff.rb
 - lib/rspec/rewind/configuration.rb
+- lib/rspec/rewind/configuration_validation.rb
+- lib/rspec/rewind/core.rb
 - lib/rspec/rewind/event.rb
 - lib/rspec/rewind/example_context.rb
 - lib/rspec/rewind/example_methods.rb
 - lib/rspec/rewind/example_state_resetter.rb
+- lib/rspec/rewind/failure_fingerprint.rb
 - lib/rspec/rewind/flaky_reporter.rb
 - lib/rspec/rewind/flaky_transition.rb
 - lib/rspec/rewind/matcher_validation.rb
@@ -62,8 +66,11 @@ files:
 - lib/rspec/rewind/retry_loop.rb
 - lib/rspec/rewind/retry_notifier.rb
 - lib/rspec/rewind/retry_policy.rb
+- lib/rspec/rewind/retry_summary.rb
 - lib/rspec/rewind/retry_transition.rb
+- lib/rspec/rewind/rspec_adapter.rb
 - lib/rspec/rewind/runner.rb
+- lib/rspec/rewind/runner_component_factory.rb
 - lib/rspec/rewind/runner_components.rb
 - lib/rspec/rewind/runner_logger.rb
 - lib/rspec/rewind/version.rb