28061778282

Committed 23 Jun 2026 10:36PM UTC coverage: 84.98% (-0.07%) from 85.053%

Build # 28061778282

Build Type

Pull #4127

github

Committed by

web-flow

Commit Message

Merge ec2322898 into 3b61e6ee7

Pull Request Pull Request #4127: Caching foundation for a dependencyGraph which maps dependency relations.

Coverage Stats

82 of 105 new or added lines in 1 file covered. (78.1%)

2 existing lines in 2 files now uncovered.

19644 of 23116 relevant lines covered (84.98%)

24104.07 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.07

/src/TDB2.cpp

////////////////////////////////////////////////////////////////////////////////
//
// Copyright 2006 - 2021, Tomas Babej, Paul Beckingham, Federico Hernandez.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
// https://www.opensource.org/licenses/mit-license.php
//
////////////////////////////////////////////////////////////////////////////////

#include <cmake.h>
// cmake.h include header must come first

#include <Color.h>
#include <Context.h>
#include <Datetime.h>
#include <TDB2.h>
#include <Table.h>
#include <format.h>
#include <shared.h>
#include <stdlib.h>
#include <util.h>

#include <algorithm>
#include <optional>
#include <unordered_set>
#include <vector>

bool TDB2::debug_mode = false;
// This functions main job is to set Task::is_blocked / Task::is_blocking flags.
static void dependency_scan(std::vector<Task>&, const std::unordered_map<std::string, size_t>&);

// Build maps for dependency queries.
static DependencyGraph build_dependency_graph(const std::vector<Task>&,
                                              const std::unordered_map<std::string, size_t>&);

////////////////////////////////////////////////////////////////////////////////
void TDB2::open_replica(const std::string& location, bool create_if_missing, bool read_write) {
  _replica = tc::new_replica_on_disk(location, create_if_missing, read_write);
}

////////////////////////////////////////////////////////////////////////////////
// Add the new task to the replica.
void TDB2::add(Task& task) {
  // Ensure the task is consistent, and provide defaults if necessary.
  // bool argument to validate() is "applyDefault", to apply default values for
  // properties not otherwise given.
  task.validate(true);

  rust::Vec<tc::Operation> ops;
  maybe_add_undo_point(ops);

  auto uuid = task.get_ref("uuid");
  changes[uuid] = task;
  tc::Uuid tcuuid = tc::uuid_from_string(uuid);

  // run hooks for this new task
  Context::getContext().hooks.onAdd(task);

  auto taskdata = tc::create_task(tcuuid, ops);

  // add the task attributes
  for (auto& attr : task.all()) {
    // TaskChampion does not store uuid or id in the task data
    if (attr == "uuid" || attr == "id") {
      continue;
    }

    taskdata->update(attr, task.get(attr), ops);
  }
  replica()->commit_operations(std::move(ops));

  invalidate_cached_info();

  // get the ID that was assigned to this task
  auto id = working_set()->by_uuid(tcuuid);
  if (id > 0) {
    task.id = id;
  }
}

