• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

realm / realm-core / github_pull_request_281750

30 Oct 2023 03:37PM UTC coverage: 90.528% (-1.0%) from 91.571%
github_pull_request_281750

Pull #6073

Evergreen

jedelbo
Log free space and history sizes when opening file
Pull Request #6073: Merge next-major

95488 of 175952 branches covered (0.0%)

8973 of 12277 new or added lines in 149 files covered. (73.09%)

622 existing lines in 51 files now uncovered.

233503 of 257934 relevant lines covered (90.53%)

6533720.56 hits per line

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

94.4
/src/realm/sync/noinst/pending_bootstrap_store.cpp
1
/*************************************************************************
2
 *
3
 * Copyright 2022 Realm, Inc.
4
 *
5
 * Licensed under the Apache License, Version 2.0 (the "License");
6
 * you may not use this file except in compliance with the License.
7
 * You may obtain a copy of the License at
8
 *
9
 * http://www.apache.org/licenses/LICENSE-2.0
10
 *
11
 * Unless required by applicable law or agreed to in writing, software
12
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 * See the License for the specific language governing permissions and
15
 * limitations under the License.
16
 *
17
 **************************************************************************/
18

19
#include "realm/sync/noinst/pending_bootstrap_store.hpp"
20

21
#include "realm/binary_data.hpp"
22
#include "realm/chunked_binary.hpp"
23
#include "realm/data_type.hpp"
24
#include "realm/db.hpp"
25
#include "realm/list.hpp"
26
#include "realm/query.hpp"
27
#include "realm/sync/changeset_parser.hpp"
28
#include "realm/sync/noinst/protocol_codec.hpp"
29
#include "realm/sync/noinst/sync_metadata_schema.hpp"
30
#include "realm/sync/protocol.hpp"
31
#include "realm/sync/transform.hpp"
32
#include "realm/util/assert.hpp"
33
#include "realm/util/buffer.hpp"
34
#include "realm/util/compression.hpp"
35
#include "realm/util/logger.hpp"
36
#include <stdexcept>
37

