Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

downstream: refactoring code to remove listener hard deps #24394

Merged
merged 2 commits into from
Dec 7, 2022
Merged

downstream: refactoring code to remove listener hard deps #24394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7175177
downstream: refactoring code to remove listener hard deps
alyssawilk Dec 6, 2022
7d4679b
tidy
alyssawilk Dec 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions envoy/server/factory_context.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,13 @@ class FilterChainFactoryContext : public virtual FactoryContext {
};

using FilterChainFactoryContextPtr = std::unique_ptr<FilterChainFactoryContext>;
using FilterChainsByName = absl::flat_hash_map<std::string, Network::DrainableFilterChainSharedPtr>;

class FilterChainBaseAction : public Matcher::Action {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in retrospect I should have commented this up when moving it. If there end up being no other comments I'm inclined to do in the immediate follow-up to spare the 4 hour CI process.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM! I did have one additional comment but it was to add a comment, so feel free to address both in a follow up instead of waiting on CI again!

public:
virtual const Network::FilterChain* get(const FilterChainsByName& filter_chains_by_name,
const StreamInfo::StreamInfo& info) const PURE;
};

/**
* An implementation of FactoryContext. The life time should cover the lifetime of the filter chains
Expand Down
7 changes: 2 additions & 5 deletions source/common/quic/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ envoy_cc_library(
":quic_transport_socket_factory_lib",
"//envoy/ssl:tls_certificate_config_interface",
"//source/common/stream_info:stream_info_lib",
"//source/server:connection_handler_lib",
"//source/server:listener_stats",
"@com_github_google_quiche//:quic_core_crypto_certificate_view_lib",
],
)
Expand Down Expand Up @@ -324,7 +324,6 @@ envoy_cc_library(
":quic_io_handle_wrapper_lib",
":quic_network_connection_lib",
"//source/common/quic:envoy_quic_utils_lib",
"//source/server:connection_handler_lib",
"@com_github_google_quiche//:quic_core_connection_lib",
],
)
Expand Down Expand Up @@ -357,7 +356,6 @@ envoy_cc_library(
":envoy_quic_server_session_lib",
":quic_stat_names_lib",
"//envoy/network:listener_interface",
"//source/server:connection_handler_lib",
"@com_github_google_quiche//:quic_core_server_lib",
"@com_github_google_quiche//:quic_core_utils_lib",
],
Expand Down Expand Up @@ -387,7 +385,7 @@ envoy_cc_library(
"//source/common/protobuf:utility_lib",
"//source/common/runtime:runtime_lib",
"//source/extensions/quic/connection_id_generator:envoy_deterministic_connection_id_generator_config",
"//source/server:connection_handler_lib",
"//source/server:active_udp_listener",
"@envoy_api//envoy/config/listener/v3:pkg_cc_proto",
"@envoy_api//envoy/extensions/quic/connection_id_generator/v3:pkg_cc_proto",
"@envoy_api//envoy/extensions/quic/crypto_stream/v3:pkg_cc_proto",
Expand Down Expand Up @@ -516,7 +514,6 @@ envoy_cc_library(
tags = ["nofips"],
deps = [
"//envoy/config:typed_config_interface",
"//source/server:connection_handler_lib",
"@com_github_google_quiche//:quic_core_crypto_proof_source_lib",
],
)
Expand Down
3 changes: 1 addition & 2 deletions source/common/quic/envoy_quic_dispatcher.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
#include "source/common/quic/envoy_quic_crypto_stream_factory.h"
#include "source/common/quic/envoy_quic_server_session.h"
#include "source/common/quic/quic_stat_names.h"
#include "source/server/active_listener_base.h"
#include "source/server/connection_handler_impl.h"
#include "source/server/listener_stats.h"

#include "quiche/quic/core/quic_dispatcher.h"
#include "quiche/quic/core/quic_utils.h"
Expand Down
3 changes: 1 addition & 2 deletions source/common/quic/envoy_quic_proof_source.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

#include "source/common/quic/envoy_quic_proof_source_base.h"
#include "source/common/quic/quic_transport_socket_factory.h"
#include "source/server/active_listener_base.h"
#include "source/server/connection_handler_impl.h"
#include "source/server/listener_stats.h"

namespace Envoy {
namespace Quic {
Expand Down
2 changes: 1 addition & 1 deletion source/common/quic/envoy_quic_proof_source_factory_interface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#include "envoy/network/filter.h"
#include "envoy/network/socket.h"

#include "source/server/active_listener_base.h"
#include "source/server/listener_stats.h"

#include "quiche/quic/core/crypto/proof_source.h"

Expand Down
1 change: 0 additions & 1 deletion source/common/quic/envoy_quic_server_connection.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

#include "source/common/quic/envoy_quic_utils.h"
#include "source/common/quic/quic_network_connection.h"
#include "source/server/connection_handler_impl.h"

#include "quiche/quic/core/quic_connection.h"

Expand Down
1 change: 0 additions & 1 deletion source/extensions/matching/actions/format_string/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ envoy_cc_extension(
"//source/common/formatter:substitution_format_string_lib",
"//source/common/http:header_map_lib",
"//source/common/matcher:matcher_lib",
"//source/server:filter_chain_manager_lib",
"@envoy_api//envoy/config/core/v3:pkg_cc_proto",
],
)
9 changes: 5 additions & 4 deletions source/extensions/matching/actions/format_string/config.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ namespace Matching {
namespace Actions {
namespace FormatString {

const Network::FilterChain* ActionImpl::get(const Server::FilterChainsByName& filter_chains_by_name,
const StreamInfo::StreamInfo& info) const {
const Network::FilterChain*
ActionImpl::get(const Server::Configuration::FilterChainsByName& filter_chains_by_name,
const StreamInfo::StreamInfo& info) const {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, why did this line change? It looks identical but just re-wrapped. Did clang-format dislike the old formatting, I guess?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Server::FilterChainsByName -> Server::Configuration::FilterChainsByName
because it was declared in the envoy/ file which has a different namespace

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow! I read that probably 10 times before sending that comment and yet still failed to notice the difference! facepalm

Thanks!

const std::string name =
formatter_->format(*Http::StaticEmptyHeaders::get().request_headers,
*Http::StaticEmptyHeaders::get().response_headers,
Expand All @@ -27,7 +28,7 @@ const Network::FilterChain* ActionImpl::get(const Server::FilterChainsByName& fi

Matcher::ActionFactoryCb
ActionFactory::createActionFactoryCb(const Protobuf::Message& proto_config,
Server::FilterChainActionFactoryContext& context,
FilterChainActionFactoryContext& context,
ProtobufMessage::ValidationVisitor& validator) {
const auto& config =
MessageUtil::downcastAndValidate<const envoy::config::core::v3::SubstitutionFormatString&>(
Expand All @@ -37,7 +38,7 @@ ActionFactory::createActionFactoryCb(const Protobuf::Message& proto_config,
return [formatter]() { return std::make_unique<ActionImpl>(formatter); };
}

REGISTER_FACTORY(ActionFactory, Matcher::ActionFactory<Server::FilterChainActionFactoryContext>);
REGISTER_FACTORY(ActionFactory, Matcher::ActionFactory<FilterChainActionFactoryContext>);

} // namespace FormatString
} // namespace Actions
Expand Down
13 changes: 7 additions & 6 deletions source/extensions/matching/actions/format_string/config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
#include "envoy/server/factory_context.h"

#include "source/common/matcher/matcher.h"
#include "source/server/filter_chain_manager_impl.h"

namespace Envoy {
namespace Extensions {
Expand All @@ -16,22 +15,24 @@ namespace Actions {
namespace FormatString {

class ActionImpl : public Matcher::ActionBase<envoy::config::core::v3::SubstitutionFormatString,
Server::FilterChainBaseAction> {
Server::Configuration::FilterChainBaseAction> {
public:
ActionImpl(const Formatter::FormatterConstSharedPtr& formatter) : formatter_(formatter) {}
const Network::FilterChain* get(const Server::FilterChainsByName& filter_chains_by_name,
const StreamInfo::StreamInfo& info) const override;
const Network::FilterChain*
get(const Server::Configuration::FilterChainsByName& filter_chains_by_name,
const StreamInfo::StreamInfo& info) const override;

private:
const Formatter::FormatterConstSharedPtr formatter_;
};

class ActionFactory : public Matcher::ActionFactory<Server::FilterChainActionFactoryContext> {
using FilterChainActionFactoryContext = Server::Configuration::ServerFactoryContext;
class ActionFactory : public Matcher::ActionFactory<FilterChainActionFactoryContext> {
public:
std::string name() const override { return "envoy.matching.actions.format_string"; }
Matcher::ActionFactoryCb
createActionFactoryCb(const Protobuf::Message& proto_config,
Server::FilterChainActionFactoryContext& context,
FilterChainActionFactoryContext& context,
ProtobufMessage::ValidationVisitor& validator) override;
ProtobufTypes::MessagePtr createEmptyConfigProto() override {
return std::make_unique<envoy::config::core::v3::SubstitutionFormatString>();
Expand Down
11 changes: 11 additions & 0 deletions source/server/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,23 @@ envoy_cc_library(
],
)

envoy_cc_library(
name = "listener_stats",
hdrs = [
"listener_stats.h",
],
deps = [
"//source/common/stats:timespan_lib",
],
)

envoy_cc_library(
name = "active_listener_base",
hdrs = [
"active_listener_base.h",
],
deps = [
":listener_stats",
"//envoy/network:connection_handler_interface",
"//envoy/network:listener_interface",
"//envoy/stats:timespan_interface",
Expand Down
35 changes: 2 additions & 33 deletions source/server/active_listener_base.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,11 @@
#include "envoy/network/listener.h"
#include "envoy/stats/scope.h"

#include "source/server/listener_stats.h"

namespace Envoy {
namespace Server {

#define ALL_LISTENER_STATS(COUNTER, GAUGE, HISTOGRAM) \
COUNTER(downstream_cx_destroy) \
COUNTER(downstream_cx_overflow) \
COUNTER(downstream_cx_total) \
COUNTER(downstream_cx_transport_socket_connect_timeout) \
COUNTER(downstream_cx_overload_reject) \
COUNTER(downstream_global_cx_overflow) \
COUNTER(downstream_pre_cx_timeout) \
COUNTER(downstream_listener_filter_remote_close) \
COUNTER(downstream_listener_filter_error) \
COUNTER(no_filter_chain_match) \
GAUGE(downstream_cx_active, Accumulate) \
GAUGE(downstream_pre_cx_active, Accumulate) \
HISTOGRAM(downstream_cx_length_ms, Milliseconds)

/**
* Wrapper struct for listener stats. @see stats_macros.h
*/
struct ListenerStats {
ALL_LISTENER_STATS(GENERATE_COUNTER_STRUCT, GENERATE_GAUGE_STRUCT, GENERATE_HISTOGRAM_STRUCT)
};

