crdt_tests/version3/green_crdt/v3/list.hpp

#pragma once

#include <cstdint>
#include <optional>
#include <unordered_map>
#include <vector>
#include <string>

#include <cassert>

#if !defined(extra_assert)
	#if defined(EXTRA_ASSERTS) && EXTRA_ASSERTS == 1
		#define extra_assert(...) assert(__VA_ARGS__)
	#else
		#define extra_assert(...) void(0)
	#endif
#endif

namespace GreenCRDT::V3 {

template<typename ValueType, typename ActorType>
struct List {
	// for public interface
	struct ListID {
		ActorType id;
		uint64_t seq{0}; // strictly increasing for that actor

		bool operator<(const ListID& rhs) const {
			if (seq < rhs.seq) {
				return true;
			} else if (seq > rhs.seq) {
				return false;
			} else { // ==
				return id < rhs.id;
			}
		}

		bool operator==(const ListID& rhs) const {
			return seq == rhs.seq && id == rhs.id;
		}

		bool operator!=(const ListID& rhs) const {
			return seq != rhs.seq || id != rhs.id;
		}
	};

	struct ListIDInternal {
		size_t actor_idx{0};
		uint64_t seq{0}; // strictly increasing for that actor

		bool operator==(const ListIDInternal& rhs) const {
			return seq == rhs.seq && actor_idx == rhs.actor_idx;
		}
	};

	// internally the index into this array is used to refer to an actor
	std::vector<ActorType> _actors;

	struct Entry_Data {
		// Yjs
		std::optional<ListIDInternal> parent_left;
		std::optional<ListIDInternal> parent_right;

		// might be deleted (yes, *sigh*, crtds need tombstones)
		std::optional<ValueType> value;
	};

	std::vector<ListIDInternal> _list_ids;
	std::vector<Entry_Data> _list_data;

	// number of not deleted entries
	size_t _doc_size {0};

	// TODO: actor index instead of map
	std::unordered_map<size_t, uint64_t> _last_seen_seq;

	// caching only, contains the last index an actor inserted at
	std::unordered_map<size_t, size_t> _last_inserted_idx;

	//size_t _stat_find_with_hint{0};
	//size_t _stat_find_with_hint_hit{0};

	[[nodiscard]] std::optional<size_t> findActor(const ActorType& actor) const {
		for (size_t i = 0; i < _actors.size(); i++) {
			if (_actors[i] == actor) {
				return i;
			}
		}
		return std::nullopt;
	}

	[[nodiscard]] std::optional<size_t> findIdx(const ListIDInternal& list_id) const {
		extra_assert(verify());

		for (size_t i = 0; i < _list_ids.size(); i++) {
			if (_list_ids[i] == list_id) {
				return i;
			}
		}

		return std::nullopt;
	}

	// search close to hint first
	[[nodiscard]] std::optional<size_t> findIdx(const ListIDInternal& list_id, size_t hint) const {
		extra_assert(verify());

		//_stat_find_with_hint++;

		// TODO: find some good magic values here
		// total: 364150
		// 2-9 hits: 360164 (3m54)
		// 1-9 hits: 360161 (3m53)
		// 1-2 hits: 359800 (3m55s)
		// 0-2 hits: 359763 (3m54s)
		// changed from loop to single if:
		// 1-2 hits: 359800 (3m50s)
		// 1-4 hits: 359928 (3m51s) (after cond reorder: 3m49s)
		static constexpr size_t c_hint_pre = 1;
		static constexpr size_t c_hint_post = 4;

		{ // go back 2, so we dont miss // TODO: is this really needed
			//for (size_t i = 0; hint > 0 && i < c_hint_pre; hint--, i++) {}
			if (hint >= c_hint_pre) {
				hint -= c_hint_pre;
			}
		}

		const size_t max_at_hint = hint + c_hint_post; // how many positions we check at hint, before falling back to full lookup

		for (size_t i = hint; i <= max_at_hint && i < _list_ids.size(); i++) {
			if (_list_ids[i] == list_id) {
				//_stat_find_with_hint_hit++;
				return i;
			}
		}

		// fall back to normal search
		// TODO: in some cases we scan the list twice now!!
		return findIdx(list_id);
	}

