proto.rs

  1use crate::{
  2    diagnostic_set::DiagnosticEntry, CodeAction, CodeLabel, Completion, Diagnostic, Language,
  3    Operation,
  4};
  5use anyhow::{anyhow, Result};
  6use clock::ReplicaId;
  7use lsp::DiagnosticSeverity;
  8use rpc::proto;
  9use std::{ops::Range, sync::Arc};
 10use text::*;
 11
 12pub use proto::{Buffer, BufferState, SelectionSet};
 13
 14pub fn serialize_operation(operation: &Operation) -> proto::Operation {
 15    proto::Operation {
 16        variant: Some(match operation {
 17            Operation::Buffer(text::Operation::Edit(edit)) => {
 18                proto::operation::Variant::Edit(serialize_edit_operation(edit))
 19            }
 20            Operation::Buffer(text::Operation::Undo {
 21                undo,
 22                lamport_timestamp,
 23            }) => proto::operation::Variant::Undo(proto::operation::Undo {
 24                replica_id: undo.id.replica_id as u32,
 25                local_timestamp: undo.id.value,
 26                lamport_timestamp: lamport_timestamp.value,
 27                version: serialize_version(&undo.version),
 28                transaction_ranges: undo
 29                    .transaction_ranges
 30                    .iter()
 31                    .map(serialize_range)
 32                    .collect(),
 33                transaction_version: serialize_version(&undo.transaction_version),
 34                counts: undo
 35                    .counts
 36                    .iter()
 37                    .map(|(edit_id, count)| proto::UndoCount {
 38                        replica_id: edit_id.replica_id as u32,
 39                        local_timestamp: edit_id.value,
 40                        count: *count,
 41                    })
 42                    .collect(),
 43            }),
 44            Operation::UpdateSelections {
 45                selections,
 46                lamport_timestamp,
 47            } => proto::operation::Variant::UpdateSelections(proto::operation::UpdateSelections {
 48                replica_id: lamport_timestamp.replica_id as u32,
 49                lamport_timestamp: lamport_timestamp.value,
 50                selections: serialize_selections(selections),
 51            }),
 52            Operation::UpdateDiagnostics {
 53                diagnostics,
 54                lamport_timestamp,
 55            } => proto::operation::Variant::UpdateDiagnostics(proto::UpdateDiagnostics {
 56                replica_id: lamport_timestamp.replica_id as u32,
 57                lamport_timestamp: lamport_timestamp.value,
 58                diagnostics: serialize_diagnostics(diagnostics.iter()),
 59            }),
 60            Operation::UpdateCompletionTriggers {
 61                triggers,
 62                lamport_timestamp,
 63            } => proto::operation::Variant::UpdateCompletionTriggers(
 64                proto::operation::UpdateCompletionTriggers {
 65                    replica_id: lamport_timestamp.replica_id as u32,
 66                    lamport_timestamp: lamport_timestamp.value,
 67                    triggers: triggers.clone(),
 68                },
 69            ),
 70        }),
 71    }
 72}
 73
 74pub fn serialize_edit_operation(operation: &EditOperation) -> proto::operation::Edit {
 75    proto::operation::Edit {
 76        replica_id: operation.timestamp.replica_id as u32,
 77        local_timestamp: operation.timestamp.local,
 78        lamport_timestamp: operation.timestamp.lamport,
 79        version: serialize_version(&operation.version),
 80        ranges: operation.ranges.iter().map(serialize_range).collect(),
 81        new_text: operation
 82            .new_text
 83            .iter()
 84            .map(|text| text.to_string())
 85            .collect(),
 86    }
 87}
 88
 89pub fn serialize_undo_map_entry(
 90    (edit_id, counts): (&clock::Local, &[(clock::Local, u32)]),
 91) -> proto::UndoMapEntry {
 92    proto::UndoMapEntry {
 93        replica_id: edit_id.replica_id as u32,
 94        local_timestamp: edit_id.value,
 95        counts: counts
 96            .iter()
 97            .map(|(undo_id, count)| proto::UndoCount {
 98                replica_id: undo_id.replica_id as u32,
 99                local_timestamp: undo_id.value,
100                count: *count,
101            })
102            .collect(),
103    }
104}
105
106pub fn serialize_selections(selections: &Arc<[Selection<Anchor>]>) -> Vec<proto::Selection> {
107    selections.iter().map(serialize_selection).collect()
108}
109
110pub fn serialize_selection(selection: &Selection<Anchor>) -> proto::Selection {
111    proto::Selection {
112        id: selection.id as u64,
113        start: Some(serialize_anchor(&selection.start)),
114        end: Some(serialize_anchor(&selection.end)),
115        reversed: selection.reversed,
116    }
117}
118
119pub fn serialize_diagnostics<'a>(
120    diagnostics: impl IntoIterator<Item = &'a DiagnosticEntry<Anchor>>,
121) -> Vec<proto::Diagnostic> {
122    diagnostics
123        .into_iter()
124        .map(|entry| proto::Diagnostic {
125            start: Some(serialize_anchor(&entry.range.start)),
126            end: Some(serialize_anchor(&entry.range.end)),
127            message: entry.diagnostic.message.clone(),
128            severity: match entry.diagnostic.severity {
129                DiagnosticSeverity::ERROR => proto::diagnostic::Severity::Error,
130                DiagnosticSeverity::WARNING => proto::diagnostic::Severity::Warning,
131                DiagnosticSeverity::INFORMATION => proto::diagnostic::Severity::Information,
132                DiagnosticSeverity::HINT => proto::diagnostic::Severity::Hint,
133                _ => proto::diagnostic::Severity::None,
134            } as i32,
135            group_id: entry.diagnostic.group_id as u64,
136            is_primary: entry.diagnostic.is_primary,
137            is_valid: entry.diagnostic.is_valid,
138            code: entry.diagnostic.code.clone(),
139            is_disk_based: entry.diagnostic.is_disk_based,
140            is_unnecessary: entry.diagnostic.is_unnecessary,
141        })
142        .collect()
143}
144
145pub fn serialize_anchor(anchor: &Anchor) -> proto::Anchor {
146    proto::Anchor {
147        replica_id: anchor.timestamp.replica_id as u32,
148        local_timestamp: anchor.timestamp.value,
149        offset: anchor.offset as u64,
150        bias: match anchor.bias {
151            Bias::Left => proto::Bias::Left as i32,
152            Bias::Right => proto::Bias::Right as i32,
153        },
154    }
155}
156
157pub fn deserialize_operation(message: proto::Operation) -> Result<Operation> {
158    Ok(
159        match message
160            .variant
161            .ok_or_else(|| anyhow!("missing operation variant"))?
162        {
163            proto::operation::Variant::Edit(edit) => {
164                Operation::Buffer(text::Operation::Edit(deserialize_edit_operation(edit)))
165            }
166            proto::operation::Variant::Undo(undo) => Operation::Buffer(text::Operation::Undo {
167                lamport_timestamp: clock::Lamport {
168                    replica_id: undo.replica_id as ReplicaId,
169                    value: undo.lamport_timestamp,
170                },
171                undo: UndoOperation {
172                    id: clock::Local {
173                        replica_id: undo.replica_id as ReplicaId,
174                        value: undo.local_timestamp,
175                    },
176                    version: deserialize_version(undo.version),
177                    counts: undo
178                        .counts
179                        .into_iter()
180                        .map(|c| {
181                            (
182                                clock::Local {
183                                    replica_id: c.replica_id as ReplicaId,
184                                    value: c.local_timestamp,
185                                },
186                                c.count,
187                            )
188                        })
189                        .collect(),
190                    transaction_ranges: undo
191                        .transaction_ranges
192                        .into_iter()
193                        .map(deserialize_range)
194                        .collect(),
195                    transaction_version: deserialize_version(undo.transaction_version),
196                },
197            }),
198            proto::operation::Variant::UpdateSelections(message) => {
199                let selections = message
200                    .selections
201                    .into_iter()
202                    .filter_map(|selection| {
203                        Some(Selection {
204                            id: selection.id as usize,
205                            start: deserialize_anchor(selection.start?)?,
206                            end: deserialize_anchor(selection.end?)?,
207                            reversed: selection.reversed,
208                            goal: SelectionGoal::None,
209                        })
210                    })
211                    .collect::<Vec<_>>();
212
213                Operation::UpdateSelections {
214                    lamport_timestamp: clock::Lamport {
215                        replica_id: message.replica_id as ReplicaId,
216                        value: message.lamport_timestamp,
217                    },
218                    selections: Arc::from(selections),
219                }
220            }
221            proto::operation::Variant::UpdateDiagnostics(message) => Operation::UpdateDiagnostics {
222                diagnostics: deserialize_diagnostics(message.diagnostics),
223                lamport_timestamp: clock::Lamport {
224                    replica_id: message.replica_id as ReplicaId,
225                    value: message.lamport_timestamp,
226                },
227            },
228            proto::operation::Variant::UpdateCompletionTriggers(message) => {
229                Operation::UpdateCompletionTriggers {
230                    triggers: message.triggers,
231                    lamport_timestamp: clock::Lamport {
232                        replica_id: message.replica_id as ReplicaId,
233                        value: message.lamport_timestamp,
234                    },
235                }
236            }
237        },
238    )
239}
240
241pub fn deserialize_edit_operation(edit: proto::operation::Edit) -> EditOperation {
242    EditOperation {
243        timestamp: InsertionTimestamp {
244            replica_id: edit.replica_id as ReplicaId,
245            local: edit.local_timestamp,
246            lamport: edit.lamport_timestamp,
247        },
248        version: deserialize_version(edit.version),
249        ranges: edit.ranges.into_iter().map(deserialize_range).collect(),
250        new_text: edit.new_text.into_iter().map(Arc::from).collect(),
251    }
252}
253
254pub fn deserialize_undo_map_entry(
255    entry: proto::UndoMapEntry,
256) -> (clock::Local, Vec<(clock::Local, u32)>) {
257    (
258        clock::Local {
259            replica_id: entry.replica_id as u16,
260            value: entry.local_timestamp,
261        },
262        entry
263            .counts
264            .into_iter()
265            .map(|undo_count| {
266                (
267                    clock::Local {
268                        replica_id: undo_count.replica_id as u16,
269                        value: undo_count.local_timestamp,
270                    },
271                    undo_count.count,
272                )
273            })
274            .collect(),
275    )
276}
277
278pub fn deserialize_selections(selections: Vec<proto::Selection>) -> Arc<[Selection<Anchor>]> {
279    Arc::from(
280        selections
281            .into_iter()
282            .filter_map(deserialize_selection)
283            .collect::<Vec<_>>(),
284    )
285}
286
287pub fn deserialize_selection(selection: proto::Selection) -> Option<Selection<Anchor>> {
288    Some(Selection {
289        id: selection.id as usize,
290        start: deserialize_anchor(selection.start?)?,
291        end: deserialize_anchor(selection.end?)?,
292        reversed: selection.reversed,
293        goal: SelectionGoal::None,
294    })
295}
296
297pub fn deserialize_diagnostics(
298    diagnostics: Vec<proto::Diagnostic>,
299) -> Arc<[DiagnosticEntry<Anchor>]> {
300    diagnostics
301        .into_iter()
302        .filter_map(|diagnostic| {
303            Some(DiagnosticEntry {
304                range: deserialize_anchor(diagnostic.start?)?..deserialize_anchor(diagnostic.end?)?,
305                diagnostic: Diagnostic {
306                    severity: match proto::diagnostic::Severity::from_i32(diagnostic.severity)? {
307                        proto::diagnostic::Severity::Error => DiagnosticSeverity::ERROR,
308                        proto::diagnostic::Severity::Warning => DiagnosticSeverity::WARNING,
309                        proto::diagnostic::Severity::Information => DiagnosticSeverity::INFORMATION,
310                        proto::diagnostic::Severity::Hint => DiagnosticSeverity::HINT,
311                        proto::diagnostic::Severity::None => return None,
312                    },
313                    message: diagnostic.message,
314                    group_id: diagnostic.group_id as usize,
315                    code: diagnostic.code,
316                    is_valid: diagnostic.is_valid,
317                    is_primary: diagnostic.is_primary,
318                    is_disk_based: diagnostic.is_disk_based,
319                    is_unnecessary: diagnostic.is_unnecessary,
320                },
321            })
322        })
323        .collect()
324}
325
326pub fn deserialize_anchor(anchor: proto::Anchor) -> Option<Anchor> {
327    Some(Anchor {
328        timestamp: clock::Local {
329            replica_id: anchor.replica_id as ReplicaId,
330            value: anchor.local_timestamp,
331        },
332        offset: anchor.offset as usize,
333        bias: match proto::Bias::from_i32(anchor.bias)? {
334            proto::Bias::Left => Bias::Left,
335            proto::Bias::Right => Bias::Right,
336        },
337    })
338}
339
340pub fn lamport_timestamp_for_operation(operation: &proto::Operation) -> Option<clock::Lamport> {
341    let replica_id;
342    let value;
343    match operation.variant.as_ref()? {
344        proto::operation::Variant::Edit(op) => {
345            replica_id = op.replica_id;
346            value = op.lamport_timestamp;
347        }
348        proto::operation::Variant::Undo(op) => {
349            replica_id = op.replica_id;
350            value = op.lamport_timestamp;
351        }
352        proto::operation::Variant::UpdateDiagnostics(op) => {
353            replica_id = op.replica_id;
354            value = op.lamport_timestamp;
355        }
356        proto::operation::Variant::UpdateSelections(op) => {
357            replica_id = op.replica_id;
358            value = op.lamport_timestamp;
359        }
360        proto::operation::Variant::UpdateCompletionTriggers(op) => {
361            replica_id = op.replica_id;
362            value = op.lamport_timestamp;
363        }
364    }
365
366    Some(clock::Lamport {
367        replica_id: replica_id as ReplicaId,
368        value,
369    })
370}
371
372pub fn serialize_completion(completion: &Completion) -> proto::Completion {
373    proto::Completion {
374        old_start: Some(serialize_anchor(&completion.old_range.start)),
375        old_end: Some(serialize_anchor(&completion.old_range.end)),
376        new_text: completion.new_text.clone(),
377        lsp_completion: serde_json::to_vec(&completion.lsp_completion).unwrap(),
378    }
379}
380
381pub fn deserialize_completion(
382    completion: proto::Completion,
383    language: Option<&Arc<Language>>,
384) -> Result<Completion> {
385    let old_start = completion
386        .old_start
387        .and_then(deserialize_anchor)
388        .ok_or_else(|| anyhow!("invalid old start"))?;
389    let old_end = completion
390        .old_end
391        .and_then(deserialize_anchor)
392        .ok_or_else(|| anyhow!("invalid old end"))?;
393    let lsp_completion = serde_json::from_slice(&completion.lsp_completion)?;
394    Ok(Completion {
395        old_range: old_start..old_end,
396        new_text: completion.new_text,
397        label: language
398            .and_then(|l| l.label_for_completion(&lsp_completion))
399            .unwrap_or(CodeLabel::plain(
400                lsp_completion.label.clone(),
401                lsp_completion.filter_text.as_deref(),
402            )),
403        lsp_completion,
404    })
405}
406
407pub fn serialize_code_action(action: &CodeAction) -> proto::CodeAction {
408    proto::CodeAction {
409        start: Some(serialize_anchor(&action.range.start)),
410        end: Some(serialize_anchor(&action.range.end)),
411        lsp_action: serde_json::to_vec(&action.lsp_action).unwrap(),
412    }
413}
414
415pub fn deserialize_code_action(action: proto::CodeAction) -> Result<CodeAction> {
416    let start = action
417        .start
418        .and_then(deserialize_anchor)
419        .ok_or_else(|| anyhow!("invalid start"))?;
420    let end = action
421        .end
422        .and_then(deserialize_anchor)
423        .ok_or_else(|| anyhow!("invalid end"))?;
424    let lsp_action = serde_json::from_slice(&action.lsp_action)?;
425    Ok(CodeAction {
426        range: start..end,
427        lsp_action,
428    })
429}
430
431pub fn serialize_transaction(transaction: &Transaction) -> proto::Transaction {
432    proto::Transaction {
433        id: Some(serialize_local_timestamp(transaction.id)),
434        edit_ids: transaction
435            .edit_ids
436            .iter()
437            .copied()
438            .map(serialize_local_timestamp)
439            .collect(),
440        start: serialize_version(&transaction.start),
441        end: serialize_version(&transaction.end),
442        ranges: transaction.ranges.iter().map(serialize_range).collect(),
443    }
444}
445
446pub fn deserialize_transaction(transaction: proto::Transaction) -> Result<Transaction> {
447    Ok(Transaction {
448        id: deserialize_local_timestamp(
449            transaction
450                .id
451                .ok_or_else(|| anyhow!("missing transaction id"))?,
452        ),
453        edit_ids: transaction
454            .edit_ids
455            .into_iter()
456            .map(deserialize_local_timestamp)
457            .collect(),
458        start: deserialize_version(transaction.start.into()),
459        end: deserialize_version(transaction.end),
460        ranges: transaction
461            .ranges
462            .into_iter()
463            .map(deserialize_range)
464            .collect(),
465    })
466}
467
468pub fn serialize_local_timestamp(timestamp: clock::Local) -> proto::LocalTimestamp {
469    proto::LocalTimestamp {
470        replica_id: timestamp.replica_id as u32,
471        value: timestamp.value,
472    }
473}
474
475pub fn deserialize_local_timestamp(timestamp: proto::LocalTimestamp) -> clock::Local {
476    clock::Local {
477        replica_id: timestamp.replica_id as ReplicaId,
478        value: timestamp.value,
479    }
480}
481
482pub fn serialize_range(range: &Range<FullOffset>) -> proto::Range {
483    proto::Range {
484        start: range.start.0 as u64,
485        end: range.end.0 as u64,
486    }
487}
488
489pub fn deserialize_range(range: proto::Range) -> Range<FullOffset> {
490    FullOffset(range.start as usize)..FullOffset(range.end as usize)
491}
492
493pub fn deserialize_version(message: Vec<proto::VectorClockEntry>) -> clock::Global {
494    let mut version = clock::Global::new();
495    for entry in message {
496        version.observe(clock::Local {
497            replica_id: entry.replica_id as ReplicaId,
498            value: entry.timestamp,
499        });
500    }
501    version
502}
503
504pub fn serialize_version(version: &clock::Global) -> Vec<proto::VectorClockEntry> {
505    version
506        .iter()
507        .map(|entry| proto::VectorClockEntry {
508            replica_id: entry.replica_id as u32,
509            timestamp: entry.value,
510        })
511        .collect()
512}