refactor yaml_config: deprecate YamlConfig::Yaml method

commit_hash:185cb59e2b6585902380179fcb74056bf26fa57a

core/src/cache/cache_update_trait_test.cpp

@@ -213,7 +213,7 @@ update-interval: 1s
 }
 
 yaml_config::YamlConfig UpdateConfig(yaml_config::YamlConfig& config, formats::yaml::Value&& other) {
-    formats::yaml::ValueBuilder builder(config.Yaml());
+    formats::yaml::ValueBuilder builder(config.GetRawYamlWithoutConfigVars());
     formats::yaml::ValueBuilder yaml{other};
     for (const auto& [name, value] : Items(yaml)) {
         builder[name] = value;

universal/include/userver/yaml_config/yaml_config.hpp

@@ -94,9 +94,6 @@ class YamlConfig {
     /// YamlConfig = config + config_vars
     YamlConfig(formats::yaml::Value yaml, formats::yaml::Value config_vars, Mode mode = Mode::kSecure);
 
-    /// Get the plain Yaml without substitutions. It may contain raw references.
-    const formats::yaml::Value& Yaml() const;
-
     /// @brief Access member by key for read.
     /// @throw TypeMismatchException if value is not missing and is not object.
     YamlConfig operator[](std::string_view key) const;
@@ -196,6 +193,11 @@ class YamlConfig {
     /// or Null.
     const_iterator end() const;
 
+    /// @brief Get the plain Yaml without substitutions. It may contain raw references.
+    /// @deprecated Either use the current `YamlConfig` as a formats value, or use `.As<formats::json::Value>()`
+    /// to get the correct treatment for `$vars`, `#fallback`, `#env` and `#file`.
+    formats::yaml::Value GetRawYamlWithoutConfigVars() const;
+
 private:
     formats::yaml::Value yaml_;
     formats::yaml::Value config_vars_;

universal/src/yaml_config/impl/validate_static_config.cpp

@@ -17,7 +17,7 @@ namespace yaml_config::impl {
 
 namespace {
 
-bool IsTypeValid(FieldType type, const formats::yaml::Value& value) {
+bool IsTypeValid(FieldType type, const yaml_config::YamlConfig& value) {
     switch (type) {
         case FieldType::kInteger:
             return value.IsInt() || value.IsUInt64() || value.IsInt64();
@@ -37,11 +37,11 @@ bool IsTypeValid(FieldType type, const formats::yaml::Value& value) {
 }
 
 void CheckType(const YamlConfig& value, const Schema& schema) {
-    if (!IsTypeValid(schema.type, value.Yaml())) {
+    if (!IsTypeValid(schema.type, value)) {
         throw std::runtime_error(fmt::format(
             "Error while validating static config against schema. "
             "Value '{}' of field '{}' must be {}",
-            formats::yaml::ToString(value.Yaml()),
+            formats::yaml::ToString(value.GetRawYamlWithoutConfigVars()),
             value.GetPath(),
             ToString(schema.type)
         ));
@@ -146,7 +146,7 @@ void CheckNumericBounds(const YamlConfig& value, const Schema& schema) {
             ToString(schema.type),
             value.GetPath(),
             *schema.minimum,
-            formats::yaml::ToString(value.Yaml())
+            formats::yaml::ToString(value.GetRawYamlWithoutConfigVars())
         ));
     }
 
@@ -157,7 +157,7 @@ void CheckNumericBounds(const YamlConfig& value, const Schema& schema) {
             ToString(schema.type),
             value.GetPath(),
             *schema.maximum,
-            formats::yaml::ToString(value.Yaml())
+            formats::yaml::ToString(value.GetRawYamlWithoutConfigVars())
         ));
     }
 }

universal/src/yaml_config/yaml_config.cpp

@@ -146,7 +146,11 @@ std::optional<YamlConfig> GetYamlConfig(
             /*met_substitution*/ false
         );
         if (res) {
-            return YamlConfig{res->Yaml().CloneWithReplacedPath(value.GetPath()), {}, YamlConfig::Mode::kSecure};
+            return YamlConfig{
+                res->GetRawYamlWithoutConfigVars().CloneWithReplacedPath(value.GetPath()),
+                {},
+                YamlConfig::Mode::kSecure,
+            };
         }
     }
 
@@ -167,8 +171,6 @@ std::optional<YamlConfig> GetYamlConfig(
 YamlConfig::YamlConfig(formats::yaml::Value yaml, formats::yaml::Value config_vars, Mode mode)
     : yaml_(std::move(yaml)), config_vars_(std::move(config_vars)), mode_(mode) {}
 
-const formats::yaml::Value& YamlConfig::Yaml() const { return yaml_; }
-
 YamlConfig YamlConfig::operator[](std::string_view key) const {
     if (utils::text::EndsWith(key, "#env") || utils::text::EndsWith(key, "#file") ||
         utils::text::EndsWith(key, "#fallback")) {
@@ -204,7 +206,11 @@ YamlConfig YamlConfig::operator[](size_t index) const {
             /*met_substitution*/ false
         );
         if (res) {
-            return YamlConfig{res->Yaml().CloneWithReplacedPath(value.GetPath()), {}, YamlConfig::Mode::kSecure};
+            return YamlConfig{
+                res->GetRawYamlWithoutConfigVars().CloneWithReplacedPath(value.GetPath()),
+                {},
+                YamlConfig::Mode::kSecure,
+            };
         }
 
         // Avoid parsing $substitution as a string
@@ -258,6 +264,8 @@ YamlConfig::const_iterator YamlConfig::begin() const { return const_iterator{*th
 
 YamlConfig::const_iterator YamlConfig::end() const { return const_iterator{*this, yaml_.end()}; }
 
+formats::yaml::Value YamlConfig::GetRawYamlWithoutConfigVars() const { return yaml_; }
+
 bool Parse(const YamlConfig& value, formats::parse::To<bool>) { return value.yaml_.As<bool>(); }
 
 int64_t Parse(const YamlConfig& value, formats::parse::To<int64_t>) { return value.yaml_.As<int64_t>(); }

universal/src/yaml_config/yaml_config_test.cpp

@@ -454,7 +454,7 @@ TYPED_TEST(YamlConfigAccessor, SquareBracketOperatorArray) {
 
     yaml_config::YamlConfig root_array_data = conf["root"];
     Accessor root_array(root_array_data);
-    EXPECT_TRUE(root_array_data.Yaml().IsArray());
+    EXPECT_TRUE(root_array_data.IsArray());
 
     EXPECT_EQ(root_array[0]["member1"].template As<int>(), 42);
     EXPECT_EQ(root_array[0]["duration"].template As<std::chrono::milliseconds>(), std::chrono::seconds{10});
@@ -525,7 +525,7 @@ TYPED_TEST(YamlConfigAccessor, SquareBracketOperatorObject) {
 
     yaml_config::YamlConfig root_object_data = conf["root"];
     Accessor root_object(root_object_data);
-    EXPECT_TRUE(root_object_data.Yaml().IsObject());
+    EXPECT_TRUE(root_object_data.IsObject());
 
     EXPECT_EQ(root_object["e0"]["member1"].template As<int>(), 42);
     EXPECT_EQ(root_object["e0"]["duration"].template As<std::chrono::milliseconds>(), std::chrono::seconds{10});
@@ -633,7 +633,7 @@ TEST(YamlConfig, SubconfigNotObject) {
 
     yaml_config::YamlConfig conf(std::move(node), std::move(vmap));
     EXPECT_EQ(conf["member"].As<std::string>(), "hello");
-    EXPECT_TRUE(conf.Yaml().IsObject());
+    EXPECT_TRUE(conf.IsObject());
     // Get subconfig that is not an object
     auto subconf = conf["member"];
     // It must throw an exception
@@ -659,7 +659,7 @@ TEST(YamlConfig, IteratorArray) {
     yaml_config::YamlConfig conf(std::move(node), std::move(vmap));
 
     auto root_array = conf["root"];
-    EXPECT_TRUE(root_array.Yaml().IsArray());
+    EXPECT_TRUE(root_array.IsArray());
 
     // Testing basics
     auto it = root_array.begin();