#define ALL_PER_HANDLER_LISTENER_STATS(COUNTER, GAUGE) \
COUNTER(downstream_cx_total) \
GAUGE(downstream_cx_active, Accumulate)

/**
* Wrapper struct for per-handler listener stats. @see stats_macros.h
*/
struct PerHandlerListenerStats {
ALL_PER_HANDLER_LISTENER_STATS(GENERATE_COUNTER_STRUCT, GENERATE_GAUGE_STRUCT)
};

/**
* Wrapper for an active listener owned by this handler.
*/
Expand Down
5 changes: 3 additions & 2 deletions source/server/filter_chain_manager_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Network::Address::InstanceConstSharedPtr fakeAddress() {
}

struct FilterChainNameAction
: public Matcher::ActionBase<ProtobufWkt::StringValue, FilterChainBaseAction> {
: public Matcher::ActionBase<ProtobufWkt::StringValue, Configuration::FilterChainBaseAction> {
explicit FilterChainNameAction(const std::string& name) : name_(name) {}
const Network::FilterChain* get(const FilterChainsByName& filter_chains_by_name,
const StreamInfo::StreamInfo&) const override {
Expand Down Expand Up @@ -591,7 +591,8 @@ FilterChainManagerImpl::findFilterChainUsingMatcher(const Network::ConnectionSoc
"Matching must complete for network streams.");
if (match_result.result_) {
const auto result = match_result.result_();
return result->getTyped<FilterChainBaseAction>().get(filter_chains_by_name_, info);
return result->getTyped<Configuration::FilterChainBaseAction>().get(filter_chains_by_name_,
info);
}
return default_filter_chain_.get();
}
Expand Down
6 changes: 0 additions & 6 deletions source/server/filter_chain_manager_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,6 @@ class PerFilterChainFactoryContextImpl : public Configuration::FilterChainFactor
using FilterChainActionFactoryContext = Configuration::ServerFactoryContext;
using FilterChainsByName = absl::flat_hash_map<std::string, Network::DrainableFilterChainSharedPtr>;

class FilterChainBaseAction : public Matcher::Action {
public:
virtual const Network::FilterChain* get(const FilterChainsByName& filter_chains_by_name,
const StreamInfo::StreamInfo& info) const PURE;
};

class FilterChainImpl : public Network::DrainableFilterChain {
public:
FilterChainImpl(Network::DownstreamTransportSocketFactoryPtr&& transport_socket_factory,
Expand Down
43 changes: 43 additions & 0 deletions source/server/listener_stats.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
#pragma once

#include "envoy/stats/scope.h"
#include "envoy/stats/stats_macros.h"

namespace Envoy {
namespace Server {

#define ALL_LISTENER_STATS(COUNTER, GAUGE, HISTOGRAM) \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a brief comment here.

COUNTER(downstream_cx_destroy) \
COUNTER(downstream_cx_overflow) \
COUNTER(downstream_cx_total) \
COUNTER(downstream_cx_transport_socket_connect_timeout) \
COUNTER(downstream_cx_overload_reject) \
COUNTER(downstream_global_cx_overflow) \
COUNTER(downstream_pre_cx_timeout) \
COUNTER(downstream_listener_filter_remote_close) \
COUNTER(downstream_listener_filter_error) \
COUNTER(no_filter_chain_match) \
GAUGE(downstream_cx_active, Accumulate) \
GAUGE(downstream_pre_cx_active, Accumulate) \
HISTOGRAM(downstream_cx_length_ms, Milliseconds)

/**
* Wrapper struct for listener stats. @see stats_macros.h
*/
struct ListenerStats {
ALL_LISTENER_STATS(GENERATE_COUNTER_STRUCT, GENERATE_GAUGE_STRUCT, GENERATE_HISTOGRAM_STRUCT)
};

#define ALL_PER_HANDLER_LISTENER_STATS(COUNTER, GAUGE) \
COUNTER(downstream_cx_total) \
GAUGE(downstream_cx_active, Accumulate)

/**
* Wrapper struct for per-handler listener stats. @see stats_macros.h
*/
struct PerHandlerListenerStats {
ALL_PER_HANDLER_LISTENER_STATS(GENERATE_COUNTER_STRUCT, GENERATE_GAUGE_STRUCT)
};

} // namespace Server
} // namespace Envoy
1 change: 1 addition & 0 deletions test/common/quic/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,7 @@ envoy_cc_test(
"//source/common/quic:envoy_quic_server_session_lib",
"//source/extensions/quic/crypto_stream:envoy_quic_crypto_server_stream_lib",
"//source/server:configuration_lib",
"//source/server:connection_handler_lib",
"//test/mocks/event:event_mocks",
"//test/mocks/http:http_mocks",
"//test/mocks/network:network_mocks",
Expand Down
1 change: 1 addition & 0 deletions test/common/quic/envoy_quic_dispatcher_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#include "source/common/quic/quic_transport_socket_factory.h"
#include "source/extensions/quic/crypto_stream/envoy_quic_crypto_server_stream.h"
#include "source/server/configuration_impl.h"
#include "source/server/connection_handler_impl.h"

#include "test/common/quic/test_proof_source.h"
#include "test/common/quic/test_utils.h"
Expand Down
4 changes: 2 additions & 2 deletions test/extensions/matching/actions/format_string/config_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ TEST(ConfigTest, TestConfig) {
ASSERT_NE(nullptr, action_cb);
auto action = action_cb();
ASSERT_NE(nullptr, action);
const auto& typed_action = action->getTyped<Server::FilterChainBaseAction>();
const auto& typed_action = action->getTyped<Server::Configuration::FilterChainBaseAction>();

Server::FilterChainsByName chains;
Server::Configuration::FilterChainsByName chains;
auto chain = std::make_shared<testing::NiceMock<Network::MockFilterChain>>();
chains.emplace("foo", chain);

Expand Down