Skip to content

Commit 755411e

Browse files
marcalffmarcalff
authored
[CONFIGURATION] File configuration - parser location (open-telemetry#3705)
1 parent 82f72f5 commit 755411e

File tree

14 files changed

+197
-99
lines changed

14 files changed

+197
-99
lines changed

‎.iwyu.imp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
# Work around for ryml
1515
{ "include": ["<c4/std/string.hpp>", "private", "<ryml_std.hpp>", "public"] },
1616

17+
{ "include": ["<c4/yml/common.hpp>", "private", "<ryml.hpp>", "public"] },
1718
{ "include": ["<c4/yml/node.hpp>", "private", "<ryml.hpp>", "public"] },
1819
{ "include": ["<c4/yml/parse.hpp>", "private", "<ryml.hpp>", "public"] },
1920
{ "include": ["<c4/yml/parse_engine.hpp>", "private", "<ryml.hpp>", "public"] },

‎functional/configuration/shelltests/empty.test‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33

44
$ example_yaml --test --yaml shelltests/empty.yaml
55
>
6-
[ERROR] [Yaml Configuration Parser] Parse failed with exception: Yaml: not a map, looking for: file_format
6+
[ERROR] <shelltests/empty.yaml>:0[0](0): Yaml: not a map, looking for: file_format
77
FAILED TO PARSE MODEL
88
>= 1

‎functional/configuration/shelltests/format_empty.test‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33

44
$ example_yaml --test --yaml shelltests/format_empty.yaml
55
>
6-
[ERROR] [Yaml Configuration Parser] Parse failed with exception: Yaml: string value is empty: file_format
6+
[ERROR] <shelltests/format_empty.yaml>:4[0](94): Yaml: string value is empty: file_format
77
FAILED TO PARSE MODEL
88
>= 1

‎functional/configuration/shelltests/propagator_broken.test‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33

44
$ example_yaml --test --yaml shelltests/propagator_broken.yaml
55
>
6-
[ERROR] [Yaml Configuration Parser] Parse failed with exception: Illegal composite child 2, properties count: 3
6+
[ERROR] <shelltests/propagator_broken.yaml>:10[6](206): Illegal composite child 2, properties count: 3
77
FAILED TO PARSE MODEL
88
>= 1

‎sdk/include/opentelemetry/sdk/configuration/configuration_parser.h‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,8 @@ namespace configuration
9999
class ConfigurationParser
100100
{
101101
public:
102-
OtlpHttpEncoding ParseOtlpHttpEncoding(const std::string &name) const;
102+
OtlpHttpEncoding ParseOtlpHttpEncoding(const std::unique_ptr<DocumentNode> &node,
103+
const std::string &name) const;
103104

104105
std::unique_ptr<StringArrayConfiguration> ParseStringArrayConfiguration(
105106
const std::unique_ptr<DocumentNode> &node) const;
@@ -151,9 +152,12 @@ class ConfigurationParser
151152
std::unique_ptr<LoggerProviderConfiguration> ParseLoggerProviderConfiguration(
152153
const std::unique_ptr<DocumentNode> &node) const;
153154

154-
DefaultHistogramAggregation ParseDefaultHistogramAggregation(const std::string &name) const;
155+
DefaultHistogramAggregation ParseDefaultHistogramAggregation(
156+
const std::unique_ptr<DocumentNode> &node,
157+
const std::string &name) const;
155158

156-
TemporalityPreference ParseTemporalityPreference(const std::string &name) const;
159+
TemporalityPreference ParseTemporalityPreference(const std::unique_ptr<DocumentNode> &node,
160+
const std::string &name) const;
157161

158162
std::unique_ptr<OtlpHttpPushMetricExporterConfiguration>
159163
ParseOtlpHttpPushMetricExporterConfiguration(const std::unique_ptr<DocumentNode> &node) const;
@@ -203,7 +207,8 @@ class ConfigurationParser
203207
std::unique_ptr<MetricReaderConfiguration> ParseMetricReaderConfiguration(
204208
const std::unique_ptr<DocumentNode> &node) const;
205209

206-
InstrumentType ParseInstrumentType(const std::string &name) const;
210+
InstrumentType ParseInstrumentType(const std::unique_ptr<DocumentNode> &node,
211+
const std::string &name) const;
207212

208213
std::unique_ptr<ViewSelectorConfiguration> ParseViewSelectorConfiguration(
209214
const std::unique_ptr<DocumentNode> &node) const;

‎sdk/include/opentelemetry/sdk/configuration/document_node.h‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ namespace configuration
1616

1717
class DocumentNodeConstIterator;
1818
class PropertiesNodeConstIterator;
19+
class DocumentNodeLocation;
1920

2021
class DocumentNode
2122
{
@@ -30,6 +31,8 @@ class DocumentNode
3031
DocumentNode &operator=(const DocumentNode &other) = default;
3132
virtual ~DocumentNode() = default;
3233

34+
virtual DocumentNodeLocation Location() const = 0;
35+
3336
virtual std::string Key() const = 0;
3437

3538
virtual bool AsBoolean() const = 0;
@@ -172,6 +175,17 @@ class PropertiesNodeConstIterator
172175
std::unique_ptr<PropertiesNodeConstIteratorImpl> impl_;
173176
};
174177

178+
class DocumentNodeLocation
179+
{
180+
public:
181+
size_t offset;
182+
size_t line;
183+
size_t col;
184+
std::string filename;
185+
186+
std::string ToString() const;
187+
};
188+
175189
} // namespace configuration
176190
} // namespace sdk
177191
OPENTELEMETRY_END_NAMESPACE

