redis_queued_locks 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e8dd94852534ed373615917be290e53b29e203e7b88907d24631869ab4f2deb
-  data.tar.gz: 9b78929772d22f8ae6cbb628d306a85c44d4eec2f6a41e68bccfa0d754db80b5
+  metadata.gz: 306e86a36b29ee294af7e0ee9eda0c3815e1b646733abf3f30e25c4f0d3f0394
+  data.tar.gz: 1f4b4d1b762f4c27aab1bfae415c2f183593ab5a2772b07e4789d44aa0b5ea1c
 SHA512:
-  metadata.gz: 14e6e0c7ff71c9bc0d8a4ff1088a0b9983a8bd365fa10b17236996b3cb20e291fb951e648c79430b2d4091179024385648a343b36913443a9459c3c9e2a71b18
-  data.tar.gz: f0aa55c8561513a87d3c8f347db2f9a0710c62b4fe6d03fd6b512fec56c2631da77b86080bbbdf051bfc82d6abe2016f8baf37e43b3eebc973bd404bb7f80a35
+  metadata.gz: f48e55fece224be62a769d2eaba83fe206b3275fed1849dc000dfd75d51794a1f023af43c4a0647809fc6ee6fb8d80258e2686d9b1f59fa3ff3a0b20651db89b
+  data.tar.gz: 338a6748a479158d2429c57b6afab1d10682b94e1751560c595c4d9dadd0a607b1d3ea45aeb5612b003a0a88d208780e7dcdb474f05418ac817a46bb9bd16de1

data/.rubocop.yml

@@ -3,14 +3,17 @@ inherit_gem:
     - lib/rubocop.general.yml
     - lib/rubocop.rake.yml
     - lib/rubocop.rspec.yml
+    - lib/rubocop.rbs.yml
 
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.3
   NewCops: enable
   Include:
     - lib/**/*.rb
     - spec/**/*.rb
+    - sig/**/*.rbs
     - Gemfile
+    - gemfiles/ruby3.3.gemfile
     - Rakefile
     - redis_queued_locks.gemspec
     - bin/console

data/.ruby-version

@@ -1 +1 @@
-3.3.4
+3.4.3

data/CHANGELOG.md

@@ -1,4 +1,41 @@
 ## [Unreleased]
+### Changed
+- Updated development dependencies (`armitage-rubocop`, `rbs`, `steep`);
+- Bumped development Ruby version (from `3.3.6` to `3.4.3`);
+- CI is splitted to "mainstream ruby version" and "previous actually maintaned ruby versions";
+- `Acquier` -> `Acquirer`, `Acquierment` -> `Acquirement` (typos):
+  - [**Breaking**] Constant renaming: all constants and constant parts were renamed from `Acquier` to `Acquirer`;
+  - [**Breaking**] Method and variable names renaming: all `acquier` text parts of method/variable names were renamed to `acquirer`;
+  - [**Breaking**] Logs: all `acquier` text parts of each log message type were renamed to `acquirer`;
+  - [**Breaking**] Instrumentation:  all `acquier` text parts of each event name were renamed to `acquirer`;
+  - [**Breaking**] Exceptions: all `Acquierment` exception constant name parts were renamed to `Acquirement`;
+- [**Breaking**] `RedisQueuedLocks::Data` is not used (**temporary**) as result type of some APIs.
+  The reason is that this type can not be used as a record type in `steep`/`rbs` (working on it);
+- [**Breaking**] Minimal Ruby Version - **3.3** (previously - **3.1**):
+  - removed `3.1` and `3.2` from `CI`;
+- [**Breaking**] Config layer was fully reworked in order to improve performance:
+  - Config API has changed from "method invocation" to "hash key/value access/assignment" with a validation layer and config-data-access wrapping;
+### Added
+- **Type Checking**:
+  - library codebase is fully typed;
+  - integrated `RBS` with `Steep` that is configured on **strict mode** (see `sig` directory, `Steepfile` config, `sig/manifest.yml` and `rbs_collection.yml` for dependencies);
+  - CI integration;
+  - Integrated RBS linting to `Rubocop`;
+- Test coverage (via `simplecov` with `html` and `lcov` formats). `minimum_coverage` config is temporary disabled (and the CI step is not configured yet) cuz we need to refactor tests in first;
+- CI:
+  - `rspec-retry` is temporary added until the tests are fully refactored;
+  - typecheck steps: `TypeCheck (Static)` (based on `steep` checks) and `TypeCheckl (Runtime)` (based on `RBS` runtime type checking/testing);
+- Support for `ActiveSupport::BroadcastLogger` logger instances;
+
+## [1.12.1]
+### Changed
+- Internal Private API: an internal Reentrant's Lock utility (`RedisQueuedLocks::Utilities::Lock`) basis
+  is changed from `::Mutex` to `::Monitor` in order to use Ruby's Core C-based
+  implementation (prevent some Ruby-runtime based GVL-oriented locking) of re-entrant locks
+  instead of the custom Ruby-based implementation;
+### Fixed
+- `redis_queued_locks.lock_hold_and_release` instrumentation event has incorrect `acq_time` payload value
+  (it incorrectly stores `lock_key` payload value);
 
 ## [1.12.0] - 2024-08-11
 ### Changed
