Skip to content

Commit

Permalink
Merge pull request #45 from akoshchiy/11270-json-delete-by-path
Browse files Browse the repository at this point in the history 
feat: add delete_by_keypath
  • Loading branch information
@b41sh
b41sh authored Jan 30, 2024
2 parents e21b273 + 85c1e2e commit 391145b
Show file tree
Hide file tree
Showing 2 changed files with 262 additions and 8 deletions.
212 changes: 209 additions & 3 deletions src/functions.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use core::convert::TryInto;
use std::borrow::Cow;
use std::cmp::Ordering;
use std::collections::BTreeMap;
use std::collections::VecDeque;
use std::str::from_utf8;
use std::str::from_utf8_unchecked;
Expand Down Expand Up @@ -288,7 +289,7 @@ pub fn get_by_name(value: &[u8], name: &str, ignore_case: bool) -> Option<Vec<u8
}

/// Extracts JSON sub-object at the specified path,
/// where path elements can be either field keys or array indexes encoded in utf-8 string.
/// where path elements can be either field keys or array indexes.
pub fn get_by_keypath<'a, I: Iterator<Item = &'a KeyPath<'a>>>(
value: &[u8],
keypaths: I,
Expand Down Expand Up @@ -2015,6 +2016,211 @@ fn concat_jsonb(left: &[u8], right: &[u8], buf: &mut Vec<u8>) -> Result<(), Erro
Ok(())
}

/// Deletes a value from a JSON object by the specified path,
/// where path elements can be either field keys or array indexes.
pub fn delete_by_keypath<'a, I: Iterator<Item = &'a KeyPath<'a>>>(
value: &[u8],
keypath: I,
buf: &mut Vec<u8>,
) -> Result<(), Error> {
let mut keypath: VecDeque<_> = keypath.collect();
if !is_jsonb(value) {
let mut value = parse_value(value)?;
match value {
Value::Array(ref mut arr) => delete_value_array_by_keypath(arr, &mut keypath),
Value::Object(ref mut obj) => delete_value_object_by_keypath(obj, &mut keypath),
_ => return Err(Error::InvalidJsonType),
};
value.write_to_vec(buf);
return Ok(());
}
delete_by_keypath_jsonb(value, keypath, buf)
}

fn delete_value_array_by_keypath<'a>(
arr: &mut Vec<Value<'_>>,
keypath: &mut VecDeque<&'a KeyPath<'a>>,
) {
if let Some(KeyPath::Index(idx)) = keypath.pop_front() {
let len = arr.len() as i32;
let idx = if *idx < 0 { len - idx.abs() } else { *idx };
if idx < 0 || idx >= len {
return;
}
if keypath.is_empty() {
arr.remove(idx as usize);
} else {
match arr[idx as usize] {
Value::Array(ref mut arr) => delete_value_array_by_keypath(arr, keypath),
Value::Object(ref mut obj) => delete_value_object_by_keypath(obj, keypath),
_ => {}
}
}
}
}

fn delete_value_object_by_keypath<'a>(
obj: &mut BTreeMap<String, Value<'_>>,
keypath: &mut VecDeque<&'a KeyPath<'a>>,
) {
if let Some(path) = keypath.pop_front() {
match path {
KeyPath::QuotedName(name) | KeyPath::Name(name) => {
if keypath.is_empty() {
obj.remove(name.as_ref());
} else if let Some(val) = obj.get_mut(name.as_ref()) {
match val {
Value::Array(ref mut arr) => delete_value_array_by_keypath(arr, keypath),
Value::Object(ref mut obj) => delete_value_object_by_keypath(obj, keypath),
_ => {}
}
}
}
_ => {}
}
}
}

fn delete_by_keypath_jsonb<'a>(
value: &[u8],
mut keypath: VecDeque<&'a KeyPath<'a>>,
buf: &mut Vec<u8>,
) -> Result<(), Error> {
let header = read_u32(value, 0)?;
match header & CONTAINER_HEADER_TYPE_MASK {
ARRAY_CONTAINER_TAG => {
match delete_jsonb_array_by_keypath(value, header, &mut keypath)? {
Some(builder) => {
builder.build_into(buf);
}
None => {
buf.extend_from_slice(value);
}
};
}
OBJECT_CONTAINER_TAG => {
match delete_jsonb_object_by_keypath(value, header, &mut keypath)? {
Some(builder) => {
builder.build_into(buf);
}
None => {
buf.extend_from_slice(value);
}
}
}
_ => return Err(Error::InvalidJsonType),
}
Ok(())
}

fn delete_jsonb_array_by_keypath<'a, 'b>(
value: &'b [u8],
header: u32,
keypath: &mut VecDeque<&'a KeyPath<'a>>,
) -> Result<Option<ArrayBuilder<'b>>, Error> {
let len = (header & CONTAINER_HEADER_LEN_MASK) as i32;
match keypath.pop_front() {
Some(KeyPath::Index(idx)) => {
let idx = if *idx < 0 { len - idx.abs() } else { *idx };
if idx < 0 || idx >= len {
return Ok(None);
}
let mut builder = ArrayBuilder::new(len as usize);
let idx = idx as usize;
for (i, entry) in iterate_array(value, header).enumerate() {
if i != idx {
builder.push_raw(entry.0, entry.1);
} else if !keypath.is_empty() {
let item_value = entry.1;
match entry.0.type_code {
CONTAINER_TAG => {
let item_header = read_u32(item_value, 0)?;
match item_header & CONTAINER_HEADER_TYPE_MASK {
ARRAY_CONTAINER_TAG => {
match delete_jsonb_array_by_keypath(
item_value,
item_header,
keypath,
)? {
Some(item_builder) => builder.push_array(item_builder),
None => return Ok(None),
}
}
OBJECT_CONTAINER_TAG => {
match delete_jsonb_object_by_keypath(
item_value,
item_header,
keypath,
)? {
Some(item_builder) => builder.push_object(item_builder),
None => return Ok(None),
}
}
_ => unreachable!(),
}
}
_ => return Ok(None),
}
}
}
Ok(Some(builder))
}
_ => Ok(None),
}
}

fn delete_jsonb_object_by_keypath<'a, 'b>(
value: &'b [u8],
header: u32,
keypath: &mut VecDeque<&'a KeyPath<'a>>,
) -> Result<Option<ObjectBuilder<'b>>, Error> {
match keypath.pop_front() {
Some(path) => match path {
KeyPath::QuotedName(name) | KeyPath::Name(name) => {
let mut builder = ObjectBuilder::new();
for (key, jentry, item) in iterate_object_entries(value, header) {
if !key.eq(name) {
builder.push_raw(key, jentry, item);
} else if !keypath.is_empty() {
match jentry.type_code {
CONTAINER_TAG => {
let item_header = read_u32(item, 0)?;
match item_header & CONTAINER_HEADER_TYPE_MASK {
ARRAY_CONTAINER_TAG => match delete_jsonb_array_by_keypath(
item,
item_header,
keypath,
)? {
Some(item_builder) => builder.push_array(key, item_builder),
None => return Ok(None),
},
OBJECT_CONTAINER_TAG => {
match delete_jsonb_object_by_keypath(
item,
item_header,
keypath,
)? {
Some(item_builder) => {
builder.push_object(key, item_builder)
}
None => return Ok(None),
}
}
_ => unreachable!(),
}
}
_ => return Ok(None),
}
}
}
Ok(Some(builder))
}
_ => Ok(None),
},
None => Ok(None),
}
}

