mod.rs 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  1. #![allow(clippy::module_inception)]
  2. mod attribute_test;
  3. mod op_test;
  4. mod serde_test;
  5. mod undo_redo_test;
  6. use derive_more::Display;
  7. use flowy_sync::client_document::{ClientDocument, InitialDocumentContent};
  8. use lib_ot::{
  9. core::*,
  10. text_delta::{BuildInTextAttribute, TextOperations},
  11. };
  12. use rand::{prelude::*, Rng as WrappedRng};
  13. use std::{sync::Once, time::Duration};
  14. #[derive(Clone, Debug, Display)]
  15. pub enum TestOp {
  16. #[display(fmt = "Insert")]
  17. Insert(usize, &'static str, usize),
  18. // delta_i, s, start, length,
  19. #[display(fmt = "InsertBold")]
  20. InsertBold(usize, &'static str, Interval),
  21. // delta_i, start, length, enable
  22. #[display(fmt = "Bold")]
  23. Bold(usize, Interval, bool),
  24. #[display(fmt = "Delete")]
  25. Delete(usize, Interval),
  26. #[display(fmt = "Replace")]
  27. Replace(usize, Interval, &'static str),
  28. #[display(fmt = "Italic")]
  29. Italic(usize, Interval, bool),
  30. #[display(fmt = "Header")]
  31. Header(usize, Interval, usize),
  32. #[display(fmt = "Link")]
  33. Link(usize, Interval, &'static str),
  34. #[display(fmt = "Bullet")]
  35. Bullet(usize, Interval, bool),
  36. #[display(fmt = "Transform")]
  37. Transform(usize, usize),
  38. #[display(fmt = "TransformPrime")]
  39. TransformPrime(usize, usize),
  40. // invert the delta_a base on the delta_b
  41. #[display(fmt = "Invert")]
  42. Invert(usize, usize),
  43. #[display(fmt = "Undo")]
  44. Undo(usize),
  45. #[display(fmt = "Redo")]
  46. Redo(usize),
  47. #[display(fmt = "Wait")]
  48. Wait(usize),
  49. #[display(fmt = "AssertStr")]
  50. AssertStr(usize, &'static str),
  51. #[display(fmt = "AssertDocJson")]
  52. AssertDocJson(usize, &'static str),
  53. #[display(fmt = "AssertPrimeJson")]
  54. AssertPrimeJson(usize, &'static str),
  55. #[display(fmt = "DocComposeDelta")]
  56. DocComposeDelta(usize, usize),
  57. #[display(fmt = "ApplyPrimeDelta")]
  58. DocComposePrime(usize, usize),
  59. }
  60. pub struct TestBuilder {
  61. documents: Vec<ClientDocument>,
  62. deltas: Vec<Option<TextOperations>>,
  63. primes: Vec<Option<TextOperations>>,
  64. }
  65. impl TestBuilder {
  66. pub fn new() -> Self {
  67. static INIT: Once = Once::new();
  68. INIT.call_once(|| {
  69. let _ = color_eyre::install();
  70. // let subscriber = FmtSubscriber::builder().with_max_level(Level::INFO).finish();
  71. // tracing::subscriber::set_global_default(subscriber).expect("setting default subscriber failed");
  72. });
  73. Self {
  74. documents: vec![],
  75. deltas: vec![],
  76. primes: vec![],
  77. }
  78. }
  79. fn run_op(&mut self, op: &TestOp) {
  80. tracing::trace!("***************** 😈{} *******************", &op);
  81. match op {
  82. TestOp::Insert(delta_i, s, index) => {
  83. let document = &mut self.documents[*delta_i];
  84. let delta = document.insert(*index, s).unwrap();
  85. tracing::debug!("Insert delta: {}", delta.json_str());
  86. self.deltas.insert(*delta_i, Some(delta));
  87. }
  88. TestOp::Delete(delta_i, iv) => {
  89. let document = &mut self.documents[*delta_i];
  90. let delta = document.replace(*iv, "").unwrap();
  91. tracing::trace!("Delete delta: {}", delta.json_str());
  92. self.deltas.insert(*delta_i, Some(delta));
  93. }
  94. TestOp::Replace(delta_i, iv, s) => {
  95. let document = &mut self.documents[*delta_i];
  96. let delta = document.replace(*iv, s).unwrap();
  97. tracing::trace!("Replace delta: {}", delta.json_str());
  98. self.deltas.insert(*delta_i, Some(delta));
  99. }
  100. TestOp::InsertBold(delta_i, s, iv) => {
  101. let document = &mut self.documents[*delta_i];
  102. document.insert(iv.start, s).unwrap();
  103. document.format(*iv, BuildInTextAttribute::Bold(true)).unwrap();
  104. }
  105. TestOp::Bold(delta_i, iv, enable) => {
  106. let document = &mut self.documents[*delta_i];
  107. let attribute = BuildInTextAttribute::Bold(*enable);
  108. let delta = document.format(*iv, attribute).unwrap();
  109. tracing::trace!("Bold delta: {}", delta.json_str());
  110. self.deltas.insert(*delta_i, Some(delta));
  111. }
  112. TestOp::Italic(delta_i, iv, enable) => {
  113. let document = &mut self.documents[*delta_i];
  114. let attribute = match *enable {
  115. true => BuildInTextAttribute::Italic(true),
  116. false => BuildInTextAttribute::Italic(false),
  117. };
  118. let delta = document.format(*iv, attribute).unwrap();
  119. tracing::trace!("Italic delta: {}", delta.json_str());
  120. self.deltas.insert(*delta_i, Some(delta));
  121. }
  122. TestOp::Header(delta_i, iv, level) => {
  123. let document = &mut self.documents[*delta_i];
  124. let attribute = BuildInTextAttribute::Header(*level);
  125. let delta = document.format(*iv, attribute).unwrap();
  126. tracing::trace!("Header delta: {}", delta.json_str());
  127. self.deltas.insert(*delta_i, Some(delta));
  128. }
  129. TestOp::Link(delta_i, iv, link) => {
  130. let document = &mut self.documents[*delta_i];
  131. let attribute = BuildInTextAttribute::Link(link.to_owned());
  132. let delta = document.format(*iv, attribute).unwrap();
  133. tracing::trace!("Link delta: {}", delta.json_str());
  134. self.deltas.insert(*delta_i, Some(delta));
  135. }
  136. TestOp::Bullet(delta_i, iv, enable) => {
  137. let document = &mut self.documents[*delta_i];
  138. let attribute = BuildInTextAttribute::Bullet(*enable);
  139. let delta = document.format(*iv, attribute).unwrap();
  140. tracing::debug!("Bullet delta: {}", delta.json_str());
  141. self.deltas.insert(*delta_i, Some(delta));
  142. }
  143. TestOp::Transform(delta_a_i, delta_b_i) => {
  144. let (a_prime, b_prime) = self.documents[*delta_a_i]
  145. .get_operations()
  146. .transform(self.documents[*delta_b_i].get_operations())
  147. .unwrap();
  148. tracing::trace!("a:{:?},b:{:?}", a_prime, b_prime);
  149. let data_left = self.documents[*delta_a_i].get_operations().compose(&b_prime).unwrap();
  150. let data_right = self.documents[*delta_b_i].get_operations().compose(&a_prime).unwrap();
  151. self.documents[*delta_a_i].set_operations(data_left);
  152. self.documents[*delta_b_i].set_operations(data_right);
  153. }
  154. TestOp::TransformPrime(a_doc_index, b_doc_index) => {
  155. let (prime_left, prime_right) = self.documents[*a_doc_index]
  156. .get_operations()
  157. .transform(self.documents[*b_doc_index].get_operations())
  158. .unwrap();
  159. self.primes.insert(*a_doc_index, Some(prime_left));
  160. self.primes.insert(*b_doc_index, Some(prime_right));
  161. }
  162. TestOp::Invert(delta_a_i, delta_b_i) => {
  163. let delta_a = &self.documents[*delta_a_i].get_operations();
  164. let delta_b = &self.documents[*delta_b_i].get_operations();
  165. tracing::debug!("Invert: ");
  166. tracing::debug!("a: {}", delta_a.json_str());
  167. tracing::debug!("b: {}", delta_b.json_str());
  168. let (_, b_prime) = delta_a.transform(delta_b).unwrap();
  169. let undo = b_prime.invert(delta_a);
  170. let new_delta = delta_a.compose(&b_prime).unwrap();
  171. tracing::debug!("new delta: {}", new_delta.json_str());
  172. tracing::debug!("undo delta: {}", undo.json_str());
  173. let new_delta_after_undo = new_delta.compose(&undo).unwrap();
  174. tracing::debug!("inverted delta a: {}", new_delta_after_undo.to_string());
  175. assert_eq!(delta_a, &&new_delta_after_undo);
  176. self.documents[*delta_a_i].set_operations(new_delta_after_undo);
  177. }
  178. TestOp::Undo(delta_i) => {
  179. self.documents[*delta_i].undo().unwrap();
  180. }
  181. TestOp::Redo(delta_i) => {
  182. self.documents[*delta_i].redo().unwrap();
  183. }
  184. TestOp::Wait(mills_sec) => {
  185. std::thread::sleep(Duration::from_millis(*mills_sec as u64));
  186. }
  187. TestOp::AssertStr(delta_i, expected) => {
  188. assert_eq!(&self.documents[*delta_i].to_content(), expected);
  189. }
  190. TestOp::AssertDocJson(delta_i, expected) => {
  191. let delta_json = self.documents[*delta_i].get_operations_json();
  192. let expected_delta: TextOperations = serde_json::from_str(expected).unwrap();
  193. let target_delta: TextOperations = serde_json::from_str(&delta_json).unwrap();
  194. if expected_delta != target_delta {
  195. log::error!("✅ expect: {}", expected,);
  196. log::error!("❌ receive: {}", delta_json);
  197. }
  198. assert_eq!(target_delta, expected_delta);
  199. }
  200. TestOp::AssertPrimeJson(doc_i, expected) => {
  201. let prime_json = self.primes[*doc_i].as_ref().unwrap().json_str();
  202. let expected_prime: TextOperations = serde_json::from_str(expected).unwrap();
  203. let target_prime: TextOperations = serde_json::from_str(&prime_json).unwrap();
  204. if expected_prime != target_prime {
  205. log::error!("✅ expect prime: {}", expected,);
  206. log::error!("❌ receive prime: {}", prime_json);
  207. }
  208. assert_eq!(target_prime, expected_prime);
  209. }
  210. TestOp::DocComposeDelta(doc_index, delta_i) => {
  211. let delta = self.deltas.get(*delta_i).unwrap().as_ref().unwrap();
  212. self.documents[*doc_index].compose_operations(delta.clone()).unwrap();
  213. }
  214. TestOp::DocComposePrime(doc_index, prime_i) => {
  215. let delta = self
  216. .primes
  217. .get(*prime_i)
  218. .expect("Must call TransformPrime first")
  219. .as_ref()
  220. .unwrap();
  221. let new_delta = self.documents[*doc_index].get_operations().compose(delta).unwrap();
  222. self.documents[*doc_index].set_operations(new_delta);
  223. }
  224. }
  225. }
  226. pub fn run_scripts<C: InitialDocumentContent>(mut self, scripts: Vec<TestOp>) {
  227. self.documents = vec![ClientDocument::new::<C>(), ClientDocument::new::<C>()];
  228. self.primes = vec![None, None];
  229. self.deltas = vec![None, None];
  230. for (_i, op) in scripts.iter().enumerate() {
  231. self.run_op(op);
  232. }
  233. }
  234. }
  235. pub struct Rng(StdRng);
  236. impl Default for Rng {
  237. fn default() -> Self {
  238. Rng(StdRng::from_rng(thread_rng()).unwrap())
  239. }
  240. }
  241. impl Rng {
  242. #[allow(dead_code)]
  243. pub fn from_seed(seed: [u8; 32]) -> Self {
  244. Rng(StdRng::from_seed(seed))
  245. }
  246. pub fn gen_string(&mut self, len: usize) -> String {
  247. (0..len)
  248. .map(|_| {
  249. let c = self.0.gen::<char>();
  250. format!("{:x}", c as u32)
  251. })
  252. .collect()
  253. }
  254. pub fn gen_delta(&mut self, s: &str) -> TextOperations {
  255. let mut delta = TextOperations::default();
  256. let s = OTString::from(s);
  257. loop {
  258. let left = s.utf16_len() - delta.utf16_base_len;
  259. if left == 0 {
  260. break;
  261. }
  262. let i = if left == 1 {
  263. 1
  264. } else {
  265. 1 + self.0.gen_range(0..std::cmp::min(left - 1, 20))
  266. };
  267. match self.0.gen_range(0.0..1.0) {
  268. f if f < 0.2 => {
  269. delta.insert(&self.gen_string(i), AttributeHashMap::default());
  270. }
  271. f if f < 0.4 => {
  272. delta.delete(i);
  273. }
  274. _ => {
  275. delta.retain(i, AttributeHashMap::default());
  276. }
  277. }
  278. }
  279. if self.0.gen_range(0.0..1.0) < 0.3 {
  280. delta.insert(&("1".to_owned() + &self.gen_string(10)), AttributeHashMap::default());
  281. }
  282. delta
  283. }
  284. }