-
Notifications
You must be signed in to change notification settings - Fork 279
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat userver: create middleware exception, make it possible to throw …
…in response hooks Tests: CI commit_hash:e0f55f096013ee6dba2da88a84922fdb6f3cd7d7
- Loading branch information
abramov-alex
committed
Oct 9, 2024
1 parent
ead0775
commit be7b0e1
Showing
7 changed files
with
164 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| #pragma once | ||
|
|
||
| #include <exception> | ||
|
|
||
| USERVER_NAMESPACE_BEGIN | ||
|
|
||
| namespace ugrpc::server::impl { | ||
|
|
||
| /// @brief Base class for userver-internal rpc errors | ||
| class BaseInternalRpcError : public std::exception {}; | ||
|
|
||
| /// @brief Middleware interruption | ||
| class MiddlewareRpcInterruptionError : public BaseInternalRpcError {}; | ||
|
|
||
| } // namespace ugrpc::server::impl | ||
|
|
||
| USERVER_NAMESPACE_END |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| #include <userver/utest/utest.hpp> | ||
|
|
||
| #include <grpcpp/support/status.h> | ||
|
|
||
| #include <userver/ugrpc/server/middlewares/base.hpp> | ||
| #include <userver/ugrpc/tests/service_fixtures.hpp> | ||
| #include <userver/utest/log_capture_fixture.hpp> | ||
| #include <userver/utils/flags.hpp> | ||
|
|
||
| #include <tests/unit_test_client.usrv.pb.hpp> | ||
| #include <tests/unit_test_service.usrv.pb.hpp> | ||
|
|
||
| USERVER_NAMESPACE_BEGIN | ||
|
|
||
| namespace { | ||
|
|
||
| class Messenger final : public sample::ugrpc::UnitTestServiceBase { | ||
| public: | ||
| void SayHello(SayHelloCall& call, | ||
| sample::ugrpc::GreetingRequest&& /*request*/) override { | ||
| call.Finish(sample::ugrpc::GreetingResponse{}); | ||
| } | ||
| }; | ||
|
|
||
| enum class MiddlewareFlag { | ||
| kNone = 0, | ||
| kErrorInRequestHook = 1 << 0, | ||
| kErrorInResponseHook = 1 << 1 | ||
| }; | ||
|
|
||
| using MiddlewareFlags = utils::Flags<MiddlewareFlag>; | ||
|
|
||
| class Middleware final : public ugrpc::server::MiddlewareBase { | ||
| public: | ||
| Middleware(MiddlewareFlag settings) : settings_(settings) {} | ||
|
|
||
| void Handle(ugrpc::server::MiddlewareCallContext& context) const override { | ||
| context.Next(); | ||
| } | ||
|
|
||
| void CallRequestHook(const ugrpc::server::MiddlewareCallContext& context, | ||
| google::protobuf::Message&) override { | ||
| if (settings_ == MiddlewareFlag::kErrorInRequestHook) { | ||
| context.GetCall().FinishWithError(::grpc::Status( | ||
| ::grpc::StatusCode::DATA_LOSS, "Data loss error in request hook")); | ||
| } | ||
| } | ||
|
|
||
| void CallResponseHook(const ugrpc::server::MiddlewareCallContext& context, | ||
| google::protobuf::Message&) override { | ||
| if (settings_ == MiddlewareFlag::kErrorInResponseHook) { | ||
| context.GetCall().FinishWithError( | ||
| ::grpc::Status(::grpc::StatusCode::OUT_OF_RANGE, | ||
| "Out of range error in response hook")); | ||
| } | ||
| } | ||
|
|
||
| private: | ||
| MiddlewareFlag settings_; | ||
| }; | ||
|
|
||
| class MockMessengerServiceFixture | ||
| : public ugrpc::tests::ServiceFixtureBase, | ||
| public testing::WithParamInterface<MiddlewareFlags> { | ||
| protected: | ||
| MockMessengerServiceFixture() { | ||
| SetServerMiddlewares({std::make_shared<Middleware>( | ||
| static_cast<MiddlewareFlag>(GetParam().GetValue()))}); | ||
| RegisterService(service_); | ||
| StartServer(); | ||
| } | ||
|
|
||
| private: | ||
| Messenger service_; | ||
| }; | ||
|
|
||
| } // namespace | ||
|
|
||
| UTEST_P(MockMessengerServiceFixture, MiddlewareInterruption) { | ||
| const auto client = MakeClient<sample::ugrpc::UnitTestServiceClient>(); | ||
| try { | ||
| client.SayHello(sample::ugrpc::GreetingRequest()).Finish(); | ||
| FAIL(); // Should not execute. The method must throw. | ||
| } catch (const ugrpc::client::ErrorWithStatus& error) { | ||
| switch (static_cast<MiddlewareFlag>(GetParam().GetValue())) { | ||
| case MiddlewareFlag::kErrorInRequestHook: { | ||
| EXPECT_EQ(error.GetStatus().error_code(), | ||
| ::grpc::StatusCode::DATA_LOSS); | ||
| EXPECT_EQ(error.GetStatus().error_message(), | ||
| "Data loss error in request hook"); | ||
| break; | ||
| } | ||
| case MiddlewareFlag::kErrorInResponseHook: { | ||
| EXPECT_EQ(error.GetStatus().error_code(), | ||
| ::grpc::StatusCode::OUT_OF_RANGE); | ||
| EXPECT_EQ(error.GetStatus().error_message(), | ||
| "Out of range error in response hook"); | ||
| break; | ||
| } | ||
| default: { | ||
| FAIL(); // Should not happen | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| INSTANTIATE_UTEST_SUITE_P( | ||
| /*no prefix*/, MockMessengerServiceFixture, | ||
| testing::Values(MiddlewareFlags{MiddlewareFlag::kErrorInRequestHook}, | ||
| MiddlewareFlags{MiddlewareFlag::kErrorInResponseHook})); | ||
|
|
||
| USERVER_NAMESPACE_END |