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