1//! Handles conversions of `language` items to and from the [`rpc`] protocol.
2
3use crate::{diagnostic_set::DiagnosticEntry, CursorShape, Diagnostic};
4use anyhow::{anyhow, Context as _, Result};
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, 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 severity: match entry.diagnostic.severity {
207 DiagnosticSeverity::ERROR => proto::diagnostic::Severity::Error,
208 DiagnosticSeverity::WARNING => proto::diagnostic::Severity::Warning,
209 DiagnosticSeverity::INFORMATION => proto::diagnostic::Severity::Information,
210 DiagnosticSeverity::HINT => proto::diagnostic::Severity::Hint,
211 _ => proto::diagnostic::Severity::None,
212 } as i32,
213 group_id: entry.diagnostic.group_id as u64,
214 is_primary: entry.diagnostic.is_primary,
215 is_valid: true,
216 code: entry.diagnostic.code.as_ref().map(|s| s.to_string()),
217 is_disk_based: entry.diagnostic.is_disk_based,
218 is_unnecessary: entry.diagnostic.is_unnecessary,
219 data: entry.diagnostic.data.as_ref().map(|data| data.to_string()),
220 })
221 .collect()
222}
223
224/// Serializes an [`Anchor`] to be sent over RPC.
225pub fn serialize_anchor(anchor: &Anchor) -> proto::Anchor {
226 proto::Anchor {
227 replica_id: anchor.timestamp.replica_id as u32,
228 timestamp: anchor.timestamp.value,
229 offset: anchor.offset as u64,
230 bias: match anchor.bias {
231 Bias::Left => proto::Bias::Left as i32,
232 Bias::Right => proto::Bias::Right as i32,
233 },
234 buffer_id: anchor.buffer_id.map(Into::into),
235 }
236}
237
238pub fn serialize_anchor_range(range: Range<Anchor>) -> proto::AnchorRange {
239 proto::AnchorRange {
240 start: Some(serialize_anchor(&range.start)),
241 end: Some(serialize_anchor(&range.end)),
242 }
243}
244
245/// Deserializes an [`Range<Anchor>`] from the RPC representation.
246pub fn deserialize_anchor_range(range: proto::AnchorRange) -> Result<Range<Anchor>> {
247 Ok(
248 deserialize_anchor(range.start.context("invalid anchor")?).context("invalid anchor")?
249 ..deserialize_anchor(range.end.context("invalid anchor")?).context("invalid anchor")?,
250 )
251}
252
253// This behavior is currently copied in the collab database, for snapshotting channel notes
254/// Deserializes an [`crate::Operation`] from the RPC representation.
255pub fn deserialize_operation(message: proto::Operation) -> Result<crate::Operation> {
256 Ok(
257 match message
258 .variant
259 .ok_or_else(|| anyhow!("missing operation variant"))?
260 {
261 proto::operation::Variant::Edit(edit) => {
262 crate::Operation::Buffer(text::Operation::Edit(deserialize_edit_operation(edit)))
263 }
264 proto::operation::Variant::Undo(undo) => {
265 crate::Operation::Buffer(text::Operation::Undo(UndoOperation {
266 timestamp: clock::Lamport {
267 replica_id: undo.replica_id as ReplicaId,
268 value: undo.lamport_timestamp,
269 },
270 version: deserialize_version(&undo.version),
271 counts: undo
272 .counts
273 .into_iter()
274 .map(|c| {
275 (
276 clock::Lamport {
277 replica_id: c.replica_id as ReplicaId,
278 value: c.lamport_timestamp,
279 },
280 c.count,
281 )
282 })
283 .collect(),
284 }))
285 }
286 proto::operation::Variant::UpdateSelections(message) => {
287 let selections = message
288 .selections
289 .into_iter()
290 .filter_map(|selection| {
291 Some(Selection {
292 id: selection.id as usize,
293 start: deserialize_anchor(selection.start?.anchor?)?,
294 end: deserialize_anchor(selection.end?.anchor?)?,
295 reversed: selection.reversed,
296 goal: SelectionGoal::None,
297 })
298 })
299 .collect::<Vec<_>>();
300
301 crate::Operation::UpdateSelections {
302 lamport_timestamp: clock::Lamport {
303 replica_id: message.replica_id as ReplicaId,
304 value: message.lamport_timestamp,
305 },
306 selections: Arc::from(selections),
307 line_mode: message.line_mode,
308 cursor_shape: deserialize_cursor_shape(
309 proto::CursorShape::from_i32(message.cursor_shape)
310 .ok_or_else(|| anyhow!("Missing cursor shape"))?,
311 ),
312 }
313 }
314 proto::operation::Variant::UpdateDiagnostics(message) => {
315 crate::Operation::UpdateDiagnostics {
316 lamport_timestamp: clock::Lamport {
317 replica_id: message.replica_id as ReplicaId,
318 value: message.lamport_timestamp,
319 },
320 server_id: LanguageServerId(message.server_id as usize),
321 diagnostics: deserialize_diagnostics(message.diagnostics),
322 }
323 }
324 proto::operation::Variant::UpdateCompletionTriggers(message) => {
325 crate::Operation::UpdateCompletionTriggers {
326 triggers: message.triggers,
327 lamport_timestamp: clock::Lamport {
328 replica_id: message.replica_id as ReplicaId,
329 value: message.lamport_timestamp,
330 },
331 server_id: LanguageServerId::from_proto(message.language_server_id),
332 }
333 }
334 },
335 )
336}
337
338/// Deserializes an [`EditOperation`] from the RPC representation.
339pub fn deserialize_edit_operation(edit: proto::operation::Edit) -> EditOperation {
340 EditOperation {
341 timestamp: clock::Lamport {
342 replica_id: edit.replica_id as ReplicaId,
343 value: edit.lamport_timestamp,
344 },
345 version: deserialize_version(&edit.version),
346 ranges: edit.ranges.into_iter().map(deserialize_range).collect(),
347 new_text: edit.new_text.into_iter().map(Arc::from).collect(),
348 }
349}
350
351/// Deserializes an entry in the undo map from the RPC representation.
352pub fn deserialize_undo_map_entry(
353 entry: proto::UndoMapEntry,
354) -> (clock::Lamport, Vec<(clock::Lamport, u32)>) {
355 (
356 clock::Lamport {
357 replica_id: entry.replica_id as u16,
358 value: entry.local_timestamp,
359 },
360 entry
361 .counts
362 .into_iter()
363 .map(|undo_count| {
364 (
365 clock::Lamport {
366 replica_id: undo_count.replica_id as u16,
367 value: undo_count.lamport_timestamp,
368 },
369 undo_count.count,
370 )
371 })
372 .collect(),
373 )
374}
375
376/// Deserializes selections from the RPC representation.
377pub fn deserialize_selections(selections: Vec<proto::Selection>) -> Arc<[Selection<Anchor>]> {
378 Arc::from(
379 selections
380 .into_iter()
381 .filter_map(deserialize_selection)
382 .collect::<Vec<_>>(),
383 )
384}
385
386/// Deserializes a [`Selection`] from the RPC representation.
387pub fn deserialize_selection(selection: proto::Selection) -> Option<Selection<Anchor>> {
388 Some(Selection {
389 id: selection.id as usize,
390 start: deserialize_anchor(selection.start?.anchor?)?,
391 end: deserialize_anchor(selection.end?.anchor?)?,
392 reversed: selection.reversed,
393 goal: SelectionGoal::None,
394 })
395}
396
397/// Deserializes a list of diagnostics from the RPC representation.
398pub fn deserialize_diagnostics(
399 diagnostics: Vec<proto::Diagnostic>,
400) -> Arc<[DiagnosticEntry<Anchor>]> {
401 diagnostics
402 .into_iter()
403 .filter_map(|diagnostic| {
404 let data = if let Some(data) = diagnostic.data {
405 Some(Value::from_str(&data).ok()?)
406 } else {
407 None
408 };
409 Some(DiagnosticEntry {
410 range: deserialize_anchor(diagnostic.start?)?..deserialize_anchor(diagnostic.end?)?,
411 diagnostic: Diagnostic {
412 source: diagnostic.source,
413 severity: match proto::diagnostic::Severity::from_i32(diagnostic.severity)? {
414 proto::diagnostic::Severity::Error => DiagnosticSeverity::ERROR,
415 proto::diagnostic::Severity::Warning => DiagnosticSeverity::WARNING,
416 proto::diagnostic::Severity::Information => DiagnosticSeverity::INFORMATION,
417 proto::diagnostic::Severity::Hint => DiagnosticSeverity::HINT,
418 proto::diagnostic::Severity::None => return None,
419 },
420 message: diagnostic.message,
421 group_id: diagnostic.group_id as usize,
422 code: diagnostic.code.map(lsp::NumberOrString::from_string),
423 is_primary: diagnostic.is_primary,
424 is_disk_based: diagnostic.is_disk_based,
425 is_unnecessary: diagnostic.is_unnecessary,
426 data,
427 },
428 })
429 })
430 .collect()
431}
432
433/// Deserializes an [`Anchor`] from the RPC representation.
434pub fn deserialize_anchor(anchor: proto::Anchor) -> Option<Anchor> {
435 let buffer_id = if let Some(id) = anchor.buffer_id {
436 Some(BufferId::new(id).ok()?)
437 } else {
438 None
439 };
440 Some(Anchor {
441 timestamp: clock::Lamport {
442 replica_id: anchor.replica_id as ReplicaId,
443 value: anchor.timestamp,
444 },
445 offset: anchor.offset as usize,
446 bias: match proto::Bias::from_i32(anchor.bias)? {
447 proto::Bias::Left => Bias::Left,
448 proto::Bias::Right => Bias::Right,
449 },
450 buffer_id,
451 })
452}
453
454/// Returns a `[clock::Lamport`] timestamp for the given [`proto::Operation`].
455pub fn lamport_timestamp_for_operation(operation: &proto::Operation) -> Option<clock::Lamport> {
456 let replica_id;
457 let value;
458 match operation.variant.as_ref()? {
459 proto::operation::Variant::Edit(op) => {
460 replica_id = op.replica_id;
461 value = op.lamport_timestamp;
462 }
463 proto::operation::Variant::Undo(op) => {
464 replica_id = op.replica_id;
465 value = op.lamport_timestamp;
466 }
467 proto::operation::Variant::UpdateDiagnostics(op) => {
468 replica_id = op.replica_id;
469 value = op.lamport_timestamp;
470 }
471 proto::operation::Variant::UpdateSelections(op) => {
472 replica_id = op.replica_id;
473 value = op.lamport_timestamp;
474 }
475 proto::operation::Variant::UpdateCompletionTriggers(op) => {
476 replica_id = op.replica_id;
477 value = op.lamport_timestamp;
478 }
479 }
480
481 Some(clock::Lamport {
482 replica_id: replica_id as ReplicaId,
483 value,
484 })
485}
486
487/// Serializes a [`Transaction`] to be sent over RPC.
488pub fn serialize_transaction(transaction: &Transaction) -> proto::Transaction {
489 proto::Transaction {
490 id: Some(serialize_timestamp(transaction.id)),
491 edit_ids: transaction
492 .edit_ids
493 .iter()
494 .copied()
495 .map(serialize_timestamp)
496 .collect(),
497 start: serialize_version(&transaction.start),
498 }
499}
500
501/// Deserializes a [`Transaction`] from the RPC representation.
502pub fn deserialize_transaction(transaction: proto::Transaction) -> Result<Transaction> {
503 Ok(Transaction {
504 id: deserialize_timestamp(
505 transaction
506 .id
507 .ok_or_else(|| anyhow!("missing transaction id"))?,
508 ),
509 edit_ids: transaction
510 .edit_ids
511 .into_iter()
512 .map(deserialize_timestamp)
513 .collect(),
514 start: deserialize_version(&transaction.start),
515 })
516}
517
518/// Serializes a [`clock::Lamport`] timestamp to be sent over RPC.
519pub fn serialize_timestamp(timestamp: clock::Lamport) -> proto::LamportTimestamp {
520 proto::LamportTimestamp {
521 replica_id: timestamp.replica_id as u32,
522 value: timestamp.value,
523 }
524}
525
526/// Deserializes a [`clock::Lamport`] timestamp from the RPC representation.
527pub fn deserialize_timestamp(timestamp: proto::LamportTimestamp) -> clock::Lamport {
528 clock::Lamport {
529 replica_id: timestamp.replica_id as ReplicaId,
530 value: timestamp.value,
531 }
532}
533
534/// Serializes a range of [`FullOffset`]s to be sent over RPC.
535pub fn serialize_range(range: &Range<FullOffset>) -> proto::Range {
536 proto::Range {
537 start: range.start.0 as u64,
538 end: range.end.0 as u64,
539 }
540}
541
542/// Deserializes a range of [`FullOffset`]s from the RPC representation.
543pub fn deserialize_range(range: proto::Range) -> Range<FullOffset> {
544 FullOffset(range.start as usize)..FullOffset(range.end as usize)
545}
546
547/// Deserializes a clock version from the RPC representation.
548pub fn deserialize_version(message: &[proto::VectorClockEntry]) -> clock::Global {
549 let mut version = clock::Global::new();
550 for entry in message {
551 version.observe(clock::Lamport {
552 replica_id: entry.replica_id as ReplicaId,
553 value: entry.timestamp,
554 });
555 }
556 version
557}
558
559/// Serializes a clock version to be sent over RPC.
560pub fn serialize_version(version: &clock::Global) -> Vec<proto::VectorClockEntry> {
561 version
562 .iter()
563 .map(|entry| proto::VectorClockEntry {
564 replica_id: entry.replica_id as u32,
565 timestamp: entry.value,
566 })
567 .collect()
568}