fallow_extract/cache/
conversion.rs

1//! Conversion between [`ModuleInfo`](crate::ModuleInfo) and [`CachedModule`].
2//!
3//! Both functions convert between borrowed source structs and owned target structs
4//! (`&CachedModule -> ModuleInfo`, `&ModuleInfo -> CachedModule`). All `String` clones
5//! are structurally necessary: the cache store retains ownership of `CachedModule`
6//! entries (for persistence), and `ModuleInfo` must outlive the cache for the
7//! analysis pipeline. Eliminating these clones would require shared ownership
8//! (`Arc<str>`) across the entire extraction + analysis pipeline.
9
10use std::time::{SystemTime, UNIX_EPOCH};
11
12use oxc_span::Span;
13
14use crate::ExportName;
15use fallow_types::extract::{NamespaceObjectAlias, VisibilityTag};
16
17/// Seconds-since-Unix-epoch from the wall clock, saturating to 0 if the
18/// system clock is set before the epoch. Used as the LRU bookkeeping
19/// timestamp on `CachedModule.last_access_secs`. Wall-clock (not monotonic)
20/// is the right source here because the value persists across process
21/// invocations.
22#[must_use]
23pub fn current_unix_seconds() -> u64 {
24    SystemTime::now()
25        .duration_since(UNIX_EPOCH)
26        .map_or(0, |d| d.as_secs())
27}
28
29use super::types::{
30    CachedDynamicImport, CachedDynamicImportPattern, CachedExport, CachedImport,
31    CachedLocalTypeDeclaration, CachedMember, CachedModule, CachedNamespaceObjectAlias,
32    CachedPublicSignatureTypeReference, CachedReExport, CachedRequireCall, CachedSuppression,
33    CachedUnknownSuppressionKind, IMPORT_KIND_DEFAULT, IMPORT_KIND_NAMED, IMPORT_KIND_NAMESPACE,
34    IMPORT_KIND_SIDE_EFFECT,
35};
36
37/// Reconstruct a [`ModuleInfo`](crate::ModuleInfo) from a [`CachedModule`].
38#[must_use]
39pub fn cached_to_module(
40    cached: &CachedModule,
41    file_id: fallow_types::discover::FileId,
42) -> crate::ModuleInfo {
43    cached_to_module_opts(cached, file_id, true)
44}
45
46/// Reconstruct a [`ModuleInfo`](crate::ModuleInfo) from a [`CachedModule`], skipping
47/// the per-function complexity vec when `need_complexity` is `false`. Avoids the
48/// `Vec<FunctionComplexity>` clone on warm runs of commands (e.g. `fallow check`)
49/// that don't consume complexity, which adds up across tens of thousands of files.
50#[must_use]
51#[expect(
52    clippy::too_many_lines,
53    reason = "single flat field-by-field deserialization; splitting it harms readability"
54)]
55pub fn cached_to_module_opts(
56    cached: &CachedModule,
57    file_id: fallow_types::discover::FileId,
58    need_complexity: bool,
59) -> crate::ModuleInfo {
60    use crate::{
61        DynamicImportInfo, ExportInfo, ImportInfo, ImportedName, LocalTypeDeclaration, MemberInfo,
62        ModuleInfo, PublicSignatureTypeReference, ReExportInfo, RequireCallInfo,
63    };
64
65    let exports = cached
66        .exports
67        .iter()
68        .map(|e| ExportInfo {
69            name: if e.is_default {
70                ExportName::Default
71            } else {
72                ExportName::Named(e.name.clone())
73            },
74            local_name: e.local_name.clone(),
75            is_type_only: e.is_type_only,
76            is_side_effect_used: e.is_side_effect_used,
77            visibility: match e.visibility {
78                1 => VisibilityTag::Public,
79                2 => VisibilityTag::Internal,
80                3 => VisibilityTag::Beta,
81                4 => VisibilityTag::Alpha,
82                5 => VisibilityTag::ExpectedUnused,
83                _ => VisibilityTag::None,
84            },
85            span: Span::new(e.span_start, e.span_end),
86            members: e
87                .members
88                .iter()
89                .map(|m| MemberInfo {
90                    name: m.name.clone(),
91                    kind: m.kind,
92                    span: Span::new(m.span_start, m.span_end),
93                    has_decorator: m.has_decorator,
94                    decorator_names: m.decorator_names.clone(),
95                    is_instance_returning_static: m.is_instance_returning_static,
96                    is_self_returning: m.is_self_returning,
97                })
98                .collect(),
99            super_class: e.super_class.clone(),
100        })
101        .collect();
102
103    let imports = cached
104        .imports
105        .iter()
106        .map(|i| ImportInfo {
107            source: i.source.clone(),
108            imported_name: match i.kind {
109                IMPORT_KIND_DEFAULT => ImportedName::Default,
110                IMPORT_KIND_NAMESPACE => ImportedName::Namespace,
111                IMPORT_KIND_SIDE_EFFECT => ImportedName::SideEffect,
112                // IMPORT_KIND_NAMED (0) and any unknown value default to Named
113                _ => ImportedName::Named(i.imported_name.clone()),
114            },
115            local_name: i.local_name.clone(),
116            is_type_only: i.is_type_only,
117            from_style: i.from_style,
118            span: Span::new(i.span_start, i.span_end),
119            source_span: Span::new(i.source_span_start, i.source_span_end),
120        })
121        .collect();
122
123    let re_exports = cached
124        .re_exports
125        .iter()
126        .map(|r| ReExportInfo {
127            source: r.source.clone(),
128            imported_name: r.imported_name.clone(),
129            exported_name: r.exported_name.clone(),
130            is_type_only: r.is_type_only,
131            span: Span::new(r.span_start, r.span_end),
132        })
133        .collect();
134
135    let dynamic_imports = cached
136        .dynamic_imports
137        .iter()
138        .map(|d| DynamicImportInfo {
139            source: d.source.clone(),
140            span: Span::new(d.span_start, d.span_end),
141            destructured_names: d.destructured_names.clone(),
142            local_name: d.local_name.clone(),
143            is_speculative: d.is_speculative,
144        })
145        .collect();
146
147    let require_calls = cached
148        .require_calls
149        .iter()
150        .map(|r| RequireCallInfo {
151            source: r.source.clone(),
152            span: Span::new(r.span_start, r.span_end),
153            destructured_names: r.destructured_names.clone(),
154            local_name: r.local_name.clone(),
155        })
156        .collect();
157
158    let dynamic_import_patterns = cached
159        .dynamic_import_patterns
160        .iter()
161        .map(|p| crate::DynamicImportPattern {
162            prefix: p.prefix.clone(),
163            suffix: p.suffix.clone(),
164            span: Span::new(p.span_start, p.span_end),
165        })
166        .collect();
167
168    let suppressions = cached
169        .suppressions
170        .iter()
171        .map(|s| crate::suppress::Suppression {
172            line: s.line,
173            comment_line: s.comment_line,
174            kind: if s.kind == 0 {
175                None
176            } else {
177                crate::suppress::IssueKind::from_discriminant(s.kind)
178            },
179        })
180        .collect();
181
182    let unknown_suppression_kinds = cached
183        .unknown_suppression_kinds
184        .iter()
185        .map(|u| fallow_types::suppress::UnknownSuppressionKind {
186            comment_line: u.comment_line,
187            is_file_level: u.is_file_level,
188            token: u.token.clone(),
189        })
190        .collect();
191
192    ModuleInfo {
193        file_id,
194        exports,
195        imports,
196        re_exports,
197        dynamic_imports,
198        dynamic_import_patterns,
199        require_calls,
200        member_accesses: cached.member_accesses.clone(),
201        whole_object_uses: cached.whole_object_uses.clone(),
202        has_cjs_exports: cached.has_cjs_exports,
203        has_angular_component_template_url: cached.has_angular_component_template_url,
204        content_hash: cached.content_hash,
205        suppressions,
206        unknown_suppression_kinds,
207        unused_import_bindings: cached.unused_import_bindings.clone(),
208        type_referenced_import_bindings: cached.type_referenced_import_bindings.clone(),
209        value_referenced_import_bindings: cached.value_referenced_import_bindings.clone(),
210        line_offsets: cached.line_offsets.clone(),
211        complexity: if need_complexity {
212            cached.complexity.clone()
213        } else {
214            Vec::new()
215        },
216        flag_uses: cached.flag_uses.clone(),
217        class_heritage: cached.class_heritage.clone(),
218        local_type_declarations: cached
219            .local_type_declarations
220            .iter()
221            .map(|decl| LocalTypeDeclaration {
222                name: decl.name.clone(),
223                span: Span::new(decl.span_start, decl.span_end),
224            })
225            .collect(),
226        public_signature_type_references: cached
227            .public_signature_type_references
228            .iter()
229            .map(|reference| PublicSignatureTypeReference {
230                export_name: reference.export_name.clone(),
231                type_name: reference.type_name.clone(),
232                span: Span::new(reference.span_start, reference.span_end),
233            })
234            .collect(),
235        namespace_object_aliases: cached
236            .namespace_object_aliases
237            .iter()
238            .map(|alias| NamespaceObjectAlias {
239                via_export_name: alias.via_export_name.clone(),
240                suffix: alias.suffix.clone(),
241                namespace_local: alias.namespace_local.clone(),
242            })
243            .collect(),
244        iconify_prefixes: cached.iconify_prefixes.clone(),
245        auto_import_candidates: cached.auto_import_candidates.clone(),
246        directives: cached.directives.clone(),
247        security_sinks: cached.security_sinks.clone(),
248        security_sinks_skipped: cached.security_sinks_skipped,
249        tainted_bindings: cached.tainted_bindings.clone(),
250        sanitized_sink_args: cached.sanitized_sink_args.clone(),
251    }
252}
253
254/// Convert a [`ModuleInfo`](crate::ModuleInfo) to a [`CachedModule`] for storage.
255///
256/// `mtime_secs` and `file_size` come from `std::fs::metadata()` at parse time
257/// and enable fast cache validation on subsequent runs (skip file read when
258/// mtime+size match).
259#[must_use]
260#[expect(
261    clippy::too_many_lines,
262    reason = "single flat field-by-field serialization; splitting it harms readability"
263)]
264pub fn module_to_cached(
265    module: &crate::ModuleInfo,
266    mtime_secs: u64,
267    file_size: u64,
268) -> CachedModule {
269    CachedModule {
270        content_hash: module.content_hash,
271        mtime_secs,
272        file_size,
273        last_access_secs: current_unix_seconds(),
274        exports: module
275            .exports
276            .iter()
277            .map(|e| CachedExport {
278                name: match &e.name {
279                    ExportName::Named(n) => n.clone(),
280                    ExportName::Default => String::new(),
281                },
282                is_default: matches!(e.name, ExportName::Default),
283                is_type_only: e.is_type_only,
284                is_side_effect_used: e.is_side_effect_used,
285                visibility: e.visibility as u8,
286                local_name: e.local_name.clone(),
287                span_start: e.span.start,
288                span_end: e.span.end,
289                members: e
290                    .members
291                    .iter()
292                    .map(|m| CachedMember {
293                        name: m.name.clone(),
294                        kind: m.kind,
295                        span_start: m.span.start,
296                        span_end: m.span.end,
297                        has_decorator: m.has_decorator,
298                        decorator_names: m.decorator_names.clone(),
299                        is_instance_returning_static: m.is_instance_returning_static,
300                        is_self_returning: m.is_self_returning,
301                    })
302                    .collect(),
303                super_class: e.super_class.clone(),
304            })
305            .collect(),
306        imports: module
307            .imports
308            .iter()
309            .map(|i| {
310                let (kind, imported_name) = match &i.imported_name {
311                    crate::ImportedName::Named(n) => (IMPORT_KIND_NAMED, n.clone()),
312                    crate::ImportedName::Default => (IMPORT_KIND_DEFAULT, String::new()),
313                    crate::ImportedName::Namespace => (IMPORT_KIND_NAMESPACE, String::new()),
314                    crate::ImportedName::SideEffect => (IMPORT_KIND_SIDE_EFFECT, String::new()),
315                };
316                CachedImport {
317                    source: i.source.clone(),
318                    imported_name,
319                    local_name: i.local_name.clone(),
320                    is_type_only: i.is_type_only,
321                    from_style: i.from_style,
322                    kind,
323                    span_start: i.span.start,
324                    span_end: i.span.end,
325                    source_span_start: i.source_span.start,
326                    source_span_end: i.source_span.end,
327                }
328            })
329            .collect(),
330        re_exports: module
331            .re_exports
332            .iter()
333            .map(|r| CachedReExport {
334                source: r.source.clone(),
335                imported_name: r.imported_name.clone(),
336                exported_name: r.exported_name.clone(),
337                is_type_only: r.is_type_only,
338                span_start: r.span.start,
339                span_end: r.span.end,
340            })
341            .collect(),
342        dynamic_imports: module
343            .dynamic_imports
344            .iter()
345            .map(|d| CachedDynamicImport {
346                source: d.source.clone(),
347                span_start: d.span.start,
348                span_end: d.span.end,
349                destructured_names: d.destructured_names.clone(),
350                local_name: d.local_name.clone(),
351                is_speculative: d.is_speculative,
352            })
353            .collect(),
354        require_calls: module
355            .require_calls
356            .iter()
357            .map(|r| CachedRequireCall {
358                source: r.source.clone(),
359                span_start: r.span.start,
360                span_end: r.span.end,
361                destructured_names: r.destructured_names.clone(),
362                local_name: r.local_name.clone(),
363            })
364            .collect(),
365        member_accesses: module.member_accesses.clone(),
366        whole_object_uses: module.whole_object_uses.clone(),
367        dynamic_import_patterns: module
368            .dynamic_import_patterns
369            .iter()
370            .map(|p| CachedDynamicImportPattern {
371                prefix: p.prefix.clone(),
372                suffix: p.suffix.clone(),
373                span_start: p.span.start,
374                span_end: p.span.end,
375            })
376            .collect(),
377        has_cjs_exports: module.has_cjs_exports,
378        has_angular_component_template_url: module.has_angular_component_template_url,
379        unused_import_bindings: module.unused_import_bindings.clone(),
380        type_referenced_import_bindings: module.type_referenced_import_bindings.clone(),
381        value_referenced_import_bindings: module.value_referenced_import_bindings.clone(),
382        suppressions: module
383            .suppressions
384            .iter()
385            .map(|s| CachedSuppression {
386                line: s.line,
387                comment_line: s.comment_line,
388                kind: s
389                    .kind
390                    .map_or(0, crate::suppress::IssueKind::to_discriminant),
391            })
392            .collect(),
393        unknown_suppression_kinds: module
394            .unknown_suppression_kinds
395            .iter()
396            .map(|u| CachedUnknownSuppressionKind {
397                comment_line: u.comment_line,
398                is_file_level: u.is_file_level,
399                token: u.token.clone(),
400            })
401            .collect(),
402        line_offsets: module.line_offsets.clone(),
403        complexity: module.complexity.clone(),
404        flag_uses: module.flag_uses.clone(),
405        class_heritage: module.class_heritage.clone(),
406        local_type_declarations: module
407            .local_type_declarations
408            .iter()
409            .map(|decl| CachedLocalTypeDeclaration {
410                name: decl.name.clone(),
411                span_start: decl.span.start,
412                span_end: decl.span.end,
413            })
414            .collect(),
415        public_signature_type_references: module
416            .public_signature_type_references
417            .iter()
418            .map(|reference| CachedPublicSignatureTypeReference {
419                export_name: reference.export_name.clone(),
420                type_name: reference.type_name.clone(),
421                span_start: reference.span.start,
422                span_end: reference.span.end,
423            })
424            .collect(),
425        namespace_object_aliases: module
426            .namespace_object_aliases
427            .iter()
428            .map(|alias| CachedNamespaceObjectAlias {
429                via_export_name: alias.via_export_name.clone(),
430                suffix: alias.suffix.clone(),
431                namespace_local: alias.namespace_local.clone(),
432            })
433            .collect(),
434        iconify_prefixes: module.iconify_prefixes.clone(),
435        auto_import_candidates: module.auto_import_candidates.clone(),
436        directives: module.directives.clone(),
437        security_sinks: module.security_sinks.clone(),
438        security_sinks_skipped: module.security_sinks_skipped,
439        tainted_bindings: module.tainted_bindings.clone(),
440        sanitized_sink_args: module.sanitized_sink_args.clone(),
441    }
442}
fallow_extract/cache/conversion.rs

fallow_extract/cache/
conversion.rs
