Copilot commented on code in PR #13579: URL: https://github.com/apache/trafficserver/pull/13579#discussion_r4324738634
########## src/proxy/http/unit_tests/test_HttpSessionManager.cc: ########## @@ -0,0 +1,337 @@ +/** @file + + Unit tests for ServerSessionPool::acquireSession. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include "proxy/http/HttpSessionManager.h" +#include "proxy/http/HttpConfig.h" + +#include <catch2/catch_test_macros.hpp> + +#include <cstring> +#include <memory> +#include <vector> + +namespace +{ + +/** A minimal PoolableSession that can be pooled and matched. + * + * Only the remote address and the hostname hash participate in the match + * paths exercised here, so no NetVConnection is required. The session must + * not be multiplexing, otherwise acquireSession consults the HttpSM. + */ +class TestPoolableSession : public PoolableSession +{ +public: + TestPoolableSession(char const *addr_str, char const *hostname) + { + ink_release_assert(ats_ip_pton(addr_str, &_remote_addr) == 0); + this->attach_hostname(hostname); + } + + void + new_connection(NetVConnection *, MIOBuffer *, IOBufferReader *) override + { + } + void + start() override + { + } + void + release(ProxyTransaction *) override + { + } + void + destroy() override + { + } + void + free() override + { + } + void + increment_current_active_connections_stat() override + { + } + void + decrement_current_active_connections_stat() override + { + } + + int + get_transact_count() const override + { + return 0; + } + + const char * + get_protocol_string() const override + { + return "test"; + } + + IOBufferReader * + get_remote_reader() override + { + return nullptr; + } + + void + do_io_close(int /* lerrno ATS_UNUSED */ = -1) override + { + ++close_count; + } + + sockaddr const * + get_remote_addr() const override + { + return &_remote_addr.sa; + } + + int close_count = 0; + +private: + IpEndpoint _remote_addr; +}; + +/// Owns the test sessions and hands raw pointers to the pool under test. +class SessionFactory +{ +public: + TestPoolableSession * + make(char const *addr_str, char const *hostname) + { + return _sessions.emplace_back(std::make_unique<TestPoolableSession>(addr_str, hostname)).get(); + } + +private: + std::vector<std::unique_ptr<TestPoolableSession>> _sessions; +}; + +/// The pool bookkeeping updates this gauge, which is normally initialized via HttpConfig. +/// Create it here (when needed) and reset it between Catch2 runs so tests don't leak state. +void +init_metrics() +{ + if (http_rsb.pooled_server_connections == nullptr) { + http_rsb.pooled_server_connections = Metrics::Gauge::createPtr("proxy.process.http.pooled_server_connections"); + } + Metrics::Gauge::store(http_rsb.pooled_server_connections, 0); +} Review Comment: This test mutates global metric state and relies on manual reset. To prevent state leaks if the test exits early (e.g., a future change introduces `REQUIRE`/exceptions), consider using a scope-based cleanup (RAII guard) that restores `pooled_server_connections` on every exit path. ########## src/proxy/http/unit_tests/test_HttpSessionManager.cc: ########## @@ -0,0 +1,337 @@ +/** @file + + Unit tests for ServerSessionPool::acquireSession. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include "proxy/http/HttpSessionManager.h" +#include "proxy/http/HttpConfig.h" + +#include <catch2/catch_test_macros.hpp> + +#include <cstring> +#include <memory> +#include <vector> + +namespace +{ + +/** A minimal PoolableSession that can be pooled and matched. + * + * Only the remote address and the hostname hash participate in the match + * paths exercised here, so no NetVConnection is required. The session must + * not be multiplexing, otherwise acquireSession consults the HttpSM. + */ +class TestPoolableSession : public PoolableSession +{ +public: + TestPoolableSession(char const *addr_str, char const *hostname) + { + ink_release_assert(ats_ip_pton(addr_str, &_remote_addr) == 0); + this->attach_hostname(hostname); + } + + void + new_connection(NetVConnection *, MIOBuffer *, IOBufferReader *) override + { + } + void + start() override + { + } + void + release(ProxyTransaction *) override + { + } + void + destroy() override + { + } + void + free() override + { + } + void + increment_current_active_connections_stat() override + { + } + void + decrement_current_active_connections_stat() override + { + } + + int + get_transact_count() const override + { + return 0; + } + + const char * + get_protocol_string() const override + { + return "test"; + } + + IOBufferReader * + get_remote_reader() override + { + return nullptr; + } + + void + do_io_close(int /* lerrno ATS_UNUSED */ = -1) override + { + ++close_count; + } + + sockaddr const * + get_remote_addr() const override + { + return &_remote_addr.sa; + } + + int close_count = 0; + +private: + IpEndpoint _remote_addr; +}; + +/// Owns the test sessions and hands raw pointers to the pool under test. +class SessionFactory +{ +public: + TestPoolableSession * + make(char const *addr_str, char const *hostname) + { + return _sessions.emplace_back(std::make_unique<TestPoolableSession>(addr_str, hostname)).get(); + } + +private: + std::vector<std::unique_ptr<TestPoolableSession>> _sessions; +}; + +/// The pool bookkeeping updates this gauge, which is normally initialized via HttpConfig. +/// Create it here (when needed) and reset it between Catch2 runs so tests don't leak state. +void +init_metrics() +{ + if (http_rsb.pooled_server_connections == nullptr) { + http_rsb.pooled_server_connections = Metrics::Gauge::createPtr("proxy.process.http.pooled_server_connections"); + } + Metrics::Gauge::store(http_rsb.pooled_server_connections, 0); +} + +CryptoHash +hash_of(char const *hostname) +{ + CryptoHash hash; + + CryptoContext().hash_immediate(hash, static_cast<unsigned char const *>(static_cast<void const *>(hostname)), + std::strlen(hostname)); Review Comment: The cast sequence here is unnecessarily complex and makes the intent harder to read. Prefer a single explicit cast to the expected byte-pointer type (keeping const-correctness) to improve readability. ########## include/proxy/http/HttpSessionManager.h: ########## @@ -89,14 +89,35 @@ class ServerSessionPool : public Continuation static bool match(PoolableSession *ss, sockaddr const *addr, CryptoHash const &host_hash, TSServerSessionSharingMatchMask match_style); - /** Get a session from the pool. - - The session is selected based on @a match_style equivalently to @a match. If found the session - is removed from the pool. - - @return A pointer to the session or @c NULL if not matching session was found. - */ - HSMresult_t acquireSession(sockaddr const *addr, CryptoHash const &host_hash, TSServerSessionSharingMatchMask match_style, + /** Search the pool for a server session compatible with the given address, hostname, and state machine. + * + * The selection criteria are controlled by @p match_style. At least one of + * @c TS_SERVER_SESSION_SHARING_MATCH_MASK_IP or @c TS_SERVER_SESSION_SHARING_MATCH_MASK_HOSTONLY + * must be set for a match to be possible; if neither is set, @c HSMresult_t::NOT_FOUND is + * returned unconditionally. + * + * When a compatible session is found and does not support multiplexed streams, it is removed from + * the pool and ownership transfers to the caller. A session that supports multiplexed streams is + * not removed and remains available for subsequent acquisitions. + * + * @param[in] addr Remote address and port to match. + * @param[in] hostname_hash Cryptographic hash of the target hostname. + * @param[in] match_style Bitmask of @c TSServerSessionSharingMatchMask values specifying which + * attributes must agree between the candidate session and the request. + * @param[in] sm The requesting HTTP state machine. Must be non-null when any SNI, + * HOSTSNISYNC, or CERT bit is set in @p match_style, or when the pool + * may contain multiplexing sessions; when non-null, @c t_state.scheme + * and @c t_state.hdr_info.server_request must be initialized. Review Comment: The phrase 'when the pool may contain multiplexing sessions' is ambiguous for callers (most pools 'may' contain them depending on runtime behavior). Consider rewording to an unambiguous condition (e.g., based on the requested protocol / multiplexing capability) and/or explicitly documenting what `acquireSession` does if `sm == nullptr` and a multiplexing candidate is encountered (e.g., skip candidate vs assert vs return a specific result). ########## src/proxy/http/unit_tests/test_HttpSessionManager.cc: ########## @@ -0,0 +1,337 @@ +/** @file + + Unit tests for ServerSessionPool::acquireSession. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include "proxy/http/HttpSessionManager.h" +#include "proxy/http/HttpConfig.h" + +#include <catch2/catch_test_macros.hpp> + +#include <cstring> +#include <memory> +#include <vector> + +namespace +{ + +/** A minimal PoolableSession that can be pooled and matched. + * + * Only the remote address and the hostname hash participate in the match + * paths exercised here, so no NetVConnection is required. The session must + * not be multiplexing, otherwise acquireSession consults the HttpSM. + */ +class TestPoolableSession : public PoolableSession +{ +public: + TestPoolableSession(char const *addr_str, char const *hostname) + { + ink_release_assert(ats_ip_pton(addr_str, &_remote_addr) == 0); + this->attach_hostname(hostname); + } + + void + new_connection(NetVConnection *, MIOBuffer *, IOBufferReader *) override + { + } + void + start() override + { + } + void + release(ProxyTransaction *) override + { + } + void + destroy() override + { + } + void + free() override + { + } + void + increment_current_active_connections_stat() override + { + } + void + decrement_current_active_connections_stat() override + { + } + + int + get_transact_count() const override + { + return 0; + } + + const char * + get_protocol_string() const override + { + return "test"; + } + + IOBufferReader * + get_remote_reader() override + { + return nullptr; + } + + void + do_io_close(int /* lerrno ATS_UNUSED */ = -1) override + { + ++close_count; + } + + sockaddr const * + get_remote_addr() const override + { + return &_remote_addr.sa; + } + + int close_count = 0; + +private: + IpEndpoint _remote_addr; +}; + +/// Owns the test sessions and hands raw pointers to the pool under test. +class SessionFactory +{ +public: + TestPoolableSession * + make(char const *addr_str, char const *hostname) + { + return _sessions.emplace_back(std::make_unique<TestPoolableSession>(addr_str, hostname)).get(); + } + +private: + std::vector<std::unique_ptr<TestPoolableSession>> _sessions; +}; + +/// The pool bookkeeping updates this gauge, which is normally initialized via HttpConfig. +/// Create it here (when needed) and reset it between Catch2 runs so tests don't leak state. +void +init_metrics() +{ + if (http_rsb.pooled_server_connections == nullptr) { + http_rsb.pooled_server_connections = Metrics::Gauge::createPtr("proxy.process.http.pooled_server_connections"); + } + Metrics::Gauge::store(http_rsb.pooled_server_connections, 0); +} + +CryptoHash +hash_of(char const *hostname) +{ + CryptoHash hash; + + CryptoContext().hash_immediate(hash, static_cast<unsigned char const *>(static_cast<void const *>(hostname)), + std::strlen(hostname)); + return hash; +} + +/// A sockaddr that can be passed inline to acquireSession. +struct Addr { + Addr(char const *addr_str) { ink_release_assert(ats_ip_pton(addr_str, &_addr) == 0); } + + operator sockaddr const *() const { return &_addr.sa; } + +private: + IpEndpoint _addr; +}; + +constexpr auto MATCH_IP = TS_SERVER_SESSION_SHARING_MATCH_MASK_IP; +constexpr auto MATCH_HOSTONLY = TS_SERVER_SESSION_SHARING_MATCH_MASK_HOSTONLY; +constexpr auto MATCH_BOTH = static_cast<TSServerSessionSharingMatchMask>(TS_SERVER_SESSION_SHARING_MATCH_MASK_IP | + TS_SERVER_SESSION_SHARING_MATCH_MASK_HOSTONLY); + +} // namespace + +TEST_CASE("ServerSessionPool::acquireSession", "[session_pool]") +{ + init_metrics(); + + // Declared before the pool so the sessions outlive it. + SessionFactory factory; + ServerSessionPool pool; + + PoolableSession *acquired = nullptr; + + SECTION("empty pool finds nothing") + { + CHECK(pool.acquireSession(Addr{"10.0.0.1:80"}, hash_of("one.example.com"), MATCH_IP, nullptr, acquired) == + HSMresult_t::NOT_FOUND); + CHECK(acquired == nullptr); + } + + SECTION("a match mask with neither IP nor host disables sharing") + { + pool.addSession(factory.make("10.0.0.1:80", "one.example.com")); + + CHECK(pool.acquireSession(Addr{"10.0.0.1:80"}, hash_of("one.example.com"), TS_SERVER_SESSION_SHARING_MATCH_MASK_NONE, nullptr, + acquired) == HSMresult_t::NOT_FOUND); + CHECK(acquired == nullptr); + CHECK(pool.count() == 1); + } + + SECTION("match on IP") + { + auto *session = factory.make("10.0.0.1:80", "one.example.com"); + + pool.addSession(session); + + SECTION("address and port match") + { + CHECK(pool.acquireSession(Addr{"10.0.0.1:80"}, hash_of("other.example.com"), MATCH_IP, nullptr, acquired) == + HSMresult_t::DONE); + CHECK(acquired == session); + + // A non-multiplexing session is handed off, not shared: it leaves both pools. + CHECK(pool.count() == 0); + CHECK(pool.acquireSession(Addr{"10.0.0.1:80"}, hash_of("one.example.com"), MATCH_HOSTONLY, nullptr, acquired) == + HSMresult_t::NOT_FOUND); Review Comment: This section asserts `NOT_FOUND` but does not assert the post-condition on the out-parameter `acquired`. The updated header contract says `server_session` must be `nullptr` unless `DONE`. Consider explicitly setting `acquired` to a non-null value before the `NOT_FOUND` call and then asserting it is cleared to `nullptr` after the call. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
