Coverage Report

Created: 2026-05-13 10:19

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/util/jsonb_utils.h
Line
Count
Source
1
/*
2
 *  Copyright (c) 2014, Facebook, Inc.
3
 *  All rights reserved.
4
 *
5
 *  This source code is licensed under the BSD-style license found in the
6
 *  LICENSE file in the root directory of this source tree. An additional grant
7
 *  of patent rights can be found in the PATENTS file in the same directory.
8
 *
9
 */
10
11
/*
12
 * This header file defines miscellaneous utility classes.
13
 *
14
 * @author Tian Xia <tianx@fb.com>
15
 *
16
 *  this file is copied from 
17
 * https://github.com/facebook/mysql-5.6/blob/fb-mysql-5.6.35/fbson/FbsonUtil.h
18
 * and modified by Doris
19
 */
20
21
#ifndef JSONB_JSONBUTIL_H
22
#define JSONB_JSONBUTIL_H
23
24
#include "common/status.h"
25
#include "util/jsonb_document.h"
26
#include "util/jsonb_stream.h"
27
28
namespace doris {
29
30
1.89k
#define OUT_BUF_SIZE 1024
31
32
/*
33
 * JsonbToJson converts an JsonbValue object to a JSON string.
34
 */
35
class JsonbToJson {
36
public:
37
1.89k
    JsonbToJson() : os_(buffer_, OUT_BUF_SIZE) {}
38
39
    // get json string
40
1.86k
    std::string to_json_string(const char* data, size_t size) {
41
1.86k
        const JsonbDocument* pdoc;
42
1.86k
        THROW_IF_ERROR(doris::JsonbDocument::checkAndCreateDocument(data, size, &pdoc));
43
1.86k
        return to_json_string(pdoc->getValue());
44
1.86k
    }
45
46
1.89k
    std::string to_json_string(const JsonbValue* val) {
47
1.89k
        os_.clear();
48
1.89k
        os_.seekp(0);
49
50
1.89k
        if (val) {
51
1.89k
            intern_json(val);
52
1.89k
        }
53
54
1.89k
        os_.put(0);
55
56
1.89k
        std::string json_string {os_.getBuffer()};
57
1.89k
        return json_string;
58
1.89k
    }
59
60
1.86k
    static std::string jsonb_to_json_string(const char* data, size_t size) {
61
1.86k
        JsonbToJson jsonb_to_json;
62
1.86k
        return jsonb_to_json.to_json_string(data, size);
63
1.86k
    }
64
65
private:
66
    // recursively convert JsonbValue
67
10.2k
    void intern_json(const JsonbValue* val) {
68
10.2k
        switch (val->type) {
69
97
        case JsonbType::T_Null: {
70
97
            os_.write("null", 4);
71
97
            break;
72
0
        }
73
52
        case JsonbType::T_True: {
74
52
            os_.write("true", 4);
75
52
            break;
76
0
        }
77
20
        case JsonbType::T_False: {
78
20
            os_.write("false", 5);
79
20
            break;
80
0
        }
81
1.87k
        case JsonbType::T_Int8: {
82
1.87k
            os_.write(val->unpack<JsonbInt8Val>()->val());
83
1.87k
            break;
84
0
        }
85
130
        case JsonbType::T_Int16: {
86
130
            os_.write(val->unpack<JsonbInt16Val>()->val());
87
130
            break;
88
0
        }
89
205
        case JsonbType::T_Int32: {
90
205
            os_.write(val->unpack<JsonbInt32Val>()->val());
91
205
            break;
92
0
        }
93
21
        case JsonbType::T_Int64: {
94
21
            os_.write(val->unpack<JsonbInt64Val>()->val());
95
21
            break;
96
0
        }
97
46
        case JsonbType::T_Double: {
98
46
            os_.write(val->unpack<JsonbDoubleVal>()->val());
99
46
            break;
100
0
        }
101
2
        case JsonbType::T_Float: {
102
2
            os_.write(val->unpack<JsonbFloatVal>()->val());
103
2
            break;
104
0
        }
105
3
        case JsonbType::T_Int128: {
106
3
            os_.write(val->unpack<JsonbInt128Val>()->val());
107
3
            break;
108
0
        }
109
3.86k
        case JsonbType::T_String: {
110
3.86k
            string_to_json(val->unpack<JsonbStringVal>()->getBlob(),
111
3.86k
                           val->unpack<JsonbStringVal>()->length());
112
3.86k
            break;
113
0
        }
114
0
        case JsonbType::T_Binary: {
115
0
            os_.write("\"<BINARY>", 9);
116
0
            os_.write(val->unpack<JsonbBinaryVal>()->getBlob(),
117
0
                      val->unpack<JsonbBinaryVal>()->getBlobLen());
118
0
            os_.write("<BINARY>\"", 9);
119
0
            break;
120
0
        }
121
2.87k
        case JsonbType::T_Object: {
122
2.87k
            object_to_json(val->unpack<ObjectVal>());
123
2.87k
            break;
124
0
        }
125
1.04k
        case JsonbType::T_Array: {
126
1.04k
            array_to_json(val->unpack<ArrayVal>());
127
1.04k
            break;
128
0
        }
129
1
        case JsonbType::T_Decimal32: {
130
1
            const auto* decimal_val = val->unpack<JsonbDecimal32>();
131
1
            decimal_to_json(Decimal32 {decimal_val->val()}, decimal_val->precision,
132
1
                            decimal_val->scale);
133
1
            break;
134
0
        }
135
1
        case JsonbType::T_Decimal64: {
136
1
            const auto* decimal_val = val->unpack<JsonbDecimal64>();
137
1
            decimal_to_json(Decimal64 {decimal_val->val()}, decimal_val->precision,
138
1
                            decimal_val->scale);
139
1
            break;
140
0
        }
141
2
        case JsonbType::T_Decimal128: {
142
2
            const auto* decimal_val = val->unpack<JsonbDecimal128>();
143
2
            decimal_to_json(Decimal128V3 {decimal_val->val()}, decimal_val->precision,
144
2
                            decimal_val->scale);
145
2
            break;
146
0
        }
147
1
        case JsonbType::T_Decimal256: {
148
1
            const auto* decimal_val = val->unpack<JsonbDecimal256>();
149
1
            decimal_to_json(Decimal256 {decimal_val->val()}, decimal_val->precision,
150
1
                            decimal_val->scale);
151
1
            break;
152
0
        }
153
0
        default:
154
0
            break;
155
10.2k
        }
156
10.2k
    }
157
158
9.63k
    void string_to_json(const char* str, size_t len) {
159
9.63k
        os_.put('"');
160
9.63k
        if (nullptr == str) {
161
1
            os_.put('"');
162
1
            return;
163
1
        }
164
9.63k
        char char_buffer[16];
165
1.05M
        for (const char* ptr = str; ptr != str + len && *ptr; ++ptr) {
166
1.04M
            if ((unsigned char)*ptr > 31 && *ptr != '\"' && *ptr != '\\') {
167
1.04M
                os_.put(*ptr);
168
1.04M
            } else {
169
98
                os_.put('\\');
170
98
                unsigned char token;
171
98
                switch (token = *ptr) {
172
0
                case '\\':
173
0
                    os_.put('\\');
174
0
                    break;
175
93
                case '\"':
176
93
                    os_.put('\"');
177
93
                    break;
178
1
                case '\b':
179
1
                    os_.put('b');
180
1
                    break;
181
1
                case '\f':
182
1
                    os_.put('f');
183
1
                    break;
184
1
                case '\n':
185
1
                    os_.put('n');
186
1
                    break;
187
1
                case '\r':
188
1
                    os_.put('r');
189
1
                    break;
190
1
                case '\t':
191
1
                    os_.put('t');
192
1
                    break;
193
0
                default: {
194
0
                    int char_num = snprintf(char_buffer, sizeof(char_buffer), "u%04x", token);
195
0
                    os_.write(char_buffer, char_num);
196
0
                    break;
197
0
                }
198
98
                }
199
98
            }
200
1.04M
        }
201
9.63k
        os_.put('"');
202
9.63k
    }
203
204
    // convert object
205
2.87k
    void object_to_json(const ObjectVal* val) {
206
2.87k
        os_.put('{');
207
208
2.87k
        auto iter = val->begin();
209
2.87k
        auto iter_fence = val->end();
210
211
8.64k
        while (iter < iter_fence) {
212
            // write key
213
5.77k
            if (iter->klen()) {
214
5.77k
                string_to_json(iter->getKeyStr(), iter->klen());
215
5.77k
            } else {
216
                // NOTE: we use sMaxKeyId to represent an empty key. see jsonb_writer.h
217
1
                if (iter->getKeyId() == JsonbKeyValue::sMaxKeyId) {
218
1
                    string_to_json(nullptr, 0);
219
1
                } else {
220
0
                    os_.write(iter->getKeyId());
221
0
                }
222
1
            }
223
5.77k
            os_.put(':');
224
225
            // convert value
226
5.77k
            intern_json(iter->value());
227
228
5.77k
            ++iter;
229
5.77k
            if (iter != iter_fence) {
230
2.92k
                os_.put(',');
231
2.92k
            }
232
5.77k
        }
233
234
2.87k
        assert(iter == iter_fence);
235
236
2.87k
        os_.put('}');
237
2.87k
    }
238
239
    // convert array to json
240
1.04k
    void array_to_json(const ArrayVal* val) {
241
1.04k
        os_.put('[');
242
243
1.04k
        auto iter = val->begin();
244
1.04k
        auto iter_fence = val->end();
245
246
3.59k
        while (iter != iter_fence) {
247
            // convert value
248
2.55k
            intern_json((const JsonbValue*)iter);
249
2.55k
            ++iter;
250
2.55k
            if (iter != iter_fence) {
251
1.53k
                os_.put(',');
252
1.53k
            }
253
2.55k
        }
254
255
1.04k
        assert(iter == iter_fence);
256
257
1.04k
        os_.put(']');
258
1.04k
    }
259
260
    template <JsonbDecimalType T>
261
    void decimal_to_json(const T& value, const uint32_t precision, const uint32_t scale);
262
263
    JsonbOutStream os_;
264
    char buffer_[OUT_BUF_SIZE];
265
};
266
267
} // namespace doris
268
269
#endif // JSONB_JSONBUTIL_H