Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for the JSON.MERGE command #1852

Merged
merged 18 commits into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions src/commands/cmd_json.cc
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,32 @@ class CommandJsonArrLen : public Commander {
}
};

class CommandJsonMerge : public Commander {
public:
Status Execute(Server *svr, Connection *conn, std::string *output) override {
redis::Json json(svr->storage, conn->GetNamespace());

std::string key = args_[1];
std::string path = args_[2];
std::string value = args_[3];
bool result = false;

auto s = json.Merge(key, path, value, result);

if (!s.ok()) {
return {Status::RedisExecErr, s.ToString()};
}

if (!result) {
*output = redis::NilString();
} else {
*output = redis::SimpleString("OK");
}

return Status::OK();
}
};

class CommandJsonArrPop : public Commander {
public:
Status Parse(const std::vector<std::string> &args) override {
Expand Down Expand Up @@ -376,6 +402,7 @@ REDIS_REGISTER_COMMANDS(MakeCmdAttr<CommandJsonSet>("json.set", 4, "write", 1, 1
MakeCmdAttr<CommandJsonClear>("json.clear", -2, "write", 1, 1, 1),
MakeCmdAttr<CommandJsonToggle>("json.toggle", -2, "write", 1, 1, 1),
MakeCmdAttr<CommandJsonArrLen>("json.arrlen", -2, "read-only", 1, 1, 1),
MakeCmdAttr<CommandJsonMerge>("json.merge", 4, "write", 1, 1, 1),
MakeCmdAttr<CommandJsonObjkeys>("json.objkeys", -2, "read-only", 1, 1, 1),
MakeCmdAttr<CommandJsonArrPop>("json.arrpop", -2, "write", 1, 1, 1),
MakeCmdAttr<CommanderJsonArrIndex>("json.arrindex", -4, "read-only", 1, 1, 1), );
Expand Down
50 changes: 50 additions & 0 deletions src/types/json.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@
#include <jsoncons_ext/cbor/cbor.hpp>
#include <jsoncons_ext/cbor/cbor_encoder.hpp>
#include <jsoncons_ext/cbor/cbor_options.hpp>
#include <jsoncons_ext/jsonpath/flatten.hpp>
#include <jsoncons_ext/jsonpath/json_query.hpp>
#include <jsoncons_ext/jsonpath/jsonpath_error.hpp>
#include <jsoncons_ext/mergepatch/mergepatch.hpp>
#include <limits>
#include <string>

Expand Down Expand Up @@ -316,6 +318,54 @@ struct JsonValue {
return Status::OK();
}

StatusOr<bool> Merge(const std::string_view path, const std::string &merge_value) {
bool is_updated = false;
const std::string json_root_path = "$";
try {
jsoncons::json patch_value = jsoncons::json::parse(merge_value);
bool not_exists = jsoncons::jsonpath::json_query(value, path).empty();

if (not_exists) {
// TODO:: Add ability to create an object from path.
return {Status::NotOK, "Path does not exist."};
}

if (path == json_root_path) {
// Merge with the root. Patch function complies with RFC7396 Json Merge Patch
jsoncons::mergepatch::apply_merge_patch(value, patch_value);
is_updated = true;
} else if (!patch_value.is_null()) {
// Replace value by path
jsoncons::jsonpath::json_replace(
value, path, [&patch_value, &is_updated](const std::string & /*path*/, jsoncons::json &target) {
jsoncons::mergepatch::apply_merge_patch(target, patch_value);
is_updated = true;
});
} else {
// Handle null case
// Unify path expression.
auto expr = jsoncons::jsonpath::make_expression<jsoncons::json>(path);
std::string converted_path;
expr.evaluate(
value, [&](const jsoncons::string_view &p, const jsoncons::json &val) { converted_path = p; },
jsoncons::jsonpath::result_options::path);
// Unify object state
jsoncons::json flattened = jsoncons::jsonpath::flatten(value);
if (flattened.contains(converted_path)) {
flattened.erase(converted_path);
value = jsoncons::jsonpath::unflatten(flattened);
is_updated = true;
}
}
} catch (const jsoncons::jsonpath::jsonpath_error &e) {
return {Status::NotOK, e.what()};
} catch (const jsoncons::ser_error &e) {
return {Status::NotOK, e.what()};
}

return is_updated;
}

Status ObjKeys(std::string_view path, std::vector<std::optional<std::vector<std::string>>> &keys) const {
try {
jsoncons::jsonpath::json_query(value, path,
Expand Down
45 changes: 40 additions & 5 deletions src/types/redis_json.cc
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,14 @@ rocksdb::Status Json::read(const Slice &ns_key, JsonMetadata *metadata, JsonValu
return rocksdb::Status::OK();
}

rocksdb::Status Json::create(const std::string &ns_key, JsonMetadata &metadata, const std::string &value) {
auto json_res = JsonValue::FromString(value, storage_->GetConfig()->json_max_nesting_depth);
if (!json_res) return rocksdb::Status::InvalidArgument(json_res.Msg());
auto json_val = *std::move(json_res);

return write(ns_key, &metadata, json_val);
}

rocksdb::Status Json::Info(const std::string &user_key, JsonStorageFormat *storage_format) {
auto ns_key = AppendNamespacePrefix(user_key);

Expand Down Expand Up @@ -103,11 +111,7 @@ rocksdb::Status Json::Set(const std::string &user_key, const std::string &path,
if (s.IsNotFound()) {
if (path != "$") return rocksdb::Status::InvalidArgument("new objects must be created at the root");

auto json_res = JsonValue::FromString(value, storage_->GetConfig()->json_max_nesting_depth);
if (!json_res) return rocksdb::Status::InvalidArgument(json_res.Msg());
auto json_val = *std::move(json_res);

return write(ns_key, &metadata, json_val);
return create(ns_key, metadata, value);
}

if (!s.ok()) return s;
Expand Down Expand Up @@ -215,6 +219,37 @@ rocksdb::Status Json::Type(const std::string &user_key, const std::string &path,
return rocksdb::Status::OK();
}

rocksdb::Status Json::Merge(const std::string &user_key, const std::string &path, const std::string &merge_value,
bool &result) {
auto ns_key = AppendNamespacePrefix(user_key);

LockGuard guard(storage_->GetLockManager(), ns_key);

JsonMetadata metadata;
JsonValue json_val;

auto s = read(ns_key, &metadata, &json_val);

if (s.IsNotFound()) {
if (path != "$") return rocksdb::Status::InvalidArgument("new objects must be created at the root");
result = true;
return create(ns_key, metadata, merge_value);
}

if (!s.ok()) return s;

auto res = json_val.Merge(path, merge_value);

if (!res.IsOK()) return s;

result = static_cast<bool>(res.GetValue());
if (!res) {
return rocksdb::Status::OK();
}

return write(ns_key, &metadata, json_val);
}

rocksdb::Status Json::Clear(const std::string &user_key, const std::string &path, size_t *result) {
auto ns_key = AppendNamespacePrefix(user_key);

Expand Down
2 changes: 2 additions & 0 deletions src/types/redis_json.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ class Json : public Database {
rocksdb::Status Type(const std::string &user_key, const std::string &path, std::vector<std::string> *results);
rocksdb::Status ArrAppend(const std::string &user_key, const std::string &path,
const std::vector<std::string> &values, std::vector<size_t> *result_count);
rocksdb::Status Merge(const std::string &user_key, const std::string &path, const std::string &value, bool &result);
rocksdb::Status Clear(const std::string &user_key, const std::string &path, size_t *result);
rocksdb::Status ArrLen(const std::string &user_key, const std::string &path,
std::vector<std::optional<uint64_t>> &arr_lens);
Expand All @@ -54,6 +55,7 @@ class Json : public Database {
private:
rocksdb::Status write(Slice ns_key, JsonMetadata *metadata, const JsonValue &json_val);
rocksdb::Status read(const Slice &ns_key, JsonMetadata *metadata, JsonValue *value);
rocksdb::Status create(const std::string &ns_key, JsonMetadata &metadata, const std::string &value);
};

} // namespace redis
30 changes: 30 additions & 0 deletions tests/cppunit/types/json_test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,36 @@ TEST_F(RedisJsonTest, ArrAppend) {
res.clear();
}

TEST_F(RedisJsonTest, Merge) {
bool result = false;

ASSERT_TRUE(json_->Set(key_, "$", R"({"a":2})").ok());
ASSERT_TRUE(json_->Merge(key_, "$.a", "3", result).ok());
ASSERT_TRUE(json_->Get(key_, {}, &json_val_).ok());
ASSERT_EQ(json_val_.Dump().GetValue(), "{\"a\":3}");
ASSERT_EQ(result, true);

ASSERT_TRUE(json_->Set(key_, "$", R"({"v": {"b": "cc"}})").ok());
ASSERT_TRUE(json_->Merge(key_, "$.v.b", "null", result).ok());
ASSERT_TRUE(json_->Get(key_, {}, &json_val_).ok());
ASSERT_EQ(json_val_.Dump().GetValue(), "{}");
ASSERT_EQ(result, true);

ASSERT_TRUE(json_->Set(key_, "$", R"({"arr":[2,4,6,8]})").ok());
ASSERT_TRUE(json_->Merge(key_, "$.arr", "[10,12]", result).ok());
ASSERT_TRUE(json_->Get(key_, {}, &json_val_).ok());
ASSERT_EQ(json_val_.Dump().GetValue(), "{\"arr\":[10,12]}");
ASSERT_EQ(result, true);

ASSERT_TRUE(json_->Set(key_, "$", R"({"f1": {"a":1}, "f2":{"a":2}})").ok());
ASSERT_TRUE(json_->Get(key_, {}, &json_val_).ok());
ASSERT_EQ(json_val_.Dump().GetValue(), "{\"f1\":{\"a\":1},\"f2\":{\"a\":2}}");
ASSERT_TRUE(json_->Merge(key_, "$", R"({"f1": null, "f2":{"a":3, "b":4}, "f3":[2,4,6]})", result).ok());
ASSERT_TRUE(json_->Get(key_, {}, &json_val_).ok());
ASSERT_EQ(json_val_.Dump().GetValue(), "{\"f2\":{\"a\":3,\"b\":4},\"f3\":[2,4,6]}");
ASSERT_EQ(result, true);
}

TEST_F(RedisJsonTest, Clear) {
size_t result = 0;

Expand Down
19 changes: 19 additions & 0 deletions tests/gocase/unit/type/json/json_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,25 @@ func TestJson(t *testing.T) {
require.EqualError(t, err, redis.Nil.Error())
})

t.Run("Merge basics", func(t *testing.T) {
require.NoError(t, rdb.Do(ctx, "JSON.SET", "key", "$", `{"a":2}`).Err())
require.NoError(t, rdb.Do(ctx, "JSON.MERGE", "key", "$.a", `3`).Err())
require.Equal(t, `{"a":3}`, rdb.Do(ctx, "JSON.GET", "key").Val())

require.NoError(t, rdb.Do(ctx, "JSON.SET", "key", "$", `{"a":2}`).Err())
require.NoError(t, rdb.Do(ctx, "JSON.MERGE", "key", "$.a", `null`).Err())
require.Equal(t, `{}`, rdb.Do(ctx, "JSON.GET", "key").Val())

require.NoError(t, rdb.Do(ctx, "JSON.SET", "key", "$", `{"a":[2,4,6,8]}`).Err())
require.NoError(t, rdb.Do(ctx, "JSON.MERGE", "key", "$.a", `[10,12]`).Err())
require.Equal(t, `{"a":[10,12]}`, rdb.Do(ctx, "JSON.GET", "key").Val())

require.NoError(t, rdb.Do(ctx, "JSON.SET", "key", "$", `{"f1": {"a":1}, "f2":{"a":2}}`).Err())
require.Equal(t, `{"f1":{"a":1},"f2":{"a":2}}`, rdb.Do(ctx, "JSON.GET", "key").Val())
require.NoError(t, rdb.Do(ctx, "JSON.MERGE", "key", "$", `{"f1": null, "f2":{"a":3, "b":4}, "f3":[2,4,6]}`).Err())
require.Equal(t, `{"f2":{"a":3,"b":4},"f3":[2,4,6]}`, rdb.Do(ctx, "JSON.GET", "key").Val())
})

t.Run("Clear JSON values", func(t *testing.T) {
require.NoError(t, rdb.Do(ctx, "JSON.SET", "bb", "$", `{"obj":{"a":1, "b":2}, "arr":[1,2,3], "str": "foo", "bool": true, "int": 42, "float": 3.14}`).Err())

Expand Down