‎sdk/include/opentelemetry/sdk/configuration/invalid_schema_exception.h‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,14 @@ namespace configuration
1919
class InvalidSchemaException : public std::runtime_error
2020
{
2121
public:
22-
InvalidSchemaException(const std::string &msg) : std::runtime_error(msg) {}
22+
InvalidSchemaException(const DocumentNodeLocation &location, const std::string &msg)
23+
: std::runtime_error(msg), location_(location)
24+
{}
25+
26+
std::string Where() const { return location_.ToString(); }
27+
28+
private:
29+
DocumentNodeLocation location_;
2330
};
2431

2532
} // namespace configuration

‎sdk/include/opentelemetry/sdk/configuration/ryml_document.h‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,23 @@ class RymlDocument : public Document
2222
public:
2323
static std::unique_ptr<Document> Parse(const std::string &source, const std::string &content);
2424

25-
RymlDocument(ryml::Tree tree) : tree_(std::move(tree)) {}
25+
RymlDocument() {}
2626
RymlDocument(RymlDocument &&) = delete;
2727
RymlDocument(const RymlDocument &) = delete;
2828
RymlDocument &operator=(RymlDocument &&) = delete;
2929
RymlDocument &operator=(const RymlDocument &other) = delete;
3030
~RymlDocument() override = default;
3131

32+
int ParseDocument(const std::string &source, const std::string &content);
33+
3234
std::unique_ptr<DocumentNode> GetRootNode() override;
3335

36+
DocumentNodeLocation Location(ryml::ConstNodeRef node) const;
37+
3438
private:
39+
ryml::ParserOptions opts_;
40+
ryml::Parser::handler_type event_handler_;
41+
std::unique_ptr<ryml::Parser> parser_;
3542
ryml::Tree tree_;
3643
};
3744

‎sdk/include/opentelemetry/sdk/configuration/ryml_document_node.h‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,22 @@ namespace sdk
1717
namespace configuration
1818
{
1919

20+
class RymlDocument;
21+
2022
class RymlDocumentNode : public DocumentNode
2123
{
2224
public:
23-
RymlDocumentNode(ryml::ConstNodeRef node, std::size_t depth) : node_(node), depth_(depth) {}
25+
RymlDocumentNode(const RymlDocument *doc, ryml::ConstNodeRef node, std::size_t depth)
26+
: doc_(doc), node_(node), depth_(depth)
27+
{}
2428
RymlDocumentNode(RymlDocumentNode &&) = delete;
2529
RymlDocumentNode(const RymlDocumentNode &) = delete;
2630
RymlDocumentNode &operator=(RymlDocumentNode &&) = delete;
2731
RymlDocumentNode &operator=(const RymlDocumentNode &other) = delete;
2832
~RymlDocumentNode() override = default;
2933

34+
DocumentNodeLocation Location() const override;
35+
3036
std::string Key() const override;
3137

3238
bool AsBoolean() const override;
@@ -62,14 +68,16 @@ class RymlDocumentNode : public DocumentNode
6268
ryml::ConstNodeRef GetRequiredRymlChildNode(const std::string &name) const;
6369
ryml::ConstNodeRef GetRymlChildNode(const std::string &name) const;
6470

71+
const RymlDocument *doc_;
6572
ryml::ConstNodeRef node_;
6673
std::size_t depth_;
6774
};
6875

6976
class RymlDocumentNodeConstIteratorImpl : public DocumentNodeConstIteratorImpl
7077
{
7178
public:
72-
RymlDocumentNodeConstIteratorImpl(ryml::ConstNodeRef parent,
79+
RymlDocumentNodeConstIteratorImpl(const RymlDocument *doc,
80+
ryml::ConstNodeRef parent,
7381
std::size_t index,
7482
std::size_t depth);
7583
RymlDocumentNodeConstIteratorImpl(RymlDocumentNodeConstIteratorImpl &&) = delete;
@@ -84,6 +92,7 @@ class RymlDocumentNodeConstIteratorImpl : public DocumentNodeConstIteratorImpl
8492
bool Equal(const DocumentNodeConstIteratorImpl *rhs) const override;
8593

8694
private:
95+
const RymlDocument *doc_;
8796
ryml::ConstNodeRef parent_;
8897
std::size_t index_;
8998
std::size_t depth_;
@@ -92,7 +101,8 @@ class RymlDocumentNodeConstIteratorImpl : public DocumentNodeConstIteratorImpl
92101
class RymlPropertiesNodeConstIteratorImpl : public PropertiesNodeConstIteratorImpl
93102
{
94103
public:
95-
RymlPropertiesNodeConstIteratorImpl(ryml::ConstNodeRef parent,
104+
RymlPropertiesNodeConstIteratorImpl(const RymlDocument *doc,
105+
ryml::ConstNodeRef parent,
96106
std::size_t index,
97107
std::size_t depth);
98108
RymlPropertiesNodeConstIteratorImpl(RymlPropertiesNodeConstIteratorImpl &&) = delete;
@@ -108,6 +118,7 @@ class RymlPropertiesNodeConstIteratorImpl : public PropertiesNodeConstIteratorIm
108118
bool Equal(const PropertiesNodeConstIteratorImpl *rhs) const override;
109119

110120
private:
121+
const RymlDocument *doc_;
111122
ryml::ConstNodeRef parent_;
112123
std::size_t index_;
113124
std::size_t depth_;

0 commit comments

Comments
 (0)