Improve error message information across all possible errors (#777)

Signed-off-by: Juan Cruz Viotti <[email protected]>

Author: jviotti

enterprise/index/CMakeLists.txt

@@ -5,6 +5,7 @@ target_compile_definitions(sourcemeta_one_enterprise_index PUBLIC SOURCEMETA_ONE
 
 target_link_libraries(sourcemeta_one_enterprise_index PUBLIC sourcemeta::one::resolver)
 target_link_libraries(sourcemeta_one_enterprise_index PUBLIC sourcemeta::blaze::configuration)
+target_link_libraries(sourcemeta_one_enterprise_index PRIVATE sourcemeta::core::error)
 target_link_libraries(sourcemeta_one_enterprise_index PRIVATE sourcemeta::blaze::compiler)
 target_link_libraries(sourcemeta_one_enterprise_index PRIVATE sourcemeta::blaze::linter)
 target_link_libraries(sourcemeta_one_enterprise_index PRIVATE sourcemeta::core::yaml)

enterprise/index/enterprise_index.cc

@@ -3,6 +3,8 @@
 #include <sourcemeta/blaze/compiler.h>
 #include <sourcemeta/blaze/linter.h>
 
+#include <sourcemeta/core/error.h>
+#include <sourcemeta/core/jsonschema.h>
 #include <sourcemeta/core/yaml.h>
 
 #include <string> // std::string
@@ -19,12 +21,28 @@ auto load_custom_lint_rules(
       configuration.default_dialect.value_or(std::string{})};
   for (const auto &rule_path : configuration.lint.rules) {
     auto rule_schema{sourcemeta::core::read_yaml_or_json(rule_path)};
-    custom_names.emplace(bundle.add<sourcemeta::blaze::SchemaRule>(
-        rule_schema, sourcemeta::core::schema_walker,
-        [&callback, &resolver](const auto identifier) {
-          return resolver(identifier, callback);
-        },
-        sourcemeta::blaze::default_schema_compiler, default_dialect));
+    try {
+      custom_names.emplace(bundle.add<sourcemeta::blaze::SchemaRule>(
+          rule_schema, sourcemeta::core::schema_walker,
+          [&callback, &resolver](const auto identifier) {
+            return resolver(identifier, callback);
+          },
+          sourcemeta::blaze::default_schema_compiler, default_dialect));
+    } catch (const sourcemeta::blaze::LinterInvalidNamePatternError &error) {
+      throw sourcemeta::core::FileError<
+          sourcemeta::blaze::LinterInvalidNamePatternError>(
+          rule_path, error.identifier(), error.regex());
+    } catch (const sourcemeta::blaze::LinterInvalidNameError &error) {
+      throw sourcemeta::core::FileError<
+          sourcemeta::blaze::LinterInvalidNameError>(
+          rule_path, error.identifier(), error.what());
+    } catch (const sourcemeta::blaze::LinterMissingNameError &) {
+      throw sourcemeta::core::FileError<
+          sourcemeta::blaze::LinterMissingNameError>(rule_path);
+    } catch (const sourcemeta::core::SchemaUnknownBaseDialectError &) {
+      throw sourcemeta::core::FileError<
+          sourcemeta::core::SchemaUnknownBaseDialectError>(rule_path);
+    }
   }
 }
 

src/configuration/include/sourcemeta/one/configuration.h

@@ -19,6 +19,7 @@ struct Configuration {
                    const std::filesystem::path &collections_path)
       -> sourcemeta::core::JSON;
   static auto parse(const sourcemeta::core::JSON &data,
+                    const std::filesystem::path &configuration_path,
                     const std::filesystem::path &default_base_path)
       -> Configuration;
 

src/configuration/include/sourcemeta/one/configuration_error.h

@@ -15,7 +15,9 @@ namespace sourcemeta::one {
 
 class ConfigurationValidationError : public std::exception {
 public:
-  ConfigurationValidationError(const sourcemeta::blaze::SimpleOutput &output) {
+  ConfigurationValidationError(std::filesystem::path path,
+                               const sourcemeta::blaze::SimpleOutput &output)
+      : path_{std::move(path)} {
     std::ostringstream stream;
     for (const auto &entry : output) {
       stream << entry.message << "\n";
@@ -33,11 +35,16 @@ class ConfigurationValidationError : public std::exception {
     return "Invalid configuration";
   }
 
+  [[nodiscard]] auto path() const noexcept -> const std::filesystem::path & {
+    return this->path_;
+  }
+
   [[nodiscard]] auto stacktrace() const noexcept -> const auto & {
     return this->stacktrace_;
   }
 
 private:
+  std::filesystem::path path_;
   std::string stacktrace_;
 };
 

src/configuration/parse.cc

@@ -52,7 +52,6 @@ auto entries_from_json(T &result, const std::filesystem::path &location,
                                           .to_string()}
                     .parent_path()
               : default_base_path};
-      collection_input.erase("x-sourcemeta-one:path");
       auto collection{sourcemeta::blaze::Configuration::from_json(
           collection_input, base_path)};
       // Filesystems behave differently with regards to casing. To unify
@@ -83,6 +82,7 @@ auto entries_from_json(T &result, const std::filesystem::path &location,
 namespace sourcemeta::one {
 
 auto Configuration::parse(const sourcemeta::core::JSON &data,
+                          const std::filesystem::path &configuration_path,
                           const std::filesystem::path &default_base_path)
     -> Configuration {
   const auto compiled_schema{sourcemeta::blaze::from_json(
@@ -91,7 +91,7 @@ auto Configuration::parse(const sourcemeta::core::JSON &data,
   sourcemeta::blaze::Evaluator evaluator;
   sourcemeta::blaze::SimpleOutput output{data};
   if (!evaluator.validate(compiled_schema.value(), data, std::ref(output))) {
-    throw ConfigurationValidationError(output);
+    throw ConfigurationValidationError(configuration_path, output);
   }
 
   Configuration result;

src/index/CMakeLists.txt

@@ -18,9 +18,11 @@ target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::one::configuratio
 target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::one::web)
 
 target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::one::build)
+target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::error)
 target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::io)
 target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::uri)
 target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::json)
+target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::yaml)
 target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::jsonschema)
 target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::semver)
 target_link_libraries(sourcemeta_one_index PRIVATE sourcemeta::core::alterschema)

src/index/error.h

@@ -39,12 +39,65 @@ class MetaschemaError : public std::exception {
   std::string stacktrace_;
 };
 
+class OptionInvalidNumericValueError : public std::exception {
+public:
+  OptionInvalidNumericValueError(std::string option, std::string value)
+      : option_{std::move(option)}, value_{std::move(value)} {}
+
+  [[nodiscard]] auto what() const noexcept -> const char * override {
+    return "Expected a valid numeric value for option";
+  }
+
+  [[nodiscard]] auto option() const noexcept -> const std::string & {
+    return this->option_;
+  }
+
+  [[nodiscard]] auto value() const noexcept -> const std::string & {
+    return this->value_;
+  }
+
+private:
+  std::string option_;
+  std::string value_;
+};
+
+class OptionInvalidURIValueError : public std::exception {
+public:
+  OptionInvalidURIValueError(std::string option, std::string value)
+      : option_{std::move(option)}, value_{std::move(value)} {}
+
+  [[nodiscard]] auto what() const noexcept -> const char * override {
+    return "Expected a valid URI value for option";
+  }
+
+  [[nodiscard]] auto option() const noexcept -> const std::string & {
+    return this->option_;
+  }
+
+  [[nodiscard]] auto value() const noexcept -> const std::string & {
+    return this->value_;
+  }
+
+private:
+  std::string option_;
+  std::string value_;
+};
+
 class CustomRuleError : public std::exception {
 public:
+  CustomRuleError(std::filesystem::path path) : path_{std::move(path)} {}
+
   [[nodiscard]] auto what() const noexcept -> const char * override {
     return "Custom linter rules are only available on the enterprise "
            "edition";
   }
+
+  [[nodiscard]] auto path() const noexcept -> const std::filesystem::path & {
+    return this->path_;
+  }
+
+private:
+  std::filesystem::path path_;
 };
 
 } // namespace sourcemeta::one

src/index/generators.h

@@ -445,8 +445,10 @@ struct GENERATE_HEALTH {
                                             configuration, resolver, callback);
 #else
     if (!configuration.lint.rules.empty()) {
-      // TODO: Show enough information to know where the error is coming from
-      throw CustomRuleError();
+      const auto *config_path{
+          configuration.extra.try_at("x-sourcemeta-one:path")};
+      assert(config_path);
+      throw CustomRuleError(std::filesystem::path{config_path->to_string()});
     }
 #endif