Track changes to prevent unnecessary disk io

Author: Neko-Box-Coder

Include/runcpp2/Data/ScriptInfo.hpp

@@ -7,6 +7,7 @@
 #include "runcpp2/Data/ProfilesProcessPaths.hpp"
 #include "runcpp2/Data/ProfilesDefines.hpp"
 #include "runcpp2/Data/ProfilesCommands.hpp"
+#include "ghc/filesystem.hpp"
 
 #include <string>
 #include <vector>
@@ -38,8 +39,12 @@ namespace runcpp2
                 std::unordered_map<PlatformName, ProfilesCommands> PostBuild;
                 std::unordered_map<PlatformName, ProfilesCommands> Cleanup;
 
+                //Internal tracking
                 bool Populated = false;
 
+                ghc::filesystem::file_time_type LastWriteTime = 
+                    ghc::filesystem::file_time_type::min();
+                
                 bool ParseYAML_Node(ryml::ConstNodeRef& node);
                 std::string ToString(std::string indentation) const;
                 bool Equals(const ScriptInfo& other) const;

Include/runcpp2/PipelineSteps.hpp

@@ -125,7 +125,7 @@ namespace runcpp2
 
     using SourceIncludeMap = std::unordered_map<std::string, std::vector<ghc::filesystem::path>>;
 
-    bool GatherFilesIncludes(   const std::vector<ghc::filesystem::path>& files,
+    bool GatherFilesIncludes(   const std::vector<ghc::filesystem::path>& sourceFiles,
                                 const std::vector<ghc::filesystem::path>& includePaths,
                                 SourceIncludeMap& outSourceIncludes);
 }

Include/runcpp2/runcpp2.hpp

@@ -29,7 +29,8 @@ namespace runcpp2
                                             const std::vector<Data::Profile>& profiles,
                                             const std::string& configPreferredProfile,
                                             const Data::ScriptInfo& scriptInfo,
