-
Notifications
You must be signed in to change notification settings - Fork 243
/
entries.rs
161 lines (148 loc) · 5.5 KB
/
entries.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
// Copyright 2020 The Kythe Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::error::KytheError;
use crate::indexer::analyzers::ByteSpan;
use crate::writer::KytheWriter;
use sha2::{Digest, Sha256};
use storage_rust_proto::*;
/// A utility data structure for writing nodes and edges to a KytheWriter
pub struct EntryEmitter<'a> {
writer: &'a mut dyn KytheWriter,
}
impl<'a> EntryEmitter<'a> {
/// Create a new instance using the provided KytheWriter
pub fn new(writer: &'a mut dyn KytheWriter) -> Self {
Self { writer }
}
/// Creates a node with the provided arguments and emits it.
///
/// # Errors
/// If an error occurs while writing the entry, an error is returned.
pub fn emit_fact(
&mut self,
vname: &VName,
fact_name: &str,
fact_value: Vec<u8>,
) -> Result<(), KytheError> {
let mut entry = Entry::new();
entry.set_source(vname.clone());
entry.set_fact_name(fact_name.into());
entry.set_fact_value(fact_value);
self.writer.write_entry(entry)
}
/// Creates an edge of edge_kind between the source and target and emits it.
///
/// # Errors
/// If an error occurs while writing the entry, an error is returned.
pub fn emit_edge(
&mut self,
source: &VName,
target: &VName,
edge_kind: &str,
) -> Result<(), KytheError> {
let mut entry = Entry::new();
entry.set_source(source.clone());
entry.set_target(target.clone());
entry.set_edge_kind(edge_kind.into());
entry.set_fact_name("/".into());
self.writer.write_entry(entry)
}
/// Creates an anchor node with defines/binding edge to the target and emits
/// it.
///
/// # Errors
/// If an error occurs while writing the entry, an error is returned.
pub fn emit_anchor(
&mut self,
anchor_vname: &VName,
target_vname: &VName,
byte_start: u32,
byte_end: u32,
) -> Result<(), KytheError> {
self.emit_fact(anchor_vname, "/kythe/node/kind", b"anchor".to_vec())?;
self.emit_fact(
anchor_vname,
"/kythe/loc/start",
byte_start.to_string().into_bytes().to_vec(),
)?;
self.emit_fact(anchor_vname, "/kythe/loc/end", byte_end.to_string().into_bytes().to_vec())?;
self.emit_edge(anchor_vname, target_vname, "/kythe/edge/defines/binding")
}
/// Creates an anchor node with ref edge to the target and emits
/// it.
///
/// # Errors
/// If an error occurs while writing the entry, an error is returned.
pub fn emit_reference(
&mut self,
anchor_vname: &VName,
target_vname: &VName,
byte_span: ByteSpan,
) -> Result<(), KytheError> {
self.emit_fact(anchor_vname, "/kythe/node/kind", b"anchor".to_vec())?;
self.emit_fact(
anchor_vname,
"/kythe/loc/start",
byte_span.start_byte.to_string().into_bytes().to_vec(),
)?;
self.emit_fact(
anchor_vname,
"/kythe/loc/end",
byte_span.end_byte.to_string().into_bytes().to_vec(),
)?;
self.emit_edge(anchor_vname, target_vname, "/kythe/edge/ref")
}
/// Creates a diagnostic node with a tagged edge from an anchor or file
/// vname to the node Accepts a message, optional details, and an
/// optional url
///
/// # Errors
/// If an error occurs while writing the entry, an error is returned.
pub fn emit_diagnostic(
&mut self,
source_vname: &VName,
message: &str,
details: Option<&str>,
url: Option<&str>,
) -> Result<(), KytheError> {
// Combine diagnostic message fields and create sha256 sum
let combined_description =
format!("{}||{}||{}", message, details.unwrap_or_default(), url.unwrap_or_default());
let mut sha256 = Sha256::new();
sha256.update(combined_description.as_str().as_bytes());
let bytes = sha256.finalize();
let sha256sum = hex::encode(bytes);
// Use source_vname signature and sha256 sum to generate diagnostic signature
let mut diagnostic_vname = source_vname.clone();
diagnostic_vname.set_signature(format!("{}_{}", source_vname.get_signature(), sha256sum));
// Emit diagnostic node
self.emit_fact(&diagnostic_vname, "/kythe/node/kind", b"diagnostic".to_vec())?;
self.emit_fact(&diagnostic_vname, "/kythe/message", message.as_bytes().to_vec())?;
if details.is_some() {
self.emit_fact(
&diagnostic_vname,
"/kythe/details",
details.unwrap().as_bytes().to_vec(),
)?;
}
if url.is_some() {
self.emit_fact(
&diagnostic_vname,
"/kythe/context/url",
url.unwrap().as_bytes().to_vec(),
)?;
}
self.emit_edge(source_vname, &diagnostic_vname, "/kythe/edge/tagged")
}
}