(trafficserver) branch master updated: records.yaml: Add record name when TS logs unknown fields. (#12030)

[dmeden]

This is an automated email from the ASF dual-hosted git repository.

dmeden pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/master by this push:
     new ad02d7de1e records.yaml: Add record name when TS logs unknown fields. 
(#12030)
ad02d7de1e is described below

commit ad02d7de1e7adfdc99d0cd1dd699261d15bd68b1
Author: Damian Meden <dme...@apache.org>
AuthorDate: Wed Feb 12 10:07:32 2025 +0100

    records.yaml: Add record name when TS logs unknown fields. (#12030)
    
    It basically goes from:
    
     Warn:   Warn: Ignoring field 'x' at Line 17. Not registered and Unknown 
tag type '?'
    
    To:
    
     Warn:   Warn: Ignoring field 'x' [proxy.config.some.field.x] at Line 17. 
Not registered and Unknown tag type '?'
    
    Record name is now included. This helps in case of multiple fields with
    that belong to different maps but have the same name.
---
 src/records/RecYAMLDecoder.cc                 | 4 ++--
 tests/gold_tests/records/records_yaml.test.py | 6 ++++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/src/records/RecYAMLDecoder.cc b/src/records/RecYAMLDecoder.cc
index e708a11948..f0e9d6293e 100644
--- a/src/records/RecYAMLDecoder.cc
+++ b/src/records/RecYAMLDecoder.cc
@@ -94,8 +94,8 @@ SetRecordFromYAMLNode(CfgNode const &field, swoc::Errata 
&errata)
     // we ignore it.
     auto [dtype, e] = detail::try_deduce_type(field.value_node);
     if (!e.empty()) {
-      errata.note(ERRATA_WARN, "Ignoring field '{}' at Line {}. Not registered 
and {}", field.node.as<std::string>(),
-                  field.node.Mark().line + 1, e);
+      errata.note(ERRATA_WARN, "Ignoring field '{}' [{}] at Line {}. Not 
registered and {}", field.node.as<std::string>(),
+                  field.get_record_name(), field.node.Mark().line + 1, e);
       // We can't continue without knowing the type.
       return;
     }
diff --git a/tests/gold_tests/records/records_yaml.test.py 
b/tests/gold_tests/records/records_yaml.test.py
index 6a3f4ebc23..95fd59b429 100644
--- a/tests/gold_tests/records/records_yaml.test.py
+++ b/tests/gold_tests/records/records_yaml.test.py
@@ -66,8 +66,10 @@ ts.Disk.diags_log.Content = 
Testers.ContainsExpression(f"Unrecognized configurat
 var2 = 'proxy.config.test.not_registered.field2'
 ts.Disk.diags_log.Content += Testers.ContainsExpression(f"Unrecognized 
configuration value '{var2}", "Field should be ignored")
 
-ts.Disk.traffic_out.Content += Testers.ContainsExpression(f"Ignoring field 
'filenamee'", "Field should be ignored")
-ts.Disk.traffic_out.Content += Testers.ContainsExpression(f"Ignoring field 
'filenam'", "Field should be ignored")
+ts.Disk.traffic_out.Content += Testers.ContainsExpression(
+    f"Ignoring field 'filenamee' 
\\[proxy.config.ssl.client.cert.filenamee\\]", "Field should be ignored")
+ts.Disk.traffic_out.Content += Testers.ContainsExpression(
+    f"Ignoring field 'filenam' \\[proxy.config.ssl.client.cert.filenam\\]", 
"Field should be ignored")
 
 # 1
 tr = Test.AddTestRun("Query unregistered records.")