Module: RSpecTracer::Storage::Schema Private

Defined in:
lib/rspec_tracer/storage/schema.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Cache schema version and compatibility policy. 1.x shipped caches without any version stamp; 2.0’s first migration is simply to start emitting a version and refuse to load anything else.

Compatibility rule (from ARCHITECTURE.md):

- `CURRENT` is written into every new cache manifest.
- `SUPPORTED` is the set of versions this backend is willing
  to load. For 2.0 there is exactly one supported version.
- On mismatch, `load_graph` returns nil after an `info` log
  line and the run proceeds cold. No in-place migrators.

Future version bumps (schema_version 3, 4, …) add entries to ‘SUPPORTED` only if the backend can load both shapes. If a change is breaking, `SUPPORTED` resets to `[CURRENT]` and the caller pays one cold run on upgrade - the deal 1.x users already expect for any rspec-tracer version bump.

Constant Summary collapse

CURRENT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

1.x caches were unstamped; schema_version 2 was the first versioned schema, and 2.0 bumped to 3 when ‘Snapshot.boot_set` landed. schema_version 4 reshaped the example-identity payload: `example_id` hashes the describe block’s description (not RSpec’s load-order-dependent class name) and excludes line numbers. schema_version 5 closes the remaining gap for unnamed examples (‘it { }` / `specify { }` / `example { }`): their `example_id` now derives from an intra-group ordinal instead of RSpec’s line-bearing ‘“example at <path>:<line>”` fallback, so a 4-stamped cache’s unnamed-example ids no longer match. Each bump is breaking, so SUPPORTED stays ‘[CURRENT]` and the caller pays one cold run on upgrade.

5
SUPPORTED =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Internal constant.

[CURRENT].freeze

Class Method Summary collapse

Class Method Details

.supported?(version) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

True when the caller can load a cache stamped with ‘version`. nil (an unstamped 1.x cache) is explicitly unsupported - treating nil as “compatible” would defeat the whole point of the version field. The caller logs and falls back to cold run.

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/rspec_tracer/storage/schema.rb', line 45

def self.supported?(version)
  SUPPORTED.include?(version)
end