////////////////////////////////////////////////////////////////////////////////
// Modify the task in storage to match the given task.
//
// Note that there are a few race conditions to consider here.  Taskwarrior
// loads the enitre task into memory and this method then essentially writes
// the entire task back to the database. So, if the task in the database
// changes between loading the task and this method being called, this method
// will "revert" those changes. In practice this would only occur when multiple
// `task` invocatoins run at the same time and try to modify the same task.
//
// There is also the possibility that another task process has deleted the task
// from the database between the time this process loaded the tsak and called
// this method. In this case, this method throws an error that will make sense
// to the user. This is especially unlikely since tasks are only deleted when
// they have been unmodified for a long time.
void TDB2::modify(Task& task) {
  // All locally modified tasks are timestamped, implicitly overwriting any
  // changes the user or hooks tried to apply to the "modified" attribute.
  task.setAsNow("modified");
  task.validate(false);
  auto uuid = task.get_ref("uuid");

  rust::Vec<tc::Operation> ops;
  maybe_add_undo_point(ops);

  changes[uuid] = task;

  // invoke the hook and allow it to modify the task before updating
  Task original;
  bool found_original = get(uuid, original);
  Context::getContext().hooks.onModify(original, task);

  tc::Uuid tcuuid = tc::uuid_from_string(uuid);
  auto maybe_tctask = replica()->get_task_data(tcuuid);
  if (maybe_tctask.is_none()) {
    throw std::string("task no longer exists");
  }
  auto tctask = maybe_tctask.take();

  // Perform the necessary `update` operations to set all keys in `tctask`
  // equal to those in `task`.
  std::unordered_set<std::string> seen;
  for (auto k : task.all()) {
    // ignore task keys that aren't stored
    if (k == "uuid") {
      continue;
    }
    seen.insert(k);
    bool update = false;
    auto v_new = task.get(k);
    std::string v_tctask;
    if (tctask->get(k, v_tctask)) {
      update = v_tctask != v_new;
    } else {
      // tctask does not contain k, so update it
      update = true;
    }
    if (update) {
      // An empty string indicates the value should be removed.
      if (v_new == "") {
        tctask->update_remove(k, ops);
      } else {
        tctask->update(k, v_new, ops);
      }
    }
  }

  // we've now added and updated properties; but must find any deleted properties
  for (auto k : tctask->properties()) {
    auto kstr = static_cast<std::string>(k);
    if (seen.find(kstr) == seen.end()) {
      tctask->update_remove(kstr, ops);
    }
  }

  replica()->commit_operations(std::move(ops));

  // If the task entered or left the pending set, we must invalidate the cache.
  bool was_pending = found_original && (original.getStatus() == Task::pending);
  bool now_pending = task.getStatus() == Task::pending;
  if (was_pending != now_pending || !found_original) {
    invalidate_cached_info();
    return;
  }

  // If the task stayed in the set, we can edit the vector in-place.
  // This speeds up modifications a lot relative to reloading and parsing from rust.
  bool deps_changed = false;
  if (_pending_tasks) {
    auto* pt = find_pending(uuid);
    if (pt) {
      auto old_deps = pt->getDependencyUUIDs();
      *pt = task;
      auto new_deps = task.getDependencyUUIDs();
      if (old_deps != new_deps) {
        deps_changed = true;
        dependency_scan(*_pending_tasks, pending_index());
      }
    }
  }
  // We have to drop the dependency map, in case modifications were made to those.
  // We only drop it if they actually changed.
  if (deps_changed) _dependency_graph = std::nullopt;
  // We also have to drop _completed_tasks. This probably isn't strictly necessary
  // but it seems sensible for correctness reasons.
  _completed_tasks = std::nullopt;
}

////////////////////////////////////////////////////////////////////////////////
void TDB2::purge(Task& task) {
  auto uuid = tc::uuid_from_string(task.get_ref("uuid"));
  rust::Vec<tc::Operation> ops;
  auto maybe_tctask = replica()->get_task_data(uuid);
  if (maybe_tctask.is_some()) {
    auto tctask = maybe_tctask.take();
    tctask->delete_task(ops);
    replica()->commit_operations(std::move(ops));
  }

  invalidate_cached_info();
}

////////////////////////////////////////////////////////////////////////////////
rust::Box<tc::Replica>& TDB2::replica() {
  // One of the open_replica_ methods must be called before this one.
  assert(_replica);
  return _replica.value();
}

////////////////////////////////////////////////////////////////////////////////
const rust::Box<tc::WorkingSet>& TDB2::working_set() {
  if (!_working_set.has_value()) {
    _working_set = replica()->working_set();
  }
  return _working_set.value();
}

////////////////////////////////////////////////////////////////////////////////
void TDB2::maybe_add_undo_point(rust::Vec<tc::Operation>& ops) {
  // Only add an UndoPoint if there are not yet any changes.
  if (changes.size() == 0) {
    tc::add_undo_point(ops);
  }
}

////////////////////////////////////////////////////////////////////////////////
void TDB2::get_changes(std::vector<Task>& changes) {
  std::map<std::string, Task>& changes_map = this->changes;
  changes.clear();
  std::transform(changes_map.begin(), changes_map.end(), std::back_inserter(changes),
                 [](const auto& kv) { return kv.second; });
}

////////////////////////////////////////////////////////////////////////////////
void TDB2::gc() {
  Timer timer;

  // Allowed as an override, but not recommended.
  if (Context::getContext().config.getBoolean("gc")) {
    replica()->rebuild_working_set(true);
  }

  Context::getContext().time_gc_us += timer.total_us();
}

////////////////////////////////////////////////////////////////////////////////
void TDB2::expire_tasks() { replica()->expire_tasks(); }

////////////////////////////////////////////////////////////////////////////////
// Latest ID is that of the last pending task.
int TDB2::latest_id() {
  auto& ws = working_set();
  return (int)ws->largest_index();
}

////////////////////////////////////////////////////////////////////////////////
// Not cached: callers read this once per process, and it can be very large.
const std::vector<Task> TDB2::all_tasks() {
  Timer timer;
  auto all_tctasks = replica()->all_task_data();
  std::vector<Task> all;
  for (auto& maybe_tctask : all_tctasks) {
    auto tctask = maybe_tctask.take();
    all.push_back(Task(std::move(tctask)));
  }

  // Build a temporary map so that dependency_scan can resolve references
  // inside all_tasks.
  std::unordered_map<std::string, size_t> all_index;
  all_index.reserve(all.size());
  for (size_t i = 0; i < all.size(); ++i) all_index[all[i].get_ref("uuid")] = i;

  dependency_scan(all, all_index);

  Context::getContext().time_load_us += timer.total_us();
  return all;
}

