Skip to content

CBL-7699: Flaky test, Database BackgroundDB torture test #2406

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.

Sign up for GitHub

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

Merged
jianminzhao merged 2 commits into from
Dec 18, 2025
+21 −9
Merged

CBL-7699: Flaky test, Database BackgroundDB torture test #2406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b91fbc8
CBL-7699: Flaky test, Database BackgroundDB torture test
jianminzhao Dec 16, 2025
9f00a4c
taking advices of Jens.
jianminzhao Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions LiteCore/Database/Housekeeper.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ namespace litecore {
Housekeeper::Housekeeper(C4Collection* coll)
: Actor(DBLog, stringprintf("Housekeeper for %s", asInternal(coll)->fullName().c_str()))
, _keyStoreName(asInternal(coll)->keyStore().name())
, _expiryTimer(std::bind(&Housekeeper::doExpirationAsync, this))
, _expiryTimer(std::make_unique<actor::Timer>(std::bind(&Housekeeper::doExpirationAsync, this)))
, _collection(coll) {}

void Housekeeper::start() {
Expand All @@ -39,12 +39,18 @@ namespace litecore {
waitTillCaughtUp();
}

void Housekeeper::documentExpirationChanged(expiration_t exp) {
enqueue(FUNCTION_TO_QUEUE(Housekeeper::_documentExpirationChanged), exp);
}

void Housekeeper::_stop() {
_expiryTimer.stop();
_expiryTimer = nullptr;
logVerbose("Housekeeper: stopped.");
}

void Housekeeper::_scheduleExpiration(bool onlyIfEarlier) {
if ( _isStopped() ) return;

// CBL-3626: Opening the background database synchronously will
// cause a deadlock when setting document expiration inside of
// a transaction (inBatch) if it is the first time that document
Expand Down Expand Up @@ -81,9 +87,9 @@ namespace litecore {
// The race is solved by using fireEarlierAfter, but any further calls
// should continue to use fireAfter or the timer will never be rescheduled.
if ( onlyIfEarlier ) {
_expiryTimer.fireEarlierAfter(chrono::milliseconds(delay));
_expiryTimer->fireEarlierAfter(chrono::milliseconds(delay));
} else {
_expiryTimer.fireAfter(chrono::milliseconds(delay));
_expiryTimer->fireAfter(chrono::milliseconds(delay));
}
} else {
_doExpiration();
Expand All @@ -96,6 +102,8 @@ namespace litecore {
}

void Housekeeper::_doExpiration() {
if ( _isStopped() ) return;

logInfo("Housekeeper: expiring documents...");
_bgdb->useInTransaction(_keyStoreName, [&](KeyStore& keyStore, SequenceTracker* sequenceTracker) -> bool {
if ( sequenceTracker ) {
Expand All @@ -109,12 +117,12 @@ namespace litecore {
_scheduleExpiration(false);
}

void Housekeeper::documentExpirationChanged(expiration_t exp) {
// This doesn't have to be enqueued, since Timer is thread-safe.
void Housekeeper::_documentExpirationChanged(expiration_t exp) {
if ( _isStopped() ) return;

if ( exp == expiration_t::None ) return;
auto delay = exp - KeyStore::now();
if ( _expiryTimer.fireEarlierAfter(chrono::milliseconds(delay)) )
if ( _expiryTimer->fireEarlierAfter(chrono::milliseconds(delay)) )
logVerbose("Housekeeper: rescheduled expiration, now in %" PRIi64 "ms", delay);
}

} // namespace litecore
6 changes: 5 additions & 1 deletion LiteCore/Database/Housekeeper.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,17 @@ namespace litecore {
private:
void _start();
void _stop();

bool _isStopped() const { return !_expiryTimer; }
Copy link
Contributor Author

@jianminzhao jianminzhao Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method is needed to deal with another race between A. releasing of Database point, and B. using of BackgroundDB in actor's methods of Housekeeper. We bail out in the actor's methods if _isStopped()==true.
Another approach is to retain the database at the time to enqueue. Maybe this is overkill. What do you think?


void _scheduleExpiration(bool onlyIfEarlier);
void _doExpiration();
void _documentExpirationChanged(expiration_t exp);
void doExpirationAsync();

alloc_slice _keyStoreName;
BackgroundDB* _bgdb{nullptr};
actor::Timer _expiryTimer;
std::unique_ptr<actor::Timer> _expiryTimer;
fleece::Retained<C4Collection> _collection; // Used for initialization only
};
} // namespace litecore