2306

Committed 10 May 2024 05:50PM UTC coverage: 90.837% (-0.2%) from 91.065%

Build # 2306

Build Type

push

Evergreen

Committed by

danieltabacaru

Commit Message

Add back ability to format Objective-C code

Run Details

102110 of 181070 branches covered (56.39%)

214623 of 236272 relevant lines covered (90.84%)

5666944.3 hits per line

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

96.58

/src/realm/object_converter.cpp

/*************************************************************************
 *
 * Copyright 2022 Realm Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 **************************************************************************/

#include <realm/object_converter.hpp>

#include <realm/dictionary.hpp>
#include <realm/list.hpp>
#include <realm/set.hpp>

#include <realm/util/flat_map.hpp>

namespace realm::converters {

// Takes two lists, src and dst, and makes dst equal src. src is unchanged.
void InterRealmValueConverter::copy_list(const LstBase& src, LstBase& dst, bool* update_out) const
{
    // The two arrays are compared by finding the longest common prefix and
    // suffix.  The middle section differs between them and is made equal by
    // updating the middle section of dst.
    //
    // Example:
    // src = abcdefghi
    // dst = abcxyhi
    // The common prefix is abc. The common suffix is hi. xy is replaced by defg.

    bool updated = false;
    const size_t len_src = src.size();
    const size_t len_dst_orig = dst.size();
    size_t len_min = std::min(len_src, len_dst_orig);

    size_t ndx = 0;
    size_t suffix_len = 0;

    while (ndx < len_min && cmp_src_to_dst(src.get_any(ndx), dst.get_any(ndx), nullptr, update_out) == 0) {
        ndx++;
    }

    if (ndx == len_src && len_src == len_dst_orig) {
        // all are equal, early out
        if (update_out) {
            *update_out = false;
        }
        return;
    }

    size_t suffix_len_max = len_min - ndx;

    while (suffix_len < suffix_len_max &&
           cmp_src_to_dst(src.get_any(len_src - 1 - suffix_len), dst.get_any(len_dst_orig - 1 - suffix_len), nullptr,
                          update_out) == 0) {
        suffix_len++;
    }

    len_min -= (ndx + suffix_len);

    auto dst_as_link_list = dynamic_cast<LnkLst*>(&dst);
    auto dst_as_lst_mixed = dynamic_cast<Lst<Mixed>*>(&dst);
    REALM_ASSERT(!dst_as_lst_mixed);
    auto is_link_to_deleted_object = [&](const Mixed& converted_value) -> bool {
        return dst_as_link_list && converted_value.is_null();
    };

    std::vector<size_t> dst_to_erase;
    for (size_t i = 0; i < len_min; i++) {
        InterRealmValueConverter::ConversionResult converted_src;
        const Mixed src_value = src.get_any(ndx);
        if (cmp_src_to_dst(src_value, dst.get_any(ndx), &converted_src, update_out)) {
            if (converted_src.requires_new_embedded_object) {
                REALM_ASSERT(dst_as_link_list); // this is the only type of list that supports embedded objects
                Obj embedded = dst_as_link_list->create_and_set_linked_object(ndx);
                track_new_embedded(converted_src.src_embedded_to_check, embedded);
            }
            else if (is_link_to_deleted_object(converted_src.converted_value)) {
                // this can happen when the source linked list points to an object
                // which has been deleted in the dest Realm. Lists do not support
                // setting an element to null, so it must be deleted later.
                dst_to_erase.push_back(ndx);
            }
            else {
                dst.set_any(ndx, converted_src.converted_value);
            }
            updated = true;
        }
        ndx++;
    }

    // New elements must be inserted in dst.
    while (ndx < len_src - suffix_len) {
        InterRealmValueConverter::ConversionResult converted_src;
        const Mixed src_value = src.get_any(ndx);
        cmp_src_to_dst(src_value, Mixed{}, &converted_src, update_out);
        size_t dst_ndx_to_insert = dst.size() - suffix_len;
        if (converted_src.requires_new_embedded_object) {
            REALM_ASSERT(dst_as_link_list); // this is the only type of list that supports embedded objects
            Obj embedded = dst_as_link_list->create_and_insert_linked_object(dst_ndx_to_insert);
            track_new_embedded(converted_src.src_embedded_to_check, embedded);
        }
        else if (is_link_to_deleted_object(converted_src.converted_value)) {
            // ignore trying to insert a link to a object which no longer exists
        }
        else {
            dst.insert_any(dst_ndx_to_insert, converted_src.converted_value);
        }
        ndx++;
        updated = true;
    }
    // Excess elements must be removed from ll_dst.
    if (dst.size() > len_src) {
        dst.remove(len_src - suffix_len, dst.size() - suffix_len);
        updated = true;
    }

    while (dst_to_erase.size()) {
        size_t ndx_to_remove = dst_to_erase.back();
        dst_as_link_list->remove(ndx_to_remove);
        dst_to_erase.pop_back();
    }
    if (updated && update_out) {
        *update_out = updated;
    }
}

void InterRealmValueConverter::copy_set(const SetBase& src, SetBase& dst, bool* update_out) const
{
    std::vector<size_t> sorted_src, sorted_dst, to_insert, to_delete;
    constexpr bool ascending = true;
    // the implementation could be storing elements in sorted order, but
    // we don't assume that here.
    src.sort(sorted_src, ascending);
    dst.sort(sorted_dst, ascending);

    size_t dst_ndx = 0;
    size_t src_ndx = 0;
    while (src_ndx < sorted_src.size()) {
        if (dst_ndx == sorted_dst.size()) {
            // if we have reached the end of the dst items, all remaining
            // src items should be added
            while (src_ndx < sorted_src.size()) {
                to_insert.push_back(sorted_src[src_ndx++]);
            }
            break;
        }
        size_t ndx_in_src = sorted_src[src_ndx];
        Mixed src_val = src.get_any(ndx_in_src);
        while (dst_ndx < sorted_dst.size()) {
            size_t ndx_in_dst = sorted_dst[dst_ndx];

            int cmp = cmp_src_to_dst(src_val, dst.get_any(ndx_in_dst), nullptr, update_out);
            if (cmp == 0) {
                // equal: advance both src and dst
                ++dst_ndx;
                ++src_ndx;
                break;
            }
            else if (cmp < 0) {
                // src < dst: insert src, advance src only
                to_insert.push_back(ndx_in_src);
                ++src_ndx;
                break;
            }
            else {
                // src > dst: delete dst, advance only dst
                to_delete.push_back(ndx_in_dst);
                ++dst_ndx;
                continue;
            }
        }
    }
    while (dst_ndx < sorted_dst.size()) {
        to_delete.push_back(sorted_dst[dst_ndx++]);
    }

    std::sort(to_delete.begin(), to_delete.end());
    for (auto it = to_delete.rbegin(); it != to_delete.rend(); ++it) {
        dst.erase_any(dst.get_any(*it));
    }
    for (auto ndx : to_insert) {
        InterRealmValueConverter::ConversionResult converted_src;
        cmp_src_to_dst(src.get_any(ndx), Mixed{}, &converted_src, update_out);
        // we do not support a set of embedded objects
        REALM_ASSERT(!converted_src.requires_new_embedded_object);
        dst.insert_any(converted_src.converted_value);
    }

    if (update_out && (to_delete.size() || to_insert.size())) {
        *update_out = true;
    }
}

void InterRealmValueConverter::copy_dictionary(const Dictionary& src, Dictionary& dst, bool* update_out) const
{
    std::vector<size_t> to_insert, to_delete;

    size_t dst_ndx = 0;
    size_t src_ndx = 0;
    while (src_ndx < src.size()) {
        if (dst_ndx == dst.size()) {
            // if we have reached the end of the dst items, all remaining
            // src items should be added
            while (src_ndx < src.size()) {
                to_insert.push_back(src_ndx++);
            }
            break;
        }

        auto src_val = src.get_pair(src_ndx);
        while (dst_ndx < dst.size()) {
            auto dst_val = dst.get_pair(dst_ndx);
            int cmp = src_val.first.compare(dst_val.first);
            if (cmp == 0) {
                // Check if the values differ
                if (cmp_src_to_dst(src_val.second, dst_val.second, nullptr, update_out)) {
                    // values are different - modify destination, advance both
                    to_insert.push_back(src_ndx);
                }
                // keys and values equal: advance both src and dst
                ++dst_ndx;
                ++src_ndx;
                break;
            }
            else if (cmp < 0) {
                // src < dst: insert src, advance src only
                to_insert.push_back(src_ndx++);
                break;
            }
            else {
                // src > dst: delete dst, advance only dst
                to_delete.push_back(dst_ndx++);
            }
        }
    }
    // at this point, we've gone through all src items but still have dst items
    // oustanding; these should all be deleted because they are not in src
    while (dst_ndx < dst.size()) {
        to_delete.push_back(dst_ndx++);
    }

    for (auto it = to_delete.rbegin(); it != to_delete.rend(); ++it) {
        dst.erase(dst.begin() + *it);
    }
    for (auto ndx : to_insert) {
        auto pair = src.get_pair(ndx);
        InterRealmValueConverter::ConversionResult converted_val;
        cmp_src_to_dst(pair.second, Mixed{}, &converted_val, update_out);
        if (converted_val.requires_new_embedded_object) {
            Obj new_embedded = dst.create_and_insert_linked_object(pair.first);
            track_new_embedded(converted_val.src_embedded_to_check, new_embedded);
        }
        else {
            dst.insert(pair.first, converted_val.converted_value);
        }
    }
    if (update_out && (to_delete.size() || to_insert.size())) {
        *update_out = true;
    }
}

void InterRealmValueConverter::copy_value(const Obj& src_obj, Obj& dst_obj, bool* update_out)
{
    if (m_src_col.is_list()) {
        LstBasePtr src = src_obj.get_listbase_ptr(m_src_col);
        LstBasePtr dst = dst_obj.get_listbase_ptr(m_dst_col);
        if (src->get_data_type() == type_Mixed) {
            Lst<Mixed> src_list{src_obj, m_src_col};
            Lst<Mixed> dst_list{dst_obj, m_dst_col};
            return handle_list_in_mixed(src_list, dst_list);
        }
        copy_list(*src, *dst, update_out);
    }
    else if (m_src_col.is_dictionary()) {
        Dictionary src = src_obj.get_dictionary(m_src_col);
        Dictionary dst = dst_obj.get_dictionary(m_dst_col);
        if (src.get_value_data_type() == type_Mixed) {
            return handle_dictionary_in_mixed(src, dst);
        }
        copy_dictionary(src, dst, update_out);
    }
    else if (m_src_col.is_set()) {
        SetBasePtr src = src_obj.get_setbase_ptr(m_src_col);
        SetBasePtr dst = dst_obj.get_setbase_ptr(m_dst_col);
        copy_set(*src, *dst, update_out);
    }
    else {
        REALM_ASSERT(!m_src_col.is_collection());
        // nested collections
        auto src_mixed = src_obj.get_any(m_src_col);
        if (src_mixed.is_type(type_List)) {
            dst_obj.set_collection(m_dst_col, CollectionType::List);
            Lst<Mixed> src_list{src_obj, m_src_col};
            Lst<Mixed> dst_list{dst_obj, m_dst_col};
            handle_list_in_mixed(src_list, dst_list);
        }
        else if (src_mixed.is_type(type_Dictionary)) {
            dst_obj.set_collection(m_dst_col, CollectionType::Dictionary);
            Dictionary src_dict{src_obj, m_src_col};
            Dictionary dst_dict{dst_obj, m_dst_col};
            handle_dictionary_in_mixed(src_dict, dst_dict);
        }
        else if (src_mixed.is_type(type_Set)) {
            REALM_COMPILER_HINT_UNREACHABLE();
        }
        else {
            InterRealmValueConverter::ConversionResult converted_src;
            auto dst_mixed = dst_obj.get_any(m_dst_col);
            if (cmp_src_to_dst(src_mixed, dst_mixed, &converted_src, update_out)) {
                if (converted_src.requires_new_embedded_object) {
                    Obj new_embedded = dst_obj.create_and_set_linked_object(m_dst_col);
                    track_new_embedded(converted_src.src_embedded_to_check, new_embedded);
                }
                else {
                    dst_obj.set_any(m_dst_col, converted_src.converted_value);
                }
            }
        }
    }
}

void InterRealmValueConverter::copy_list(const LstBase& src_list, LstBase& dst_list) const
{
    auto src_as_lst_mixed = dynamic_cast<const Lst<Mixed>*>(&src_list);
    auto dst_as_lst_mixed = dynamic_cast<Lst<Mixed>*>(&dst_list);
    REALM_ASSERT(bool(src_as_lst_mixed) == bool(dst_as_lst_mixed));
    if (src_as_lst_mixed) {
        return handle_list_in_mixed(*src_as_lst_mixed, *dst_as_lst_mixed);
    }
    copy_list(src_list, dst_list, nullptr);
}

//
// Handle collections in mixed. A collection can have N nested levels (except for Sets). And these levels can be
// nested in arbitrary way (eg a List within a Dictionary or viceversa). In order to try to merge server changes with
// client changes, the algorithm needs to go through each single element in the collection, check its type and perform
// the most appropriate action in order to minimize the number of notifications triggered.
//
void InterRealmValueConverter::handle_list_in_mixed(const Lst<Mixed>& src_list, Lst<Mixed>& dst_list) const
{
    const auto sz = (int)std::min(src_list.size(), dst_list.size());
    int left = 0;

    // find fist not matching element from beginning
    while (left < sz && check_if_list_elements_match(src_list, dst_list, left, left)) {
        left += 1;
    }

    // find first not matching element from end
    int right_src = (int)src_list.size() - 1;
    int right_dst = (int)dst_list.size() - 1;
    while (right_src >= left && right_dst >= left &&
           check_if_list_elements_match(src_list, dst_list, right_src, right_dst)) {
        right_src -= 1;
        right_dst -= 1;
    }

    auto is_link_to_deleted_object = [&](const Mixed& src_value, const Mixed& converted_value) -> bool {
        return converted_value.is_null() && src_value.is_type(type_TypedLink);
    };

    // Replace all different elements in [left, right]
    auto left_src = left;
    auto left_dst = left;
    std::vector<size_t> dst_to_erase;
    while (left_src <= right_src && left_dst <= right_dst) {
        auto src_any = src_list.get_any(left_src);
        auto dst_any = dst_list.get_any(left_dst);

        if (is_collection(src_any)) {
            auto coll_type = to_collection_type(src_any);

            if (!dst_any.is_type(src_any.get_type())) {
                // Primitive vs Collection or different collection types
                dst_list.set_collection(left_dst, coll_type);
                copy_list_in_mixed(src_list, dst_list, left_src, left_dst, coll_type);
            }
            else if (!check_if_list_elements_match(src_list, dst_list, left_src, left_dst)) {
                // Same collection type but different contents
                copy_list_in_mixed(src_list, dst_list, left_src, left_dst, coll_type);
            }
        }
        else if (dst_any != src_any) {
            // Mixed vs Mixed
            InterRealmValueConverter::ConversionResult converted_src;
            bool update_out = false;
            cmp_src_to_dst(src_any, dst_any, &converted_src, &update_out);
            REALM_ASSERT(!converted_src.requires_new_embedded_object);
            if (is_link_to_deleted_object(src_any, converted_src.converted_value)) {
                dst_to_erase.push_back(left_dst);
            }
            else {
                dst_list.set_any(left_dst, converted_src.converted_value);
            }
        }
        left_src += 1;
        left_dst += 1;
    }

    // remove dst elements not present in src
    while (right_dst > right_src)
        dst_list.remove(right_dst--);

    // append remainig src into dst
    for (int i = left_src; i <= right_src; ++i) {
        auto src_any = src_list.get(i);
        if (is_collection(src_any)) {
            auto coll_type = to_collection_type(src_any);
            dst_list.insert_collection(i, coll_type);
            copy_list_in_mixed(src_list, dst_list, i, i, coll_type);
        }
        else {
            InterRealmValueConverter::ConversionResult converted_src;
            bool update_out = false;
            cmp_src_to_dst(src_any, Mixed{}, &converted_src, &update_out);
            REALM_ASSERT(!converted_src.requires_new_embedded_object);
            if (is_link_to_deleted_object(src_any, converted_src.converted_value)) {
                // ignore trying to insert a link to a object which no longer exists
            }
            else {
                dst_list.insert_any(i, converted_src.converted_value);
            }
        }
    }

    while (dst_to_erase.size()) {
        size_t ndx_to_remove = dst_to_erase.back();
        dst_list.remove(ndx_to_remove);
        dst_to_erase.pop_back();
    }
}

void InterRealmValueConverter::handle_dictionary_in_mixed(Dictionary& src_dictionary,
                                                          Dictionary& dst_dictionary) const
{
    std::vector<size_t> to_insert, to_delete;
    size_t src_ndx = 0, dst_ndx = 0;
    while (src_ndx < src_dictionary.size() && dst_ndx < dst_dictionary.size()) {
        const auto [key_src, src_any] = src_dictionary.get_pair(src_ndx);
        const auto [key_dst, dst_any] = dst_dictionary.get_pair(dst_ndx);

        auto cmp = key_src.compare(key_dst);
        if (cmp == 0) {
            if (src_any != dst_any) {
                to_insert.push_back(src_ndx);
            }
            else if (is_collection(src_any) &&
                     !check_if_dictionary_elements_match(src_dictionary, dst_dictionary, key_src.get_string())) {
                to_insert.push_back(src_ndx);
            }
            src_ndx += 1;
            dst_ndx += 1;
        }
        else if (cmp < 0) {
            to_insert.push_back(src_ndx);
            src_ndx += 1;
        }
        else {
            to_delete.push_back(dst_ndx);
            dst_ndx += 1;
        }
    }

    // append src to dst
    while (src_ndx < src_dictionary.size()) {
        to_insert.push_back(src_ndx);
        src_ndx += 1;
    }

    // delete everything that did not match passed src.size()
    while (dst_ndx < dst_dictionary.size()) {
        to_delete.push_back(dst_ndx);
        dst_ndx += 1;
    }

    // delete all the non matching keys
    while (!to_delete.empty()) {
        dst_dictionary.erase(dst_dictionary.begin() + to_delete.back());
        to_delete.pop_back();
    }

    // insert into dst
    for (const auto pos : to_insert) {
        const auto [key, any] = src_dictionary.get_pair(pos);
        if (is_collection(any)) {
            auto coll_type = to_collection_type(any);
            dst_dictionary.insert_collection(key.get_string(), coll_type);
            copy_dictionary_in_mixed(src_dictionary, dst_dictionary, key.get_string(), coll_type);
        }
        else {

            InterRealmValueConverter::ConversionResult converted_src;
            bool update_out = false;
            cmp_src_to_dst(any, Mixed{}, &converted_src, &update_out);
            if (update_out) {
                // we do not support embedded objects
                REALM_ASSERT(!converted_src.requires_new_embedded_object);
                dst_dictionary.insert(key, converted_src.converted_value);
            }
            else
                dst_dictionary.insert(key, any);
        }
    }
}

bool InterRealmValueConverter::check_if_list_elements_match(const Lst<Mixed>& src_list, Lst<Mixed>& dst_list,
                                                            size_t ndx_src, size_t ndx_dst) const
{
    REALM_ASSERT(ndx_src < src_list.size() && ndx_dst < dst_list.size());
    auto src_any = src_list.get_any(ndx_src);
    auto dst_any = dst_list.get_any(ndx_dst);
    if (src_any != dst_any)
        return false;
    if (!is_collection(src_any))
        return true;
    // Check collections are equal
    if (src_any.is_type(type_List)) {
        auto src_element = src_list.get_list(ndx_src);
        auto dst_element = dst_list.get_list(ndx_dst);
        auto src_element_size = src_element->size();
        auto dst_element_size = dst_element->size();
        if (src_element_size != dst_element_size)
            return false;
        for (size_t i = 0; i < src_element_size; ++i) {
            if (!(check_if_list_elements_match(*src_element, *dst_element, i, i)))
                return false;
        }
    }
    else if (src_any.is_type(type_Dictionary)) {
        auto src_element = src_list.get_dictionary(ndx_src);
        auto dst_element = dst_list.get_dictionary(ndx_dst);
        auto src_element_size = src_element->size();
        auto dst_element_size = dst_element->size();
        if (src_element_size != dst_element_size)
            return false;
        for (size_t i = 0; i < src_element_size; ++i) {
            auto src_key = src_element->get_key(i);
            auto dst_key = dst_element->get_key(i);
            if (src_key != dst_key)
                return false;
            if (!check_if_dictionary_elements_match(*src_element, *dst_element, src_key.get_string()))
                return false;
        }
    }
    return true;
}

bool InterRealmValueConverter::check_if_dictionary_elements_match(const Dictionary& src_dictionary,
                                                                  const Dictionary& dst_dictionary,
                                                                  StringData key) const
{
    REALM_ASSERT(src_dictionary.contains(key) && dst_dictionary.contains(key));
    auto src_any = src_dictionary.get(key);
    auto dst_any = dst_dictionary.get(key);
    if (src_any != dst_any)
        return false;
    if (!is_collection(src_any))
        return true;
    // Check collections are equal
    if (src_any.is_type(type_List)) {
        auto src_element = src_dictionary.get_list(key);
        auto dst_element = dst_dictionary.get_list(key);
        auto src_element_size = src_element->size();
        auto dst_element_size = dst_element->size();
        if (src_element_size != dst_element_size)
            return false;
        for (size_t i = 0; i < src_element_size; ++i) {
            if (!(check_if_list_elements_match(*src_element, *dst_element, i, i)))
                return false;
        }
    }
    else if (src_any.is_type(type_Dictionary)) {
        auto src_element = src_dictionary.get_dictionary(key);
        auto dst_element = dst_dictionary.get_dictionary(key);
        auto src_element_size = src_element->size();
        auto dst_element_size = dst_element->size();
        if (src_element_size != dst_element_size)
            return false;
        for (size_t i = 0; i < src_element_size; ++i) {
            auto left_key = src_element->get_key(i);
            auto right_key = dst_element->get_key(i);
            if (left_key != right_key)
                return false;
            if (!check_if_dictionary_elements_match(*src_element, *dst_element, left_key.get_string()))
                return false;
        }
    }
    return true;
}

void InterRealmValueConverter::copy_list_in_mixed(const Lst<Mixed>& src_list, Lst<Mixed>& dst_list, size_t ndx_src,
                                                  size_t ndx_dst, CollectionType type) const
{
    if (type == CollectionType::List) {
        auto n_src_list = src_list.get_list(ndx_src);
        auto n_dst_list = dst_list.get_list(ndx_dst);
        handle_list_in_mixed(*n_src_list, *n_dst_list);
    }
    else if (type == CollectionType::Dictionary) {
        auto n_src_dict = src_list.get_dictionary(ndx_src);
        auto n_dst_dict = dst_list.get_dictionary(ndx_dst);
        handle_dictionary_in_mixed(*n_src_dict, *n_dst_dict);
    }
}

void InterRealmValueConverter::copy_dictionary_in_mixed(const Dictionary& src_dictionary, Dictionary& dst_dictionary,
                                                        StringData key, CollectionType type) const
{
    if (type == CollectionType::List) {
        auto n_src_list = src_dictionary.get_list(key);
        auto n_dst_list = dst_dictionary.get_list(key);
        handle_list_in_mixed(*n_src_list, *n_dst_list);
    }
    else if (type == CollectionType::Dictionary) {
        auto n_src_dictionary = src_dictionary.get_dictionary(key);
        auto n_dst_dictionary = dst_dictionary.get_dictionary(key);
        handle_dictionary_in_mixed(*n_src_dictionary, *n_dst_dictionary);
    }
}

bool InterRealmValueConverter::is_collection(Mixed mixed) const
{
    REALM_ASSERT_DEBUG(!mixed.is_type(type_Set));
    return mixed.is_type(type_List, type_Dictionary);
}

CollectionType InterRealmValueConverter::to_collection_type(Mixed mixed) const
{
    const auto mixed_type = mixed.get_type();
    if (mixed_type == type_List)
        return CollectionType::List;
    else if (mixed_type == type_Dictionary)
        return CollectionType::Dictionary;
    REALM_UNREACHABLE();
}

// If an embedded object is encountered, add it to a list of embedded objects to process.
// This relies on the property that embedded objects only have one incoming link
// otherwise there could be an infinite loop while discovering embedded objects.
void EmbeddedObjectConverter::track(const Obj& e_src, const Obj& e_dst)
{
    embedded_pending.push_back({e_src, e_dst});
}

void EmbeddedObjectConverter::process_pending()
{
    util::FlatMap<TableKey, InterRealmObjectConverter> converters;

    while (!embedded_pending.empty()) {
        EmbeddedToCheck pending = embedded_pending.back();
        embedded_pending.pop_back();

        TableRef dst_table = pending.embedded_in_dst.get_table();
        TableKey dst_table_key = dst_table->get_key();
        auto it = converters.find(dst_table_key);
        if (it == converters.end()) {
            TableRef src_table = pending.embedded_in_src.get_table();
            it = converters.insert({dst_table_key, InterRealmObjectConverter{src_table, dst_table, this}}).first;
        }
        InterRealmObjectConverter& converter = it->second;
        converter.copy(pending.embedded_in_src, pending.embedded_in_dst, nullptr);
    }
}

InterRealmValueConverter::InterRealmValueConverter(ConstTableRef src_table, ColKey src_col, ConstTableRef dst_table,
                                                   ColKey dst_col, EmbeddedObjectConverter* ec)
    : m_src_table(src_table)
    , m_dst_table(dst_table)
    , m_src_col(src_col)
    , m_dst_col(dst_col)
    , m_embedded_converter(ec)
    , m_is_embedded_link(false)
    , m_primitive_types_only(!(src_col.get_type() == col_type_TypedLink || src_col.get_type() == col_type_Link ||
                               src_col.get_type() == col_type_Mixed))
{
    if (!m_primitive_types_only) {
        REALM_ASSERT(src_table);
        m_opposite_of_src = src_table->get_opposite_table(src_col);
        m_opposite_of_dst = dst_table->get_opposite_table(dst_col);
        REALM_ASSERT(bool(m_opposite_of_src) == bool(m_opposite_of_dst));
        if (m_opposite_of_src) {
            m_is_embedded_link = m_opposite_of_src->is_embedded();
        }
    }
}

void InterRealmValueConverter::track_new_embedded(const Obj& src, const Obj& dst) const
{
    m_embedded_converter->track(src, dst);
}

// convert `src` to the destination Realm and compare that value with `dst`
// If `converted_src_out` is provided, it will be set to the converted src value
int InterRealmValueConverter::cmp_src_to_dst(Mixed src, Mixed dst, ConversionResult* converted_src_out,
                                             bool* did_update_out) const
{
    int cmp = 0;
    Mixed converted_src;
    if (m_primitive_types_only || !src.is_type(type_Link, type_TypedLink)) {
        converted_src = src;
        cmp = src.compare(dst);
    }
    else if (m_opposite_of_src) {
        ObjKey src_link_key = src.get<ObjKey>();
        if (m_is_embedded_link) {
            Obj src_embedded = m_opposite_of_src->get_object(src_link_key);
            REALM_ASSERT_DEBUG(src_embedded.is_valid());
            if (dst.is_type(type_Link, type_TypedLink)) {
                cmp = 0; // no need to set this link, there is already an embedded object here
                Obj dst_embedded = m_opposite_of_dst->get_object(dst.get<ObjKey>());
                REALM_ASSERT_DEBUG(dst_embedded.is_valid());
                converted_src = dst_embedded.get_key();
                track_new_embedded(src_embedded, dst_embedded);
            }
            else {
                cmp = src.compare(dst);
                if (converted_src_out) {
                    converted_src_out->requires_new_embedded_object = true;
                    converted_src_out->src_embedded_to_check = src_embedded;
                }
            }
        }
        else {
            Obj dst_link;
            if (m_opposite_of_dst == m_opposite_of_src) {
                // if this is the same Realm, we can use the ObjKey
                dst_link = m_opposite_of_dst->get_object(src_link_key);
            }
            else {
                // in different Realms we create a new object
                if (m_opposite_of_src->get_primary_key_column()) {
                    Mixed src_link_pk = m_opposite_of_src->get_primary_key(src_link_key);
                    dst_link =
                        m_opposite_of_dst->get_object_with_primary_key(src_link_pk); // returns ObjKey{} if not found
                }
                else {
                    dst_link = m_opposite_of_dst->create_object();
                }
            }
            converted_src = dst_link.get_key();
            if (dst.is_type(type_TypedLink)) {
                cmp = converted_src.compare(dst.get<ObjKey>());
            }
            else {
                cmp = converted_src.compare(dst);
            }
        }
    }
    else {
        ObjLink src_link = src.get<ObjLink>();
        if (src_link.is_unresolved()) {
            converted_src = Mixed{}; // no need to transfer over unresolved links
            cmp = converted_src.compare(dst);
        }
        else {
            TableRef src_link_table = m_src_table->get_parent_group()->get_table(src_link.get_table_key());
            REALM_ASSERT_EX(src_link_table, src_link.get_table_key());
            TableRef dst_link_table = m_dst_table->get_parent_group()->get_table(src_link_table->get_name());
            REALM_ASSERT_EX(dst_link_table, src_link_table->get_name());
            // embedded tables should always be covered by the m_opposite_of_src case above.
            REALM_ASSERT_EX(!src_link_table->is_embedded(), src_link_table->get_name());
            // regular table, convert by pk
            if (src_link_table->get_primary_key_column()) {
                Mixed src_pk = src_link_table->get_primary_key(src_link.get_obj_key());
                if (Obj dst_link = dst_link_table->get_object_with_primary_key(src_pk)) {
                    converted_src = ObjLink{dst_link_table->get_key(), dst_link.get_key()};
                }
            }
            else if (src_link_table == dst_link_table) {
                // no pk, but this is the same Realm, so convert by ObjKey
                Obj dst_link = dst_link_table->get_object(src_link.get_obj_key());
                converted_src = ObjLink{dst_link_table->get_key(), dst_link.get_key()};
            }
            else {
                // no pk, and different Realm, create an object
                Obj dst_link = dst_link_table->create_object();
                converted_src = ObjLink{dst_link_table->get_key(), dst_link.get_key()};
            }
            cmp = converted_src.compare(dst);
        }
    }
    if (converted_src_out) {
        converted_src_out->converted_value = converted_src;
    }
    if (did_update_out && cmp) {
        *did_update_out = true;
    }
    return cmp;
}

InterRealmObjectConverter::InterRealmObjectConverter(ConstTableRef table_src, TableRef table_dst,
                                                     EmbeddedObjectConverter* embedded_tracker)
    : m_embedded_tracker(embedded_tracker)
{
    m_columns_cache.reserve(table_src->get_column_count());
    ColKey pk_col = table_src->get_primary_key_column();
    for (ColKey col_key_src : table_src->get_column_keys()) {
        if (col_key_src == pk_col)
            continue;
        StringData col_name = table_src->get_column_name(col_key_src);
        ColKey col_key_dst = table_dst->get_column_key(col_name);
        REALM_ASSERT(col_key_dst);
        m_columns_cache.emplace_back(table_src, col_key_src, table_dst, col_key_dst, m_embedded_tracker);
    }
}

void InterRealmObjectConverter::copy(const Obj& src, Obj& dst, bool* update_out)
{
    for (auto& column : m_columns_cache) {
        column.copy_value(src, dst, update_out);
    }
}

} // namespace realm::converters

realm / realm-core / 2306

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