From 13d70ce4091946b1ee5851d73c87ba3a0731c9f3 Mon Sep 17 00:00:00 2001
From: kevaundray <kevtheappdev@gmail.com>
Date: Mon, 18 Dec 2023 16:05:17 +0000
Subject: [PATCH] chore: `fetch_file` now returns ` &str` instead of a `File`
 (#3846)

# Description

This makes the API more uniform because to add a file, we call:

```
    pub fn add_file_with_source(&mut self, file_name: &Path, source: String) -> Option<FileId> {
```

and now to fetch a file we call:

```
    pub fn fetch_file(&self, file_id: FileId) -> &str;
```


Instead of returning a `File` which was not present when we were adding
a File

## Problem\*

Resolves <!-- Link to GitHub Issue -->

## Summary\*



## Additional Context



## Documentation\*

Check one:
- [ ] No documentation needed.
- [ ] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [ ] I have tested the changes locally.
- [ ] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
---
 compiler/fm/src/lib.rs                         | 4 ++--
 compiler/noirc_driver/src/debug.rs             | 2 +-
 compiler/noirc_frontend/src/hir/def_map/mod.rs | 4 ++--
 tooling/nargo/src/artifacts/debug.rs           | 2 +-
 tooling/nargo_cli/src/cli/fmt_cmd.rs           | 2 +-
 5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/compiler/fm/src/lib.rs b/compiler/fm/src/lib.rs
index 47b245eea2e..4870a6c283b 100644
--- a/compiler/fm/src/lib.rs
+++ b/compiler/fm/src/lib.rs
@@ -88,9 +88,9 @@ impl FileManager {
         assert!(old_value.is_none(), "ice: the same path was inserted into the file manager twice");
     }
 
-    pub fn fetch_file(&self, file_id: FileId) -> File {
+    pub fn fetch_file(&self, file_id: FileId) -> &str {
         // Unwrap as we ensure that all file_id's map to a corresponding file in the file map
-        self.file_map.get_file(file_id).unwrap()
+        self.file_map.get_file(file_id).unwrap().source()
     }
 
     pub fn path(&self, file_id: FileId) -> &Path {
diff --git a/compiler/noirc_driver/src/debug.rs b/compiler/noirc_driver/src/debug.rs
index 144e636b534..84a3e143357 100644
--- a/compiler/noirc_driver/src/debug.rs
+++ b/compiler/noirc_driver/src/debug.rs
@@ -31,7 +31,7 @@ pub(crate) fn filter_relevant_files(
     let mut file_map = BTreeMap::new();
 
     for file_id in files_with_debug_symbols {
-        let file_source = file_manager.fetch_file(file_id).source();
+        let file_source = file_manager.fetch_file(file_id);
 
         file_map.insert(
             file_id,
diff --git a/compiler/noirc_frontend/src/hir/def_map/mod.rs b/compiler/noirc_frontend/src/hir/def_map/mod.rs
index 026f407981d..20f05532ce4 100644
--- a/compiler/noirc_frontend/src/hir/def_map/mod.rs
+++ b/compiler/noirc_frontend/src/hir/def_map/mod.rs
@@ -270,8 +270,8 @@ pub struct Contract {
 
 /// Given a FileId, fetch the File, from the FileManager and parse it's content
 pub fn parse_file(fm: &FileManager, file_id: FileId) -> (ParsedModule, Vec<ParserError>) {
-    let file = fm.fetch_file(file_id);
-    parse_program(file.source())
+    let file_source = fm.fetch_file(file_id);
+    parse_program(file_source)
 }
 
 impl std::ops::Index<LocalModuleId> for CrateDefMap {
diff --git a/tooling/nargo/src/artifacts/debug.rs b/tooling/nargo/src/artifacts/debug.rs
index 40acc7db8f8..324c476d13d 100644
--- a/tooling/nargo/src/artifacts/debug.rs
+++ b/tooling/nargo/src/artifacts/debug.rs
@@ -34,7 +34,7 @@ impl DebugArtifact {
             .collect();
 
         for file_id in files_with_debug_symbols {
-            let file_source = file_manager.fetch_file(file_id).source();
+            let file_source = file_manager.fetch_file(file_id);
 
             file_map.insert(
                 file_id,
diff --git a/tooling/nargo_cli/src/cli/fmt_cmd.rs b/tooling/nargo_cli/src/cli/fmt_cmd.rs
index 0c2ca71eba3..e62fc560217 100644
--- a/tooling/nargo_cli/src/cli/fmt_cmd.rs
+++ b/tooling/nargo_cli/src/cli/fmt_cmd.rs
@@ -62,7 +62,7 @@ pub(crate) fn run(args: FormatCommand, config: NargoConfig) -> Result<(), CliErr
                 return Ok(());
             }
 
-            let original = file_manager.fetch_file(file_id).source();
+            let original = file_manager.fetch_file(file_id);
             let formatted = nargo_fmt::format(original, parsed_module, &config);
 
             if check_mode {