Robustify script name checking and reporting

Author: URJala

include/ur_client_library/primary/primary_client.h

@@ -351,6 +351,7 @@ class PrimaryClient
 
   ScriptInfo prepare_script(std::string script, std::string script_name);
   std::vector<std::string> strip_comments_and_whitespace(std::vector<std::string> script_lines);
+  std::string truncate_and_check_script_name(std::string candidate_name);
 
   PrimaryParser parser_;
   std::shared_ptr<PrimaryConsumer> consumer_;

src/primary/primary_client.cpp

@@ -340,6 +340,26 @@ std::vector<std::string> PrimaryClient::strip_comments_and_whitespace(std::vecto
   return stripped_script;
 }
 
+std::string PrimaryClient::truncate_and_check_script_name(const std::string candidate_name)
+{
+  std::string final_name = candidate_name;
+  // Limit script name length to 31, to ensure backwards compatibility
+  if (final_name.size() > 31)
+  {
+    final_name = final_name.substr(0, 31);
+    URCL_LOG_WARN("Given script name was too long, and has been truncated. New script name is: %s", final_name.c_str());
+  }
+  // Validate script_name
+  static const std::regex valid_name(R"(^[A-Za-z_][A-Za-z0-9_]*$)");
+  if (!std::regex_match(final_name, valid_name))
+  {
+    throw urcl::ScriptCodeSyntaxException("Invalid script name: '" + final_name +
+                                          "'. Can only contain letters, numbers and underscores. First character "
+                                          "must be a letter or underscore.");
+  }
+  return final_name;
+}
+
 ScriptInfo PrimaryClient::prepare_script(std::string script, std::string script_name)
 {
   // Split the given script in to separate lines
@@ -357,7 +377,12 @@ ScriptInfo PrimaryClient::prepare_script(std::string script, std::string script_
   int64_t current_time =
       std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::system_clock::now().time_since_epoch())
           .count();
+  // Assign name according to inputs
   std::string actual_script_name = script_name.empty() ? "script_" + std::to_string(current_time) : script_name;
+
+  // Check that the final name is valid
+  actual_script_name = truncate_and_check_script_name(actual_script_name);
+
   ScriptTypes actual_script_type = urcl::primary_interface::ScriptTypes::DEF;
   // Is the script wrapped in a function definition? If not add one
   if (stripped_script[0].substr(0, 4).find("def ") == script.npos &&
@@ -378,7 +403,7 @@ ScriptInfo PrimaryClient::prepare_script(std::string script, std::string script_
   else
   {
     size_t name_end = stripped_script[0].find("(");
-    actual_script_name = stripped_script[0].substr(4, name_end - 4);
+    std::string name_in_script = stripped_script[0].substr(4, name_end - 4);
     if (stripped_script[0].find("def") != stripped_script[0].npos)
     {
       actual_script_type = ScriptTypes::DEF;
@@ -387,26 +412,14 @@ ScriptInfo PrimaryClient::prepare_script(std::string script, std::string script_
     {
       actual_script_type = ScriptTypes::SEC;
     }
+    // Check that the script name is valid, replace it if it is not
+    actual_script_name = truncate_and_check_script_name(name_in_script);
+    if (actual_script_name.size() != name_in_script.size())
+    {
+      stripped_script[0].replace(stripped_script[0].find(name_in_script), name_in_script.size(), actual_script_name);
+    }
   }
 
-  // Validate script_name
-  static const std::regex valid_name(R"(^[A-Za-z_][A-Za-z0-9_]*$)");
-  if (!std::regex_match(actual_script_name, valid_name))
-  {
-    throw urcl::ScriptCodeSyntaxException("Invalid script name: '" + script_name +
-                                          "'. Can only contain letters, numbers and underscores. First character "
-                                          "must "
-                                          "be a letter or "
-                                          "underscore.");
-  }
-
-  // Limit script name length to 31, to ensure backwards compatibility
-  if (actual_script_name.size() > 31)
-  {
-    actual_script_name = actual_script_name.substr(0, 31);
-    URCL_LOG_WARN("Given script name was too long, and has been truncated. New script name is: %s",
-                  actual_script_name.c_str());
-  }
   if (stripped_script.back().find("end") == script.npos)
   {
     throw urcl::ScriptCodeSyntaxException("Script contains either function definition or secondary process "