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