	[[nodiscard]] std::optional<size_t> findIdx(const ListID& list_id) const {
		extra_assert(verify());

		const auto actor_idx_opt = findActor(list_id.id);
		if (!actor_idx_opt.has_value()) {
			return std::nullopt;
		}

		const ListIDInternal tmp_id {actor_idx_opt.value(), list_id.seq};

		return findIdx(tmp_id);
	}

	[[nodiscard]] std::optional<size_t> findIdx(const ListID& list_id, size_t hint) const {
		extra_assert(verify());

		const auto actor_idx_opt = findActor(list_id.id);
		if (!actor_idx_opt.has_value()) {
			return std::nullopt;
		}

		const ListIDInternal tmp_id {actor_idx_opt.value(), list_id.seq};

		return findIdx(tmp_id, hint);
	}

	// returns false if missing OPs
	// based on YjsMod https://github.com/josephg/reference-crdts/blob/9f4f9c3a97b497e2df8ae4473d1e521d3c3bf2d2/crdts.ts#L293-L348
	// which is a modified Yjs(YATA) algo
	// TODO: idx_hint
	bool add(const ListID& list_id, const ValueType& value, const std::optional<ListID>& parent_left, const std::optional<ListID>& parent_right) {
		extra_assert(verify());

		size_t actor_idx {0};
		{ // new actor?
			// add, even if op fails
			const auto actor_opt = findActor(list_id.id);
			if (!actor_opt.has_value()) {
				actor_idx = _actors.size();
				_last_inserted_idx[_actors.size()] = 0; // hack
				_actors.push_back(list_id.id);
			} else {
				actor_idx = actor_opt.value();
			}
		}

		// check actor op order
		if (!_last_seen_seq.count(actor_idx)) {
			// we dont know this actor yet, first seq needs to be 0
			if (list_id.seq != 0) {
				return false;
			}
		} else {
			// making sure we dont skip operations by that actor
			if (list_id.seq != _last_seen_seq.at(actor_idx) + 1) {
				return false;
			}
		}

		size_t insert_idx = 0;
		if (_list_ids.empty()) {
			if (parent_left.has_value() || parent_right.has_value()) {
				// empty, missing parents
				return false;
			}
		} else {
			// find left
			std::optional<size_t> left_idx_opt = std::nullopt;
			if (parent_left.has_value()) {
				left_idx_opt = findIdx(parent_left.value(), _last_inserted_idx[actor_idx]);
				if (!left_idx_opt.has_value()) {
					// missing parent left
					return false;
				}

				// we insert before the it, so we need to go past the left parent
				insert_idx = left_idx_opt.value() + 1;
			} // else insert_idx = 0
			const size_t left_idx_hint = insert_idx;

			// find right
			size_t right_idx = _list_ids.size();
			if (parent_right.has_value()) {
				auto tmp_right = findIdx(parent_right.value(), left_idx_hint);
				if (!tmp_right.has_value()) {
					return false;
				}
				right_idx = tmp_right.value();
			}

			bool scanning {false};

			for(size_t i = insert_idx;; i++) {
				if (!scanning) {
					insert_idx = i;
				}
				// if right parent / end of doc, insert
				if (insert_idx == right_idx) {
					break;
				}
				// we ran past right o.o ?
				if (insert_idx == _list_ids.size()) {
					break;
				}

				const Entry_Data& at_i = _list_data[i];
				// parents left and right
				std::optional<size_t> i_left_idx {std::nullopt};
				if (at_i.parent_left.has_value()) {
					i_left_idx = findIdx(at_i.parent_left.value(), left_idx_hint);
					if (!i_left_idx.has_value()) {
						assert(false && "item in list with unknown parent left!!");
						return false;
					}
				}

				// possibility map
				//
				//         | ir < r | ir == r       | ir > r
				// -------------------------------------
				// il < l  | insert | insert        | insert
				// il == l | ?      | agentfallback | ?
				// il > l  | skip   | skip          | skip

				if (i_left_idx < left_idx_opt) {
					break;
				} else if (i_left_idx == left_idx_opt) {
					// get i parent_right
					size_t i_right_idx = _list_ids.size();
					if (at_i.parent_right.has_value()) {
						auto tmp_right = findIdx(at_i.parent_right.value(), insert_idx);
						if (!tmp_right.has_value()) {
							assert(false && "item in list with unknown parent right!!");
							return false;
						}
						i_right_idx = tmp_right.value();
					}

					if (i_right_idx < right_idx) {
						scanning = true;
					} else if (i_right_idx == right_idx) {
						// actor id tie breaker
						if (_actors[actor_idx] < _actors[_list_ids[i].actor_idx]) {
							break;
						} else {
							scanning = false;
						}
					} else { // i_right_idx > right_idx
						scanning = false;
					}
				} else { // il > l
					// do nothing
				}
			}
		}

		{ // actual insert
			_list_ids.emplace(_list_ids.begin() + insert_idx, ListIDInternal{actor_idx, list_id.seq});

			Entry_Data new_entry;
			if (parent_left.has_value()) {
				new_entry.parent_left = ListIDInternal{findActor(parent_left.value().id).value(), parent_left.value().seq};
			}

			if (parent_right.has_value()) {
				new_entry.parent_right = ListIDInternal{findActor(parent_right.value().id).value(), parent_right.value().seq};
			}

			new_entry.value = value;

			_list_data.emplace(_list_data.begin() + insert_idx, new_entry);
			_last_inserted_idx[actor_idx] = insert_idx;
		}

		_doc_size++;
		_last_seen_seq[actor_idx] = list_id.seq;

		extra_assert(verify());
		return true;
	}