////////////////////////////////////////////////////////////////////////////////
// Load and cache pending tasks. The first call will build the UUID index,
// after which it is reused.
const std::vector<Task>& TDB2::pending_tasks() {
  if (!_pending_tasks) {
    Timer timer;

    auto pending_tctasks = replica()->pending_task_data();
    std::vector<Task> result;

    result.reserve(pending_tctasks.size());

    for (auto& maybe_tctask : pending_tctasks) {
      auto tctask = maybe_tctask.take();
      result.push_back(Task(std::move(tctask)));
    }

    // Build a UUID map for use with get()/modify() and dependency_scan()
    // while the pending vector is already in memory.
    _pending_index.emplace();
    _pending_index->reserve(result.size());
    for (size_t i = 0, n = result.size(); i < n; ++i)
      _pending_index->emplace(result[i].get_ref("uuid"), i);

    dependency_scan(result, *_pending_index);

    Context::getContext().time_load_us += timer.total_us();
    _pending_tasks = std::move(result);
  }

  return *_pending_tasks;
}

////////////////////////////////////////////////////////////////////////////////
// Load and cache all completed tests by scanning all tasks,
// and excluding those in the working set. We cache it to speed up those reports
// which involve completed tasks.
const std::vector<Task>& TDB2::completed_tasks() {
  if (!_completed_tasks) {
    auto all_tctasks = replica()->all_task_data();
    auto& ws = working_set();

    std::vector<Task> result;

    result.reserve(all_tctasks.size());

    for (auto& maybe_tctask : all_tctasks) {
      auto tctask = maybe_tctask.take();
      // if this task is _not_ in the working set, return it.
      if (ws->by_uuid(tctask->get_uuid()) == 0) {
        result.push_back(Task(std::move(tctask)));
      }
    }
    _completed_tasks = std::move(result);
  }
  return *_completed_tasks;
}

/////////////////////////////////////////////////////////////////////////////////
// Build and return the dependency map for pending tasks.
// We invalidate it whenever pending_tasks may have changed.
const DependencyGraph& TDB2::dependency_graph() {
  if (!_dependency_graph) {
    pending_tasks();
    // reuse the UUID index
    _dependency_graph = build_dependency_graph(*_pending_tasks, pending_index());
  }

  return *_dependency_graph;
}

/////////////////////////////////////////////////////////////////////////////////
// This builds and returns the UUID map if it is missing.
const std::unordered_map<std::string, size_t>& TDB2::pending_index() {
  if (!_pending_index) {
    _pending_index.emplace();
    _pending_index->reserve(_pending_tasks->size());
    for (size_t i = 0, n = _pending_tasks->size(); i < n; ++i)
      _pending_index->emplace((*_pending_tasks)[i].get_ref("uuid"), i);
  }

  return *_pending_index;
}

// Finds the UUID in the index. Returns nullptr if the task is not in the pending
// set.
Task* TDB2::find_pending(const std::string& uuid) {
  auto& idx = pending_index();
  auto it = idx.find(uuid);
  if (it != idx.end()) return &(*_pending_tasks)[it->second];
  return nullptr;
}

////////////////////////////////////////////////////////////////////////////////
void TDB2::invalidate_cached_info() {
  _pending_tasks = std::nullopt;
  _completed_tasks = std::nullopt;
  _working_set = std::nullopt;
  _dependency_graph = std::nullopt;
  _pending_index = std::nullopt;
}

////////////////////////////////////////////////////////////////////////////////
// Locate task by ID, wherever it is.
bool TDB2::get(int id, Task& task) {
  auto& ws = working_set();
  const auto tcuuid = ws->by_index(id);
  if (!tcuuid.is_nil()) {
    std::string uuid = static_cast<std::string>(tcuuid.to_string());
    // Load index of pending tasks.
    pending_tasks();
    // Lookup the UUID in the index instead of scanning the vector.
    auto* pt = find_pending(uuid);
    if (pt) {
      task = *pt;
      return true;
    }
  }

  return false;
}

////////////////////////////////////////////////////////////////////////////////
// Locate task by UUID, including by partial ID, wherever it is.
bool TDB2::get(const std::string& uuid, Task& task) {
  pending_tasks();

  // Try to match exact UUID within the index.
  auto* pt = find_pending(uuid);
  if (pt) {
    task = *pt;
    return true;
  }

  // try a partial match
  if (uuid.length() < 36) {
    for (const auto& pending_task : *_pending_tasks) {
      if (closeEnough(pending_task.get_ref("uuid"), uuid, uuid.length())) {
        task = pending_task;
        return true;
      }
    }
  }

  // Nothing to do but iterate over all tasks and check whether it's closeEnough.
  for (auto& maybe_tctask : replica()->all_task_data()) {
    auto tctask = maybe_tctask.take();
    auto tctask_uuid = static_cast<std::string>(tctask->get_uuid().to_string());
    if (closeEnough(tctask_uuid, uuid, uuid.length())) {
      task = Task{std::move(tctask)};
      return true;
    }
  }

  return false;
}

