yugabyte/yugabyte-db

Audit use of ForceRocksDBCompactInTest and rename

Open

#5,611 opened on Sep 8, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (1,003 forks)batch import
area/docdbgood first issuekind/enhancementpriority/medium

Repository metrics

Stars
 (8,229 stars)
PR merge metrics
 (Avg merge 17d 21h) (92 merged PRs in 30d)

Description

Jira Link: DB-1508 Despite this methods name, we seem to have used this method in void TabletServiceAdminImpl::FlushTablets

void Tablet::ForceRocksDBCompactInTest() {
  if (regular_db_) {
    docdb::ForceRocksDBCompact(regular_db_.get());
  }
  if (intents_db_) {
    CHECK_OK(intents_db_->Flush(rocksdb::FlushOptions()));
    docdb::ForceRocksDBCompact(intents_db_.get());
  }
}

One obvious issue with this method in production code is the use of CHECK_OK. This only affects admin CLI flush commands, so this isn't a huge deal, but we should fix this regardless and ensure there are no other obvious or subtle issues with using this in production

cc @spolitov

Contributor guide

Research direction
Inspect the usage of ForceRocksDBCompactInTest in production code, rename it to reflect its actual usage (e.g., ForceRocksDBCompactAndFlushIntents), and replace CHECK OK with proper error handling.
Tech stack
cpp
Domain
databasebackend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55