feat: allow you to override environment file path

Author: joshstevens19

cli/src/main.rs

@@ -15,7 +15,7 @@ mod rindexer_yaml;
 use std::{path::PathBuf, str::FromStr, sync::Once};
 
 use clap::Parser;
-use rindexer::{load_env_from_path, manifest::core::ProjectType};
+use rindexer::{load_env_from_project_path, manifest::core::ProjectType};
 
 use crate::{
     cli_interface::{AddSubcommands, Commands, NewSubcommands, CLI},
@@ -79,7 +79,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     match &cli.command {
         Commands::New { subcommand, path } => {
             let resolved_path = resolve_path(path).inspect_err(|e| print_error_message(e))?;
-            load_env_from_path(&resolved_path);
+            load_env_from_project_path(&resolved_path);
 
             let project_type = match subcommand {
                 NewSubcommands::NoCode => ProjectType::NoCode,
@@ -90,30 +90,30 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
         }
         Commands::Add { subcommand, path } => {
             let resolved_path = resolve_path(path).inspect_err(|e| print_error_message(e))?;
-            load_env_from_path(&resolved_path);
+            load_env_from_project_path(&resolved_path);
 
             match subcommand {
                 AddSubcommands::Contract => handle_add_contract_command(resolved_path).await,
             }
         }
         Commands::Codegen { subcommand, path } => {
             let resolved_path = resolve_path(path).inspect_err(|e| print_error_message(e))?;
-            load_env_from_path(&resolved_path);
+            load_env_from_project_path(&resolved_path);
             handle_codegen_command(resolved_path, subcommand).await
         }
         Commands::Start { subcommand, path } => {
             let resolved_path = resolve_path(path).inspect_err(|e| print_error_message(e))?;
-            load_env_from_path(&resolved_path);
+            load_env_from_project_path(&resolved_path);
             start(resolved_path, subcommand).await
         }
         Commands::Delete { path } => {
             let resolved_path = resolve_path(path).inspect_err(|e| print_error_message(e))?;
-            load_env_from_path(&resolved_path);
+            load_env_from_project_path(&resolved_path);
             handle_delete_command(resolved_path).await
         }
         Commands::Phantom { subcommand, path } => {
             let resolved_path = resolve_path(path).inspect_err(|e| print_error_message(e))?;
-            load_env_from_path(&resolved_path);
+            load_env_from_project_path(&resolved_path);
             handle_phantom_commands(resolved_path, subcommand).await
         }
     }

core/src/generator/build.rs

@@ -440,7 +440,6 @@ serde = {{ version = "1.0.194", features = ["derive"] }}
                         let manifest_path = path.join("rindexer.yaml");
                         let result = start_rindexer(StartDetails {
                             manifest_path: &manifest_path,
-                            override_environment_path: None,
                             indexing_details: if enable_indexer {
                                 Some(IndexingDetails {
                                     registry: register_all_handlers(&manifest_path).await,

core/src/helpers/file.rs

@@ -119,8 +119,15 @@ pub fn create_mod_file(
     Ok(())
 }
 
-pub fn load_env_from_path(project_path: &Path) {
+pub fn load_env_from_project_path(project_path: &Path) {
     if from_path(project_path.join(".env")).is_err() {
         dotenv().ok();
     }
 }
+
+pub fn load_env_from_full_path(path: &Path) {
+    if from_path(path).is_err() {
+        dotenv().ok();
+    }
+}
+

core/src/helpers/mod.rs

@@ -15,8 +15,8 @@ use std::{
 use dotenv::dotenv;
 use ethers::prelude::{I256, U256};
 pub use file::{
-    create_mod_file, format_all_files_for_project, load_env_from_path, write_file,
-    CreateModFileError, WriteFileError,
+    create_mod_file, format_all_files_for_project, load_env_from_project_path, write_file,
+    CreateModFileError, WriteFileError, load_env_from_full_path
 };
 use rand::{distributions::Alphanumeric, Rng};
 

core/src/indexer/no_code.rs

@@ -84,8 +84,6 @@ pub async fn setup_no_code(
             if !details.indexing_details.enabled {
                 return Ok(StartDetails {
                     manifest_path: details.manifest_path,
-                    // TODO: enable ability to override this for no-code projects
-                    override_environment_path: None,
                     indexing_details: None,
                     graphql_details: details.graphql_details,
                 });
@@ -117,8 +115,6 @@ pub async fn setup_no_code(
 
             Ok(StartDetails {
                 manifest_path: details.manifest_path,
-                // TODO: enable ability to override this for no-code projects
-                override_environment_path: None,
                 indexing_details: Some(IndexingDetails { registry }),
                 graphql_details: details.graphql_details,
             })

core/src/lib.rs

@@ -16,7 +16,7 @@ pub use simple_file_formatters::csv::AsyncCsvAppender;
 
 mod helpers;
 pub use helpers::{
-    format_all_files_for_project, generate_random_id, load_env_from_path, public_read_env_value,
+    format_all_files_for_project, generate_random_id, load_env_from_project_path, public_read_env_value,
     write_file, WriteFileError,
 };
 mod api;

core/src/manifest/yaml.rs

@@ -5,21 +5,17 @@ use std::{
     io::{Read, Write},
     path::{Path, PathBuf},
 };
-
+use std::str::FromStr;
 use ethers::types::ValueOrArray;
 use regex::{Captures, Regex};
 use serde::{Deserialize, Serialize};
 use tracing::error;
 
-use crate::{
-    abi::ABIItem,
-    helpers::replace_env_variable_to_raw_name,
-    manifest::{
-        core::{Manifest, ProjectType},
-        network::Network,
-    },
-    StringOrArray,
-};
+use crate::{abi::ABIItem, helpers::replace_env_variable_to_raw_name, load_env_from_project_path, manifest::{
+    core::{Manifest, ProjectType},
+    network::Network,
+}, StringOrArray};
+use crate::helpers::load_env_from_full_path;
 
 pub const YAML_CONFIG_NAME: &str = "rindexer.yaml";
 
@@ -275,12 +271,31 @@ struct ManifestNetworksOnly {
     pub networks: Vec<Network>,
 }
 
+fn extract_environment_path(contents: &str, file_path: &Path) -> Option<PathBuf> {
+    let re = Regex::new(r"(?m)^environment_path:\s*(.+)$").unwrap();
+    re.captures(contents)
+        .and_then(|cap| cap.get(1))
+        .map(|m| {
+            let path_str = m.as_str().trim().replace('\"', ""); // Remove any quotes
+            let base_dir = file_path.parent().unwrap_or(Path::new(""));
+            let full_path = base_dir.join(path_str);
+            full_path.canonicalize().unwrap_or(full_path)
+        })
+}
+
+
 pub fn read_manifest(file_path: &PathBuf) -> Result<Manifest, ReadManifestError> {
     let mut file = File::open(file_path)?;
     let mut contents = String::new();
 
     file.read_to_string(&mut contents)?;
 
+    let environment_path = extract_environment_path(&contents, file_path);
+    if let Some(ref path) = environment_path {
+        println!("Loading environment from path: {:?}", path);
+        load_env_from_full_path(path);
+    }
+
     let contents_before_transform = contents.clone();
 
     contents = substitute_env_variables(&contents)?;

core/src/start.rs

@@ -17,7 +17,7 @@ use crate::{
         start::{start_indexing, StartIndexingError},
         ContractEventDependencies, ContractEventDependenciesMapFromRelationshipsError,
     },
-    load_env_from_path,
+    load_env_from_project_path,
     manifest::{
         core::ProjectType,
         storage::RelationshipsAndIndexersError,
@@ -32,7 +32,6 @@ pub struct IndexingDetails {
 
 pub struct StartDetails<'a> {
     pub manifest_path: &'a PathBuf,
-    pub override_environment_path: Option<&'a PathBuf>,
     pub indexing_details: Option<IndexingDetails>,
     pub graphql_details: GraphqlOverrideSettings,
 }
@@ -79,9 +78,6 @@ pub async fn start_rindexer(details: StartDetails<'_>) -> Result<(), StartRindex
     let project_path = details.manifest_path.parent();
     match project_path {
         Some(project_path) => {
-            let env_path =
-                details.override_environment_path.map(PathBuf::as_path).unwrap_or(project_path);
-            load_env_from_path(env_path);
             let manifest = Arc::new(read_manifest(details.manifest_path)?);
 
             if manifest.project_type != ProjectType::NoCode {

documentation/docs/pages/docs/changelog.mdx

@@ -10,7 +10,7 @@
 - feat: expose postgres ToSql trait
 - feat: support with_transaction in postgres client
 - feat: get the block timestamp from the RPC call (its an option as not all providers expose it)
-- feat: allow rust project to override the environment file path
+- feat: allow you to override environment file path
 
 ### Bug fixes
 -------------------------------------------------

documentation/docs/pages/docs/start-building/rust-project-deep-dive/indexers.mdx

@@ -992,7 +992,6 @@ async fn main() {
             let manifest_path = path.join("rindexer.yaml");
             let result = start_rindexer(StartDetails {
                 manifest_path: &manifest_path,
-                override_environment_path: None,
                 indexing_details: if enable_indexer {
                     Some(IndexingDetails {
                         registry: register_all_handlers(&manifest_path).await,