////////////////////////////////////////////////////////////////////////////////
// Locate task by UUID, wherever it is.
bool TDB2::has(const std::string& uuid) {
  return replica()->get_task_data(tc::uuid_from_string(uuid)).is_some();
}

////////////////////////////////////////////////////////////////////////////////
const std::vector<Task> TDB2::siblings(Task& task) {
  std::vector<Task> results;
  if (task.has("parent")) {
    const auto& parent = task.get_ref("parent");

    for (const auto& i : pending_tasks()) {
      // Do not include self in results.
      if (i.id != task.id) {
        // Do not include completed or deleted tasks.
        if (i.getStatus() != Task::completed && i.getStatus() != Task::deleted) {
          // If task has the same parent, it is a sibling.
          if (i.has("parent") && i.get("parent") == parent) {
            results.push_back(i);
          }
        }
      }
    }
  }

  return results;
}

////////////////////////////////////////////////////////////////////////////////
// Return the child tasks of a parent. Uses the _pending_tasks cache, to avoid
// having to fetch this info from the Rust replica.
const std::vector<Task> TDB2::children(Task& parent) {
  std::vector<Task> results;
  const auto& this_uuid = parent.get_ref("uuid");

  for (const auto& i : pending_tasks()) {
    if (i.get_ref("uuid") == this_uuid) continue;
    if (i.has("parent") && i.get_ref("parent") == this_uuid) results.push_back(i);
  }
  return results;
}

////////////////////////////////////////////////////////////////////////////////
std::string TDB2::uuid(int id) {
  auto& ws = working_set();
  auto uuid = ws->by_index(id);
  if (uuid.is_nil()) {
    return "";
  }
  return static_cast<std::string>(uuid.to_string());
}

////////////////////////////////////////////////////////////////////////////////
int TDB2::id(const std::string& uuid) {
  auto& ws = working_set();
  return ws->by_uuid(tc::uuid_from_string(uuid));
}

////////////////////////////////////////////////////////////////////////////////
int TDB2::num_local_changes() { return (int)replica()->num_local_operations(); }

////////////////////////////////////////////////////////////////////////////////
int TDB2::num_reverts_possible() { return (int)replica()->num_undo_points(); }

////////////////////////////////////////////////////////////////////////////////
// Set Task::is_blocked / Task::is_blocking flags using the pre-built UUID map
static void dependency_scan(std::vector<Task>& tasks,
                            const std::unordered_map<std::string, size_t>& uuid_index) {
  // Reset all flags first. This is for safety reasons - if we don't do this
  // dependency_scan() only sets them to true, so it can stay true (within the cache)
  // even after we have changed a task's dependencies after a modify when
  // dependency_scan() runs the second time - the flag will still be set to true!
  // In many cases, this isn't user-visible - it's only visible in reports
  // or filters that explicitly filter for +BLOCKING.
  for (auto& task : tasks) {
    task.is_blocking = false;
    task.is_blocked = false;
  }
  for (size_t i = 0; i < tasks.size(); ++i) {
    auto lstatus = tasks[i].getStatus();
    for (const auto& dep : tasks[i].getDependencyUUIDs()) {
      auto it = uuid_index.find(dep);
      if (it == uuid_index.end()) continue;

      size_t j = it->second;
      auto rstatus = tasks[j].getStatus();
      if (lstatus != Task::completed && lstatus != Task::deleted && rstatus != Task::completed &&
          rstatus != Task::deleted) {
        tasks[i].is_blocked = true;
        tasks[j].is_blocking = true;
      }
    }
  }
}

/////////////////////////////////////////////////////////////////////////////////
// Build the full dependency map from the task vector.
static DependencyGraph build_dependency_graph(
    const std::vector<Task>& tasks, const std::unordered_map<std::string, size_t>& uuid_index) {
  DependencyGraph graph;

  for (size_t i = 0; i < tasks.size(); ++i) {
    const auto& deps = tasks[i].getDependencyUUIDs();
    if (deps.empty()) continue;

    const auto& uuid = tasks[i].get_ref("uuid");

    for (const auto& dep : deps) {
      auto it = uuid_index.find(dep);
      if (it == uuid_index.end()) continue;

      graph.dependencies[uuid].push_back(it->second);
      graph.dependents[dep].push_back(i);
    }
  }

  return graph;
}

////////////////////////////////////////////////////////////////////////////////
// vim: ts=2 et sw=2

GothenburgBitFactory / taskwarrior / 28061778282

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous