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

realm / realm-core / 2042

14 Feb 2024 09:23PM UTC coverage: 91.852% (-0.01%) from 91.863%
2042

push

Evergreen

web-flow
Schema migration tests to use admin API rather than querying backing cluster (#7345)

93058 of 171514 branches covered (54.26%)

31 of 31 new or added lines in 2 files covered. (100.0%)

82 existing lines in 17 files now uncovered.

235413 of 256295 relevant lines covered (91.85%)

6119133.78 hits per line

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

88.0
/src/realm/array_string.cpp
1
/*************************************************************************
2
 *
3
 * Copyright 2016 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/array_string.hpp>
20
#include <realm/spec.hpp>
21
#include <realm/mixed.hpp>
22

23
using namespace realm;
24

25
ArrayString::ArrayString(Allocator& a)
26
    : m_alloc(a)
27
{
16,182,792✔
28
    m_arr = new (&m_storage) ArrayStringShort(a, true);
16,182,792✔
29
}
16,182,792✔
30

31
void ArrayString::create()
32
{
166,611✔
33
    static_cast<ArrayStringShort*>(m_arr)->create();
166,611✔
34
}
166,611✔
35

36
void ArrayString::init_from_mem(MemRef mem) noexcept
37
{
15,094,086✔
38
    char* header = mem.get_addr();
15,094,086✔
39

7,514,370✔
40
    ArrayParent* parent = m_arr->get_parent();
15,094,086✔
41
    size_t ndx_in_parent = m_arr->get_ndx_in_parent();
15,094,086✔
42

7,514,370✔
43
    bool long_strings = Array::get_hasrefs_from_header(header);
15,094,086✔
44
    if (!long_strings) {
15,094,086✔
45
        // Small strings
5,165,058✔
46
        bool is_small = Array::get_wtype_from_header(header) == Array::wtype_Multiply;
10,401,921✔
47
        if (is_small) {
10,401,921✔
48
            auto arr = new (&m_storage) ArrayStringShort(m_alloc, m_nullable);
4,729,989✔
49
            arr->init_from_mem(mem);
4,729,989✔
50
            m_type = Type::small_strings;
4,729,989✔
51
        }
4,729,989✔
52
        else {
5,671,932✔
53
            auto arr = new (&m_storage) Array(m_alloc);
5,671,932✔
54
            arr->init_from_mem(mem);
5,671,932✔
55
            m_string_enum_values = std::make_unique<ArrayString>(m_alloc);
5,671,932✔
56
            ArrayParent* p;
5,671,932✔
57
            REALM_ASSERT(m_spec != nullptr);
5,671,932✔
58
            REALM_ASSERT(m_col_ndx != realm::npos);
5,671,932✔
59
            ref_type r = m_spec->get_enumkeys_ref(m_col_ndx, p);
5,671,932✔
60
            m_string_enum_values->init_from_ref(r);
5,671,932✔
61
            m_string_enum_values->set_parent(p, m_col_ndx);
5,671,932✔
62
            m_type = Type::enum_strings;
5,671,932✔
63
        }
5,671,932✔
64
    }
10,401,921✔
65
    else {
4,692,165✔
66
        bool is_big = Array::get_context_flag_from_header(header);
4,692,165✔
67
        if (!is_big) {
4,692,165✔
68
            auto arr = new (&m_storage) ArraySmallBlobs(m_alloc);
1,208,433✔
69
            arr->init_from_mem(mem);
1,208,433✔
70
            m_type = Type::medium_strings;
1,208,433✔
71
        }
1,208,433✔
72
        else {
3,483,732✔
73
            auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, m_nullable);
3,483,732✔
74
            arr->init_from_mem(mem);
3,483,732✔
75
            m_type = Type::big_strings;
3,483,732✔
76
        }
3,483,732✔
77
    }
4,692,165✔
78
    m_arr->set_parent(parent, ndx_in_parent);
15,094,086✔
79
}
15,094,086✔
80

81
void ArrayString::init_from_parent()
82
{
5,071,218✔
83
    ref_type ref = m_arr->get_ref_from_parent();
5,071,218✔
84
    init_from_ref(ref);
5,071,218✔
85
}
5,071,218✔
86

87
void ArrayString::destroy() noexcept
88
{
366✔
89
    if (m_arr->is_attached()) {
366✔
90
        Array::destroy_deep(m_arr->get_ref(), m_alloc);
360✔
91
        detach();
360✔
92
    }
360✔
93
}
366✔
94

95
void ArrayString::detach() noexcept
96
{
291,987✔
97
    m_arr->detach();
291,987✔
98
    // Make sure the object is in a state like right after construction
145,587✔
99
    // Next call must be to create()
145,587✔
100
    m_arr = new (&m_storage) ArrayStringShort(m_alloc, true);
291,987✔
101
    m_type = Type::small_strings;
291,987✔
102
}
291,987✔
103

104
size_t ArrayString::size() const
105
{
12,941,355✔
106
    switch (m_type) {
12,941,355✔
107
        case Type::small_strings:
3,912,024✔
108
            return static_cast<ArrayStringShort*>(m_arr)->size();
3,912,024✔
109
        case Type::medium_strings:
432,684✔
110
            return static_cast<ArraySmallBlobs*>(m_arr)->size();
432,684✔
111
        case Type::big_strings:
8,608,353✔
112
            return static_cast<ArrayBigBlobs*>(m_arr)->size();
8,608,353✔
113
        case Type::enum_strings:
282✔
114
            return static_cast<Array*>(m_arr)->size();
282✔
115
    }
×
116
    return {};
×
117
}
×
118

119
void ArrayString::add(StringData value)
120
{
132,861✔
121
    switch (upgrade_leaf(value.size())) {
132,861✔
122
        case Type::small_strings:
77,349✔
123
            static_cast<ArrayStringShort*>(m_arr)->add(value);
77,349✔
124
            break;
77,349✔
125
        case Type::medium_strings:
27,810✔
126
            static_cast<ArraySmallBlobs*>(m_arr)->add_string(value);
27,810✔
127
            break;
27,810✔
128
        case Type::big_strings:
27,702✔
129
            static_cast<ArrayBigBlobs*>(m_arr)->add_string(value);
27,702✔
130
            break;
27,702✔
131
        case Type::enum_strings: {
✔
132
            auto a = static_cast<Array*>(m_arr);
×
133
            size_t ndx = a->size();
×
134
            a->add(0);
×
135
            set(ndx, value);
×
136
            break;
×
137
        }
×
138
    }
132,861✔
139
}
132,861✔
140

141
void ArrayString::set(size_t ndx, StringData value)
142
{
3,733,704✔
143
    switch (upgrade_leaf(value.size())) {
3,733,704✔
144
        case Type::small_strings:
497,940✔
145
            static_cast<ArrayStringShort*>(m_arr)->set(ndx, value);
497,940✔
146
            break;
497,940✔
147
        case Type::medium_strings:
234,360✔
148
            static_cast<ArraySmallBlobs*>(m_arr)->set_string(ndx, value);
234,360✔
149
            break;
234,360✔
150
        case Type::big_strings:
377,373✔
151
            static_cast<ArrayBigBlobs*>(m_arr)->set_string(ndx, value);
377,373✔
152
            break;
377,373✔
153
        case Type::enum_strings: {
2,625,384✔
154
            size_t sz = m_string_enum_values->size();
2,625,384✔
155
            size_t res = m_string_enum_values->find_first(value, 0, sz);
2,625,384✔
156
            if (res == realm::not_found) {
2,625,384✔
157
                m_string_enum_values->add(value);
9,636✔
158
                res = sz;
9,636✔
159
            }
9,636✔
160
            static_cast<Array*>(m_arr)->set(ndx, res);
2,625,384✔
161
            break;
2,625,384✔
162
        }
×
163
    }
3,733,704✔
164
}
3,733,704✔
165

166
void ArrayString::insert(size_t ndx, StringData value)
167
{
3,255,696✔
168
    switch (upgrade_leaf(value.size())) {
3,255,696✔
169
        case Type::small_strings:
850,764✔
170
            static_cast<ArrayStringShort*>(m_arr)->insert(ndx, value);
850,764✔
171
            break;
850,764✔
172
        case Type::medium_strings:
287,016✔
173
            static_cast<ArraySmallBlobs*>(m_arr)->insert_string(ndx, value);
287,016✔
174
            break;
287,016✔
175
        case Type::big_strings:
806,310✔
176
            static_cast<ArrayBigBlobs*>(m_arr)->insert_string(ndx, value);
806,310✔
177
            break;
806,310✔
178
        case Type::enum_strings: {
1,312,737✔
179
            static_cast<Array*>(m_arr)->insert(ndx, 0);
1,312,737✔
180
            set(ndx, value);
1,312,737✔
181
        }
1,312,737✔
182
    }
3,255,696✔
183
}
3,255,696✔
184

185
StringData ArrayString::get(size_t ndx) const
186
{
22,640,997✔
187
    switch (m_type) {
22,640,997✔
188
        case Type::small_strings:
9,186,228✔
189
            return static_cast<ArrayStringShort*>(m_arr)->get(ndx);
9,186,228✔
190
        case Type::medium_strings:
1,385,418✔
191
            return static_cast<ArraySmallBlobs*>(m_arr)->get_string(ndx);
1,385,418✔
192
        case Type::big_strings:
9,045,321✔
193
            return static_cast<ArrayBigBlobs*>(m_arr)->get_string(ndx);
9,045,321✔
194
        case Type::enum_strings: {
3,081,876✔
195
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
3,081,876✔
196
            return m_string_enum_values->get(index);
3,081,876✔
197
        }
×
198
    }
×
199
    return {};
×
200
}
×
201

202
StringData ArrayString::get_legacy(size_t ndx) const
203
{
6,648✔
204
    switch (m_type) {
6,648✔
205
        case Type::small_strings:
402✔
206
            return static_cast<ArrayStringShort*>(m_arr)->get(ndx);
402✔
207
        case Type::medium_strings:
3,060✔
208
            return static_cast<ArraySmallBlobs*>(m_arr)->get_string_legacy(ndx);
3,060✔
209
        case Type::big_strings:
3,078✔
210
            return static_cast<ArrayBigBlobs*>(m_arr)->get_string(ndx);
3,078✔
211
        case Type::enum_strings: {
108✔
212
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
108✔
213
            return m_string_enum_values->get(index);
108✔
214
        }
×
215
    }
×
216
    return {};
×
217
}
×
218

219
Mixed ArrayString::get_any(size_t ndx) const
220
{
22,464✔
221
    return Mixed(get(ndx));
22,464✔
222
}
22,464✔
223

224
bool ArrayString::is_null(size_t ndx) const
225
{
3,982,701✔
226
    switch (m_type) {
3,982,701✔
227
        case Type::small_strings:
739,179✔
228
            return static_cast<ArrayStringShort*>(m_arr)->is_null(ndx);
739,179✔
229
        case Type::medium_strings:
13,950✔
230
            return static_cast<ArraySmallBlobs*>(m_arr)->is_null(ndx);
13,950✔
231
        case Type::big_strings:
3,231,231✔
232
            return static_cast<ArrayBigBlobs*>(m_arr)->is_null(ndx);
3,231,231✔
233
        case Type::enum_strings: {
✔
234
            size_t index = size_t(static_cast<Array*>(m_arr)->get(ndx));
×
235
            return m_string_enum_values->is_null(index);
×
236
        }
×
237
    }
×
238
    return {};
×
239
}
×
240

241
void ArrayString::erase(size_t ndx)
242
{
129,189✔
243
    switch (m_type) {
129,189✔
244
        case Type::small_strings:
36,492✔
245
            static_cast<ArrayStringShort*>(m_arr)->erase(ndx);
36,492✔
246
            break;
36,492✔
247
        case Type::medium_strings:
58,494✔
248
            static_cast<ArraySmallBlobs*>(m_arr)->erase(ndx);
58,494✔
249
            break;
58,494✔
250
        case Type::big_strings:
25,881✔
251
            static_cast<ArrayBigBlobs*>(m_arr)->erase(ndx);
25,881✔
252
            break;
25,881✔
253
        case Type::enum_strings:
8,340✔
254
            static_cast<Array*>(m_arr)->erase(ndx);
8,340✔
255
            break;
8,340✔
256
    }
129,189✔
257
}
129,189✔
258

259
void ArrayString::move(ArrayString& dst, size_t ndx)
260
{
66✔
261
    size_t sz = size();
66✔
262
    for (size_t i = ndx; i < sz; i++) {
20,730✔
263
        dst.add(get(i));
20,664✔
264
    }
20,664✔
265

33✔
266
    switch (m_type) {
66✔
267
        case Type::small_strings:
✔
268
            static_cast<ArrayStringShort*>(m_arr)->truncate(ndx);
×
269
            break;
×
270
        case Type::medium_strings:
60✔
271
            static_cast<ArraySmallBlobs*>(m_arr)->truncate(ndx);
60✔
272
            break;
60✔
273
        case Type::big_strings:
6✔
274
            static_cast<ArrayBigBlobs*>(m_arr)->truncate(ndx);
6✔
275
            break;
6✔
276
        case Type::enum_strings:
✔
277
            // this operation will never be called for enumerated columns
278
            REALM_UNREACHABLE();
279
            break;
×
280
    }
66✔
281
}
66✔
282

283
void ArrayString::clear()
284
{
342✔
285
    switch (m_type) {
342✔
286
        case Type::small_strings:
288✔
287
            static_cast<ArrayStringShort*>(m_arr)->clear();
288✔
288
            break;
288✔
289
        case Type::medium_strings:
6✔
290
            static_cast<ArraySmallBlobs*>(m_arr)->clear();
6✔
291
            break;
6✔
292
        case Type::big_strings:
48✔
293
            static_cast<ArrayBigBlobs*>(m_arr)->clear();
48✔
294
            break;
48✔
295
        case Type::enum_strings:
✔
296
            static_cast<Array*>(m_arr)->clear();
×
297
            break;
×
298
    }
342✔
299
}
342✔
300

301
size_t ArrayString::find_first(StringData value, size_t begin, size_t end) const noexcept
302
{
4,057,629✔
303
    switch (m_type) {
4,057,629✔
304
        case Type::small_strings:
3,099,603✔
305
            return static_cast<ArrayStringShort*>(m_arr)->find_first(value, begin, end);
3,099,603✔
306
        case Type::medium_strings: {
105,288✔
307
            BinaryData as_binary(value.data(), value.size());
105,288✔
308
            return static_cast<ArraySmallBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
105,288✔
309
            break;
×
310
        }
×
311
        case Type::big_strings: {
256,677✔
312
            BinaryData as_binary(value.data(), value.size());
256,677✔
313
            return static_cast<ArrayBigBlobs*>(m_arr)->find_first(as_binary, true, begin, end);
256,677✔
314
            break;
×
315
        }
×
316
        case Type::enum_strings: {
596,490✔
317
            size_t sz = m_string_enum_values->size();
596,490✔
318
            size_t res = m_string_enum_values->find_first(value, 0, sz);
596,490✔
319
            if (res != realm::not_found) {
596,490✔
320
                return static_cast<Array*>(m_arr)->find_first(res, begin, end);
596,490✔
321
            }
596,490✔
UNCOV
322
            break;
×
UNCOV
323
        }
×
324
    }
×
325
    return not_found;
×
326
}
×
327

328
namespace {
329

330
template <class T>
331
inline StringData get_string(const T* arr, size_t ndx)
332
{
437,337✔
333
    return arr->get_string(ndx);
437,337✔
334
}
437,337✔
335

336
template <>
337
inline StringData get_string(const ArrayStringShort* arr, size_t ndx)
338
{
93,648✔
339
    return arr->get(ndx);
93,648✔
340
}
93,648✔
341

342
template <class T, class U>
343
size_t lower_bound_string(const T* arr, U value)
344
{
234,912✔
345
    size_t i = 0;
234,912✔
346
    size_t sz = arr->size();
234,912✔
347
    while (0 < sz) {
765,897✔
348
        size_t half = sz / 2;
530,985✔
349
        size_t mid = i + half;
530,985✔
350
        auto probe = get_string(arr, mid);
530,985✔
351
        if (probe < value) {
530,985✔
352
            i = mid + 1;
190,662✔
353
            sz -= half + 1;
190,662✔
354
        }
190,662✔
355
        else {
340,323✔
356
            sz = half;
340,323✔
357
        }
340,323✔
358
    }
530,985✔
359
    return i;
234,912✔
360
}
234,912✔
361
}
362

363
size_t ArrayString::lower_bound(StringData value)
364
{
234,912✔
365
    switch (m_type) {
234,912✔
366
        case Type::small_strings:
58,434✔
367
            return lower_bound_string(static_cast<ArrayStringShort*>(m_arr), value);
58,434✔
368
        case Type::medium_strings:
68,418✔
369
            return lower_bound_string(static_cast<ArraySmallBlobs*>(m_arr), value);
68,418✔
370
        case Type::big_strings:
108,060✔
371
            return lower_bound_string(static_cast<ArrayBigBlobs*>(m_arr), value);
108,060✔
372
        case Type::enum_strings:
✔
373
            break;
×
374
    }
×
375
    return realm::npos;
×
376
}
×
377

378
ArrayString::Type ArrayString::upgrade_leaf(size_t value_size)
379
{
7,118,724✔
380
    if (m_type == Type::big_strings)
7,118,724✔
381
        return Type::big_strings;
1,191,132✔
382

2,898,882✔
383
    if (m_type == Type::enum_strings)
5,927,592✔
384
        return Type::enum_strings;
3,937,812✔
385

930,273✔
386
    if (m_type == Type::medium_strings) {
1,989,780✔
387
        if (value_size <= medium_string_max_size)
532,536✔
388
            return Type::medium_strings;
531,981✔
389

282✔
390
        // Upgrade root leaf from medium to big strings
282✔
391
        auto string_medium = static_cast<ArraySmallBlobs*>(m_arr);
555✔
392
        ArrayBigBlobs big_blobs(m_alloc, true);
555✔
393
        big_blobs.create(); // Throws
555✔
394

282✔
395
        size_t n = string_medium->size();
555✔
396
        for (size_t i = 0; i < n; i++) {
11,115✔
397
            big_blobs.add_string(string_medium->get_string(i)); // Throws
10,560✔
398
        }
10,560✔
399
        auto parent = string_medium->get_parent();
555✔
400
        auto ndx_in_parent = string_medium->get_ndx_in_parent();
555✔
401
        string_medium->destroy();
555✔
402

282✔
403
        auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, true);
555✔
404
        arr->init_from_mem(big_blobs.get_mem());
555✔
405
        arr->set_parent(parent, ndx_in_parent);
555✔
406
        arr->update_parent();
555✔
407

282✔
408
        m_type = Type::big_strings;
555✔
409
        return Type::big_strings;
555✔
410
    }
555✔
411

663,324✔
412
    // m_type == Type::small
663,324✔
413
    if (value_size <= small_string_max_size)
1,457,244✔
414
        return Type::small_strings;
1,425,813✔
415

13,878✔
416
    if (value_size <= medium_string_max_size) {
31,431✔
417
        // Upgrade root leaf from small to medium strings
8,463✔
418
        auto string_short = static_cast<ArrayStringShort*>(m_arr);
17,205✔
419
        ArraySmallBlobs string_long(m_alloc);
17,205✔
420
        string_long.create(); // Throws
17,205✔
421

8,463✔
422
        size_t n = string_short->size();
17,205✔
423
        for (size_t i = 0; i < n; i++) {
38,970✔
424
            string_long.add_string(string_short->get(i)); // Throws
21,765✔
425
        }
21,765✔
426
        auto parent = string_short->get_parent();
17,205✔
427
        auto ndx_in_parent = string_short->get_ndx_in_parent();
17,205✔
428
        string_short->destroy();
17,205✔
429

8,463✔
430
        auto arr = new (&m_storage) ArraySmallBlobs(m_alloc);
17,205✔
431
        arr->init_from_mem(string_long.get_mem());
17,205✔
432
        arr->set_parent(parent, ndx_in_parent);
17,205✔
433
        arr->update_parent();
17,205✔
434

8,463✔
435
        m_type = Type::medium_strings;
17,205✔
436
    }
17,205✔
437
    else {
14,226✔
438
        // Upgrade root leaf from small to big strings
5,415✔
439
        auto string_short = static_cast<ArrayStringShort*>(m_arr);
14,226✔
440
        ArrayBigBlobs big_blobs(m_alloc, true);
14,226✔
441
        big_blobs.create(); // Throws
14,226✔
442

5,415✔
443
        size_t n = string_short->size();
14,226✔
444
        for (size_t i = 0; i < n; i++) {
34,104✔
445
            big_blobs.add_string(string_short->get(i)); // Throws
19,878✔
446
        }
19,878✔
447
        auto parent = string_short->get_parent();
14,226✔
448
        auto ndx_in_parent = string_short->get_ndx_in_parent();
14,226✔
449
        string_short->destroy();
14,226✔
450

5,415✔
451
        auto arr = new (&m_storage) ArrayBigBlobs(m_alloc, true);
14,226✔
452
        arr->init_from_mem(big_blobs.get_mem());
14,226✔
453
        arr->set_parent(parent, ndx_in_parent);
14,226✔
454
        arr->update_parent();
14,226✔
455

5,415✔
456
        m_type = Type::big_strings;
14,226✔
457
    }
14,226✔
458

13,878✔
459
    return m_type;
31,431✔
460
}
31,431✔
461

462
void ArrayString::verify() const
463
{
210,411✔
464
#ifdef REALM_DEBUG
210,411✔
465
    switch (m_type) {
210,411✔
466
        case Type::small_strings:
203,904✔
467
            static_cast<ArrayStringShort*>(m_arr)->verify();
203,904✔
468
            break;
203,904✔
469
        case Type::medium_strings:
825✔
470
            static_cast<ArraySmallBlobs*>(m_arr)->verify();
825✔
471
            break;
825✔
472
        case Type::big_strings:
5,436✔
473
            static_cast<ArrayBigBlobs*>(m_arr)->verify();
5,436✔
474
            break;
5,436✔
475
        case Type::enum_strings:
246✔
476
            static_cast<Array*>(m_arr)->verify();
246✔
477
            break;
246✔
478
    }
210,411✔
479
#endif
210,411✔
480
}
210,411✔
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