@@ -6,7 +43,7 @@
 
 ## [1.11.0] - 2024-08-11
 ### Changed
-- Lock Acquierment Timeout (`acq_timeout`/`queue_ttl`): more correct timeout error interception
+- Lock Acquirement Timeout (`acq_timeout`/`queue_ttl`): more correct timeout error interception
   inside the `RedisQueuedLocks::Acquier::AcquireLock::WithAcqTimeout` logic that now raises and
   intercepts an internal timeout error class in order to prevent interceptions of
   other timeouts that can be raised from the wrapped block of code;
@@ -36,7 +73,7 @@
   - each ruby worker of the swarm probes himself that he is alive;
   - worker that does not probes himselfs treats as a zombie;
   - worekr becomes dead when your ruby process is dead, or thread is dead or your ractor is dead;
-  - each zombie's lock, acquier and position in queue are flushed in background via `flush_zombies` swarm element;
+  - each zombie's lock, acquirer and position in queue are flushed in background via `flush_zombies` swarm element;
   - the supervisor module keeps up and running each swarm melement (`probe_hosts` and `flush_zombies`):
     - cuz each element works in background and can fail by any unexpected exception the supervisor guarantees that your elements will ressurect after that;
   - each element can be deeply configured (and enabled/disabled);
@@ -47,7 +84,7 @@
     - supervisor that keeps all elements running and wokring;
     - an ability to check the swarm status (`#swarm_status`): who is working, who is dead, running status, internal main loop states, etc;
     - an abiltiy to check the swarm information (`#swarm_info`): showing the current swarm hosts and their last probes and current zombie status;
-    - an ability to find zombie locks, zombie acquiers and zombie hosts (`#zombie_locks`, `#zombie_acquiers`, `#zombie_hosts`);
+    - an ability to find zombie locks, zombie acquirers and zombie hosts (`#zombie_locks`, `#zombie_acquiers`, `#zombie_hosts`);
     - an ability to extract the full zombie information (`#zombies_info`/`#zombies`);
     - each zombie lock will be flushed in background by appropriated swarm element (`flush_zombies`);
     - deeply configurable zombie factors: zombie ttl, host probing period, supervisor check period;
@@ -246,7 +283,7 @@
 
 ## [0.0.27] - 2024-03-21
 ### Changed
-- Better acquier position accuracy: acquier position in lock queue
+- Better acquirer position accuracy: acquirer position in lock queue
   should be represented as EPOCH in seconds+microseconds (previously: simply in seconds);
 
 ## [0.0.26] - 2024-03-21
@@ -325,7 +362,7 @@
 
 ## [0.0.9] - 2024-02-27
 ### Changed
-- The lock acquier identifier (`acq_id`) now includes the fiber id, the ractor id and an unique per-process
+- The lock acquirer identifier (`acq_id`) now includes the fiber id, the ractor id and an unique per-process
   10 byte string. It is added in order to prevent collisions between different processes/pods
   that will have the same process id / thread id identifiers (cuz it is an object_id integers) that can lead
   to the same position with the same `acq_id` for different processes/pods in the lock request queue.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Rustam Ibragimov
+Copyright (c) 2024-2025 Rustam Ibragimov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal