surrealdb-expr 4.0.0

A scalable, distributed, collaborative, document-graph database, for the realtime web
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
use std::fmt;

use revision::revisioned;
use surrealdb_strand::Strand;
use surrealdb_types::{SqlFormat, ToSql};

use crate::expr::part::Part;
use crate::val::{Array, Object, Value};

#[derive(Debug)]
pub struct PatchError {
	pub message: String,
}

impl fmt::Display for PatchError {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		write!(f, "Failed to parse JSON patch structure: {}", self.message.to_sql())
	}
}

/// A type representing an delta change to a value.

#[revisioned(revision = 1)]
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub enum Operation {
	Add {
		path: Vec<Strand>,
		value: Value,
	},
	Remove {
		path: Vec<Strand>,
	},
	Replace {
		path: Vec<Strand>,
		value: Value,
	},
	Change {
		path: Vec<Strand>,
		value: Value,
	},
	Copy {
		path: Vec<Strand>,
		from: Vec<Strand>,
	},
	Move {
		path: Vec<Strand>,
		from: Vec<Strand>,
	},
	Test {
		path: Vec<Strand>,
		value: Value,
	},
}

/// Reject a root `from` pointer for `copy` / `move`. Without this guard, an
/// empty `from` makes `Value::pick` return the entire current document, which
/// can copy field values past their SELECT permissions into an attacker-chosen
/// destination path.
fn reject_root_from(op: &str, from: Vec<Strand>) -> Result<Vec<Strand>, PatchError> {
	if from.is_empty() {
		Err(PatchError {
			message: format!("'{op}' operation requires a non-root 'from' pointer"),
		})
	} else {
		Ok(from)
	}
}

/// Reject a `copy` or `move` whose `from` pointer is a proper prefix of its
/// `path`.
///
/// The destination lies inside the value the operation reads, so the write
/// lands in the value it came from. For `copy` that nests another snapshot of
/// the source inside itself on every application, which doubles the document a
/// caller builds from a patch whose own size never grows. For `move` (RFC 6902
/// §4.4) the source is removed before the destination is written, so the write
/// names a location the removal has just taken away.
///
/// An equal pair is not a proper prefix: it names one location, and copying or
/// moving a value onto itself leaves it where it is.
fn reject_nested_destination(op: &str, path: &[Strand], from: &[Strand]) -> Result<(), PatchError> {
	if path.len() > from.len() && path.starts_with(from) {
		return Err(PatchError {
			message: format!("'{op}' operation requires a 'path' that is not inside 'from'"),
		});
	}
	Ok(())
}

impl Operation {
	/// The longest JSON-Pointer path this operation carries. Applying an
	/// operation drives `Value::put` / `cut` / `pick` once per path segment, and
	/// those are natively recursive, so a caller bounds this against the value
	/// depth cap before applying to keep the recursion off the host stack.
	pub fn max_path_len(&self) -> usize {
		match self {
			Operation::Add {
				path,
				..
			}
			| Operation::Remove {
				path,
			}
			| Operation::Replace {
				path,
				..
			}
			| Operation::Change {
				path,
				..
			}
			| Operation::Test {
				path,
				..
			} => path.len(),
			Operation::Copy {
				path,
				from,
			}
			| Operation::Move {
				path,
				from,
			} => path.len().max(from.len()),
		}
	}

	/// The array index a JSON Pointer reference token names, if it names one.
	///
	/// RFC 6901 §4 spells an array index as `0` or `[1-9][0-9]*`. `str::parse`
	/// is wider than that grammar — it also accepts a leading `+` and leading
	/// zeroes — and those spellings name distinct object members, so the
	/// parsed value is re-rendered and compared to reject them. The result is
	/// bounded by `usize` on the target, which is the range an index part can
	/// address.
	pub fn array_index(token: &str) -> Option<usize> {
		let index: usize = token.parse().ok()?;
		(index.to_string() == token).then_some(index)
	}

	/// Maps the reference tokens of a JSON Pointer to the parts that select
	/// the value it points at.
	///
	/// A token spelled as an array index becomes an index part, which selects
	/// the element at that position in an array and the member of that name in
	/// an object — the two readings RFC 6901 gives a token, and they agree
	/// only because the spelling is canonical, so the member name an index
	/// part derives is the token itself. Every other token becomes a field
	/// part carrying it verbatim, which keeps members named `007`, `+3` or
	/// `-1` addressable.
	///
	/// Every pointer that `Value::patch` resolves is mapped here, so that a
	/// caller deciding whether a pointer may be applied — see
	/// `Document::check_patch_read_pointers` — judges the same location the
	/// patch will reach.
	pub fn path_to_parts(path: &[Strand]) -> Vec<Part> {
		path.iter()
			.map(|p| match Self::array_index(p.as_str()).and_then(|i| i64::try_from(i).ok()) {
				Some(i) => Part::index_int(i),
				None => Part::Field(p.clone()),
			})
			.collect()
	}