	// returns false if not found
	bool del(const ListID& id) {
		extra_assert(verify());

		auto actor_idx_opt = findActor(id.id);
		if (!actor_idx_opt.has_value()) {
			// we dont have anything with that actor
			return false;
		}

#if 0
		const ListIDInternal tmp_id {actor_idx_opt.value(), id.seq};
		for (auto& it : list) {
			if (it.id == tmp_id) {
				if (it.value.has_value()) {
					it.value.reset();

					doc_size--;
					extra_assert(verify());
					return true;
				} else {
					extra_assert(verify());
					return false; // TODO: allow double deletes?,,,, need ids
				}
			}
		}
#endif
		// TODO: actually test deletes lol
		const auto idx_opt = findIdx(id);
		if (idx_opt.has_value()) {
			auto& it = _list_data[idx_opt.value()];
			if (it.value.has_value()) {
				it.value.reset();

				_doc_size--;
				extra_assert(verify());
				return true;
			} else {
				extra_assert(verify());
				return false; // TODO: allow double deletes?,,,, need ids
			}
		}

		// not found
		extra_assert(verify());
		return false;
	}

	[[nodiscard]] bool empty(void) const {
		return _list_ids.empty();
	}

	[[nodiscard]] size_t size(void) const {
		return _list_ids.size();
	}

	[[nodiscard]] ListIDInternal getIDInternal(size_t idx) const {
		return _list_ids.at(idx);
	}

	[[nodiscard]] const ListID getID(size_t idx) const {
		return {_actors.at(_list_ids.at(idx).actor_idx), _list_ids.at(idx).seq};
	}

	[[nodiscard]] const std::optional<ValueType>& getValue(size_t idx) const {
		return _list_data.at(idx).value;
	}

	// returns the size of alive entries
	[[nodiscard]] size_t getDocSize(void) const {
		return _doc_size;
	}

	[[nodiscard]] std::vector<ValueType> getArray(void) const {
		std::vector<ValueType> array;
		for (const auto& e : _list_data) {
			if (e.value.has_value()) {
				array.push_back(e.value.value());
			}
		}

		return array;
	}

	// TODO: only in debug?
	bool verify(void) const {
		if (_list_ids.size() != _list_data.size()) {
			return false;
		}

		size_t actual_size = 0;
		for (const auto& it : _list_data) {
			if (it.value.has_value()) {
				actual_size++;
			}
		}
		//assert(doc_size == actual_size);
		return _doc_size == actual_size;
	}
};

} // GreenCRDT::V1