integrate macro scanning with vscode extension

Author: lzoghbi

lang_server/src/request.rs

@@ -133,7 +133,7 @@ impl ScanCommandResponse {
 
 /// Scan crate in root path and get crate stats
 fn get_simple_scan_results(path: &Path) -> CrateStats {
-    let res = get_crate_stats_default(path.to_path_buf(), false, false);
+    let res = get_crate_stats_default(path.to_path_buf(), false, true);
     info!("Finished scanning. Found {} effects.", res.effects.len());
 
     res

lang_server/src/server.rs

@@ -112,12 +112,8 @@ fn runner(
     let root_crate_path = std::path::PathBuf::from_str(root_uri.path())?;
     info!("Crate path received in cargo-scan LSP server: {}", root_crate_path.display());
 
-    let scan_res = scanner::scan_crate(
-        &root_crate_path,
-        effect::DEFAULT_EFFECT_TYPES,
-        false,
-        false,
-    )?;
+    let scan_res =
+        scanner::scan_crate(&root_crate_path, effect::DEFAULT_EFFECT_TYPES, false, true)?;
 
     info!("Starting main server loop\n");
     let mut audit_file: Option<AuditFile> = None;

src/audit_chain.rs

@@ -455,6 +455,7 @@ fn make_new_audit_file(
     audit_type: DefaultAuditType,
     relevant_effects: &[EffectType],
     quick_mode: bool,
+    expand_macro: bool,
 ) -> Result<()> {
     let audit_file_path = PathBuf::from(format!(
         "{}/{}-{}.audit",
@@ -503,6 +504,7 @@ fn make_new_audit_file(
         audit_type,
         relevant_effects,
         quick_mode,
+        expand_macro,
     )?;
     audit_file.save_to_file(audit_file_path.clone())?;
 
@@ -515,6 +517,7 @@ pub fn create_new_audit_chain(
     args: Create,
     crate_download_path: &str,
     quick_mode: bool,
+    expand_macro: bool,
 ) -> Result<AuditChain> {
     info!("Creating audit chain");
     let mut chain = AuditChain::new(
@@ -572,6 +575,7 @@ pub fn create_new_audit_chain(
             audit_type,
             &args.effect_types,
             quick_mode,
+            expand_macro,
         )?;
     }
 

src/audit_file.rs

@@ -538,12 +538,14 @@ impl AuditFile {
         crate_path: &FilePath,
         relevant_effects: &[EffectType],
         quick_mode: bool,
+        expand_macro: bool,
     ) -> Result<AuditFile> {
         Self::new_caller_checked_default_with_sinks(
             crate_path,
             HashSet::new(),
             relevant_effects,
             quick_mode,
+            expand_macro,
         )
     }
 
@@ -567,13 +569,14 @@ impl AuditFile {
         sinks: HashSet<CanonicalPath>,
         relevant_effects: &[EffectType],
         quick: bool,
+        expand_macro: bool,
     ) -> Result<AuditFile> {
         Self::new_caller_checked_default_with_sinks_and_results(
             crate_path,
             sinks,
             relevant_effects,
             quick,
-            false,
+            expand_macro,
         )
         .map(|x| x.0)
     }
@@ -621,6 +624,7 @@ impl AuditFile {
         sinks: HashSet<CanonicalPath>,
         relevant_effects: &[EffectType],
         quick: bool,
+        expand_macro: bool,
     ) -> Result<AuditFile> {
         let mut audit_file =
             AuditFile::empty(crate_path.to_path_buf(), relevant_effects.to_vec())?;
@@ -631,7 +635,7 @@ impl AuditFile {
             ident_sinks,
             relevant_effects,
             quick,
-            false,
+            expand_macro,
         )?;
         audit_file.set_base_audit_trees(scan_res.effects_set());
 
@@ -643,9 +647,15 @@ impl AuditFile {
         sinks: HashSet<CanonicalPath>,
         relevant_effects: &[EffectType],
         quick: bool,
+        expand_macro: bool,
     ) -> Result<AuditFile> {
-        let (mut audit_file, _scan_res) =
-            Self::scan_with_sinks(crate_path, sinks, relevant_effects, quick, false)?;
+        let (mut audit_file, _scan_res) = Self::scan_with_sinks(
+            crate_path,
+            sinks,
+            relevant_effects,
+            quick,
+            expand_macro,
+        )?;
         for (_, mut t) in audit_file.audit_trees.iter_mut() {
             if let EffectTree::Leaf(_, a) = &mut t {
                 *a = SafetyAnnotation::Safe;
@@ -661,6 +671,7 @@ impl AuditFile {
         audit_type: DefaultAuditType,
         relevant_effects: &[EffectType],
         quick: bool,
+        expand_macro: bool,
     ) -> Result<AuditFile> {
         match audit_type {
             DefaultAuditType::CallerChecked => {
@@ -669,19 +680,22 @@ impl AuditFile {
                     sinks,
                     relevant_effects,
                     quick,
+                    expand_macro,
                 )
             }
             DefaultAuditType::Empty => Self::new_empty_default_with_sinks(
                 crate_path,
                 sinks,
                 relevant_effects,
                 quick,
+                expand_macro,
             ),
             DefaultAuditType::Safe => Self::new_safe_default_with_sinks(
                 crate_path,
                 sinks,
                 relevant_effects,
                 quick,
+                expand_macro,
             ),
         }
     }

src/auditing/audit.rs

@@ -468,6 +468,7 @@ pub fn audit_pub_fn(
     sink_ident: &Sink,
     config: &Config,
     quick_mode: bool,
+    expand_macro: bool,
 ) -> Result<HashSet<CanonicalPath>> {
     let sink_crate = sink_ident
         .first_ident()
@@ -484,7 +485,7 @@ pub fn audit_pub_fn(
         &new_audit_file.base_dir,
         &prev_audit_file.scanned_effects,
         quick_mode,
-        false,
+        expand_macro,
     )?;
     let sink_fn = CanonicalPath::new(sink_ident.as_str());
     loop {
@@ -515,7 +516,7 @@ pub fn audit_pub_fn(
                         ))
                     }
                 };
-                audit_pub_fn(chain, child_sink, config, quick_mode)?;
+                audit_pub_fn(chain, child_sink, config, quick_mode, expand_macro)?;
                 // We have to reload the new audit file because auditing child
                 // effects may have removed some base effects from the current
                 // crate

src/auditing/chain.rs

@@ -21,11 +21,18 @@ pub struct OuterArgs {
 
     #[clap(long, default_value_t = false)]
     pub quick_mode: bool,
+
+    #[clap(long, default_value_t = true)]
+    pub expand_macro: bool,
 }
 
 impl Default for OuterArgs {
     fn default() -> Self {
-        Self { crate_download_path: ".audit_crates".to_string(), quick_mode: false }
+        Self {
+            crate_download_path: ".audit_crates".to_string(),
+            quick_mode: false,
+            expand_macro: true,
+        }
     }
 }
 
@@ -89,7 +96,12 @@ impl CommandRunner for Create {
             std::fs::rename(&tmp_path, &self.crate_path)?;
         }
 
-        let chain = create_new_audit_chain(self, &args.crate_download_path, false)?;
+        let chain = create_new_audit_chain(
+            self,
+            &args.crate_download_path,
+            args.quick_mode,
+            args.expand_macro,
+        )?;
         chain.save_to_file()?;
         Ok(())
     }
@@ -205,8 +217,8 @@ impl CommandRunner for Audit {
                     let scan_res = scanner::scan_crate(
                         &crate_path,
                         &orig_audit_file.scanned_effects,
-                        false,
-                        false,
+                        args.quick_mode,
+                        args.expand_macro,
                     )?;
 
                     let mut audit_config = AuditConfig::default();
@@ -229,6 +241,7 @@ impl CommandRunner for Audit {
                                 sink_ident,
                                 &audit_config,
                                 args.quick_mode,
+                                args.expand_macro,
                             )?,
                             _ => {
                                 return Err(anyhow!(

src/bin/audit.rs

@@ -102,6 +102,10 @@ struct Args {
     /// TESTING ONLY: Use the quick-mode scan option
     #[clap(long, default_value_t = false)]
     quick_mode: bool,
+
+    /// Whether to analyze macro expanded code for effects
+    #[clap(long, default_value_t = true)]
+    expand_macros: bool,
 }
 
 #[derive(ValueEnum, Clone, Copy, Debug, PartialEq, Eq)]
@@ -250,7 +254,7 @@ fn audit_crate(args: Args, audit_file: Option<AuditFile>) -> Result<()> {
             sinks,
             relevant_effects,
             args.quick_mode,
-            false,
+            args.expand_macros,
         )?
     };
     let scan_effects = scan_res.effects_set();
@@ -334,8 +338,12 @@ fn runner(args: Args) -> Result<()> {
         println!("Previewing crate effects.");
         println!("Scanning crate...");
 
-        let res =
-            scan_crate(&args.crate_path, &args.effect_types, args.quick_mode, false)?;
+        let res = scan_crate(
+            &args.crate_path,
+            &args.effect_types,
+            args.quick_mode,
+            args.expand_macros,
+        )?;
         for effect in res.effects {
             println!("{}", effect.to_csv());
         }

src/bin/default_audit.rs

@@ -34,6 +34,10 @@ struct Args {
     /// Run in quick mode (turns off RustAnalyzer)
     #[clap(long, default_value_t = false)]
     quick_mode: bool,
+
+    /// Whether to analyze macro expansions for effects
+    #[clap(long, default_value_t = true)]
+    expand_macro: bool,
 }
 
 // TODO: Combine this with DefaultAuditType once we implement every version
@@ -56,12 +60,14 @@ fn runner(args: Args) -> Result<()> {
             &args.crate_path,
             &EffectType::unsafe_effects(),
             args.quick_mode,
+            args.expand_macro,
         )?,
         AuditType::Safe => AuditFile::new_safe_default_with_sinks(
             &args.crate_path,
             HashSet::new(),
             &EffectType::unsafe_effects(),
             args.quick_mode,
+            args.expand_macro,
         )?,
     };
 

src/bin/stat.rs

@@ -55,6 +55,12 @@ struct Args {
         EffectType::ClosureCreation,
     ])]
     effect_types: Vec<EffectType>,
+
+    #[clap(long, default_value_t = false)]
+    pub quick_mode: bool,
+
+    #[clap(long, default_value_t = true)]
+    pub expand_macro: bool,
 }
 
 #[derive(ValueEnum, Clone, Copy, Debug)]
@@ -128,7 +134,12 @@ fn main() -> Result<()> {
         args.effect_types,
     );
 
-    let mut chain = create_new_audit_chain(create, &args.audit_file_path, false)?;
+    let mut chain = create_new_audit_chain(
+        create,
+        &args.audit_file_path,
+        args.quick_mode,
+        args.expand_macro,
+    )?;
     let root_crate = chain.root_crate()?;
     let root_audit_file = chain
         .read_audit_file(&root_crate)?