Skip to content

Commit 74cec3e

Browse files
committed
cc core: rename some middlewares classes
commit_hash:e49b72da0562eafa0fdff33d52e354a4d5ff4ef4
1 parent d493fe8 commit 74cec3e

5 files changed

Lines changed: 25 additions & 23 deletions

File tree

core/include/userver/middlewares/impl/middleware_pipeline_config.hpp

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,19 @@ struct BaseMiddlewareConfig final {
1414
bool enabled{true};
1515
};
1616

17-
struct BasePipelineConfig final {
18-
std::unordered_map<std::string, BaseMiddlewareConfig> middlewares{};
19-
};
20-
2117
BaseMiddlewareConfig Parse(const yaml_config::YamlConfig& value, formats::parse::To<BaseMiddlewareConfig>);
2218

23-
struct MiddlewarePipelineConfig final {
24-
std::unordered_map<std::string, BaseMiddlewareConfig> middlewares{};
19+
using MiddlewaresMap = std::unordered_map<std::string, BaseMiddlewareConfig>;
20+
21+
struct BuiltInConfig final {
22+
MiddlewaresMap middlewares{};
23+
};
24+
25+
struct MiddlewaresConfig final {
26+
MiddlewaresMap middlewares{};
2527
};
2628

27-
MiddlewarePipelineConfig Parse(const yaml_config::YamlConfig& value, formats::parse::To<MiddlewarePipelineConfig>);
29+
MiddlewaresConfig Parse(const yaml_config::YamlConfig& value, formats::parse::To<MiddlewaresConfig>);
2830

2931
struct MiddlewareRunnerConfig final {
3032
std::unordered_map<std::string, yaml_config::YamlConfig> middlewares{};

core/include/userver/middlewares/pipeline.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ namespace middlewares {
2222
/// @brief The dependency type between middlewares.
2323
///
2424
/// Iff dependency type from 'X' to 'Y' is `kStrong` and 'Y' is disabled, middlewares pipeline will failure when start,
25-
/// otherwise (in `kWeak`) we ignore this dependency.
25+
/// otherwise (`kWeak`) we ignore this dependency.
2626
enum class DependencyType {
2727
kStrong = 0,
2828
kWeak = 1,
@@ -84,7 +84,7 @@ class AnyMiddlewarePipelineComponent : public components::ComponentBase {
8484
AnyMiddlewarePipelineComponent(
8585
const components::ComponentConfig& config,
8686
const components::ComponentContext& context,
87-
impl::BasePipelineConfig&& base_config
87+
impl::BuiltInConfig&& builtin_config
8888
);
8989

9090
static yaml_config::Schema GetStaticConfigSchema();

core/src/middlewares/impl/middleware_pipeline_config.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ USERVER_NAMESPACE_BEGIN
66

77
namespace middlewares::impl {
88

9-
MiddlewarePipelineConfig Parse(const yaml_config::YamlConfig& value, formats::parse::To<MiddlewarePipelineConfig>) {
10-
MiddlewarePipelineConfig config;
11-
config.middlewares = value["middlewares"].As<std::unordered_map<std::string, BaseMiddlewareConfig>>({});
9+
MiddlewaresConfig Parse(const yaml_config::YamlConfig& value, formats::parse::To<MiddlewaresConfig>) {
10+
MiddlewaresConfig config;
11+
config.middlewares = value["middlewares"].As<decltype(config.middlewares)>({});
1212
return config;
1313
}
1414

core/src/middlewares/impl/middlewares_graph.cpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ namespace middlewares::impl {
1515

1616
namespace {
1717

18-
bool IsUserverGroup(const std::string& group) {
18+
bool IsGroupBoundary(const std::string& group) {
1919
return utils::text::EndsWith(group, "#end") || utils::text::EndsWith(group, "#begin");
2020
}
2121

@@ -25,7 +25,7 @@ void ValidateConnects(
2525
const Dependencies& dependencies
2626
) {
2727
for (const auto& con : connects) {
28-
if (IsUserverGroup(con.node_name)) {
28+
if (IsGroupBoundary(con.node_name)) {
2929
continue;
3030
}
3131

@@ -49,7 +49,7 @@ void ValidateConnects(
4949
UINVARIANT(
5050
con.type != DependencyType::kStrong,
5151
fmt::format(
52-
"Middleware `{}` does not exist and there is a kStrong dependency from {}.",
52+
"Middleware '{}' does not exist and there is a `kStrong` dependency from '{}'.",
5353
con.node_name,
5454
dep.middleware_name
5555
)
@@ -160,11 +160,11 @@ MiddlewareOrderedList BuildPipeline(Dependencies&& dependencies) {
160160
MiddlewareOrderedList list{};
161161
list.reserve(nodes.size());
162162
for (auto& mid : nodes) {
163-
if (IsUserverGroup(mid)) {
163+
if (IsGroupBoundary(mid)) {
164164
continue;
165165
}
166166
const auto it = dependencies.find(mid);
167-
UINVARIANT(it != dependencies.end(), fmt::format("Middleware {} does not exist.", mid));
167+
UINVARIANT(it != dependencies.end(), fmt::format("Middleware `{}` does not exist.", mid));
168168
list.push_back({mid, it->second.enabled});
169169
}
170170

core/src/middlewares/pipeline.cpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ namespace {
2121
impl::Dependencies MakeDependencies(
2222
const components::ComponentConfig& config,
2323
const components::ComponentContext& context,
24-
impl::BasePipelineConfig&& base_config
24+
impl::BuiltInConfig&& builtin_config
2525
) {
26-
auto builtin_middlewares = base_config.middlewares;
27-
auto pipeline_config = config.As<impl::MiddlewarePipelineConfig>();
26+
auto builtin_middlewares = builtin_config.middlewares;
27+
auto pipeline_config = config.As<impl::MiddlewaresConfig>();
2828
pipeline_config.middlewares.merge(std::move(builtin_middlewares));
2929

3030
impl::Dependencies dependencies{};
@@ -36,7 +36,7 @@ impl::Dependencies MakeDependencies(
3636
auto dep = middleware->GetMiddlewareDependency(utils::impl::InternalTag{});
3737
dep.enabled = conf.enabled;
3838
dependencies.emplace(mname, std::move(dep));
39-
} else if (base_config.middlewares.count(mname) != 0) {
39+
} else if (builtin_config.middlewares.count(mname) != 0) {
4040
impl::MiddlewareDependency fake_dep;
4141
fake_dep.middleware_name = mname;
4242
fake_dep.enabled = false;
@@ -60,7 +60,7 @@ std::vector<std::string> MiddlewarePipeline::GetPerServiceMiddlewares(const impl
6060
const auto& per_service_middlewares = config.middlewares;
6161
for (const auto& [name, enabled] : pipeline_) {
6262
if (const auto it = per_service_middlewares.find(name); it != per_service_middlewares.end()) {
63-
// Per-service enabled is high priority
63+
// Per-service `enabled` has a higher priority than a global priority.
6464
if (it->second.As<BaseMiddlewareConfig>().enabled) {
6565
res.push_back(name);
6666
}
@@ -84,7 +84,7 @@ std::vector<std::string> MiddlewarePipeline::GetPerServiceMiddlewares(const impl
8484
AnyMiddlewarePipelineComponent::AnyMiddlewarePipelineComponent(
8585
const components::ComponentConfig& config,
8686
const components::ComponentContext& context,
87-
impl::BasePipelineConfig&& base_config
87+
impl::BuiltInConfig&& base_config
8888
)
8989
: components::ComponentBase(config, context),
9090
pipeline_(MakeDependencies(config, context, std::move(base_config))) {}

0 commit comments

Comments
 (0)