magellan 3.3.1

Deterministic codebase mapping tool for local development
Documentation
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
//! Reference node operations for CodeGraph
//!
//! Handles reference node CRUD operations and REFERENCES edge management.

use anyhow::Result;
use sqlitegraph::{
    BackendDirection, EdgeSpec, GraphBackend, NeighborQuery, NodeId, NodeSpec, SnapshotId,
};
use std::collections::HashMap;
use std::path::PathBuf;
use std::sync::Arc;

use crate::graph::schema::ReferenceNode;
use crate::ingest::c::CParser;
use crate::ingest::cpp::CppParser;
use crate::ingest::java::JavaParser;
use crate::ingest::javascript::JavaScriptParser;
use crate::ingest::pool;
use crate::ingest::python::PythonParser;
use crate::ingest::typescript::TypeScriptParser;
use crate::ingest::{detect::Language, detect_language, Parser};
use crate::references::ReferenceFact;

/// Reference operations for CodeGraph
pub struct ReferenceOps {
    pub backend: Arc<dyn GraphBackend>,
}

impl ReferenceOps {
    /// Delete all Reference nodes that belong to a specific file path.
    ///
    /// Determinism: collects candidate entity IDs, sorts ascending, deletes in that order.
    pub fn delete_references_in_file(&self, path: &str) -> Result<usize> {
        let entity_ids = self.backend.entity_ids()?;
        let snapshot = SnapshotId::current();

        let mut to_delete: Vec<i64> = Vec::new();
        for entity_id in entity_ids {
            let node = match self.backend.get_node(snapshot, entity_id) {
                Ok(n) => n,
                Err(_) => continue,
            };

            if node.kind != "Reference" {
                continue;
            }

            let reference_node: ReferenceNode = match serde_json::from_value(node.data) {
                Ok(value) => value,
                Err(_) => continue,
            };

            if reference_node.file == path {
                to_delete.push(entity_id);
            }
        }

        to_delete.sort_unstable();

        for id in &to_delete {
            self.backend.delete_entity(*id)?;
        }

        Ok(to_delete.len())
    }
    /// Index references for a file into the graph
    ///
    /// # Status
    ///
    /// **LEGACY METHOD** - Superseded by `index_references_with_symbol_id()` which supports
    /// both SymbolId and FQN lookups for v1.5+ compatibility. Kept for potential future use.
    ///
    /// # Behavior
    /// 1. Parse symbols from source (to get correct spans for filtering)
    /// 2. Extract references to those symbols
    /// 3. Insert Reference nodes
    /// 4. Create REFERENCES edges from Reference to Symbol
    ///
    /// # Arguments
    /// * `path` - File path
    /// * `source` - File contents as bytes
    /// * `symbol_fqn_to_id` - Map of FQNs to their node IDs (ALL symbols in database)
    #[expect(dead_code)] // LEGACY: Superseded by index_references_with_symbol_id (v1.5). Kept for potential future use. See: https://github.com/oldnordic/magellan/issues
    pub fn index_references(
        &self,
        path: &str,
        source: &[u8],
        symbol_fqn_to_id: &HashMap<String, i64>,
    ) -> Result<usize> {
        let path_buf = PathBuf::from(path);
        let language = detect_language(&path_buf);

        // Build symbol_facts from ALL symbols in the database
        // This enables cross-file reference matching across all files in the codebase
        // Note: We iterate ALL entity_ids, not just symbols from the current file
        let mut all_symbol_facts: Vec<crate::ingest::SymbolFact> = Vec::new();

        // Get all entity IDs from the graph
        let entity_ids = match self.backend.entity_ids() {
            Ok(ids) => ids,
            Err(_) => return Ok(0), // If we can't get entities, no references to index
        };

        // Iterate through all entities and find Symbol nodes
        let snapshot = SnapshotId::current();
        for entity_id in entity_ids {
            if let Ok(node) = self.backend.get_node(snapshot, entity_id) {
                // Check if this is a Symbol node by looking at the kind field
                if node.kind == "Symbol" {
                    if let Ok(symbol_node) = serde_json::from_value::<
                        crate::graph::schema::SymbolNode,
                    >(node.data.clone())
                    {
                        // Convert SymbolNode to SymbolFact
                        if let Some(name) = &symbol_node.name {
                            // Validate file_path is valid UTF-8 before creating SymbolFact
                            let file_path_str = node.file_path.as_deref().unwrap_or("");
                            if std::str::from_utf8(file_path_str.as_bytes()).is_ok() {
                                // Extract FQN, fall back to name for backward compatibility
                                let fqn = symbol_node
                                    .fqn
                                    .clone()
                                    .or(symbol_node.name.clone())
                                    .unwrap_or_default();

                                all_symbol_facts.push(crate::ingest::SymbolFact {
                                    file_path: PathBuf::from(file_path_str),
                                    kind: match symbol_node.kind_normalized.as_deref() {
                                        Some("fn") => crate::ingest::SymbolKind::Function,
                                        Some("method") => crate::ingest::SymbolKind::Method,
                                        Some("struct") => crate::ingest::SymbolKind::Class,
                                        Some("enum") => crate::ingest::SymbolKind::Enum,
                                        Some("trait") => crate::ingest::SymbolKind::Interface,
                                        Some("mod") => crate::ingest::SymbolKind::Module,
                                        _ => crate::ingest::SymbolKind::Unknown,
                                    },
                                    kind_normalized: symbol_node
                                        .kind_normalized
                                        .clone()
                                        .unwrap_or(symbol_node.kind.clone()),
                                    name: Some(name.clone()),
                                    fqn: if fqn.is_empty() { None } else { Some(fqn) },
                                    canonical_fqn: None,
                                    display_fqn: None,
                                    byte_start: symbol_node.byte_start,
                                    byte_end: symbol_node.byte_end,
                                    start_line: symbol_node.start_line,
                                    start_col: symbol_node.start_col,
                                    end_line: symbol_node.end_line,
                                    end_col: symbol_node.end_col,
                                });
                            }
                        }
                    }
                }
            }
        }

        // Extract references using language-specific parser
        // Pass all_symbol_facts to enable cross-file reference matching
        let references = match language {
            Some(Language::Rust) => {
                let mut parser = Parser::new()?;
                parser.extract_references(path_buf.clone(), source, &all_symbol_facts)
            }
            Some(Language::Python) => {
                let mut parser = PythonParser::new()?;
                parser.extract_references(path_buf.clone(), source, &all_symbol_facts)
            }
            Some(Language::C) => {
                let mut parser = CParser::new()?;
                parser.extract_references(path_buf.clone(), source, &all_symbol_facts)
            }
            Some(Language::Cpp) => {
                let mut parser = CppParser::new()?;
                parser.extract_references(path_buf.clone(), source, &all_symbol_facts)
            }
            Some(Language::Java) => {
                let mut parser = JavaParser::new()?;
                parser.extract_references(path_buf.clone(), source, &all_symbol_facts)
            }
            Some(Language::JavaScript) => {
                let mut parser = JavaScriptParser::new()?;
                parser.extract_references(path_buf.clone(), source, &all_symbol_facts)
            }
            Some(Language::TypeScript) => {
                let mut parser = TypeScriptParser::new()?;
                parser.extract_references(path_buf.clone(), source, &all_symbol_facts)
            }
            None => Vec::new(),
        };

        // Insert reference nodes and REFERENCES edges
        for reference in &references {
            if let Some(&target_symbol_id) = symbol_fqn_to_id.get(&reference.referenced_symbol) {
                let reference_id = self.insert_reference_node(reference)?;
                self.insert_references_edge(
                    reference_id,
                    NodeId::from(target_symbol_id),
                    reference,
                )?;
            }
        }

        Ok(references.len())
    }

