This repository was archived by the owner on Sep 9, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 162
Expand file tree
/
Copy pathquery.rs
More file actions
325 lines (292 loc) · 10.3 KB
/
query.rs
File metadata and controls
325 lines (292 loc) · 10.3 KB
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
// -*- coding: utf-8 -*-
// ------------------------------------------------------------------------------------------------
// Copyright © 2023, stack-graphs authors.
// Licensed under either of Apache License, Version 2.0, or MIT license, at your option.
// Please see the LICENSE-APACHE or LICENSE-MIT files in this distribution for license details.
// ------------------------------------------------------------------------------------------------
use std::path::Path;
use std::path::PathBuf;
use clap::Args;
use clap::Parser;
use clap::Subcommand;
use clap::ValueHint;
use stack_graphs::stitching::ForwardPartialPathStitcher;
use stack_graphs::stitching::Stats as StitchingStats;
use stack_graphs::stitching::StitcherConfig;
use stack_graphs::storage::FileStatus;
use stack_graphs::storage::SQLiteReader;
use thiserror::Error;
use tree_sitter_graph::parse_error::Excerpt;
use crate::cli::util::print_database_stats;
use crate::cli::util::print_stitching_stats;
use crate::cli::util::reporter::ConsoleReporter;
use crate::cli::util::reporter::Reporter;
use crate::cli::util::sha1;
use crate::cli::util::wait_for_input;
use crate::cli::util::SourcePosition;
use crate::cli::util::SourceSpan;
use crate::loader::FileReader;
use crate::CancellationFlag;
use crate::NoCancellation;
#[derive(Args)]
pub struct QueryArgs {
/// Wait for user input before starting analysis. Useful for profiling.
#[clap(long)]
pub wait_at_start: bool,
#[clap(long)]
pub stats: bool,
#[clap(subcommand)]
target: Target,
}
impl QueryArgs {
pub fn run(self, db_path: &Path) -> anyhow::Result<()> {
if self.wait_at_start {
wait_for_input()?;
}
let mut db = SQLiteReader::open(&db_path)?;
let stitching_stats = self.target.run(&mut db, self.stats)?;
if self.stats {
println!();
print_stitching_stats(stitching_stats);
println!();
print_database_stats(db.stats());
}
Ok(())
}
}
#[derive(Subcommand)]
pub enum Target {
Definition(Definition),
}
impl Target {
fn run(self, db: &mut SQLiteReader, collect_stats: bool) -> anyhow::Result<StitchingStats> {
let reporter = ConsoleReporter::details();
let mut querier = Querier::new(db, &reporter);
querier.set_collect_stats(collect_stats);
match self {
Self::Definition(cmd) => cmd.run(&mut querier)?,
}
Ok(querier.into_stats())
}
}
#[derive(Parser)]
pub struct Definition {
/// Reference source positions, formatted as PATH:LINE:COLUMN.
#[clap(
value_name = "SOURCE_POSITION",
required = true,
value_hint = ValueHint::AnyPath,
value_parser,
)]
pub references: Vec<SourcePosition>,
}
impl Definition {
pub fn run(self, querier: &mut Querier) -> anyhow::Result<()> {
let cancellation_flag = NoCancellation;
let mut file_reader = FileReader::new();
for mut reference in self.references {
reference.canonicalize()?;
let results = querier.definitions(reference.clone(), &cancellation_flag)?;
let numbered = results.len() > 1;
let indent = if numbered { 6 } else { 0 };
if numbered {
println!("found {} references at position", results.len());
}
for (
idx,
QueryResult {
source: reference,
targets: definitions,
},
) in results.into_iter().enumerate()
{
if numbered {
println!("{:4}: queried reference", idx);
} else {
println!("queried reference");
}
println!(
"{}",
Excerpt::from_source(
&reference.path,
file_reader.get(&reference.path).unwrap_or_default(),
reference.first_line(),
reference.first_line_column_range(),
indent
)
);
match definitions.len() {
0 => println!("{}has no definitions", " ".repeat(indent)),
1 => println!("{}has definition", " ".repeat(indent)),
n => println!("{}has {} definitions", " ".repeat(indent), n),
}
for definition in definitions.into_iter() {
print!(
"{}",
Excerpt::from_source(
&definition.path,
file_reader.get(&definition.path).unwrap_or_default(),
definition.first_line(),
definition.first_line_column_range(),
indent
)
);
}
}
}
Ok(())
}
}
pub struct Querier<'a> {
db: &'a mut SQLiteReader,
reporter: &'a dyn Reporter,
stats: Option<StitchingStats>,
}
impl<'a> Querier<'a> {
pub fn new(db: &'a mut SQLiteReader, reporter: &'a dyn Reporter) -> Self {
Self {
db,
reporter,
stats: None,
}
}
pub fn set_collect_stats(&mut self, collect_stats: bool) {
if !collect_stats {
self.stats = None;
} else if self.stats.is_none() {
self.stats = Some(StitchingStats::default());
}
}
pub fn definitions(
&mut self,
reference: SourcePosition,
cancellation_flag: &dyn CancellationFlag,
) -> Result<Vec<QueryResult>> {
let log_path = PathBuf::from(reference.to_string());
let mut file_reader = FileReader::new();
let tag = file_reader.get(&reference.path).ok().map(sha1);
match self
.db
.status_for_file(&reference.path.to_string_lossy(), tag.as_ref())?
{
FileStatus::Indexed => {}
_ => {
self.reporter.started(&log_path);
self.reporter.failed(&log_path, "file not indexed", None);
return Ok(Default::default());
}
}
self.reporter.started(&log_path);
self.db
.load_graph_for_file(&reference.path.to_string_lossy())?;
let (graph, _, _) = self.db.get();
let starting_nodes = reference.iter_references(graph).collect::<Vec<_>>();
if starting_nodes.is_empty() {
self.reporter
.cancelled(&log_path, "no references at location", None);
return Ok(Default::default());
}
let mut result = Vec::new();
for (node, span) in starting_nodes {
let reference_span = SourceSpan {
path: reference.path.clone(),
span,
};
let mut reference_paths = Vec::new();
let stitcher_config = StitcherConfig::default()
// always detect similar paths, we don't know the language configurations for the data in the database
.with_detect_similar_paths(true)
.with_collect_stats(self.stats.is_some());
let ref_result = ForwardPartialPathStitcher::find_all_complete_partial_paths(
self.db,
std::iter::once(node),
stitcher_config,
&cancellation_flag,
|_g, _ps, p| {
reference_paths.push(p.clone());
},
);
match ref_result {
Ok(ref_stats) => {
if let Some(stats) = &mut self.stats {
*stats += ref_stats
}
}
Err(err) => {
self.reporter.failed(&log_path, "query timed out", None);
return Err(err.into());
}
}
let (graph, partials, _) = self.db.get();
let mut actual_paths = Vec::new();
for reference_path in &reference_paths {
if let Err(err) = cancellation_flag.check("shadowing") {
self.reporter.failed(&log_path, "query timed out", None);
return Err(err.into());
}
if reference_paths
.iter()
.all(|other| !other.shadows(partials, reference_path))
{
actual_paths.push(reference_path.clone());
}
}
let definitions = actual_paths
.into_iter()
.filter_map(|path| {
let span = match graph.source_info(path.end_node) {
Some(p) => p.span.clone(),
None => return None,
};
let path = match graph[path.end_node].id().file() {
Some(f) => PathBuf::from(graph[f].name()),
None => return None,
};
Some(SourceSpan { path, span })
})
.collect::<Vec<_>>();
result.push(QueryResult {
source: reference_span,
targets: definitions,
});
}
let count: usize = result.iter().map(|r| r.targets.len()).sum();
self.reporter.succeeded(
&log_path,
&format!(
"found {} definitions for {} references",
count,
result.len()
),
None,
);
Ok(result)
}
pub fn into_stats(self) -> StitchingStats {
self.stats.unwrap_or_default()
}
}
#[derive(Debug, Error)]
pub enum QueryError {
#[error("cancelled at {0}")]
Cancelled(&'static str),
#[error("failed to read file")]
ReadError(#[from] std::io::Error),
#[error(transparent)]
StorageError(#[from] stack_graphs::storage::StorageError),
}
impl From<stack_graphs::CancellationError> for QueryError {
fn from(value: stack_graphs::CancellationError) -> Self {
Self::Cancelled(value.0)
}
}
impl From<crate::CancellationError> for QueryError {
fn from(value: crate::CancellationError) -> Self {
Self::Cancelled(value.0)
}
}
pub struct QueryResult {
pub source: SourceSpan,
pub targets: Vec<SourceSpan>,
}
type Result<T> = std::result::Result<T, QueryError>;