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