-                                            const std::unordered_map<CmdOptions, std::string>& currentOptions,
+                                            const std::unordered_map<   CmdOptions, 
+                                                                        std::string>& currentOptions,
                                             bool& outNeedsUpdate);
 
     PipelineResult StartPipeline(   const std::string& scriptPath, 

Src/runcpp2/PipelineSteps.cpp

@@ -309,8 +309,6 @@ runcpp2::ParseAndValidateScriptInfo(const ghc::filesystem::path& absoluteScriptP
     ssLOG_FUNC_INFO();
     INTERNAL_RUNCPP2_SAFE_START();
 
-    //TODO: Record last script info write time. Use last script info if possible to reduce disk io
-
     //Check if there's script info as yaml file instead
     std::error_code e;
     std::string parsableInfo;
@@ -320,13 +318,29 @@ runcpp2::ParseAndValidateScriptInfo(const ghc::filesystem::path& absoluteScriptP
 
     if(ghc::filesystem::exists(dedicatedYamlLoc, e))
     {
+        //Record write time for yaml file
+        outScriptInfo.LastWriteTime = ghc::filesystem::last_write_time(dedicatedYamlLoc, e);
+        if(e)
+        {
+            ssLOG_ERROR("Failed to get last write time for: " << dedicatedYamlLoc);
+            return PipelineResult::INVALID_SCRIPT_INFO;
+        }
+
         inputFile.open(dedicatedYamlLoc);
         std::stringstream buffer;
         buffer << inputFile.rdbuf();
         parsableInfo = buffer.str();
     }
     else
     {
+        //Record write time for script file
+        outScriptInfo.LastWriteTime = ghc::filesystem::last_write_time(absoluteScriptPath, e);
+        if(e)
+        {
+            ssLOG_ERROR("Failed to get last write time for: " << absoluteScriptPath);
+            return PipelineResult::INVALID_SCRIPT_INFO;
+        }
+
         inputFile.open(absoluteScriptPath);
 
         if (!inputFile)
@@ -1192,7 +1206,7 @@ bool runcpp2::GatherIncludePaths(   const ghc::filesystem::path& scriptDirectory
     INTERNAL_RUNCPP2_SAFE_CATCH_RETURN(false);
 }
 
-bool runcpp2::GatherFilesIncludes(  const std::vector<ghc::filesystem::path>& files,
+bool runcpp2::GatherFilesIncludes(  const std::vector<ghc::filesystem::path>& sourceFiles,
                                     const std::vector<ghc::filesystem::path>& includePaths,
                                     SourceIncludeMap& outSourceIncludes)
 {
@@ -1202,13 +1216,13 @@ bool runcpp2::GatherFilesIncludes(  const std::vector<ghc::filesystem::path>& fi
     outSourceIncludes.clear();
     std::unordered_set<std::string> visitedFiles;
 
-    for(const ghc::filesystem::path& file : files)
+    for(const ghc::filesystem::path& source : sourceFiles)
     {
-        ssLOG_INFO("Gathering includes for " << file.string());
+        ssLOG_INFO("Gathering includes for " << source.string());
 
-        std::vector<ghc::filesystem::path>& currentIncludes = outSourceIncludes[file.string()];
+        std::vector<ghc::filesystem::path>& currentIncludes = outSourceIncludes[source.string()];
         std::queue<ghc::filesystem::path> filesToProcess;
-        filesToProcess.push(file);
+        filesToProcess.push(source);
 
         while(!filesToProcess.empty())
         {

Src/runcpp2/runcpp2.cpp

@@ -306,7 +306,8 @@ runcpp2::CheckSourcesNeedUpdate(    const std::string& scriptPath,
                                     const std::vector<Data::Profile>& profiles,
                                     const std::string& configPreferredProfile,
                                     const Data::ScriptInfo& scriptInfo,
-                                    const std::unordered_map<CmdOptions, std::string>& currentOptions,
+                                    const std::unordered_map<   CmdOptions, 
+                                                                std::string>& currentOptions,
                                     bool& outNeedsUpdate)
 {
     INTERNAL_RUNCPP2_SAFE_START();
@@ -325,6 +326,30 @@ runcpp2::CheckSourcesNeedUpdate(    const std::string& scriptPath,
     if(result != PipelineResult::SUCCESS)
         return result;
 
+    //First check if script info file has changed
+    std::error_code e;
+    ghc::filesystem::path dedicatedYamlLoc = 
+        scriptDirectory / ghc::filesystem::path(scriptName + ".yaml");
+    
+    ghc::filesystem::file_time_type currentWriteTime;
+    if(ghc::filesystem::exists(dedicatedYamlLoc, e))
+        currentWriteTime = ghc::filesystem::last_write_time(dedicatedYamlLoc, e);
+    else
+        currentWriteTime = ghc::filesystem::last_write_time(absoluteScriptPath, e);
+
+    if(e)
+    {
+        ssLOG_ERROR("Failed to get write time for script info");
+        return PipelineResult::UNEXPECTED_FAILURE;
+    }
+
+    //If script info file is newer than last check, we need to update
+    if(currentWriteTime > scriptInfo.LastWriteTime)
+    {
+        outNeedsUpdate = true;
+        return PipelineResult::SUCCESS;
+    }
+
     //Initialize BuildsManager and IncludeManager
     ghc::filesystem::path configDir = GetConfigFilePath();
     ghc::filesystem::path buildDir;
@@ -506,7 +531,7 @@ runcpp2::StartPipeline( const std::string& scriptPath,
         if(result != PipelineResult::SUCCESS)
             return result;
 
-        if(!lastScriptInfo || recompileNeeded || !changedDependencies.empty() || relinkNeeded)
+        //if(!lastScriptInfo || recompileNeeded || !changedDependencies.empty() || relinkNeeded)
             outScriptInfo = scriptInfo;
 
         std::vector<std::string> gatheredBinariesPaths;

TODO.md

@@ -15,7 +15,6 @@ TODO:
     - Add branch/tag option for git
     - Add initialize submodule option for git
 - Use System2 subprocess if no prepend commands to be safer
-- Record last script info write time for `ParseAndValidateScriptInfo()`
 - Migrate to libyaml
 - Add wildcard support for filenames and extensions
 - Add tests and examples (On Windows as well)