    /// Index references with dual SymbolId and FQN lookup support
    ///
    /// # Arguments
    /// * `path` - File path
    /// * `source` - File contents as bytes
    /// * `symbol_id_to_id` - Map of SymbolId to entity_id (primary lookup)
    /// * `fqn_to_id` - Map of FQN to entity_id (fallback for backward compatibility)
    ///
    /// # Returns
    /// Number of references indexed
    pub fn index_references_with_symbol_id(
        &self,
        path: &str,
        source: &[u8],
        symbol_id_to_id: &HashMap<String, i64>,
        fqn_to_id: &HashMap<String, i64>,
        all_symbol_facts: &[crate::ingest::SymbolFact],
    ) -> Result<usize> {
        let path_buf = PathBuf::from(path);
        let language = detect_language(&path_buf);

        // Extract references using parser pool (was creating fresh parsers per file)
        let references = match language {
            Some(Language::Rust) => pool::with_parser_opt(Language::Rust, |opt_parser| {
                let parser = opt_parser
                    .take()
                    .expect("Parser pool corruption: parser was None"); // M-UNWRAP: thread-local parser pool guarantees initialized parser
                let mut wrapper = Parser::from_parser(parser);
                let result =
                    wrapper.extract_references(path_buf.clone(), source, &all_symbol_facts);
                *opt_parser = Some(wrapper.parser);
                result
            })?,
            Some(Language::Python) => pool::with_parser_opt(Language::Python, |opt_parser| {
                let parser = opt_parser
                    .take()
                    .expect("Parser pool corruption: parser was None"); // M-UNWRAP: thread-local parser pool guarantees initialized parser
                let mut wrapper = PythonParser::from_parser(parser);
                let result =
                    wrapper.extract_references(path_buf.clone(), source, &all_symbol_facts);
                *opt_parser = Some(wrapper.parser);
                result
            })?,
            Some(Language::C) => pool::with_parser_opt(Language::C, |opt_parser| {
                let parser = opt_parser
                    .take()
                    .expect("Parser pool corruption: parser was None"); // M-UNWRAP: thread-local parser pool guarantees initialized parser
                let mut wrapper = CParser::from_parser(parser);
                let result =
                    wrapper.extract_references(path_buf.clone(), source, &all_symbol_facts);
                *opt_parser = Some(wrapper.parser);
                result
            })?,
            Some(Language::Cpp) => pool::with_parser_opt(Language::Cpp, |opt_parser| {
                let parser = opt_parser
                    .take()
                    .expect("Parser pool corruption: parser was None"); // M-UNWRAP: thread-local parser pool guarantees initialized parser
                let mut wrapper = CppParser::from_parser(parser);
                let result =
                    wrapper.extract_references(path_buf.clone(), source, &all_symbol_facts);
                *opt_parser = Some(wrapper.parser);
                result
            })?,
            Some(Language::Java) => pool::with_parser_opt(Language::Java, |opt_parser| {
                let parser = opt_parser
                    .take()
                    .expect("Parser pool corruption: parser was None"); // M-UNWRAP: thread-local parser pool guarantees initialized parser
                let mut wrapper = JavaParser::from_parser(parser);
                let result =
                    wrapper.extract_references(path_buf.clone(), source, &all_symbol_facts);
                *opt_parser = Some(wrapper.parser);
                result
            })?,
            Some(Language::JavaScript) => {
                pool::with_parser_opt(Language::JavaScript, |opt_parser| {
                    let parser = opt_parser
                        .take()
                        .expect("Parser pool corruption: parser was None"); // M-UNWRAP: thread-local parser pool guarantees initialized parser
                    let mut wrapper = JavaScriptParser::from_parser(parser);
                    let result =
                        wrapper.extract_references(path_buf.clone(), source, &all_symbol_facts);
                    *opt_parser = Some(wrapper.parser);
                    result
                })?
            }
            Some(Language::TypeScript) => {
                pool::with_parser_opt(Language::TypeScript, |opt_parser| {
                    let parser = opt_parser
                        .take()
                        .expect("Parser pool corruption: parser was None"); // M-UNWRAP: thread-local parser pool guarantees initialized parser
                    let mut wrapper = TypeScriptParser::from_parser(parser);
                    let result =
                        wrapper.extract_references(path_buf.clone(), source, &all_symbol_facts);
                    *opt_parser = Some(wrapper.parser);
                    result
                })?
            }
            None => Vec::new(),
        };

        // Insert reference nodes and REFERENCES edges
        for reference in &references {
            let target_symbol_id = symbol_id_to_id
                .get(&reference.referenced_symbol)
                .or_else(|| fqn_to_id.get(&reference.referenced_symbol));

            if let Some(&target_symbol_id) = target_symbol_id {
                let reference_id = self.insert_reference_node(reference)?;
                self.insert_references_edge(
                    reference_id,
                    NodeId::from(target_symbol_id),
                    reference,
                )?;
            }
        }

        Ok(references.len())
    }

