-
Notifications
You must be signed in to change notification settings - Fork 78
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improved version of UniqueList: OrderedSet #76
Merged
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
b326e1e
Back UniqueList with a Redis Sorted Set
lewispb 649b59b
Wrap unique list insert and trim in a transaction
lewispb f3c1a9e
Fallback / migration mechanism for existing users of UniqueLists
lewispb 0bf8ee9
Update the Readme with sorted set backed unique list commands
lewispb 3e8dad9
Test remaining methods with migration fallbacks
lewispb ae53aed
Be more specific about which errors to raise
lewispb c479e60
Improve the fallback / migration system
lewispb 3773736
Improve unique list scoring to avoid collisions
lewispb f28ff6d
Update Readme with realistic Unique List scores
lewispb 71ba1a7
Implement OrderedSet
lewispb 9260457
Merge branch 'main' into unique_list_with_sorted_set
lewispb 1df0c66
Resolve pipeline deprecation warnings
lewispb 5cfdc28
Document OrderedSet
lewispb 6035c06
Remove UniqueListLegacy
lewispb f2f7940
Revert fallback options
lewispb 4beba5a
Revert change to type_from
lewispb 316d9c6
Enforce limit is not negative
lewispb 1e62574
Revert config proxying
lewispb cfe0310
Fix bug in score ge
lewispb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
class Kredis::Types::OrderedSet < Kredis::Types::Proxying | ||
proxying :multi, :zrange, :zrem, :zadd, :zremrangebyrank, :zcard, :exists?, :del | ||
|
||
attr_accessor :typed | ||
attr_reader :limit | ||
|
||
def elements | ||
strings_to_types(zrange(0, -1) || [], typed) | ||
end | ||
alias to_a elements | ||
|
||
def remove(*elements) | ||
zrem(types_to_strings(elements, typed)) | ||
end | ||
|
||
def prepend(elements) | ||
insert(elements, prepending: true) | ||
end | ||
|
||
def append(elements) | ||
insert(elements) | ||
end | ||
alias << append | ||
|
||
def limit=(limit) | ||
raise "Limit must be greater than 0" if limit && limit <= 0 | ||
|
||
@limit = limit | ||
end | ||
|
||
private | ||
def insert(elements, prepending: false) | ||
elements = Array(elements) | ||
return if elements.empty? | ||
|
||
elements_with_scores = types_to_strings(elements, typed).map.with_index do |element, index| | ||
score = generate_base_score(negative: prepending) + (index / 100000) | ||
|
||
[ score , element ] | ||
end | ||
|
||
multi do |pipeline| | ||
pipeline.zadd(elements_with_scores) | ||
trim(from_beginning: prepending, pipeline: pipeline) | ||
end | ||
end | ||
|
||
def generate_base_score(negative:) | ||
current_time = process_start_time + process_uptime | ||
|
||
negative ? -current_time : current_time | ||
end | ||
|
||
def process_start_time | ||
@process_start_time ||= redis.time.join(".").to_f - process_uptime | ||
end | ||
|
||
def process_uptime | ||
Process.clock_gettime(Process::CLOCK_MONOTONIC) | ||
end | ||
|
||
def trim(from_beginning:, pipeline:) | ||
return unless limit | ||
|
||
if from_beginning | ||
pipeline.zremrangebyrank(limit, -1) | ||
else | ||
pipeline.zremrangebyrank(0, -(limit + 1)) | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
require "test_helper" | ||
|
||
class OrderedSetTest < ActiveSupport::TestCase | ||
setup { @set = Kredis.ordered_set "ordered-set", limit: 5 } | ||
|
||
test "append" do | ||
@set.append(%w[ 1 2 3 ]) | ||
@set.append(%w[ 1 2 3 4 ]) | ||
assert_equal %w[ 1 2 3 4 ], @set.elements | ||
|
||
@set << "5" | ||
assert_equal %w[ 1 2 3 4 5 ], @set.elements | ||
end | ||
|
||
test "appending the same element re-appends it" do | ||
@set.append(%w[ 1 2 3 ]) | ||
@set.append(%w[ 2 ]) | ||
assert_equal %w[ 1 3 2 ], @set.elements | ||
end | ||
|
||
test "mass append maintains ordering" do | ||
@set = Kredis.ordered_set "ordered-set" # no limit | ||
|
||
thousand_elements = 1000.times.map { [*"A".."Z"].sample(10).join } | ||
@set.append(thousand_elements) | ||
assert_equal thousand_elements, @set.elements | ||
|
||
thousand_elements.each { |element| @set.append(element) } | ||
assert_equal thousand_elements, @set.elements | ||
end | ||
|
||
test "prepend" do | ||
@set.prepend(%w[ 1 2 3 ]) | ||
@set.prepend(%w[ 1 2 3 4 ]) | ||
assert_equal %w[ 4 3 2 1 ], @set.elements | ||
end | ||
|
||
test "append nothing" do | ||
@set.append(%w[ 1 2 3 ]) | ||
@set.append([]) | ||
assert_equal %w[ 1 2 3 ], @set.elements | ||
end | ||
|
||
test "prepend nothing" do | ||
@set.prepend(%w[ 1 2 3 ]) | ||
@set.prepend([]) | ||
assert_equal %w[ 3 2 1 ], @set.elements | ||
end | ||
|
||
test "typed as integers" do | ||
@set = Kredis.ordered_set "mylist", typed: :integer | ||
|
||
@set.append [ 1, 2 ] | ||
@set << 2 | ||
assert_equal [ 1, 2 ], @set.elements | ||
|
||
@set.remove(2) | ||
assert_equal [ 1 ], @set.elements | ||
|
||
@set.append [ "1-a", 2 ] | ||
|
||
assert_equal [ 1, 2 ], @set.elements | ||
end | ||
|
||
test "exists?" do | ||
assert_not @set.exists? | ||
|
||
@set.append [ 1, 2 ] | ||
assert @set.exists? | ||
end | ||
|
||
test "appending over limit" do | ||
@set.append(%w[ 1 2 3 4 5 ]) | ||
@set.append(%w[ 6 7 8 ]) | ||
assert_equal %w[ 4 5 6 7 8 ], @set.elements | ||
end | ||
|
||
test "prepending over limit" do | ||
@set.prepend(%w[ 1 2 3 4 5 ]) | ||
@set.prepend(%w[ 6 7 8 ]) | ||
assert_equal %w[ 8 7 6 5 4 ], @set.elements | ||
end | ||
|
||
test "appending array with duplicates" do | ||
@set.append(%w[ 1 1 1 ]) | ||
assert_equal %w[ 1 ], @set.elements | ||
end | ||
|
||
test "prepending array with duplicates" do | ||
@set.prepend(%w[ 1 1 1 ]) | ||
assert_equal %w[ 1 ], @set.elements | ||
end | ||
|
||
test "limit can't be 0 or less" do | ||
assert_raises do | ||
Kredis.ordered_set "ordered-set", limit: -1 | ||
end | ||
end | ||
end |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clever approach 👍!
Just a note for your consideration:
What would happen in case of skewed Redis clocks / concurrent writes? Is possible to face the scenario where appending 2 arrays would lead to mixing their elements?
Maybe a less clever approach that relies getting the max/min (with an optimistic lock) would be more resilient?