-wip refactoring

kamchatka-volcano · Jul 14, 2024 · fe30c1b · fe30c1b
1 parent 1749147
commit fe30c1b
Show file tree

Hide file tree

Showing 11 changed files with 96 additions and 97 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -25,7 +25,7 @@ SealLake_Bundle(
     GIT_REPOSITORY https://github.com/kamchatka-volcano/fcgi_responder.git
         GIT_TAG dev
     TEXT_REPLACEMENTS
-        "namespace fcgi" "namespace asyncgi::fcgi"
+        "namespace fcgi" "namespace asyncgi::detail::fcgi"
 )
 
 SealLake_Bundle(
@@ -73,13 +73,13 @@ set(SRC
     src/connectionlistener.cpp
     src/connectionlistenerfactory.cpp
     src/clientconnection.cpp
-    src/request.cpp
-    src/response.cpp
+        src/requestproxy.cpp
+        src/responder.cpp
     src/routeresponsecontextaccessor.cpp
     src/serviceholder.cpp
         src/fastcgirequest.cpp
         src/fastcgiresponse.cpp
-    )
+)
 
 SealLake_StaticLibrary(
     SOURCES ${SRC}

diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ int main()
     auto io = asyncgi::IO{};
     auto router = asyncgi::Router{io};
     router.route("/", http::RequestMethod::Get).process(
-        [](const asyncgi::Request&)
+        [](const asyncgi::RequestProxy&)
         {
             return http::Response{"Hello world"};
         });
@@ -33,7 +33,7 @@ int main()
 ## Table of Contents
 *    [Usage](#usage)
      * [Connection](#connection)
-     * [Request processor](#request-processor)
+     * [RequestProxy processor](#request-processor)
      * [Router](#router)
      * [Route parameters](#route-parameters)
      * [Route context](#route-context)
@@ -75,13 +75,13 @@ server {
 
 `asyncgi` supports both `UNIX domain` and `TCP` sockets for opening `FastCGI` connections.
 
-### Request processor
+### RequestProxy processor
 
 In order to process requests, it's necessary to provide a function or function object that fulfills
 the `RequestProcessor` requirement. This means that the function must be invocable with one of the following signatures:
 
-* `http::Response (const asyncgi::Request&)`
-* `void (const asyncgi::Request&, asyncgi::Responder&)`.
+* `http::Response (const asyncgi::RequestProxy&)`
+* `void (const asyncgi::RequestProxy&, asyncgi::Responder&)`.
 
 <details>
   <summary>Example</summary>
@@ -93,7 +93,7 @@ the `RequestProcessor` requirement. This means that the function must be invocab
 
 namespace http = asyncgi::http;
 
-http::Response guestBookPage(const asyncgi::Request& request)
+http::Response guestBookPage(const asyncgi::RequestProxy& request)
 {
     if (request.path() == "/")
         return {R"(
@@ -121,7 +121,7 @@ Here, the `guestBookPage` function serves as the request processor. Another way
 reference to the `asyncgi::Responder` object, which can be used for sending responses manually:
 
 ```c++
-void guestBookPage(const asyncgi::Request& request, asyncgi::Responder& responder)
+void guestBookPage(const asyncgi::RequestProxy& request, asyncgi::Responder& responder)
 {
     if (request.path() == "/")
         responder.send(R"(
@@ -186,7 +186,7 @@ public:
     {
     }
 
-    http::Response operator()(const asyncgi::Request&)
+    http::Response operator()(const asyncgi::RequestProxy&)
     {
         auto messages = state_->messages();
         auto page = "<h1>Guest book</h1>"s;
@@ -216,7 +216,7 @@ public:
     {
     }
 
-    http::Response operator()(const asyncgi::Request& request)
+    http::Response operator()(const asyncgi::RequestProxy& request)
     {
         state_->addMessage(std::string{request.formField("msg")});
         return http::Redirect{"/"};
@@ -251,11 +251,11 @@ When using `asyncgi::Router` with regular expressions, request processors must s
 the `ParametrizedRequestProcessor` requirement. That means that a function object must be invocable with one of the
 following signatures:
 
-* `http::Response void(const TRouteParams&..., const asyncgi::Request&)`
-* `void (const TRouteParams&..., const asyncgi::Request&, asyncgi::Responder&)`
+* `http::Response void(const TRouteParams&..., const asyncgi::RequestProxy&)`
+* `void (const TRouteParams&..., const asyncgi::RequestProxy&, asyncgi::Responder&)`
 
 The `TRouteParams` represents zero or more parameters generated from the capturing groups of the regular expression. For
-example, `http::Response (int age, string name, const asyncgi::Request&)` signature can be used to process
+example, `http::Response (int age, string name, const asyncgi::RequestProxy&)` signature can be used to process
 requests matched by `asyncgi::rx{"/person/(\\w+)/age/(\\d+)"}`.
 
 In the following example a `ParametrizedRequestProcessor` named `GuestBookRemoveMessage` is added to remove the stored
@@ -313,7 +313,7 @@ public:
     {
     }
 
-    http::Response operator()(const asyncgi::Request&)
+    http::Response operator()(const asyncgi::RequestProxy&)
     {
         auto messages = state_->messages();
         auto page = "<h1>Guest book</h1>"s;
@@ -343,7 +343,7 @@ public:
     {
     }
 
-    http::Response operator()(const asyncgi::Request& request)
+    http::Response operator()(const asyncgi::RequestProxy& request)
     {
         state_->addMessage(std::string{request.formField("msg")});
         return http::Redirect{"/"};
@@ -360,7 +360,7 @@ public:
     {
     }
 
-    http::Response operator()(int index, const asyncgi::Request&)
+    http::Response operator()(int index, const asyncgi::RequestProxy&)
     {
         state_->removeMessage(index);
         return http::Redirect{"/"};
@@ -457,7 +457,7 @@ public:
     {
     }
 
-    http::Response operator()(const asyncgi::Request&)
+    http::Response operator()(const asyncgi::RequestProxy&)
     {
         auto messages = state_->messages();
         auto page = "<h1>Guest book</h1>"s;
@@ -487,7 +487,7 @@ public:
     {
     }
 
-    http::Response operator()(const asyncgi::Request& request)
+    http::Response operator()(const asyncgi::RequestProxy& request)
     {
         state_->addMessage(std::string{request.formField("msg")});
         return http::Redirect{"/"};
@@ -504,7 +504,7 @@ public:
     {
     }
 
-    http::Response operator()(MessageNumber msgNumber, const asyncgi::Request&)
+    http::Response operator()(MessageNumber msgNumber, const asyncgi::RequestProxy&)
     {
         state_->removeMessage(msgNumber.value);
         return http::Redirect{"/"};
@@ -569,7 +569,7 @@ struct RouteContext {
 };
 
 struct AdminAuthorizer {
-    std::optional<http::Response> operator()(const asyncgi::Request& request, RouteContext& context)
+    std::optional<http::Response> operator()(const asyncgi::RequestProxy& request, RouteContext& context)
     {
         if (request.cookie("admin_id") == "ADMIN_SECRET")
             context.role = AccessRole::Admin;
@@ -579,7 +579,7 @@ struct AdminAuthorizer {
 };
 
 struct LoginPage {
-    http::Response operator()(const asyncgi::Request&, RouteContext& context)
+    http::Response operator()(const asyncgi::RequestProxy&, RouteContext& context)
     {
         if (context.role == AccessRole::Guest)
             return {R"(
@@ -597,7 +597,7 @@ struct LoginPage {
 };
 
 struct LoginPageAuthorize {
-    http::Response operator()(const asyncgi::Request& request, RouteContext& context)
+    http::Response operator()(const asyncgi::RequestProxy& request, RouteContext& context)
     {
         if (context.role == AccessRole::Guest) {
             if (request.formField("login") == "admin" && request.formField("passwd") == "12345")
@@ -616,7 +616,7 @@ int main()
     auto router = asyncgi::Router<RouteContext>{io};
     router.route(asyncgi::rx{".*"}).process<AdminAuthorizer>();
     router.route("/").process(
-            [](const asyncgi::Request&, asyncgi::Responder& response, RouteContext& context)
+            [](const asyncgi::RequestProxy&, asyncgi::Responder& response, RouteContext& context)
             {
                 if (context.role == AccessRole::Admin)
                     response.send("<p>Hello admin</p>");
@@ -666,7 +666,7 @@ struct RouteContext {
 };
 
 struct AdminAuthorizer {
-    std::optional<http::Response> operator()(const asyncgi::Request& request, RouteContext& context)
+    std::optional<http::Response> operator()(const asyncgi::RequestProxy& request, RouteContext& context)
     {
         if (request.cookie("admin_id") == "ADMIN_SECRET")
             context.role = AccessRole::Admin;
@@ -676,7 +676,7 @@ struct AdminAuthorizer {
 };
 
 struct LoginPage {
-    http::Response operator()(const asyncgi::Request&)
+    http::Response operator()(const asyncgi::RequestProxy&)
     {
         return {R"(
                 <html>
@@ -691,7 +691,7 @@ struct LoginPage {
 };
 
 struct LoginPageAuthorize {
-    http::Response operator()(const asyncgi::Request& request)
+    http::Response operator()(const asyncgi::RequestProxy& request)
     {
         if (request.formField("login") == "admin" && request.formField("passwd") == "12345")
             return {http::Redirect{"/"}, {asyncgi::http::Cookie("admin_id", "ADMIN_SECRET")}};
@@ -702,7 +702,7 @@ struct LoginPageAuthorize {
 
 template<>
 struct asyncgi::config::RouteMatcher<AccessRole, RouteContext> {
-    bool operator()(AccessRole value, const asyncgi::Request&, const RouteContext& context) const
+    bool operator()(AccessRole value, const asyncgi::RequestProxy&, const RouteContext& context) const
     {
         return value == context.role;
     }
@@ -714,7 +714,7 @@ int main()
     auto router = asyncgi::Router<RouteContext>{io};
     router.route(asyncgi::rx{".*"}).process<AdminAuthorizer>();
     router.route("/").process(
-            [](const asyncgi::Request&, RouteContext& context) -> http::Response
+            [](const asyncgi::RequestProxy&, RouteContext& context) -> http::Response
             {
                 if (context.role == AccessRole::Admin)
                     return {"<p>Hello admin</p>"};
@@ -768,21 +768,21 @@ struct RouteContext {
 
 template<>
 struct asyncgi::config::RouteMatcher<AccessRole, RouteContext> {
-    bool operator()(AccessRole value, const asyncgi::Request&, const RouteContext& context) const
+    bool operator()(AccessRole value, const asyncgi::RequestProxy&, const RouteContext& context) const
     {
         return value == context.role;
     }
 };
 
-std::optional<http::Response> authorizeAdmin(const asyncgi::Request& request, RouteContext& context)
+std::optional<http::Response> authorizeAdmin(const asyncgi::RequestProxy& request, RouteContext& context)
 {
     if (request.cookie("admin_id") == "ADMIN_SECRET")
         context.role = AccessRole::Admin;
 
     return std::nullopt;
 }
 
-http::Response showLoginPage(const asyncgi::Request&)
+http::Response showLoginPage(const asyncgi::RequestProxy&)
 {
     return {R"(
             <head><link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css"></head>
@@ -795,15 +795,15 @@ http::Response showLoginPage(const asyncgi::Request&)
             </form>)"};
 }
 
-http::Response loginAdmin(const asyncgi::Request& request)
+http::Response loginAdmin(const asyncgi::RequestProxy& request)
 {
     if (request.formField("login") == "admin" && request.formField("passwd") == "12345")
         return {http::Redirect{"/"}, {http::Cookie("admin_id", "ADMIN_SECRET")}};
     else
         return http::Redirect{"/login"};
 }
 
-http::Response logoutAdmin(const asyncgi::Request&)
+http::Response logoutAdmin(const asyncgi::RequestProxy&)
 {
     return {http::Redirect{"/"}, {http::Cookie("admin_id", "")}};
 }
@@ -868,7 +868,7 @@ std::string makeLinksDiv(AccessRole role)
 
 auto showGuestBookPage(GuestBookState& state)
 {
-    return [&state](const asyncgi::Request& request, RouteContext& context) -> http::Response
+    return [&state](const asyncgi::RequestProxy& request, RouteContext& context) -> http::Response
     {
         auto page = R"(<head><link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css"></head>
                        <div style="display:flex; flex-direction: row; justify-content: flex-end">%LINKS%</div>
@@ -910,7 +910,7 @@ auto showGuestBookPage(GuestBookState& state)
 
 auto addMessage(GuestBookState& state)
 {
-    return [&state](const asyncgi::Request& request) -> http::Response
+    return [&state](const asyncgi::RequestProxy& request) -> http::Response
     {
         if (std::all_of(
                     request.formField("msg").begin(),
@@ -933,7 +933,7 @@ auto addMessage(GuestBookState& state)
 
 auto removeMessage(GuestBookState& state)
 {
-    return [&state](int index, const asyncgi::Request&) -> http::Response
+    return [&state](int index, const asyncgi::RequestProxy&) -> http::Response
     {
         state.removeMessage(index);
         return http::Redirect{"/"};
@@ -987,7 +987,7 @@ struct Greeter{
     {
     }
 
-    http::Response operator()(const asyncgi::Request&)
+    http::Response operator()(const asyncgi::RequestProxy&)
     {
         return "Hello world\n(alive for " + std::to_string(*secondsCounter_) + " seconds)";
     }
@@ -1040,7 +1040,7 @@ been sent.
 using namespace asyncgi;
 
 struct DelayedPage{
-    void operator()(const asyncgi::Request&, asyncgi::Responder& responder)
+    void operator()(const asyncgi::RequestProxy&, asyncgi::Responder& responder)
     {
         auto timer = asyncgi::Timer{responder};
         timer.waitFuture(
@@ -1096,7 +1096,7 @@ int main()
     auto client = asyncgi::Client{io};
     client.makeRequest(
             "/tmp/fcgi.sock",
-            http::Request{http::RequestMethod::Get, "/"},
+            http::RequestProxy{http::RequestMethod::Get, "/"},
             [&io](const std::optional<http::ResponseView>& response)
             {
                 if (response)
@@ -1124,13 +1124,13 @@ be used. It is important to avoid using this client object after the response ha
 namespace http = asyncgi::http;
 
 struct RequestPage{
-    void operator()(const asyncgi::Request&, asyncgi::Responder& responder)
+    void operator()(const asyncgi::RequestProxy&, asyncgi::Responder& responder)
     {
         // making request to FastCgi application listening on /tmp/fcgi.sock and showing the received response
         auto client = asyncgi::Client{responder};
         client.makeRequest(
                 "/tmp/fcgi.sock",
-                http::Request{http::RequestMethod::Get, "/"},
+                http::RequestProxy{http::RequestMethod::Get, "/"},
                 [responder](const std::optional<http::ResponseView>& reqResponse) mutable
                 {
                     if (reqResponse)
@@ -1208,7 +1208,7 @@ must be used. It is important to avoid using this dispatcher after the response
 namespace http = asyncgi::http;
 
 struct DelayedPage {
-    void operator()(const asyncgi::Request&, asyncgi::Responder& responder)
+    void operator()(const asyncgi::RequestProxy&, asyncgi::Responder& responder)
     {
         auto disp = asyncgi::AsioDispatcher{responder};
         disp.postTask(