    /// Query all references to a specific symbol
    ///
    /// # Arguments
    /// * `symbol_id` - Node ID of the target symbol
    ///
    /// # Returns
    /// Vector of ReferenceFact for all references to the symbol
    pub fn references_to_symbol(&mut self, symbol_id: i64) -> Result<Vec<ReferenceFact>> {
        // Query incoming REFERENCES edges
        let snapshot = SnapshotId::current();
        let neighbor_ids = self.backend.neighbors(
            snapshot,
            symbol_id,
            NeighborQuery {
                direction: BackendDirection::Incoming,
                edge_type: Some("REFERENCES".to_string()),
            },
        )?;

        let mut references = Vec::new();
        for reference_node_id in neighbor_ids {
            if let Ok(Some(reference)) = self.reference_fact_from_node(reference_node_id) {
                references.push(reference);
            }
        }

        Ok(references)
    }

    /// Insert a reference node from ReferenceFact
    fn insert_reference_node(&self, reference: &ReferenceFact) -> Result<NodeId> {
        let reference_node = ReferenceNode {
            file: reference.file_path.to_string_lossy().to_string(),
            byte_start: reference.byte_start as u64,
            byte_end: reference.byte_end as u64,
            start_line: reference.start_line as u64,
            start_col: reference.start_col as u64,
            end_line: reference.end_line as u64,
            end_col: reference.end_col as u64,
        };

        let node_spec = NodeSpec {
            kind: "Reference".to_string(),
            name: format!("ref to {}", reference.referenced_symbol),
            file_path: Some(reference.file_path.to_string_lossy().to_string()),
            data: serde_json::to_value(reference_node)?,
        };

        let id = self.backend.insert_node(node_spec)?;
        Ok(NodeId::from(id))
    }