	/// Converts a value to a JSON path.
	///
	/// The value is an RFC 6901 JSON Pointer: reference tokens are separated by
	/// `/` and `~1` and `~0` stand for a literal `/` and `~` inside a token.
	/// Any other character, `.` included, is part of the token it appears in.
	fn value_to_jsonpath(val: &Value) -> Vec<Strand> {
		// Per RFC 6901, an empty JSON Pointer ("") refers to the root document.
		// Splitting an empty string would produce `[Strand("")]` rather than the
		// empty `Vec` round-trip target of `path_to_jsonpath(&[])`.
		let raw = val.to_raw_string();
		if raw.is_empty() {
			return Vec::new();
		}
		// A pointer that omits its leading `/` is read as if it had one.
		let tokens = raw.strip_prefix('/').unwrap_or(&raw);
		tokens
			.split('/')
			.map(|token| {
				if token.contains('~') {
					Strand::from(unescape_pointer_token(token))
				} else {
					Strand::from(token)
				}
			})
			.collect()
	}

	/// Converts the operation to a JSON patch object.
	pub fn into_object(self) -> Object {
		// Converts a path to a JSON path
		fn path_to_jsonpath(p: &[Strand]) -> Value {
			let mut res = String::with_capacity(p.len() + p.iter().map(|x| x.len()).sum::<usize>());
			for p in p {
				res.push('/');
				escape_pointer_token(p.as_str(), &mut res);
			}
			res.into()
		}
		// Return the JSON patch operation
		Object(match self {
			Operation::Add {
				path,
				value,
			} => {
				map! {
					"op".into() => Value::from("add"),
					"path".into() => path_to_jsonpath(&path),
					"value".into() => value,
				}
			}
			Operation::Remove {
				path,
			} => {
				map! {
					"op".into() => Value::from("remove"),
					"path".into() => path_to_jsonpath(&path),
				}
			}
			Operation::Replace {
				path,
				value,
			} => {
				map! {
					"op".into() => Value::from("replace"),
					"path".into() => path_to_jsonpath(&path),
					"value".into() => value,
				}
			}
			Operation::Change {
				path,
				value,
			} => {
				map! {
					"op".into() => Value::from("change"),
					"path".into() => path_to_jsonpath(&path),
					"value".into() => value,
				}
			}
			Operation::Copy {
				path,
				from,
			} => {
				map! {
					"op".into() => Value::from("copy"),
					"path".into() => path_to_jsonpath(&path),
					"from".into() => path_to_jsonpath(&from),
				}
			}
			Operation::Move {
				path,
				from,
			} => {
				map! {
					"op".into() => Value::from("move"),
					"path".into() => path_to_jsonpath(&path),
					"from".into() => path_to_jsonpath(&from),
				}
			}
			Operation::Test {
				path,
				value,
			} => {
				map! {
					"op".into() => Value::from("test"),
					"path".into() => path_to_jsonpath(&path),
					"value".into() => value,
				}
			}
		})
	}

	/// Returns the operaton encoded in the object, or an error if the object
	/// does not contain a valid operation.
	pub fn operation_from_object(object: &Object) -> Result<Operation, PatchError> {
		let Some(op) = object.get("op") else {
			return Err(PatchError {
				message: "Key 'op' missing".to_owned(),
			});
		};

		let Value::String(op) = op else {
			return Err(PatchError {
				message: "Key 'op' not a string".to_owned(),
			});
		};

		let Some(path) = object.get("path") else {
			return Err(PatchError {
				message: "Key 'path' missing".to_owned(),
			});
		};

		let from = || {
			object.get("from").map(Operation::value_to_jsonpath).ok_or_else(|| PatchError {
				message: "Key 'from' missing".to_owned(),
			})
		};

		let value = || {
			object.get("value").cloned().ok_or_else(|| PatchError {
				message: "Key 'value' missing".to_owned(),
			})
		};

		let path = Operation::value_to_jsonpath(path);

		match op.as_str() {
			"add" => Ok(Operation::Add {
				path,
				value: value()?,
			}),
			"remove" => Ok(Operation::Remove {
				path,
			}),
			"replace" => Ok(Operation::Replace {
				path,
				value: value()?,
			}),
			"change" => Ok(Operation::Change {
				path,
				value: value()?,
			}),
			"copy" => {
				let from = reject_root_from("copy", from()?)?;
				reject_nested_destination("copy", &path, &from)?;
				Ok(Operation::Copy {
					path,
					from,
				})
			}
			"move" => {
				let from = reject_root_from("move", from()?)?;
				reject_nested_destination("move", &path, &from)?;
				Ok(Operation::Move {
					path,
					from,
				})
			}
			"test" => Ok(Operation::Test {
				path,
				value: value()?,
			}),

			x => Err(PatchError {
				message: format!("Invalid operation '{x}'"),
			}),
		}
	}

	/// Turns a value into a list of operations if the value has the right
	/// structure.
	pub fn value_to_operations(value: Value) -> Result<Vec<Operation>, PatchError> {
		let Value::Array(array) = value else {
			return Err(PatchError {
				message: "Patch operations should be an array of objects".to_owned(),
			});
		};

		let mut res = Vec::new();
		for o in array {
			let Value::Object(o) = o else {
				return Err(PatchError {
					message: "Patch operations should be an array of objects".to_owned(),
				});
			};
			res.push(Operation::operation_from_object(&o)?)
		}
		Ok(res)
	}

	pub fn operations_to_value(operations: Vec<Operation>) -> Value {
		let array = operations.into_iter().map(|x| Value::Object(x.into_object())).collect();
		Value::Array(Array(array))
	}
}

impl ToSql for Operation {
	fn fmt_sql(&self, f: &mut String, fmt: SqlFormat) {
		self.clone().into_object().fmt_sql(f, fmt);
	}
}

/// Decodes one RFC 6901 reference token: `~1` is `/` and `~0` is `~`.
///
/// `~1` is decoded before `~0` so that `~01` yields `~1` rather than `/`.
/// A `~` followed by anything else is not an escape and is kept as written.
fn unescape_pointer_token(token: &str) -> String {
	token.replace("~1", "/").replace("~0", "~")
}

/// Appends `token` to `out` as an RFC 6901 reference token.
fn escape_pointer_token(token: &str, out: &mut String) {
	if !token.contains(['~', '/']) {
		out.push_str(token);
		return;
	}
	for c in token.chars() {
		match c {
			'~' => out.push_str("~0"),
			'/' => out.push_str("~1"),
			c => out.push(c),
		}
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	fn roundtrip(op: &Operation) {
		let obj = op.clone().into_object();
		let decoded = Operation::operation_from_object(&obj)
			.expect("operation_from_object should accept into_object output");
		assert_eq!(*op, decoded);
	}

	#[test]
	fn round_trip_all_variants() {
		let path: Vec<Strand> = vec!["a".into(), "b".into()];
		let from: Vec<Strand> = vec!["c".into(), "d".into()];
		let value = Value::Bool(true);

		roundtrip(&Operation::Add {
			path: path.clone(),
			value: value.clone(),
		});
		roundtrip(&Operation::Remove {
			path: path.clone(),
		});
		roundtrip(&Operation::Replace {
			path: path.clone(),
			value: value.clone(),
		});
		roundtrip(&Operation::Change {
			path: path.clone(),
			value: value.clone(),
		});
		roundtrip(&Operation::Copy {
			path: path.clone(),
			from: from.clone(),
		});
		roundtrip(&Operation::Move {
			path: path.clone(),
			from,
		});
		roundtrip(&Operation::Test {
			path,
			value,
		});
	}

	/// A reference token is one path element whatever characters it holds: `~1`
	/// and `~0` decode to `/` and `~`, and `.` is an ordinary character.
	#[test]
	fn pointer_tokens_follow_rfc_6901() {
		let path_of = |pointer: &str| Operation::value_to_jsonpath(&Value::from(pointer));
		let strands = |tokens: &[&str]| tokens.iter().map(|t| Strand::from(*t)).collect::<Vec<_>>();

		assert_eq!(path_of(""), strands(&[]));
		assert_eq!(path_of("/"), strands(&[""]));
		assert_eq!(path_of("/foo/0"), strands(&["foo", "0"]));
		assert_eq!(path_of("/a~1b"), strands(&["a/b"]));
		assert_eq!(path_of("/m~0n"), strands(&["m~n"]));
		assert_eq!(path_of("/~01"), strands(&["~1"]));
		assert_eq!(path_of("/a.b"), strands(&["a.b"]));
		assert_eq!(path_of("/c%d/e^f/ /k\"l"), strands(&["c%d", "e^f", " ", "k\"l"]));
	}

	/// A key holding `/`, `~` or `.` survives a trip through the patch object
	/// form, which is also the form a diff of such a document is emitted in.
	#[test]
	fn round_trip_path_tokens_needing_escapes() {
		let path: Vec<Strand> =
			vec!["a/b".into(), "m~n".into(), "~1".into(), "x.y".into(), "".into()];
		roundtrip(&Operation::Replace {
			path,
			value: Value::Bool(true),
		});
	}

	#[test]
	fn round_trip_root_path() {
		// Empty path Vec must round-trip through the JSON Patch object form,
		// otherwise diff/patch silently no-ops on top-level scalars (issue 7239).
		let empty: Vec<Strand> = Vec::new();
		let value = Value::from("Hello there!");

		roundtrip(&Operation::Add {
			path: empty.clone(),
			value: value.clone(),
		});
		roundtrip(&Operation::Remove {
			path: empty.clone(),
		});
		roundtrip(&Operation::Replace {
			path: empty.clone(),
			value: value.clone(),
		});
		roundtrip(&Operation::Change {
			path: empty.clone(),
			value: value.clone(),
		});
		roundtrip(&Operation::Test {
			path: empty,
			value,
		});
	}
}