1//! Handles conversions of `language` items to and from the [`rpc`] protocol.
2
3use crate::{CursorShape, Diagnostic, diagnostic_set::DiagnosticEntry};
4use anyhow::{Context as _, Result, anyhow};
5use clock::ReplicaId;
6use lsp::{DiagnosticSeverity, LanguageServerId};
7use rpc::proto;
8use serde_json::Value;
9use std::{ops::Range, str::FromStr, sync::Arc};
10use text::*;
11
12pub use proto::{BufferState, File, Operation};
13
14/// Deserializes a `[text::LineEnding]` from the RPC representation.
15pub fn deserialize_line_ending(message: proto::LineEnding) -> text::LineEnding {
16 match message {
17 proto::LineEnding::Unix => text::LineEnding::Unix,
18 proto::LineEnding::Windows => text::LineEnding::Windows,
19 }
20}
21
22/// Serializes a [`text::LineEnding`] to be sent over RPC.
23pub fn serialize_line_ending(message: text::LineEnding) -> proto::LineEnding {
24 match message {
25 text::LineEnding::Unix => proto::LineEnding::Unix,
26 text::LineEnding::Windows => proto::LineEnding::Windows,
27 }
28}
29
30/// Serializes a [`crate::Operation`] to be sent over RPC.
31pub fn serialize_operation(operation: &crate::Operation) -> proto::Operation {
32 proto::Operation {
33 variant: Some(match operation {
34 crate::Operation::Buffer(text::Operation::Edit(edit)) => {
35 proto::operation::Variant::Edit(serialize_edit_operation(edit))
36 }
37
38 crate::Operation::Buffer(text::Operation::Undo(undo)) => {
39 proto::operation::Variant::Undo(proto::operation::Undo {
40 replica_id: undo.timestamp.replica_id as u32,
41 lamport_timestamp: undo.timestamp.value,
42 version: serialize_version(&undo.version),
43 counts: undo
44 .counts
45 .iter()
46 .map(|(edit_id, count)| proto::UndoCount {
47 replica_id: edit_id.replica_id as u32,
48 lamport_timestamp: edit_id.value,
49 count: *count,
50 })
51 .collect(),
52 })
53 }
54
55 crate::Operation::UpdateSelections {
56 selections,
57 line_mode,
58 lamport_timestamp,
59 cursor_shape,
60 } => proto::operation::Variant::UpdateSelections(proto::operation::UpdateSelections {
61 replica_id: lamport_timestamp.replica_id as u32,
62 lamport_timestamp: lamport_timestamp.value,
63 selections: serialize_selections(selections),
64 line_mode: *line_mode,
65 cursor_shape: serialize_cursor_shape(cursor_shape) as i32,
66 }),
67
68 crate::Operation::UpdateDiagnostics {
69 lamport_timestamp,
70 server_id,
71 diagnostics,
72 } => proto::operation::Variant::UpdateDiagnostics(proto::UpdateDiagnostics {
73 replica_id: lamport_timestamp.replica_id as u32,
74 lamport_timestamp: lamport_timestamp.value,
75 server_id: server_id.0 as u64,
76 diagnostics: serialize_diagnostics(diagnostics.iter()),
77 }),
78
79 crate::Operation::UpdateCompletionTriggers {
80 triggers,
81 lamport_timestamp,
82 server_id,
83 } => proto::operation::Variant::UpdateCompletionTriggers(
84 proto::operation::UpdateCompletionTriggers {
85 replica_id: lamport_timestamp.replica_id as u32,
86 lamport_timestamp: lamport_timestamp.value,
87 triggers: triggers.iter().cloned().collect(),
88 language_server_id: server_id.to_proto(),
89 },
90 ),
91 }),
92 }
93}
94
95/// Serializes an [`EditOperation`] to be sent over RPC.
96pub fn serialize_edit_operation(operation: &EditOperation) -> proto::operation::Edit {
97 proto::operation::Edit {
98 replica_id: operation.timestamp.replica_id as u32,
99 lamport_timestamp: operation.timestamp.value,
100 version: serialize_version(&operation.version),
101 ranges: operation.ranges.iter().map(serialize_range).collect(),
102 new_text: operation
103 .new_text
104 .iter()
105 .map(|text| text.to_string())
106 .collect(),
107 }
108}
109
110/// Serializes an entry in the undo map to be sent over RPC.
111pub fn serialize_undo_map_entry(
112 (edit_id, counts): (&clock::Lamport, &[(clock::Lamport, u32)]),
113) -> proto::UndoMapEntry {
114 proto::UndoMapEntry {
115 replica_id: edit_id.replica_id as u32,
116 local_timestamp: edit_id.value,
117 counts: counts
118 .iter()
119 .map(|(undo_id, count)| proto::UndoCount {
120 replica_id: undo_id.replica_id as u32,
121 lamport_timestamp: undo_id.value,
122 count: *count,
123 })
124 .collect(),
125 }
126}
127
128/// Splits the given list of operations into chunks.
129pub fn split_operations(
130 mut operations: Vec<proto::Operation>,
131) -> impl Iterator<Item = Vec<proto::Operation>> {
132 #[cfg(any(test, feature = "test-support"))]
133 const CHUNK_SIZE: usize = 5;
134
135 #[cfg(not(any(test, feature = "test-support")))]
136 const CHUNK_SIZE: usize = 100;
137
138 let mut done = false;
139 std::iter::from_fn(move || {
140 if done {
141 return None;
142 }
143
144 let operations = operations
145 .drain(..std::cmp::min(CHUNK_SIZE, operations.len()))
146 .collect::<Vec<_>>();
147 if operations.is_empty() {
148 done = true;
149 }
150 Some(operations)
151 })
152}
153
154/// Serializes selections to be sent over RPC.
155pub fn serialize_selections(selections: &Arc<[Selection<Anchor>]>) -> Vec<proto::Selection> {
156 selections.iter().map(serialize_selection).collect()
157}
158
159/// Serializes a [`Selection`] to be sent over RPC.
160pub fn serialize_selection(selection: &Selection<Anchor>) -> proto::Selection {
161 proto::Selection {
162 id: selection.id as u64,
163 start: Some(proto::EditorAnchor {
164 anchor: Some(serialize_anchor(&selection.start)),
165 excerpt_id: 0,
166 }),
167 end: Some(proto::EditorAnchor {
168 anchor: Some(serialize_anchor(&selection.end)),
169 excerpt_id: 0,
170 }),
171 reversed: selection.reversed,
172 }
173}
174
175/// Serializes a [`CursorShape`] to be sent over RPC.
176pub fn serialize_cursor_shape(cursor_shape: &CursorShape) -> proto::CursorShape {
177 match cursor_shape {
178 CursorShape::Bar => proto::CursorShape::CursorBar,
179 CursorShape::Block => proto::CursorShape::CursorBlock,
180 CursorShape::Underline => proto::CursorShape::CursorUnderscore,
181 CursorShape::Hollow => proto::CursorShape::CursorHollow,
182 }
183}
184
185/// Deserializes a [`CursorShape`] from the RPC representation.
186pub fn deserialize_cursor_shape(cursor_shape: proto::CursorShape) -> CursorShape {
187 match cursor_shape {
188 proto::CursorShape::CursorBar => CursorShape::Bar,
189 proto::CursorShape::CursorBlock => CursorShape::Block,
190 proto::CursorShape::CursorUnderscore => CursorShape::Underline,
191 proto::CursorShape::CursorHollow => CursorShape::Hollow,
192 }
193}
194
195/// Serializes a list of diagnostics to be sent over RPC.
196pub fn serialize_diagnostics<'a>(
197 diagnostics: impl IntoIterator<Item = &'a DiagnosticEntry<Anchor>>,
198) -> Vec<proto::Diagnostic> {
199 diagnostics
200 .into_iter()
201 .map(|entry| proto::Diagnostic {
202 source: entry.diagnostic.source.clone(),
203 start: Some(serialize_anchor(&entry.range.start)),
204 end: Some(serialize_anchor(&entry.range.end)),
205 message: entry.diagnostic.message.clone(),
206 markdown: entry.diagnostic.markdown.clone(),
207 severity: match entry.diagnostic.severity {
208 DiagnosticSeverity::ERROR => proto::diagnostic::Severity::Error,
209 DiagnosticSeverity::WARNING => proto::diagnostic::Severity::Warning,
210 DiagnosticSeverity::INFORMATION => proto::diagnostic::Severity::Information,
211 DiagnosticSeverity::HINT => proto::diagnostic::Severity::Hint,
212 _ => proto::diagnostic::Severity::None,
213 } as i32,
214 group_id: entry.diagnostic.group_id as u64,
215 is_primary: entry.diagnostic.is_primary,
216 code: entry.diagnostic.code.as_ref().map(|s| s.to_string()),
217 code_description: entry
218 .diagnostic
219 .code_description
220 .as_ref()
221 .map(|s| s.to_string()),
222 is_disk_based: entry.diagnostic.is_disk_based,
223 is_unnecessary: entry.diagnostic.is_unnecessary,
224 data: entry.diagnostic.data.as_ref().map(|data| data.to_string()),
225 })
226 .collect()
227}
228
229/// Serializes an [`Anchor`] to be sent over RPC.
230pub fn serialize_anchor(anchor: &Anchor) -> proto::Anchor {
231 proto::Anchor {
232 replica_id: anchor.timestamp.replica_id as u32,
233 timestamp: anchor.timestamp.value,
234 offset: anchor.offset as u64,
235 bias: match anchor.bias {
236 Bias::Left => proto::Bias::Left as i32,
237 Bias::Right => proto::Bias::Right as i32,
238 },
239 buffer_id: anchor.buffer_id.map(Into::into),
240 }
241}
242
243pub fn serialize_anchor_range(range: Range<Anchor>) -> proto::AnchorRange {
244 proto::AnchorRange {
245 start: Some(serialize_anchor(&range.start)),
246 end: Some(serialize_anchor(&range.end)),
247 }
248}
249
250/// Deserializes an [`Range<Anchor>`] from the RPC representation.
251pub fn deserialize_anchor_range(range: proto::AnchorRange) -> Result<Range<Anchor>> {
252 Ok(
253 deserialize_anchor(range.start.context("invalid anchor")?).context("invalid anchor")?
254 ..deserialize_anchor(range.end.context("invalid anchor")?).context("invalid anchor")?,
255 )
256}
257
258// This behavior is currently copied in the collab database, for snapshotting channel notes
259/// Deserializes an [`crate::Operation`] from the RPC representation.
260pub fn deserialize_operation(message: proto::Operation) -> Result<crate::Operation> {
261 Ok(
262 match message
263 .variant
264 .ok_or_else(|| anyhow!("missing operation variant"))?
265 {
266 proto::operation::Variant::Edit(edit) => {
267 crate::Operation::Buffer(text::Operation::Edit(deserialize_edit_operation(edit)))
268 }
269 proto::operation::Variant::Undo(undo) => {
270 crate::Operation::Buffer(text::Operation::Undo(UndoOperation {
271 timestamp: clock::Lamport {
272 replica_id: undo.replica_id as ReplicaId,
273 value: undo.lamport_timestamp,
274 },
275 version: deserialize_version(&undo.version),
276 counts: undo
277 .counts
278 .into_iter()
279 .map(|c| {
280 (
281 clock::Lamport {
282 replica_id: c.replica_id as ReplicaId,
283 value: c.lamport_timestamp,
284 },
285 c.count,
286 )
287 })
288 .collect(),
289 }))
290 }
291 proto::operation::Variant::UpdateSelections(message) => {
292 let selections = message
293 .selections
294 .into_iter()
295 .filter_map(|selection| {
296 Some(Selection {
297 id: selection.id as usize,
298 start: deserialize_anchor(selection.start?.anchor?)?,
299 end: deserialize_anchor(selection.end?.anchor?)?,
300 reversed: selection.reversed,
301 goal: SelectionGoal::None,
302 })
303 })
304 .collect::<Vec<_>>();
305
306 crate::Operation::UpdateSelections {
307 lamport_timestamp: clock::Lamport {
308 replica_id: message.replica_id as ReplicaId,
309 value: message.lamport_timestamp,
310 },
311 selections: Arc::from(selections),
312 line_mode: message.line_mode,
313 cursor_shape: deserialize_cursor_shape(
314 proto::CursorShape::from_i32(message.cursor_shape)
315 .ok_or_else(|| anyhow!("Missing cursor shape"))?,
316 ),
317 }
318 }
319 proto::operation::Variant::UpdateDiagnostics(message) => {
320 crate::Operation::UpdateDiagnostics {
321 lamport_timestamp: clock::Lamport {
322 replica_id: message.replica_id as ReplicaId,
323 value: message.lamport_timestamp,
324 },
325 server_id: LanguageServerId(message.server_id as usize),
326 diagnostics: deserialize_diagnostics(message.diagnostics),
327 }
328 }
329 proto::operation::Variant::UpdateCompletionTriggers(message) => {
330 crate::Operation::UpdateCompletionTriggers {
331 triggers: message.triggers,
332 lamport_timestamp: clock::Lamport {
333 replica_id: message.replica_id as ReplicaId,
334 value: message.lamport_timestamp,
335 },
336 server_id: LanguageServerId::from_proto(message.language_server_id),
337 }
338 }
339 },
340 )
341}
342
343/// Deserializes an [`EditOperation`] from the RPC representation.
344pub fn deserialize_edit_operation(edit: proto::operation::Edit) -> EditOperation {
345 EditOperation {
346 timestamp: clock::Lamport {
347 replica_id: edit.replica_id as ReplicaId,
348 value: edit.lamport_timestamp,
349 },
350 version: deserialize_version(&edit.version),
351 ranges: edit.ranges.into_iter().map(deserialize_range).collect(),
352 new_text: edit.new_text.into_iter().map(Arc::from).collect(),
353 }
354}
355
356/// Deserializes an entry in the undo map from the RPC representation.
357pub fn deserialize_undo_map_entry(
358 entry: proto::UndoMapEntry,
359) -> (clock::Lamport, Vec<(clock::Lamport, u32)>) {
360 (
361 clock::Lamport {
362 replica_id: entry.replica_id as u16,
363 value: entry.local_timestamp,
364 },
365 entry
366 .counts
367 .into_iter()
368 .map(|undo_count| {
369 (
370 clock::Lamport {
371 replica_id: undo_count.replica_id as u16,
372 value: undo_count.lamport_timestamp,
373 },
374 undo_count.count,
375 )
376 })
377 .collect(),
378 )
379}
380
381/// Deserializes selections from the RPC representation.
382pub fn deserialize_selections(selections: Vec<proto::Selection>) -> Arc<[Selection<Anchor>]> {
383 Arc::from(
384 selections
385 .into_iter()
386 .filter_map(deserialize_selection)
387 .collect::<Vec<_>>(),
388 )
389}
390
391/// Deserializes a [`Selection`] from the RPC representation.
392pub fn deserialize_selection(selection: proto::Selection) -> Option<Selection<Anchor>> {
393 Some(Selection {
394 id: selection.id as usize,
395 start: deserialize_anchor(selection.start?.anchor?)?,
396 end: deserialize_anchor(selection.end?.anchor?)?,
397 reversed: selection.reversed,
398 goal: SelectionGoal::None,
399 })
400}
401
402/// Deserializes a list of diagnostics from the RPC representation.
403pub fn deserialize_diagnostics(
404 diagnostics: Vec<proto::Diagnostic>,
405) -> Arc<[DiagnosticEntry<Anchor>]> {
406 diagnostics
407 .into_iter()
408 .filter_map(|diagnostic| {
409 let data = if let Some(data) = diagnostic.data {
410 Some(Value::from_str(&data).ok()?)
411 } else {
412 None
413 };
414 Some(DiagnosticEntry {
415 range: deserialize_anchor(diagnostic.start?)?..deserialize_anchor(diagnostic.end?)?,
416 diagnostic: Diagnostic {
417 source: diagnostic.source,
418 severity: match proto::diagnostic::Severity::from_i32(diagnostic.severity)? {
419 proto::diagnostic::Severity::Error => DiagnosticSeverity::ERROR,
420 proto::diagnostic::Severity::Warning => DiagnosticSeverity::WARNING,
421 proto::diagnostic::Severity::Information => DiagnosticSeverity::INFORMATION,
422 proto::diagnostic::Severity::Hint => DiagnosticSeverity::HINT,
423 proto::diagnostic::Severity::None => return None,
424 },
425 message: diagnostic.message,
426 markdown: diagnostic.markdown,
427 group_id: diagnostic.group_id as usize,
428 code: diagnostic.code.map(lsp::NumberOrString::from_string),
429 code_description: diagnostic
430 .code_description
431 .and_then(|s| lsp::Url::parse(&s).ok()),
432 is_primary: diagnostic.is_primary,
433 is_disk_based: diagnostic.is_disk_based,
434 is_unnecessary: diagnostic.is_unnecessary,
435 data,
436 },
437 })
438 })
439 .collect()
440}
441
442/// Deserializes an [`Anchor`] from the RPC representation.
443pub fn deserialize_anchor(anchor: proto::Anchor) -> Option<Anchor> {
444 let buffer_id = if let Some(id) = anchor.buffer_id {
445 Some(BufferId::new(id).ok()?)
446 } else {
447 None
448 };
449 Some(Anchor {
450 timestamp: clock::Lamport {
451 replica_id: anchor.replica_id as ReplicaId,
452 value: anchor.timestamp,
453 },
454 offset: anchor.offset as usize,
455 bias: match proto::Bias::from_i32(anchor.bias)? {
456 proto::Bias::Left => Bias::Left,
457 proto::Bias::Right => Bias::Right,
458 },
459 buffer_id,
460 })
461}
462
463/// Returns a `[clock::Lamport`] timestamp for the given [`proto::Operation`].
464pub fn lamport_timestamp_for_operation(operation: &proto::Operation) -> Option<clock::Lamport> {
465 let replica_id;
466 let value;
467 match operation.variant.as_ref()? {
468 proto::operation::Variant::Edit(op) => {
469 replica_id = op.replica_id;
470 value = op.lamport_timestamp;
471 }
472 proto::operation::Variant::Undo(op) => {
473 replica_id = op.replica_id;
474 value = op.lamport_timestamp;
475 }
476 proto::operation::Variant::UpdateDiagnostics(op) => {
477 replica_id = op.replica_id;
478 value = op.lamport_timestamp;
479 }
480 proto::operation::Variant::UpdateSelections(op) => {
481 replica_id = op.replica_id;
482 value = op.lamport_timestamp;
483 }
484 proto::operation::Variant::UpdateCompletionTriggers(op) => {
485 replica_id = op.replica_id;
486 value = op.lamport_timestamp;
487 }
488 }
489
490 Some(clock::Lamport {
491 replica_id: replica_id as ReplicaId,
492 value,
493 })
494}
495
496/// Serializes a [`Transaction`] to be sent over RPC.
497pub fn serialize_transaction(transaction: &Transaction) -> proto::Transaction {
498 proto::Transaction {
499 id: Some(serialize_timestamp(transaction.id)),
500 edit_ids: transaction
501 .edit_ids
502 .iter()
503 .copied()
504 .map(serialize_timestamp)
505 .collect(),
506 start: serialize_version(&transaction.start),
507 }
508}
509
510/// Deserializes a [`Transaction`] from the RPC representation.
511pub fn deserialize_transaction(transaction: proto::Transaction) -> Result<Transaction> {
512 Ok(Transaction {
513 id: deserialize_timestamp(
514 transaction
515 .id
516 .ok_or_else(|| anyhow!("missing transaction id"))?,
517 ),
518 edit_ids: transaction
519 .edit_ids
520 .into_iter()
521 .map(deserialize_timestamp)
522 .collect(),
523 start: deserialize_version(&transaction.start),
524 })
525}
526
527/// Serializes a [`clock::Lamport`] timestamp to be sent over RPC.
528pub fn serialize_timestamp(timestamp: clock::Lamport) -> proto::LamportTimestamp {
529 proto::LamportTimestamp {
530 replica_id: timestamp.replica_id as u32,
531 value: timestamp.value,
532 }
533}
534
535/// Deserializes a [`clock::Lamport`] timestamp from the RPC representation.
536pub fn deserialize_timestamp(timestamp: proto::LamportTimestamp) -> clock::Lamport {
537 clock::Lamport {
538 replica_id: timestamp.replica_id as ReplicaId,
539 value: timestamp.value,
540 }
541}
542
543/// Serializes a range of [`FullOffset`]s to be sent over RPC.
544pub fn serialize_range(range: &Range<FullOffset>) -> proto::Range {
545 proto::Range {
546 start: range.start.0 as u64,
547 end: range.end.0 as u64,
548 }
549}
550
551/// Deserializes a range of [`FullOffset`]s from the RPC representation.
552pub fn deserialize_range(range: proto::Range) -> Range<FullOffset> {
553 FullOffset(range.start as usize)..FullOffset(range.end as usize)
554}
555
556/// Deserializes a clock version from the RPC representation.
557pub fn deserialize_version(message: &[proto::VectorClockEntry]) -> clock::Global {
558 let mut version = clock::Global::new();
559 for entry in message {
560 version.observe(clock::Lamport {
561 replica_id: entry.replica_id as ReplicaId,
562 value: entry.timestamp,
563 });
564 }
565 version
566}
567
568/// Serializes a clock version to be sent over RPC.
569pub fn serialize_version(version: &clock::Global) -> Vec<proto::VectorClockEntry> {
570 version
571 .iter()
572 .map(|entry| proto::VectorClockEntry {
573 replica_id: entry.replica_id as u32,
574 timestamp: entry.value,
575 })
576 .collect()
577}