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