38
namespace realm::sync {
39
namespace {
40
constexpr static int c_schema_version = 1;
41
constexpr static std::string_view c_progress_table("flx_pending_bootstrap_progress");
42
constexpr static std::string_view c_pending_bootstrap_table("flx_pending_bootstrap");
43
constexpr static std::string_view c_pending_changesets_table("flx_pending_bootstrap_changesets");
44
constexpr static std::string_view c_pending_bootstrap_query_version("query_version");
45
constexpr static std::string_view c_pending_bootstrap_changesets("changesets");
46
constexpr static std::string_view c_pending_bootstrap_progress("progress");
47
constexpr static std::string_view c_pending_changesets_remote_version("remote_version");
48
constexpr static std::string_view
49
    c_pending_changesets_last_integrated_client_version("last_integrated_client_version");
50
constexpr static std::string_view c_pending_changesets_origin_file_ident("origin_file_ident");
51
constexpr static std::string_view c_pending_changesets_origin_timestamp("origin_timestamp");
52
constexpr static std::string_view c_pending_changesets_original_size("original_size");
53
constexpr static std::string_view c_pending_changesets_data("data");
54
constexpr static std::string_view c_progress_download_server_version("download_server_version");
55
constexpr static std::string_view c_progress_download_client_version("download_client_version");
56
constexpr static std::string_view c_progress_upload_server_version("upload_server_version");
57
constexpr static std::string_view c_progress_upload_client_version("upload_client_version");
58
constexpr static std::string_view c_progress_latest_server_version("latest_server_version");
59
constexpr static std::string_view c_progress_latest_server_version_salt("latest_server_version_salt");
60

61
} // namespace
62

63
PendingBootstrapStore::PendingBootstrapStore(DBRef db, util::Logger& logger)
64
    : m_db(std::move(db))
65
    , m_logger(logger)
66
{
1,016✔
67
    std::vector<SyncMetadataTable> internal_tables{
1,016✔
68
        {&m_table,
1,016✔
69
         c_pending_bootstrap_table,
1,016✔
70
         {&m_query_version, c_pending_bootstrap_query_version, type_Int},
1,016✔
71
         {
1,016✔
72
             {&m_changesets, c_pending_bootstrap_changesets, c_pending_changesets_table, true},
1,016✔
73
             {&m_progress, c_pending_bootstrap_progress, c_progress_table, false},
1,016✔
74
         }},
1,016✔
75
        {&m_progress_table,
1,016✔
76
         c_progress_table,
1,016✔
77
         SyncMetadataTable::IsEmbeddedTag{},
1,016✔
78
         {
1,016✔
79
             {&m_progress_upload_server_version, c_progress_upload_server_version, type_Int},
1,016✔
80
             {&m_progress_upload_client_version, c_progress_upload_client_version, type_Int},
1,016✔
81
             {&m_progress_download_server_version, c_progress_download_server_version, type_Int},
1,016✔
82
             {&m_progress_download_client_version, c_progress_download_client_version, type_Int},
1,016✔
83
             {&m_progress_latest_server_version, c_progress_latest_server_version, type_Int},
1,016✔
84
             {&m_progress_latest_server_version_salt, c_progress_latest_server_version_salt, type_Int},
1,016✔
85
         }},
1,016✔
86
        {&m_changeset_table,
1,016✔
87
         c_pending_changesets_table,
1,016✔
88
         SyncMetadataTable::IsEmbeddedTag{},
1,016✔
89
         {
1,016✔
90
             {&m_changeset_remote_version, c_pending_changesets_remote_version, type_Int},
1,016✔
91
             {&m_changeset_last_integrated_client_version, c_pending_changesets_last_integrated_client_version,
1,016✔
92
              type_Int},
1,016✔
93
             {&m_changeset_origin_file_ident, c_pending_changesets_origin_file_ident, type_Int},
1,016✔
94
             {&m_changeset_origin_timestamp, c_pending_changesets_origin_timestamp, type_Int},
1,016✔
95
             {&m_changeset_original_changeset_size, c_pending_changesets_original_size, type_Int},
1,016✔
96
             {&m_changeset_data, c_pending_changesets_data, type_Binary, true},
1,016✔
97
         }}};
1,016✔
98

510✔
99
    auto tr = m_db->start_read();
1,016✔
100
    SyncMetadataSchemaVersions schema_versions(tr);
1,016✔
101
    if (auto schema_version = schema_versions.get_version_for(tr, internal_schema_groups::c_pending_bootstraps)) {
1,016✔
102
        if (*schema_version != c_schema_version) {
304✔
103
            throw RuntimeError(ErrorCodes::SchemaVersionMismatch,
×
104
                               "Invalid schema version for FLX sync pending bootstrap table group");
×
105
        }
×
106
        load_sync_metadata_schema(tr, &internal_tables);
304✔
107
    }
304✔
108
    else {
712✔
109
        tr->promote_to_write();
712✔
110
        create_sync_metadata_schema(tr, &internal_tables);
712✔
111
        schema_versions.set_version_for(tr, internal_schema_groups::c_pending_bootstraps, c_schema_version);
712✔
112
        tr->commit_and_continue_as_read();
712✔
113
    }
712✔
114

510✔
115
    if (auto bootstrap_table = tr->get_table(m_table); !bootstrap_table->is_empty()) {
1,016✔
116
        m_has_pending = true;
32✔
117
    }
32✔
118
    else {
984✔
119
        m_has_pending = false;
984✔
120
    }
984✔
121
}
1,016✔
122

123
void PendingBootstrapStore::add_batch(int64_t query_version, util::Optional<SyncProgress> progress,
124
                                      const _impl::ClientProtocol::ReceivedChangesets& changesets,
125
                                      bool* created_new_batch_out)
126
{
1,578✔
127
    std::vector<util::AppendBuffer<char>> compressed_changesets;
1,578✔
128
    compressed_changesets.reserve(changesets.size());
1,578✔
129

790✔
130
    util::compression::CompressMemoryArena arena;
1,578✔
131
    for (auto& changeset : changesets) {
1,594✔
132
        compressed_changesets.emplace_back();
1,594✔
133
        util::compression::allocate_and_compress_nonportable(arena, {changeset.data.get_first_chunk()},
1,594✔
134
                                                             compressed_changesets.back());
1,594✔
135
    }
1,594✔
136

790✔
137
    auto tr = m_db->start_write();
1,578✔
138
    auto bootstrap_table = tr->get_table(m_table);
1,578✔
139
    auto incomplete_bootstraps = Query(bootstrap_table).not_equal(m_query_version, query_version).find_all();
1,578✔
140
    incomplete_bootstraps.for_each([&](Obj obj) {
790✔
NEW
141
        m_logger.debug(util::LogCategory::changeset, "Clearing incomplete bootstrap for query version %1",
×
NEW
142
                       obj.get<int64_t>(m_query_version));
×
143
        return IteratorControl::AdvanceToNext;
×
144
    });
×
145
    incomplete_bootstraps.clear();
1,578✔
146

790✔
147
    bool did_create = false;
1,578✔
148
    auto bootstrap_obj = bootstrap_table->create_object_with_primary_key(Mixed{query_version}, &did_create);
1,578✔
149
    if (progress) {
1,578✔
150
        auto progress_obj = bootstrap_obj.create_and_set_linked_object(m_progress);
1,414✔
151
        progress_obj.set(m_progress_latest_server_version, int64_t(progress->latest_server_version.version));
1,414✔
152
        progress_obj.set(m_progress_latest_server_version_salt, int64_t(progress->latest_server_version.salt));
1,414✔
153
        progress_obj.set(m_progress_download_server_version, int64_t(progress->download.server_version));
1,414✔
154
        progress_obj.set(m_progress_download_client_version,
1,414✔
155
                         int64_t(progress->download.last_integrated_client_version));
1,414✔
156
        progress_obj.set(m_progress_upload_server_version, int64_t(progress->upload.last_integrated_server_version));
1,414✔
157
        progress_obj.set(m_progress_upload_client_version, int64_t(progress->upload.client_version));
1,414✔
158
    }
1,414✔
159

790✔
160
    auto changesets_list = bootstrap_obj.get_linklist(m_changesets);
1,578✔
161
    for (size_t idx = 0; idx < changesets.size(); ++idx) {
3,172✔
162
        auto cur_changeset = changesets_list.create_and_insert_linked_object(changesets_list.size());
1,594✔
163
        cur_changeset.set(m_changeset_remote_version, int64_t(changesets[idx].remote_version));
1,594✔
164
        cur_changeset.set(m_changeset_last_integrated_client_version,
1,594✔
165
                          int64_t(changesets[idx].last_integrated_local_version));
1,594✔
166
        cur_changeset.set(m_changeset_origin_file_ident, int64_t(changesets[idx].origin_file_ident));
1,594✔
167
        cur_changeset.set(m_changeset_origin_timestamp, int64_t(changesets[idx].origin_timestamp));
1,594✔
168
        cur_changeset.set(m_changeset_original_changeset_size, int64_t(changesets[idx].original_changeset_size));
1,594✔
169
        BinaryData compressed_data(compressed_changesets[idx].data(), compressed_changesets[idx].size());
1,594✔
170
        cur_changeset.set(m_changeset_data, compressed_data);
1,594✔
171
    }
1,594✔
172

790✔
173
    tr->commit();
1,578✔
174

790✔
175
    if (created_new_batch_out) {
1,578✔
176
        *created_new_batch_out = did_create;
1,578✔
177
    }
1,578✔
178

790✔
179
    if (did_create) {
1,578✔
180
        m_logger.debug(util::LogCategory::changeset, "Created new pending bootstrap object for query version %1",
1,422✔
181
                       query_version);
1,422✔
182
    }
1,422✔
183
    else {
156✔
184
        m_logger.debug(util::LogCategory::changeset, "Added batch to pending bootstrap object for query version %1",
156✔
185
                       query_version);
156✔
186
    }
156✔
187
    if (progress) {
1,578✔
188
        m_logger.debug(util::LogCategory::changeset, "Finalized pending bootstrap object for query version %1",
1,414✔
189
                       query_version);
1,414✔
190
    }
1,414✔
191
    m_has_pending = true;
1,578✔
192
}
1,578✔
193

194
bool PendingBootstrapStore::has_pending()
195
{
5,374✔
196
    return m_has_pending;
5,374✔
197
}
5,374✔
198

199
void PendingBootstrapStore::clear()
200
{
12✔
201
    auto tr = m_db->start_write();
12✔
202
    auto bootstrap_table = tr->get_table(m_table);
12✔
203
    bootstrap_table->clear();
12✔
204
    m_has_pending = false;
12✔
205
    tr->commit();
12✔
206
}
12✔
207

208
PendingBootstrapStore::PendingBatch PendingBootstrapStore::peek_pending(size_t limit_in_bytes)
209
{
1,574✔
210
    auto tr = m_db->start_read();
1,574✔
211
    auto bootstrap_table = tr->get_table(m_table);
1,574✔
212
    if (bootstrap_table->is_empty()) {
1,574✔
213
        return {};
4✔
214
    }
4✔
215

786✔
216
    // We should only have one pending bootstrap at a time.
786✔
217
    REALM_ASSERT(bootstrap_table->size() == 1);
1,570✔
218

786✔
219
    auto bootstrap_obj = bootstrap_table->get_object(0);
1,570✔
220
    PendingBatch ret;
1,570✔
221
    ret.query_version = bootstrap_obj.get<int64_t>(m_query_version);
1,570✔
222

786✔
223
    if (!bootstrap_obj.is_null(m_progress)) {
1,570✔
224
        auto progress_obj = bootstrap_obj.get_linked_object(m_progress);
1,558✔
225
        SyncProgress progress;
1,558✔
226
        progress.latest_server_version.version = progress_obj.get<int64_t>(m_progress_latest_server_version);
1,558✔
227
        progress.latest_server_version.salt = progress_obj.get<int64_t>(m_progress_latest_server_version_salt);
1,558✔
228
        progress.download.server_version = progress_obj.get<int64_t>(m_progress_download_server_version);
1,558✔
229
        progress.download.last_integrated_client_version =
1,558✔
230
            progress_obj.get<int64_t>(m_progress_download_client_version);
1,558✔
231
        progress.upload.last_integrated_server_version = progress_obj.get<int64_t>(m_progress_upload_server_version);
1,558✔
232
        progress.upload.client_version = progress_obj.get<int64_t>(m_progress_upload_client_version);
1,558✔
233
        ret.progress = std::move(progress);
1,558✔
234
    }
1,558✔
235

786✔
236
    auto changeset_list = bootstrap_obj.get_linklist(m_changesets);
1,570✔
237
    size_t bytes_so_far = 0;
1,570✔
238
    for (size_t idx = 0; idx < changeset_list.size() && bytes_so_far < limit_in_bytes; ++idx) {
3,196✔
239
        auto cur_changeset = changeset_list.get_object(idx);
1,626✔
240
        ret.changeset_data.push_back(util::AppendBuffer<char>());
1,626✔
241
        auto& uncompressed_buffer = ret.changeset_data.back();
1,626✔
242

814✔
243
        auto compressed_changeset_data = cur_changeset.get<BinaryData>(m_changeset_data);
1,626✔
244
        ChunkedBinaryInputStream changeset_is(compressed_changeset_data);
1,626✔
245
        auto ec = util::compression::decompress_nonportable(changeset_is, uncompressed_buffer);
1,626✔
246
        if (ec == util::compression::error::decompress_unsupported) {
1,626✔
247
            REALM_TERMINATE(
×
248
                "Synchronized Realm files with unprocessed pending bootstraps cannot be copied between platforms.");
×
249
        }
×
250
        REALM_ASSERT_3(ec, ==, std::error_code{});
1,626✔
251

814✔
252
        Transformer::RemoteChangeset parsed_changeset;
1,626✔
253
        parsed_changeset.original_changeset_size =
1,626✔
254
            static_cast<size_t>(cur_changeset.get<int64_t>(m_changeset_original_changeset_size));
1,626✔
255
        parsed_changeset.origin_timestamp = cur_changeset.get<int64_t>(m_changeset_origin_timestamp);
1,626✔
256
        parsed_changeset.origin_file_ident = cur_changeset.get<int64_t>(m_changeset_origin_file_ident);
1,626✔
257
        parsed_changeset.remote_version = cur_changeset.get<int64_t>(m_changeset_remote_version);
1,626✔
258
        parsed_changeset.last_integrated_local_version =
1,626✔
259
            cur_changeset.get<int64_t>(m_changeset_last_integrated_client_version);
1,626✔
260
        parsed_changeset.data = BinaryData(uncompressed_buffer.data(), uncompressed_buffer.size());
1,626✔
261
        bytes_so_far += parsed_changeset.data.size();
1,626✔
262
        ret.changesets.push_back(std::move(parsed_changeset));
1,626✔
263
    }
1,626✔
264
    ret.remaining_changesets = changeset_list.size() - ret.changesets.size();
1,570✔
265

786✔
266
    return ret;
1,570✔
267
}
1,570✔
268

269
PendingBootstrapStore::PendingBatchStats PendingBootstrapStore::pending_stats()
270
{
1,418✔
271
    auto tr = m_db->start_read();
1,418✔
272
    auto bootstrap_table = tr->get_table(m_table);
1,418✔
273
    if (bootstrap_table->is_empty()) {
1,418✔
274
        return {};
×
275
    }
×
276

710✔
277
    REALM_ASSERT(bootstrap_table->size() == 1);
1,418✔
278

710✔
279
    auto bootstrap_obj = bootstrap_table->get_object(0);
1,418✔
280
    auto changeset_list = bootstrap_obj.get_linklist(m_changesets);
1,418✔
281

710✔
282
    PendingBatchStats stats;
1,418✔
283
    stats.query_version = bootstrap_obj.get<int64_t>(m_query_version);
1,418✔
284
    stats.pending_changesets = changeset_list.size();
1,418✔
285
    changeset_list.for_each([&](Obj& cur_changeset) {
1,586✔
286
        stats.pending_changeset_bytes +=
1,586✔
287
            static_cast<size_t>(cur_changeset.get<int64_t>(m_changeset_original_changeset_size));
1,586✔
288
        return IteratorControl::AdvanceToNext;
1,586✔
289
    });
1,586✔
290

710✔
291
    return stats;
1,418✔
292
}
1,418✔
293

294
void PendingBootstrapStore::pop_front_pending(const TransactionRef& tr, size_t count)
295
{
1,534✔
296
    REALM_ASSERT_3(tr->get_transact_stage(), ==, DB::transact_Writing);
1,534✔
297
    auto bootstrap_table = tr->get_table(m_table);
1,534✔
298
    if (bootstrap_table->is_empty()) {
1,534✔
299
        return;
×
300
    }
×
301

768✔
302
    // We should only have one pending bootstrap at a time.
768✔
303
    REALM_ASSERT(bootstrap_table->size() == 1);
1,534✔
304

768✔
305
    auto bootstrap_obj = bootstrap_table->get_object(0);
1,534✔
306
    auto changeset_list = bootstrap_obj.get_linklist(m_changesets);
1,534✔
307
    REALM_ASSERT_3(changeset_list.size(), >=, count);
1,534✔
308
    if (count == changeset_list.size()) {
1,534✔
309
        changeset_list.clear();
1,398✔
310
    }
1,398✔
311
    else {
136✔
312
        for (size_t idx = 0; idx < count; ++idx) {
280✔
313
            changeset_list.remove(0);
144✔
314
        }
144✔
315
    }
136✔
316

768✔
317
    if (changeset_list.is_empty()) {
1,534✔
318
        m_logger.debug(util::LogCategory::changeset, "Removing pending bootstrap obj for query version %1",
1,398✔
319
                       bootstrap_obj.get<int64_t>(m_query_version));
1,398✔
320
        bootstrap_obj.remove();
1,398✔
321
    }
1,398✔
322
    else {
136✔
323
        m_logger.debug(util::LogCategory::changeset,
136✔
324
                       "Removing pending bootstrap batch for query version %1. %2 changeset remaining",
136✔
325
                       bootstrap_obj.get<int64_t>(m_query_version), changeset_list.size());
136✔
326
    }
136✔
327

768✔
328
    m_has_pending = (bootstrap_table->is_empty() == false);
1,534✔
329
}
1,534✔
330

331
} // namespace realm::sync
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc