Skip to content

Commit 30d186f

Browse files
committed
Prepare release 0.8.0
Prepare release 0.8.0, mostly containing the changes in #32.
1 parent 2caf879 commit 30d186f

File tree

7 files changed

+16
-14
lines changed

7 files changed

+16
-14
lines changed

CHANGELOG.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [0.8.0] - 2024-12-19
11+
1012
⚠️ Version 0.8.0 contains breaking changes to transition to River's new unique jobs implementation and to enable broader, more flexible application of unique jobs. Detailed notes on the implementation are contained in [the original River PR](https://github.com/riverqueue/river/pull/590), and the notes below include short summaries of the ways this impacts this client specifically.
1113

1214
Users should upgrade backends to River v0.12.0 before upgrading this library in order to ensure a seamless transition of all in-flight jobs. Afterward, the latest River version may be used.
1315

1416
### Breaking
1517

16-
- **Breaking change:** The return type of `Client#insert_many` has been changed. Rather than returning just the number of rows inserted, it returns an array of all the `InsertResult` values for each inserted row. Unique conflicts which are skipped as duplicates are indicated in the same fashion as single inserts (the `unique_skipped_as_duplicated` attribute), and in such cases the conflicting row will be returned instead.
17-
- **Breaking change:** Unique jobs no longer allow total customization of their states when using the `by_state` option. The pending, scheduled, available, and running states are required whenever customizing this list.
18+
- **Breaking change:** The return type of `Client#insert_many` has been changed. Rather than returning just the number of rows inserted, it returns an array of all the `InsertResult` values for each inserted row. Unique conflicts which are skipped as duplicates are indicated in the same fashion as single inserts (the `unique_skipped_as_duplicated` attribute), and in such cases the conflicting row will be returned instead. [PR #32](https://github.com/riverqueue/riverqueue-ruby/pull/32).
19+
- **Breaking change:** Unique jobs no longer allow total customization of their states when using the `by_state` option. The pending, scheduled, available, and running states are required whenever customizing this list. [PR #32](https://github.com/riverqueue/riverqueue-ruby/pull/32).
1820

1921
### Added
2022

21-
- The `UniqueOpts` class gains an `exclude_kind` option for cases where uniqueness needs to be guaranteed across multiple job types.
23+
- The `UniqueOpts` class gains an `exclude_kind` option for cases where uniqueness needs to be guaranteed across multiple job types. [PR #32](https://github.com/riverqueue/riverqueue-ruby/pull/32).
2224
- Unique jobs utilizing `by_args` can now also opt to have a subset of the job's arguments considered for uniqueness. For example, you could choose to consider only the `customer_id` field while ignoring the other fields:
2325

2426
```ruby
2527
UniqueOpts.new(by_args: ["customer_id"])
2628
```
2729

28-
Any fields considered in uniqueness are also sorted alphabetically in order to guarantee a consistent result across implementations, even if the encoded JSON isn't sorted consistently.
30+
Any fields considered in uniqueness are also sorted alphabetically in order to guarantee a consistent result across implementations, even if the encoded JSON isn't sorted consistently. [PR #32](https://github.com/riverqueue/riverqueue-ruby/pull/32).
2931

3032
### Changed
3133

3234
- Unique jobs have been improved to allow bulk insertion of unique jobs via `Client#insert_many`.
3335

34-
This updated implementation is significantly faster due to the removal of advisory locks in favor of an index-backed uniqueness system, while allowing some flexibility in which job states are considered. However, not all states may be removed from consideration when using the `by_state` option; pending, scheduled, available, and running states are required whenever customizing this list.
36+
This updated implementation is significantly faster due to the removal of advisory locks in favor of an index-backed uniqueness system, while allowing some flexibility in which job states are considered. However, not all states may be removed from consideration when using the `by_state` option; pending, scheduled, available, and running states are required whenever customizing this list. [PR #32](https://github.com/riverqueue/riverqueue-ruby/pull/32).
3537

3638
- Update REXML dependency. [PR #28](https://github.com/riverqueue/riverqueue-ruby/pull/36).
3739

Gemfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
PATH
22
remote: .
33
specs:
4-
riverqueue (0.7.0)
4+
riverqueue (0.8.0)
55

66
PATH
77
remote: driver/riverqueue-sequel
88
specs:
9-
riverqueue-sequel (0.7.0)
9+
riverqueue-sequel (0.8.0)
1010
pg (> 0, < 1000)
1111
sequel (> 0, < 1000)
1212

driver/riverqueue-activerecord/Gemfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
PATH
22
remote: ../..
33
specs:
4-
riverqueue (0.7.0)
4+
riverqueue (0.8.0)
55

66
PATH
77
remote: .
88
specs:
9-
riverqueue-activerecord (0.7.0)
9+
riverqueue-activerecord (0.8.0)
1010
activerecord (> 0, < 1000)
1111
activesupport (> 0, < 1000)
1212
pg (> 0, < 1000)

driver/riverqueue-activerecord/riverqueue-activerecord.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Gem::Specification.new do |s|
22
s.name = "riverqueue-activerecord"
3-
s.version = "0.7.0"
3+
s.version = "0.8.0"
44
s.summary = "ActiveRecord driver for the River Ruby gem."
55
s.description = "ActiveRecord driver for the River Ruby gem. Use in conjunction with the riverqueue gem to insert jobs that are worked in Go."
66
s.authors = ["Blake Gentry", "Brandur Leach"]

driver/riverqueue-sequel/Gemfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
PATH
22
remote: ../..
33
specs:
4-
riverqueue (0.7.0)
4+
riverqueue (0.8.0)
55

66
PATH
77
remote: .
88
specs:
9-
riverqueue-sequel (0.7.0)
9+
riverqueue-sequel (0.8.0)
1010
pg (> 0, < 1000)
1111
sequel (> 0, < 1000)
1212

driver/riverqueue-sequel/riverqueue-sequel.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Gem::Specification.new do |s|
22
s.name = "riverqueue-sequel"
3-
s.version = "0.7.0"
3+
s.version = "0.8.0"
44
s.summary = "Sequel driver for the River Ruby gem."
55
s.description = "Sequel driver for the River Ruby gem. Use in conjunction with the riverqueue gem to insert jobs that are worked in Go."
66
s.authors = ["Blake Gentry", "Brandur Leach"]

riverqueue.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Gem::Specification.new do |s|
22
s.name = "riverqueue"
3-
s.version = "0.7.0"
3+
s.version = "0.8.0"
44
s.summary = "River is a fast job queue for Go."
55
s.description = "River is a fast job queue for Go. Use this gem in conjunction with gems riverqueue-activerecord or riverqueue-sequel to insert jobs in Ruby which will be worked from Go."
66
s.authors = ["Blake Gentry", "Brandur Leach"]

0 commit comments

Comments
 (0)