/// Deletes a key (and its value) from a JSON object, or matching string value(s) from a JSON array.
pub fn delete_by_name(value: &[u8], name: &str, buf: &mut Vec<u8>) -> Result<(), Error> {
if !is_jsonb(value) {
Expand Down Expand Up @@ -2166,7 +2372,7 @@ fn strip_nulls_array(header: u32, value: &[u8]) -> Result<ArrayBuilder<'_>, Erro
for (jentry, item) in iterate_array(value, header) {
match jentry.type_code {
CONTAINER_TAG => {
let item_header = read_u32(item, 0).unwrap();
let item_header = read_u32(item, 0)?;
match item_header & CONTAINER_HEADER_TYPE_MASK {
OBJECT_CONTAINER_TAG => {
builder.push_object(strip_nulls_object(item_header, item)?);
Expand All @@ -2188,7 +2394,7 @@ fn strip_nulls_object(header: u32, value: &[u8]) -> Result<ObjectBuilder<'_>, Er
for (key, jentry, item) in iterate_object_entries(value, header) {
match jentry.type_code {
CONTAINER_TAG => {
let item_header = read_u32(item, 0).unwrap();
let item_header = read_u32(item, 0)?;
match item_header & CONTAINER_HEADER_TYPE_MASK {
OBJECT_CONTAINER_TAG => {
builder.push_object(key, strip_nulls_object(item_header, item)?);
Expand Down
58 changes: 53 additions & 5 deletions tests/it/functions.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,12 @@ use std::collections::BTreeMap;

use jsonb::{
array_length, array_values, as_bool, as_null, as_number, as_str, build_array, build_object,
compare, concat, contains, convert_to_comparable, delete_by_index, delete_by_name,
exists_all_keys, exists_any_keys, from_slice, get_by_index, get_by_keypath, get_by_name,
get_by_path, is_array, is_object, keypath::parse_key_paths, object_each, object_keys,
parse_value, path_exists, path_match, strip_nulls, to_bool, to_f64, to_i64, to_pretty_string,
to_str, to_string, to_u64, traverse_check_string, type_of, Error, Number, Object, Value,
compare, concat, contains, convert_to_comparable, delete_by_index, delete_by_keypath,
delete_by_name, exists_all_keys, exists_any_keys, from_slice, get_by_index, get_by_keypath,
get_by_name, get_by_path, is_array, is_object, keypath::parse_key_paths, object_each,
object_keys, parse_value, path_exists, path_match, strip_nulls, to_bool, to_f64, to_i64,
to_pretty_string, to_str, to_string, to_u64, traverse_check_string, type_of, Error, Number,
Object, Value,
};

use jsonb::jsonpath::parse_json_path;
Expand Down Expand Up @@ -1416,6 +1417,53 @@ fn test_delete_by_index_errors() {
}
}

#[test]
fn test_delete_by_keypath() {
let sources = vec![
(r#"{"a":1,"b":[1,2,3]}"#, "{}", r#"{"a":1,"b":[1,2,3]}"#),
(r#"{"a":1,"b":[1,2,3]}"#, "{b}", r#"{"a":1}"#),
(r#"{"a":1,"b":[1,2,3]}"#, "{b,2}", r#"{"a":1,"b":[1,2]}"#),
(r#"{"a":1,"b":[1,2,3]}"#, "{b,-2}", r#"{"a":1,"b":[1,3]}"#),
(
r#"{"a":1,"b":[{"c":1,"d":10},2,3]}"#,
"{b,0,d}",
r#"{"a":1,"b":[{"c":1},2,3]}"#,
),
(r#"{"a":1,"b":[1,2,3]}"#, "{b,20}", r#"{"a":1,"b":[1,2,3]}"#),
(
r#"{"a":1,"b":[1,2,3]}"#,
"{b,20,c,e}",
r#"{"a":1,"b":[1,2,3]}"#,
),
];
for (json, keypath, result) in sources {
{
let json = json.as_bytes();
let keypath = parse_key_paths(keypath.as_bytes()).unwrap();
let mut buf = Vec::new();

delete_by_keypath(json, keypath.paths.iter(), &mut buf).unwrap();

let actual = from_slice(&buf).unwrap();
let expected = parse_value(result.as_bytes()).unwrap();

assert_eq!(actual, expected);
}
{
let json = parse_value(json.as_bytes()).unwrap().to_vec();
let keypath = parse_key_paths(keypath.as_bytes()).unwrap();
let mut buf = Vec::new();

delete_by_keypath(&json, keypath.paths.iter(), &mut buf).unwrap();

let actual = from_slice(&buf).unwrap();
let expected = parse_value(result.as_bytes()).unwrap();

assert_eq!(actual, expected);
}
}
}

fn init_object<'a>(entries: Vec<(&str, Value<'a>)>) -> Value<'a> {
let mut map = BTreeMap::new();
for (key, val) in entries {
Expand Down

0 comments on commit 391145b

Please sign in to comment.