    /// Insert REFERENCES edge from reference to symbol
    fn insert_references_edge(
        &self,
        reference_id: NodeId,
        symbol_id: NodeId,
        reference: &ReferenceFact,
    ) -> Result<()> {
        let edge_spec = EdgeSpec {
            from: reference_id.as_i64(),
            to: symbol_id.as_i64(),
            edge_type: "REFERENCES".to_string(),
            data: serde_json::json!({
                "byte_start": reference.byte_start,
                "byte_end": reference.byte_end,
                "start_line": reference.start_line,
                "start_col": reference.start_col,
                "end_line": reference.end_line,
                "end_col": reference.end_col,
            }),
        };

        self.backend.insert_edge(edge_spec)?;
        Ok(())
    }

    /// Convert a reference node to ReferenceFact
    fn reference_fact_from_node(&self, node_id: i64) -> Result<Option<ReferenceFact>> {
        let snapshot = SnapshotId::current();
        let node = self.backend.get_node(snapshot, node_id)?;

        let reference_node: Option<ReferenceNode> = serde_json::from_value(node.data).ok();

        let reference_node = match reference_node {
            Some(n) => n,
            None => return Ok(None),
        };

        // Extract symbol name from node.name (format: "ref to {symbol_name}")
        let referenced_symbol = node.name.strip_prefix("ref to ").unwrap_or("").to_string();

        Ok(Some(ReferenceFact {
            file_path: PathBuf::from(&reference_node.file),
            referenced_symbol,
            byte_start: reference_node.byte_start as usize,
            byte_end: reference_node.byte_end as usize,
            start_line: reference_node.start_line as usize,
            start_col: reference_node.start_col as usize,
            end_line: reference_node.end_line as usize,
            end_col: reference_node.end_col as usize,
        }))
    }
}

#[cfg(test)]
mod tests {
    use crate::graph::schema::SymbolNode;
    use sqlitegraph::{GraphBackend, SnapshotId};
    use std::collections::HashMap;

    #[test]
    fn test_index_references_with_symbol_id_uses_fqn_fallback() {
        let temp_dir = tempfile::TempDir::new().unwrap();
        let db_path = temp_dir.path().join("test.db");
        let mut graph = crate::CodeGraph::open(&db_path).unwrap();

        let test_file = temp_dir.path().join("test.rs");
        std::fs::write(
            &test_file,
            r#"
fn foo() {}

fn bar() {
    foo();
}
"#,
        )
        .unwrap();

        let path_str = test_file.to_string_lossy().to_string();
        let source = std::fs::read(&test_file).unwrap();
        graph.index_file(&path_str, &source).unwrap();

        let mut symbol_id_to_id: HashMap<String, i64> = HashMap::new();
        let mut fqn_to_id: HashMap<String, i64> = HashMap::new();

        let entity_ids = graph.files.backend.entity_ids().unwrap();
        let snapshot = SnapshotId::current();
        for entity_id in entity_ids {
            if let Ok(node) = graph.files.backend.get_node(snapshot, entity_id) {
                if node.kind == "Symbol" {
                    if let Ok(symbol_node) = serde_json::from_value::<SymbolNode>(node.data) {
                        if let Some(symbol_id) = symbol_node.symbol_id {
                            symbol_id_to_id.insert(symbol_id, entity_id);
                        }

                        let fqn = symbol_node.fqn.or(symbol_node.name).unwrap_or_default();

                        if !fqn.is_empty() {
                            fqn_to_id.insert(fqn, entity_id);
                        }
                    }
                }
            }
        }

        let all_symbol_facts = graph.symbols.lookup.all_symbol_facts();
        let count = graph
            .references
            .index_references_with_symbol_id(
                &path_str,
                &source,
                &symbol_id_to_id,
                &fqn_to_id,
                &all_symbol_facts,
            )
            .unwrap();

        assert!(count > 0, "Expected at least one reference to be indexed");
    }
}