2373

Committed 03 Jun 2024 12:53PM UTC coverage: 90.809% (-0.02%) from 90.826%

Build # 2373

Build Type

push

Evergreen

Committed by

web-flow

Commit Message

Fix race in schema migration tests (#7766)

Some of the schema migration tests test the recovery of subscriptions and objects after a schema migration. This requires that the subscriptions and objects are committed when the synchronization session is paused so nothing is uploaded. `SyncSession::pause()` is used for this, but pause is an async operation so there is a race between pausing the session and uploading the data and subscriptions. `SyncSession::shutdown_and_wait()` is used instead.

Run Details

101684 of 180086 branches covered (56.46%)

6 of 6 new or added lines in 1 file covered. (100.0%)

82 existing lines in 15 files now uncovered.

214531 of 236243 relevant lines covered (90.81%)

5410491.76 hits per line

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

79.47

/src/realm/sync/noinst/changeset_index.cpp

#include <realm/sync/noinst/changeset_index.hpp>
#include <realm/sync/object_id.hpp>

#include <iterator> // std::distance, std::advance

using namespace realm::sync;

namespace realm {
namespace _impl {

#if REALM_DEBUG
static bool compare_ranges(const Changeset::Range& left, const Changeset::Range& right)
{
    return left.begin < right.begin;
}

template <class InputIterator>
static bool check_ranges(InputIterator begin, InputIterator end)
{
    if (!std::is_sorted(begin, end, compare_ranges))
        return false;

    // Check that there are no overlaps
    if (begin != end) {
        auto last_end = begin->end;
        for (auto i = begin + 1; i != end; ++i) {
            if (last_end > i->begin)
                return false;
            last_end = i->end;
        }
    }
    return true;
}

static bool check_ranges(const ChangesetIndex::Ranges& ranges)
{
    for (auto& pair : ranges) {
        if (!check_ranges(pair.second.begin(), pair.second.end()))
            return false;
    }
    return true;
}
#endif // REALM_DEBUG


void ChangesetIndex::clear() noexcept
{
    m_object_instructions.clear();
    m_schema_instructions.clear();
    m_conflict_groups_owner.clear();
    m_num_conflict_groups = 0;
}


void ChangesetIndex::scan_changeset(Changeset& changeset)
{
    if (m_contains_destructive_schema_changes)
        return;

#if defined(REALM_DEBUG) // LCOV_EXCL_START
    for (auto& confict_group : m_conflict_groups_owner) {
        // Check that add_changeset() has not been called yet.
        REALM_ASSERT(confict_group.ranges.empty());
    }
#endif // REALM_DEBUG LCOV_EXCL_STOP

    using Instruction = realm::sync::Instruction;

    for (auto it = changeset.begin(); it != changeset.end(); ++it) {
        if (!*it)
            continue;

        const auto& instr = **it;

        if (auto add_table_instr = instr.get_if<Instruction::AddTable>()) {
            auto& p = *add_table_instr;
            schema_conflict_group(changeset.get_string(p.table));
        }
        else if (instr.get_if<Instruction::EraseTable>()) {
            m_contains_destructive_schema_changes = true;
            clear();
            return;
        }
        else if (auto add_column_instr = instr.get_if<Instruction::AddColumn>()) {
            auto& p = *add_column_instr;
            StringData table_name = changeset.get_string(p.table);
            ConflictGroup& cg = schema_conflict_group(table_name);
            if (p.type == Instruction::Payload::Type::Link) {
                StringData target_table = changeset.get_string(p.link_target_table);
                ConflictGroup& cg2 = schema_conflict_group(target_table);
                merge_conflict_groups(cg, cg2);
            }
        }
        else if (instr.get_if<Instruction::EraseColumn>()) {
            m_contains_destructive_schema_changes = true;
            clear();
            return;
        }
        else {
            GlobalID ids[2];
            size_t num_ids = get_object_ids_in_instruction(changeset, instr, ids, 2);
            REALM_ASSERT(num_ids >= 1);
            REALM_ASSERT(num_ids <= 2);

            ConflictGroup& cg = object_conflict_group(ids[0]);
            for (size_t i = 1; i < num_ids; ++i) {
                ConflictGroup& cg2 = object_conflict_group(ids[1]);
                merge_conflict_groups(cg, cg2);
            }
        }
    }
}


void ChangesetIndex::merge_conflict_groups(ConflictGroup& into, ConflictGroup& from)
{
    if (&into == &from)
        return;

    if (from.size > into.size) {
        // This is an optimization. The time it takes to merge two conflict
        // groups is proportional to the size of the incoming group (in number
        // of objects touched). If the incoming group is larger, merge the other
        // way.
        merge_conflict_groups(from, into);
        return;
    }

    REALM_ASSERT(into.ranges.empty());
    REALM_ASSERT(from.ranges.empty());

    for (auto& class_name : from.schemas) {
        m_schema_instructions[class_name] = &into;
    }
    into.schemas.insert(into.schemas.end(), from.schemas.begin(), from.schemas.end());

    for (auto& pair : from.objects) {
        auto& objset = into.objects[pair.first];
        auto& objinstr = m_object_instructions[pair.first];
        for (auto& object : pair.second) {
            objinstr[object] = &into;
        }
        objset.insert(objset.end(), pair.second.begin(), pair.second.end());
    }
    into.size += from.size;

    m_conflict_groups_owner.erase(from.self_it);
    --m_num_conflict_groups;
}


void ChangesetIndex::add_changeset(Changeset& log)
{
    if (!log.empty())
        m_everything[&log] = std::vector<Changeset::Range>(1, Changeset::Range{log.begin(), log.end()});

    if (m_contains_destructive_schema_changes)
        return; // Just add to everything.

    using Instruction = realm::sync::Instruction;

    // Iterate over all instructions (skipping tombstones), and add them to the
    // index.
    for (auto it = log.begin(); it != log.end(); ++it) {
        if (!*it)
            continue;

        const auto& instr = **it;

        if (auto add_table_instr = instr.get_if<Instruction::AddTable>()) {
            StringData table = log.get_string(add_table_instr->table);
            auto& cg = schema_conflict_group(table);
            add_instruction_at(cg.ranges, log, it);
        }
        else if (instr.get_if<Instruction::EraseTable>()) {
            REALM_TERMINATE("Call scan_changeset() before add_changeset().");
        }
        else if (auto add_column_instr = instr.get_if<Instruction::AddColumn>()) {
            auto& p = *add_column_instr;
            StringData table = log.get_string(p.table);
            auto& cg = schema_conflict_group(table);
            if (p.type == Instruction::Payload::Type::Link) {
                REALM_ASSERT(&cg == &schema_conflict_group(log.get_string(p.link_target_table)));
            }
            add_instruction_at(cg.ranges, log, it);
        }
        else if (instr.get_if<Instruction::EraseColumn>()) {
            REALM_TERMINATE("Call scan_changeset() before add_changeset().");
        }
        else {
            GlobalID ids[2];
            size_t num_ids = get_object_ids_in_instruction(log, instr, ids, 2);
            REALM_ASSERT(num_ids >= 1);
            REALM_ASSERT(num_ids <= 2);

            auto& cg = object_conflict_group(ids[0]);
            for (size_t i = 1; i < num_ids; ++i) {
                REALM_ASSERT(&cg == &object_conflict_group(ids[i]));
            }
            add_instruction_at(cg.ranges, log, it);
        }
    }
}

size_t get_object_ids_in_instruction(const Changeset& changeset, const sync::Instruction& instr,
                                     ChangesetIndex::GlobalID* ids, size_t max_num_ids)
{
    REALM_ASSERT_RELEASE(max_num_ids >= 2);

    using Instruction = realm::sync::Instruction;

    if (auto obj_instr = instr.get_if<Instruction::ObjectInstruction>()) {
        ids[0] = {changeset.get_string(obj_instr->table), changeset.get_key(obj_instr->object)};

        if (auto set_instr = instr.get_if<Instruction::Update>()) {
            auto& p = *set_instr;
            if (p.value.type == Instruction::Payload::Type::Link) {
                ids[1] = {changeset.get_string(p.value.data.link.target_table),
                          changeset.get_key(p.value.data.link.target)};
                return 2;
            }
        }
        else if (auto insert_instr = instr.get_if<Instruction::ArrayInsert>()) {
            auto& p = *insert_instr;
            if (p.value.type == Instruction::Payload::Type::Link) {
                ids[1] = {changeset.get_string(p.value.data.link.target_table),
                          changeset.get_key(p.value.data.link.target)};
                return 2;
            }
        }

        return 1;
    }

    return 0;
}

auto ChangesetIndex::get_schema_changes_for_class(StringData class_name) const -> const Ranges*
{
    return const_cast<ChangesetIndex*>(this)->get_schema_changes_for_class(class_name);
}

auto ChangesetIndex::get_schema_changes_for_class(StringData class_name) -> Ranges*
{
    if (m_contains_destructive_schema_changes)
        return &m_everything;
    auto it = m_schema_instructions.find(class_name);
    if (it == m_schema_instructions.end())
        return &m_empty;
    return &it->second->ranges;
}

auto ChangesetIndex::get_modifications_for_object(GlobalID id) -> Ranges*
{
    if (m_contains_destructive_schema_changes)
        return &m_everything;
    auto it = m_object_instructions.find(id.table_name);
    if (it == m_object_instructions.end())
        return &m_empty;

    auto& object_instructions = it->second;
    auto it2 = object_instructions.find(id.object_id);
    if (it2 == object_instructions.end())
        return &m_empty;
    return &it2->second->ranges;
}

auto ChangesetIndex::get_modifications_for_object(GlobalID id) const -> const Ranges*
{
    return const_cast<ChangesetIndex*>(this)->get_modifications_for_object(id);
}

auto ChangesetIndex::schema_conflict_group(StringData class_name) -> ConflictGroup&
{
    auto& conflict_group = m_schema_instructions[class_name];
    if (conflict_group == nullptr) {
        m_conflict_groups_owner.emplace_back();
        ++m_num_conflict_groups;
        auto new_cg = std::prev(m_conflict_groups_owner.end());
        new_cg->schemas.push_back(class_name);
        new_cg->size = 1;
        new_cg->self_it = new_cg;
        conflict_group = &*new_cg;
    }
    return *conflict_group;
}

auto ChangesetIndex::object_conflict_group(const GlobalID& object_id) -> ConflictGroup&
{
    auto& objects_for_table = m_object_instructions[object_id.table_name];
    auto& conflict_group = objects_for_table[object_id.object_id];
    if (conflict_group == nullptr) {
        m_conflict_groups_owner.emplace_back();
        ++m_num_conflict_groups;
        auto new_cg = std::prev(m_conflict_groups_owner.end());
        new_cg->objects[object_id.table_name].push_back(object_id.object_id);
        new_cg->size = 1;
        new_cg->self_it = new_cg;
        conflict_group = &*new_cg;
    }
    return *conflict_group;
}

auto ChangesetIndex::erase_instruction(RangeIterator pos) -> RangeIterator
{
    Changeset* changeset = pos.m_outer->first;
    pos.check();
    auto new_pos = pos;
    new_pos.m_pos = changeset->erase_stable(pos.m_pos);

    if (new_pos.m_pos >= new_pos.m_inner->end) {
        // erased the last instruction in the range, move to the next range.
        REALM_ASSERT(new_pos.m_inner < new_pos.m_outer->second.end());
        ++new_pos.m_inner;
        if (new_pos.m_inner == new_pos.m_outer->second.end()) {
            REALM_ASSERT(new_pos.m_outer != new_pos.m_ranges->end());
            ++new_pos.m_outer;
            if (new_pos.m_outer == new_pos.m_ranges->end()) {
                return RangeIterator{new_pos.m_ranges, RangeIterator::end_tag{}}; // avoid new_pos.check()
            }
            else {
                new_pos.m_inner = new_pos.m_outer->second.begin();
                REALM_ASSERT(new_pos.m_inner != new_pos.m_outer->second.end());
                new_pos.m_pos = new_pos.m_inner->begin;
            }
        }
        else {
            new_pos.m_pos = new_pos.m_inner->begin;
            REALM_ASSERT(new_pos.m_pos != new_pos.m_inner->end); // empty ranges not allowed
        }
    }
    new_pos.check();
    return new_pos;
}

#if REALM_DEBUG
static std::ostream& operator<<(std::ostream& os, GlobalID gid)
{
    return os << gid.table_name << "/" << format_pk(gid.object_id);
}

void ChangesetIndex::print(std::ostream& os) const
{
    auto print_ranges = [&](auto& subjects, const Ranges& ranges) {
        std::sort(subjects.begin(), subjects.end());
        subjects.erase(std::unique(subjects.begin(), subjects.end()), subjects.end());

        os << "[";
        for (auto it = subjects.begin(); it != subjects.end();) {
            os << *it;
            auto next = it;
            ++next;
            if (next != subjects.end())
                os << ", ";
            it = next;
        }
        os << "]: ";
        for (auto it = ranges.begin(); it != ranges.end();) {
            os << "Changeset" << std::dec << it->first->version << "(";
            for (auto it2 = it->second.begin(); it2 != it->second.end(); ++it2) {
                auto offset = std::distance(it->first->begin(), it2->begin);
                auto length = std::distance(it2->begin, it2->end);
                os << "[" << std::dec << offset << "+" << length << "]";
                if (it2 + 1 != it->second.end())
                    os << ", ";
            }
            os << ")";
            auto next = it;
            ++next;
            if (next != ranges.end())
                os << ", ";
            it = next;
        }
    };

    std::map<Ranges*, std::vector<StringData>> schema_modifications;
    std::map<Ranges*, std::vector<GlobalID>> object_modifications;

    for (auto& pair : m_schema_instructions) {
        schema_modifications[&pair.second->ranges].push_back(pair.first);
    }

    for (auto& pair : m_object_instructions) {
        for (auto& pair2 : pair.second) {
            object_modifications[&pair2.second->ranges].push_back(GlobalID{pair.first, pair2.first});
        }
    }

    if (schema_modifications.size()) {
        os << "SCHEMA MODIFICATIONS:\n";
        for (auto& pair : schema_modifications) {
            print_ranges(pair.second, *pair.first);
            os << "\n";
        }
        os << "\n";
    }

    if (object_modifications.size()) {
        os << "OBJECT MODIFICATIONS:\n";
        for (auto& pair : object_modifications) {
            print_ranges(pair.second, *pair.first);
            os << "\n";
        }
        os << "\n";
    }
}

void ChangesetIndex::verify() const
{
    REALM_ASSERT(m_num_conflict_groups == m_conflict_groups_owner.size());

    // Verify that there are no stray pointers.
    for (auto& pair : m_object_instructions) {
        for (auto& pair2 : pair.second) {
            REALM_ASSERT(&*pair2.second->self_it == pair2.second);
            REALM_ASSERT(std::any_of(m_conflict_groups_owner.begin(), m_conflict_groups_owner.end(), [&](auto& cg) {
                return &cg == pair2.second;
            }));
        }
    }

    for (auto& pair : m_schema_instructions) {
        REALM_ASSERT(&*pair.second->self_it == pair.second);
        REALM_ASSERT(std::any_of(m_conflict_groups_owner.begin(), m_conflict_groups_owner.end(), [&](auto& cg) {
            return &cg == pair.second;
        }));
    }

    // Collect all changesets
    std::vector<Changeset*> changesets;
    for (auto& cg : m_conflict_groups_owner) {
        check_ranges(cg.ranges);

        for (auto& ranges : cg.ranges) {
            changesets.push_back(ranges.first);
        }
    }
    std::sort(changesets.begin(), changesets.end(), std::less<>());
    changesets.erase(std::unique(changesets.begin(), changesets.end()), changesets.end());

    // Run through all instructions in each changeset and check that
    // instructions are correctly covered by the index.
    for (auto changeset : changesets) {
        auto& log = *changeset;

        using Instruction = realm::sync::Instruction;

        // Iterate over all instructions (skipping tombstones), and verify that
        // the index covers any objects mentioned in that instruction.
        for (auto it = log.begin(); it != log.end(); ++it) {
            if (!*it)
                continue;

            const auto& instr = **it;

            if (auto add_table_instr = instr.get_if<Instruction::AddTable>()) {
                StringData table = log.get_string(add_table_instr->table);
                auto ranges = *get_schema_changes_for_class(table);
                REALM_ASSERT(ranges_cover(ranges, log, it));
            }
            else if (auto erase_table_instr = instr.get_if<Instruction::EraseTable>()) {
                StringData table = log.get_string(erase_table_instr->table);
                auto ranges = *get_schema_changes_for_class(table);
                REALM_ASSERT(ranges_cover(ranges, log, it));
            }
            else if (auto add_column_instr = instr.get_if<Instruction::AddColumn>()) {
                StringData table = log.get_string(add_column_instr->table);
                auto ranges = *get_schema_changes_for_class(table);
                REALM_ASSERT(ranges_cover(ranges, log, it));
            }
            else if (auto erase_column_instr = instr.get_if<Instruction::EraseColumn>()) {
                StringData table = log.get_string(erase_column_instr->table);
                auto ranges = *get_schema_changes_for_class(table);
                REALM_ASSERT(ranges_cover(ranges, log, it));
            }
            else {
                GlobalID ids[2];
                size_t num_ids = get_object_ids_in_instruction(log, instr, ids, 2);
                REALM_ASSERT(num_ids >= 1);
                REALM_ASSERT(num_ids <= 2);
                auto& ranges_first = *get_modifications_for_object(ids[0]);

                for (size_t i = 0; i < num_ids; ++i) {
                    auto& ranges = *get_modifications_for_object(ids[i]);
                    REALM_ASSERT(&ranges == &ranges_first);
                    REALM_ASSERT(ranges_cover(ranges, log, it));
                }
            }
        }
    }
}

bool ChangesetIndex::ranges_cover(const Ranges& ranges, Changeset& log, Changeset::const_iterator it) const
{
    auto outer = ranges.find(&log);
    if (outer == ranges.end())
        return false;
    for (auto& range : outer->second) {
        if (it >= range.begin && it < range.end)
            return true;
    }
    return false;
}

#endif // REALM_DEBUG

void ChangesetIndex::add_instruction_at(Ranges& ranges, Changeset& changeset, Changeset::iterator pos)
{
    auto& ranges_for_changeset = ranges[&changeset];

    REALM_ASSERT(pos != changeset.end());
    auto next = pos;
    ++next;

    Changeset::Range incoming{pos, next};

    auto cmp = [](const Changeset::Range& range_a, const Changeset::Range& range_b) {
        return range_a.begin < range_b.begin;
    };

    auto it = std::lower_bound(ranges_for_changeset.begin(), ranges_for_changeset.end(), incoming, cmp);

    it = ranges_for_changeset.insert(it, incoming);
    if (it != ranges_for_changeset.begin())
        --it;

    // Merge adjacent overlapping ranges
    while (it + 1 != ranges_for_changeset.end()) {
        auto next_it = it + 1;
        if (it->end >= next_it->begin) {
            it->end = std::max(it->end, next_it->end);
            next_it = ranges_for_changeset.erase(next_it);
            it = next_it - 1;
        }
        else {
            ++it;
        }
    }
}


} // namespace _impl
} // namespace realm

1	#include <realm/sync/noinst/changeset_index.hpp>
2	#include <realm/sync/object_id.hpp>
3
4	#include <iterator> // std::distance, std::advance
5
6	using namespace realm::sync;
7
8	namespace realm {
9	namespace _impl {
10
11	#if REALM_DEBUG
12	static bool compare_ranges(const Changeset::Range& left, const Changeset::Range& right)
13	{	3,436✔
14	return left.begin < right.begin;	3,436✔
15	}	3,436✔
16
17	template <class InputIterator>
18	static bool check_ranges(InputIterator begin, InputIterator end)
19	{	78,482✔
20	if (!std::is_sorted(begin, end, compare_ranges))	78,482✔
21	return false;	×
22
23	// Check that there are no overlaps
24	if (begin != end) {	78,484✔
25	auto last_end = begin->end;	78,484✔
26	for (auto i = begin + 1; i != end; ++i) {	81,920✔
27	if (last_end > i->begin)	3,436✔
28	return false;	×
29	last_end = i->end;	3,436✔
30	}	3,436✔
31	}	78,484✔
32	return true;	78,482✔
33	}	78,482✔
34
35	static bool check_ranges(const ChangesetIndex::Ranges& ranges)
36	{	286,450✔
37	for (auto& pair : ranges) {	286,450✔
38	if (!check_ranges(pair.second.begin(), pair.second.end()))	78,488✔
39	return false;	×
40	}	78,488✔
41	return true;	286,450✔
42	}	286,450✔
43	#endif // REALM_DEBUG
44
45
46	void ChangesetIndex::clear() noexcept
47	{	4,880✔
48	m_object_instructions.clear();	4,880✔
49	m_schema_instructions.clear();	4,880✔
50	m_conflict_groups_owner.clear();	4,880✔
51	m_num_conflict_groups = 0;	4,880✔
52	}	4,880✔
53
54
55	void ChangesetIndex::scan_changeset(Changeset& changeset)
56	{	671,466✔
57	if (m_contains_destructive_schema_changes)	671,466✔
58	return;	99,878✔
59
60	#if defined(REALM_DEBUG) // LCOV_EXCL_START	571,588✔
61	for (auto& confict_group : m_conflict_groups_owner) {	6,594,766✔
62	// Check that add_changeset() has not been called yet.
63	REALM_ASSERT(confict_group.ranges.empty());	6,594,766✔
64	}	6,594,766✔
65	#endif // REALM_DEBUG LCOV_EXCL_STOP	571,588✔
66
67	using Instruction = realm::sync::Instruction;	571,588✔
68
69	for (auto it = changeset.begin(); it != changeset.end(); ++it) {	1,227,562✔
70	if (!*it)	660,854✔
71	continue;	4,088✔
72
73	const auto& instr = **it;	656,766✔
74
75	if (auto add_table_instr = instr.get_if<Instruction::AddTable>()) {	656,766✔
76	auto& p = *add_table_instr;	17,490✔
77	schema_conflict_group(changeset.get_string(p.table));	17,490✔
78	}	17,490✔
79	else if (instr.get_if<Instruction::EraseTable>()) {	639,276✔
80	m_contains_destructive_schema_changes = true;	4,880✔
81	clear();	4,880✔
82	return;	4,880✔
83	}	4,880✔
84	else if (auto add_column_instr = instr.get_if<Instruction::AddColumn>()) {	634,396✔
85	auto& p = *add_column_instr;	40,066✔
86	StringData table_name = changeset.get_string(p.table);	40,066✔
87	ConflictGroup& cg = schema_conflict_group(table_name);	40,066✔
88	if (p.type == Instruction::Payload::Type::Link) {	40,066✔
89	StringData target_table = changeset.get_string(p.link_target_table);	4,568✔
90	ConflictGroup& cg2 = schema_conflict_group(target_table);	4,568✔
91	merge_conflict_groups(cg, cg2);	4,568✔
92	}	4,568✔
93	}	40,066✔
94	else if (instr.get_if<Instruction::EraseColumn>()) {	594,330✔
95	m_contains_destructive_schema_changes = true;	×
96	clear();	×
97	return;	×
98	}	×
99	else {	594,330✔
100	GlobalID ids[2];	594,330✔
101	size_t num_ids = get_object_ids_in_instruction(changeset, instr, ids, 2);	594,330✔
102	REALM_ASSERT(num_ids >= 1);	594,330✔
103	REALM_ASSERT(num_ids <= 2);	594,330✔
104
105	ConflictGroup& cg = object_conflict_group(ids[0]);	594,330✔
106	for (size_t i = 1; i < num_ids; ++i) {	594,686✔
107	ConflictGroup& cg2 = object_conflict_group(ids[1]);	356✔
108	merge_conflict_groups(cg, cg2);	356✔
109	}	356✔
110	}	594,330✔
111	}	656,766✔
112	}	571,588✔
113
114
115	void ChangesetIndex::merge_conflict_groups(ConflictGroup& into, ConflictGroup& from)
116	{	4,940✔
117	if (&into == &from)	4,940✔
118	return;	3,252✔
119
120	if (from.size > into.size) {	1,688✔
121	// This is an optimization. The time it takes to merge two conflict
122	// groups is proportional to the size of the incoming group (in number
123	// of objects touched). If the incoming group is larger, merge the other
124	// way.
125	merge_conflict_groups(from, into);	16✔
126	return;	16✔
127	}	16✔
128
129	REALM_ASSERT(into.ranges.empty());	1,672✔
130	REALM_ASSERT(from.ranges.empty());	1,672✔
131
132	for (auto& class_name : from.schemas) {	1,672✔
133	m_schema_instructions[class_name] = &into;	1,348✔
134	}	1,348✔
135	into.schemas.insert(into.schemas.end(), from.schemas.begin(), from.schemas.end());	1,672✔
136
137	for (auto& pair : from.objects) {	1,672✔
138	auto& objset = into.objects[pair.first];	324✔
139	auto& objinstr = m_object_instructions[pair.first];	324✔
140	for (auto& object : pair.second) {	324✔
141	objinstr[object] = &into;	324✔
142	}	324✔
143	objset.insert(objset.end(), pair.second.begin(), pair.second.end());	324✔
144	}	324✔
145	into.size += from.size;	1,672✔
146
147	m_conflict_groups_owner.erase(from.self_it);	1,672✔
148	--m_num_conflict_groups;	1,672✔
149	}	1,672✔
150
151
152	void ChangesetIndex::add_changeset(Changeset& log)
153	{	71,922✔
154	if (!log.empty())	71,922✔
155	m_everything[&log] = std::vector<Changeset::Range>(1, Changeset::Range{log.begin(), log.end()});	66,344✔
156
157	if (m_contains_destructive_schema_changes)	71,922✔
158	return; // Just add to everything.	4,880✔
159
160	using Instruction = realm::sync::Instruction;	67,042✔
161
162	// Iterate over all instructions (skipping tombstones), and add them to the
163	// index.
164	for (auto it = log.begin(); it != log.end(); ++it) {	190,616✔
165	if (!*it)	123,574✔
166	continue;	×
167
168	const auto& instr = **it;	123,574✔
169
170	if (auto add_table_instr = instr.get_if<Instruction::AddTable>()) {	123,574✔
171	StringData table = log.get_string(add_table_instr->table);	4,418✔
172	auto& cg = schema_conflict_group(table);	4,418✔
173	add_instruction_at(cg.ranges, log, it);	4,418✔
174	}	4,418✔
175	else if (instr.get_if<Instruction::EraseTable>()) {	119,156✔
176	REALM_TERMINATE("Call scan_changeset() before add_changeset().");
177	}	×
178	else if (auto add_column_instr = instr.get_if<Instruction::AddColumn>()) {	119,156✔
179	auto& p = *add_column_instr;	10,796✔
180	StringData table = log.get_string(p.table);	10,796✔
181	auto& cg = schema_conflict_group(table);	10,796✔
182	if (p.type == Instruction::Payload::Type::Link) {	10,796✔
183	REALM_ASSERT(&cg == &schema_conflict_group(log.get_string(p.link_target_table)));	2,284✔
184	}	2,284✔
185	add_instruction_at(cg.ranges, log, it);	10,796✔
186	}	10,796✔
187	else if (instr.get_if<Instruction::EraseColumn>()) {	108,360✔
188	REALM_TERMINATE("Call scan_changeset() before add_changeset().");
189	}	×
190	else {	108,360✔
191	GlobalID ids[2];	108,360✔
192	size_t num_ids = get_object_ids_in_instruction(log, instr, ids, 2);	108,360✔
193	REALM_ASSERT(num_ids >= 1);	108,360✔
194	REALM_ASSERT(num_ids <= 2);	108,360✔
195
196	auto& cg = object_conflict_group(ids[0]);	108,360✔
197	for (size_t i = 1; i < num_ids; ++i) {	108,568✔
198	REALM_ASSERT(&cg == &object_conflict_group(ids[i]));	208✔
199	}	208✔
200	add_instruction_at(cg.ranges, log, it);	108,360✔
201	}	108,360✔
202	}	123,574✔
203	}	67,042✔
204
205	size_t get_object_ids_in_instruction(const Changeset& changeset, const sync::Instruction& instr,
206	ChangesetIndex::GlobalID* ids, size_t max_num_ids)
207	{	1,364,616✔
208	REALM_ASSERT_RELEASE(max_num_ids >= 2);	1,364,616✔
209
210	using Instruction = realm::sync::Instruction;	1,364,616✔
211
212	if (auto obj_instr = instr.get_if<Instruction::ObjectInstruction>()) {	1,364,616✔
213	ids[0] = {changeset.get_string(obj_instr->table), changeset.get_key(obj_instr->object)};	1,363,166✔
214
215	if (auto set_instr = instr.get_if<Instruction::Update>()) {	1,363,166✔
216	auto& p = *set_instr;	727,160✔
217	if (p.value.type == Instruction::Payload::Type::Link) {	727,160✔
218	ids[1] = {changeset.get_string(p.value.data.link.target_table),	268✔
219	changeset.get_key(p.value.data.link.target)};	268✔
220	return 2;	268✔
221	}	268✔
222	}	727,160✔
223	else if (auto insert_instr = instr.get_if<Instruction::ArrayInsert>()) {	636,006✔
224	auto& p = *insert_instr;	75,818✔
225	if (p.value.type == Instruction::Payload::Type::Link) {	75,818✔
226	ids[1] = {changeset.get_string(p.value.data.link.target_table),	636✔
227	changeset.get_key(p.value.data.link.target)};	636✔
228	return 2;	636✔
229	}	636✔
230	}	75,818✔
231
232	return 1;	1,362,262✔
233	}	1,363,166✔
234
235	return 0;	1,450✔
236	}	1,364,616✔
237
238	auto ChangesetIndex::get_schema_changes_for_class(StringData class_name) const -> const Ranges*
239	{	1,026✔
240	return const_cast<ChangesetIndex*>(this)->get_schema_changes_for_class(class_name);	1,026✔
241	}	1,026✔
242
243	auto ChangesetIndex::get_schema_changes_for_class(StringData class_name) -> Ranges*
244	{	1,026✔
245	if (m_contains_destructive_schema_changes)	1,026✔
246	return &m_everything;	×
247	auto it = m_schema_instructions.find(class_name);	1,026✔
248	if (it == m_schema_instructions.end())	1,026✔
249	return &m_empty;	×
250	return &it->second->ranges;	1,026✔
251	}	1,026✔
252
253	auto ChangesetIndex::get_modifications_for_object(GlobalID id) -> Ranges*
254	{	764,798✔
255	if (m_contains_destructive_schema_changes)	764,798✔
256	return &m_everything;	122,846✔
257	auto it = m_object_instructions.find(id.table_name);	641,952✔
258	if (it == m_object_instructions.end())	641,952✔
259	return &m_empty;	×
260
261	auto& object_instructions = it->second;	641,952✔
262	auto it2 = object_instructions.find(id.object_id);	641,952✔
263	if (it2 == object_instructions.end())	641,952✔
264	return &m_empty;	×
265	return &it2->second->ranges;	641,952✔
266	}	641,952✔
267
268	auto ChangesetIndex::get_modifications_for_object(GlobalID id) const -> const Ranges*
269	{	204,212✔
270	return const_cast<ChangesetIndex*>(this)->get_modifications_for_object(id);	204,212✔
271	}	204,212✔
272
273	auto ChangesetIndex::schema_conflict_group(StringData class_name) -> ConflictGroup&
274	{	79,618✔
275	auto& conflict_group = m_schema_instructions[class_name];	79,618✔
276	if (conflict_group == nullptr) {	79,618✔
277	m_conflict_groups_owner.emplace_back();	25,342✔
278	++m_num_conflict_groups;	25,342✔
279	auto new_cg = std::prev(m_conflict_groups_owner.end());	25,342✔
280	new_cg->schemas.push_back(class_name);	25,342✔
281	new_cg->size = 1;	25,342✔
282	new_cg->self_it = new_cg;	25,342✔
283	conflict_group = &*new_cg;	25,342✔
284	}	25,342✔
285	return *conflict_group;	79,618✔
286	}	79,618✔
287
288	auto ChangesetIndex::object_conflict_group(const GlobalID& object_id) -> ConflictGroup&
289	{	702,764✔
290	auto& objects_for_table = m_object_instructions[object_id.table_name];	702,764✔
291	auto& conflict_group = objects_for_table[object_id.object_id];	702,764✔
292	if (conflict_group == nullptr) {	702,764✔
293	m_conflict_groups_owner.emplace_back();	298,582✔
294	++m_num_conflict_groups;	298,582✔
295	auto new_cg = std::prev(m_conflict_groups_owner.end());	298,582✔
296	new_cg->objects[object_id.table_name].push_back(object_id.object_id);	298,582✔
297	new_cg->size = 1;	298,582✔
298	new_cg->self_it = new_cg;	298,582✔
299	conflict_group = &*new_cg;	298,582✔
300	}	298,582✔
301	return *conflict_group;	702,764✔
302	}	702,764✔
303
304	auto ChangesetIndex::erase_instruction(RangeIterator pos) -> RangeIterator
305	{	22,008✔
306	Changeset* changeset = pos.m_outer->first;	22,008✔
307	pos.check();	22,008✔
308	auto new_pos = pos;	22,008✔
309	new_pos.m_pos = changeset->erase_stable(pos.m_pos);	22,008✔
310
311	if (new_pos.m_pos >= new_pos.m_inner->end) {	22,008✔
312	// erased the last instruction in the range, move to the next range.
313	REALM_ASSERT(new_pos.m_inner < new_pos.m_outer->second.end());	10,608✔
314	++new_pos.m_inner;	10,608✔
315	if (new_pos.m_inner == new_pos.m_outer->second.end()) {	10,608✔
316	REALM_ASSERT(new_pos.m_outer != new_pos.m_ranges->end());	10,606✔
317	++new_pos.m_outer;	10,606✔
318	if (new_pos.m_outer == new_pos.m_ranges->end()) {	10,606✔
319	return RangeIterator{new_pos.m_ranges, RangeIterator::end_tag{}}; // avoid new_pos.check()	8,740✔
320	}	8,740✔
321	else {	1,866✔
322	new_pos.m_inner = new_pos.m_outer->second.begin();	1,866✔
323	REALM_ASSERT(new_pos.m_inner != new_pos.m_outer->second.end());	1,866✔
324	new_pos.m_pos = new_pos.m_inner->begin;	1,866✔
325	}	1,866✔
326	}	10,606✔
327	else {	2✔
328	new_pos.m_pos = new_pos.m_inner->begin;	2✔
329	REALM_ASSERT(new_pos.m_pos != new_pos.m_inner->end); // empty ranges not allowed	2✔
330	}	2✔
331	}	10,608✔
332	new_pos.check();	13,268✔
333	return new_pos;	13,268✔
334	}	22,008✔
335
336	#if REALM_DEBUG
337	static std::ostream& operator<<(std::ostream& os, GlobalID gid)
338	{	×
339	return os << gid.table_name << "/" << format_pk(gid.object_id);	×
340	}	×
341
342	void ChangesetIndex::print(std::ostream& os) const
343	{	×
344	auto print_ranges = [&](auto& subjects, const Ranges& ranges) {	×
345	std::sort(subjects.begin(), subjects.end());	×
346	subjects.erase(std::unique(subjects.begin(), subjects.end()), subjects.end());	×
347
348	os << "[";	×
349	for (auto it = subjects.begin(); it != subjects.end();) {	×
350	os << *it;	×
351	auto next = it;	×
352	++next;	×
353	if (next != subjects.end())	×
354	os << ", ";	×
355	it = next;	×
356	}	×
357	os << "]: ";	×
358	for (auto it = ranges.begin(); it != ranges.end();) {	×
359	os << "Changeset" << std::dec << it->first->version << "(";	×
360	for (auto it2 = it->second.begin(); it2 != it->second.end(); ++it2) {	×
361	auto offset = std::distance(it->first->begin(), it2->begin);	×
362	auto length = std::distance(it2->begin, it2->end);	×
363	os << "[" << std::dec << offset << "+" << length << "]";	×
364	if (it2 + 1 != it->second.end())	×
365	os << ", ";	×
366	}	×
367	os << ")";	×
368	auto next = it;	×
369	++next;	×
370	if (next != ranges.end())	×
371	os << ", ";	×
372	it = next;	×
373	}	×
374	};	×
375
376	std::map<Ranges*, std::vector<StringData>> schema_modifications;	×
377	std::map<Ranges*, std::vector<GlobalID>> object_modifications;	×
378
379	for (auto& pair : m_schema_instructions) {	×
380	schema_modifications[&pair.second->ranges].push_back(pair.first);	×
381	}	×
382
383	for (auto& pair : m_object_instructions) {	×
384	for (auto& pair2 : pair.second) {	×
385	object_modifications[&pair2.second->ranges].push_back(GlobalID{pair.first, pair2.first});	×
386	}	×
387	}	×
388
389	if (schema_modifications.size()) {	×
390	os << "SCHEMA MODIFICATIONS:\n";	×
391	for (auto& pair : schema_modifications) {	×
392	print_ranges(pair.second, *pair.first);	×
393	os << "\n";	×
394	}	×
395	os << "\n";	×
396	}	×
397
398	if (object_modifications.size()) {	×
399	os << "OBJECT MODIFICATIONS:\n";	×
400	for (auto& pair : object_modifications) {	×
401	print_ranges(pair.second, *pair.first);	×
402	os << "\n";	×
403	}	×
404	os << "\n";	×
405	}	×
406	}	×
407
408	void ChangesetIndex::verify() const
409	{	49,362✔
410	REALM_ASSERT(m_num_conflict_groups == m_conflict_groups_owner.size());	49,362✔
411
412	// Verify that there are no stray pointers.
413	for (auto& pair : m_object_instructions) {	88,450✔
414	for (auto& pair2 : pair.second) {	268,394✔
415	REALM_ASSERT(&*pair2.second->self_it == pair2.second);	268,394✔
416	REALM_ASSERT(std::any_of(m_conflict_groups_owner.begin(), m_conflict_groups_owner.end(), [&](auto& cg) {	268,394✔
417	return &cg == pair2.second;	268,394✔
418	}));	268,394✔
419	}	268,394✔
420	}	88,450✔
421
422	for (auto& pair : m_schema_instructions) {	49,362✔
423	REALM_ASSERT(&*pair.second->self_it == pair.second);	19,708✔
424	REALM_ASSERT(std::any_of(m_conflict_groups_owner.begin(), m_conflict_groups_owner.end(), [&](auto& cg) {	19,708✔
425	return &cg == pair.second;	19,708✔
426	}));	19,708✔
427	}	19,708✔
428
429	// Collect all changesets
430	std::vector<Changeset*> changesets;	49,362✔
431	for (auto& cg : m_conflict_groups_owner) {	286,456✔
432	check_ranges(cg.ranges);	286,456✔
433
434	for (auto& ranges : cg.ranges) {	286,456✔
435	changesets.push_back(ranges.first);	78,484✔
436	}	78,484✔
437	}	286,456✔
438	std::sort(changesets.begin(), changesets.end(), std::less<>());	49,362✔
439	changesets.erase(std::unique(changesets.begin(), changesets.end()), changesets.end());	49,362✔
440
441	// Run through all instructions in each changeset and check that
442	// instructions are correctly covered by the index.
443	for (auto changeset : changesets) {	62,742✔
444	auto& log = *changeset;	62,742✔
445
446	using Instruction = realm::sync::Instruction;	62,742✔
447
448	// Iterate over all instructions (skipping tombstones), and verify that
449	// the index covers any objects mentioned in that instruction.
450	for (auto it = log.begin(); it != log.end(); ++it) {	186,208✔
451	if (!*it)	123,466✔
452	continue;	20,416✔
453
454	const auto& instr = **it;	103,050✔
455
456	if (auto add_table_instr = instr.get_if<Instruction::AddTable>()) {	103,050✔
457	StringData table = log.get_string(add_table_instr->table);	328✔
458	auto ranges = *get_schema_changes_for_class(table);	328✔
459	REALM_ASSERT(ranges_cover(ranges, log, it));	328✔
460	}	328✔
461	else if (auto erase_table_instr = instr.get_if<Instruction::EraseTable>()) {	102,722✔
462	StringData table = log.get_string(erase_table_instr->table);	×
463	auto ranges = *get_schema_changes_for_class(table);	×
464	REALM_ASSERT(ranges_cover(ranges, log, it));	×
465	}	×
466	else if (auto add_column_instr = instr.get_if<Instruction::AddColumn>()) {	102,722✔
467	StringData table = log.get_string(add_column_instr->table);	698✔
468	auto ranges = *get_schema_changes_for_class(table);	698✔
469	REALM_ASSERT(ranges_cover(ranges, log, it));	698✔
470	}	698✔
471	else if (auto erase_column_instr = instr.get_if<Instruction::EraseColumn>()) {	102,024✔
472	StringData table = log.get_string(erase_column_instr->table);	×
473	auto ranges = *get_schema_changes_for_class(table);	×
474	REALM_ASSERT(ranges_cover(ranges, log, it));	×
475	}	×
476	else {	102,024✔
477	GlobalID ids[2];	102,024✔
478	size_t num_ids = get_object_ids_in_instruction(log, instr, ids, 2);	102,024✔
479	REALM_ASSERT(num_ids >= 1);	102,024✔
480	REALM_ASSERT(num_ids <= 2);	102,024✔
481	auto& ranges_first = *get_modifications_for_object(ids[0]);	102,024✔
482
483	for (size_t i = 0; i < num_ids; ++i) {	204,236✔
484	auto& ranges = *get_modifications_for_object(ids[i]);	102,212✔
485	REALM_ASSERT(&ranges == &ranges_first);	102,212✔
486	REALM_ASSERT(ranges_cover(ranges, log, it));	102,212✔
487	}	102,212✔
488	}	102,024✔
489	}	103,050✔
490	}	62,742✔
491	}	49,362✔
492
493	bool ChangesetIndex::ranges_cover(const Ranges& ranges, Changeset& log, Changeset::const_iterator it) const
494	{	103,228✔
495	auto outer = ranges.find(&log);	103,228✔
496	if (outer == ranges.end())	103,228✔
497	return false;	×
498	for (auto& range : outer->second) {	106,640✔
499	if (it >= range.begin && it < range.end)	106,642✔
500	return true;	103,228✔
501	}	106,640✔
UNCOV 502	return false;	×
503	}	103,228✔
504
505	#endif // REALM_DEBUG
506
507	void ChangesetIndex::add_instruction_at(Ranges& ranges, Changeset& changeset, Changeset::iterator pos)
508	{	123,570✔
509	auto& ranges_for_changeset = ranges[&changeset];	123,570✔
510
511	REALM_ASSERT(pos != changeset.end());	123,570✔
512	auto next = pos;	123,570✔
513	++next;	123,570✔
514
515	Changeset::Range incoming{pos, next};	123,570✔
516
517	auto cmp = [](const Changeset::Range& range_a, const Changeset::Range& range_b) {	123,570✔
518	return range_a.begin < range_b.begin;	45,836✔
519	};	45,836✔
520
521	auto it = std::lower_bound(ranges_for_changeset.begin(), ranges_for_changeset.end(), incoming, cmp);	123,570✔
522
523	it = ranges_for_changeset.insert(it, incoming);	123,570✔
524	if (it != ranges_for_changeset.begin())	123,570✔
525	--it;	45,066✔
526
527	// Merge adjacent overlapping ranges
528	while (it + 1 != ranges_for_changeset.end()) {	168,636✔
529	auto next_it = it + 1;	45,066✔
530	if (it->end >= next_it->begin) {	45,066✔
531	it->end = std::max(it->end, next_it->end);	41,622✔
532	next_it = ranges_for_changeset.erase(next_it);	41,622✔
533	it = next_it - 1;	41,622✔
534	}	41,622✔
535	else {	3,444✔
536	++it;	3,444✔
537	}	3,444✔
538	}	45,066✔
539	}	123,570✔
540
541
542	} // namespace _impl
543	} // namespace realm

realm / realm-core / 2373

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