Files
chatwoot/spec/lib/redis/lock_manager_spec.rb
3fae800936 feat: base layer for unread counts (store, counter and builder) (1/3)[CW-6851] (#14368)
## Description

This is the first PR in a series of PRs for Introducing unread counts in
the sidebar for inboxes and labels.

In this PR:

* Added the unread store, counter and builder modules
* Added redis keys for unread count management
* Added specs for all 3 modules, some specs are for testing enterprise
only feature like specific roles and permissions which are added in the
respective enterprise folder itself.

**Note**
None of this changes affect anything else and nothing is wired to
existing modules.

Issue:
https://linear.app/chatwoot/issue/CW-6851/support-unread-conversation-counts

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality not to work as expected)
- [ ] This change requires a documentation update

## How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration.


## Checklist:

- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my code
- [ ] I have commented on my code, particularly in hard-to-understand
areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream
modules

---------

Co-authored-by: Sojan Jose <sojan@pepalo.com>
2026-05-20 14:26:21 +05:30

71 lines
2.1 KiB
Ruby

require 'rails_helper'
RSpec.describe Redis::LockManager do
let(:lock_manager) { described_class.new }
let(:lock_key) { 'test_lock' }
after do
# Cleanup: Ensure that the lock key is deleted after each test to avoid interference
Redis::Alfred.delete(lock_key)
end
describe '#lock' do
it 'acquires a lock and returns true' do
expect(lock_manager.lock(lock_key)).to be true
expect(lock_manager.locked?(lock_key)).to be true
end
it 'returns false if the lock is already acquired' do
lock_manager.lock(lock_key)
expect(lock_manager.lock(lock_key)).to be false
end
it 'can acquire a lock again after the timeout' do
lock_manager.lock(lock_key, 1) # 1-second timeout
sleep 2
expect(lock_manager.lock(lock_key)).to be true
end
end
describe '#unlock' do
it 'releases a lock' do
lock_manager.lock(lock_key)
lock_manager.unlock(lock_key)
expect(lock_manager.locked?(lock_key)).to be false
end
end
describe '#with_lock' do
it 'yields when the lock is acquired and releases the lock' do
yielded = false
expect(lock_manager.with_lock(lock_key) { yielded = true }).to be true
expect(yielded).to be true
expect(lock_manager.locked?(lock_key)).to be false
end
it 'returns false without yielding when the lock is already acquired' do
lock_manager.lock(lock_key)
expect { |block| lock_manager.with_lock(lock_key, &block) }.not_to yield_control
expect(lock_manager.with_lock(lock_key) { raise 'should not run' }).to be false
end
it 'releases the lock when the block raises' do
expect { lock_manager.with_lock(lock_key) { raise 'boom' } }.to raise_error('boom')
expect(lock_manager.locked?(lock_key)).to be false
end
end
describe '#locked?' do
it 'returns true if a key is locked' do
lock_manager.lock(lock_key)
expect(lock_manager.locked?(lock_key)).to be true
end
it 'returns false if a key is not locked' do
expect(lock_manager.locked?(lock_key)).to be false
end
end
end