Erlang Server – cowboy return types improvements (#19561)

* Declare the correct types for cowboy rest requests

* Adding myself to the erlang team

samples/server/echo_api/erlang-server/src/openapi_auth_handler.erl

@@ -106,21 +106,21 @@ content_types_provided(Req, State) ->
 -spec delete_resource(cowboy_req:req(), state()) ->
     {boolean(), cowboy_req:req(), state()}.
 delete_resource(Req, State) ->
-    case handle_type_accepted(Req, State) of
-        true ->
-            {true, Req, State};
-        _ ->
-            {false, Req, State}
-    end.
+    {Res, Req1, State} = handle_type_accepted(Req, State),
+    {true =:= Res, Req1, State}.
 
 -spec handle_type_accepted(cowboy_req:req(), state()) ->
-    boolean() | {created, iodata()} | {see_other, iodata()}.
+    { openapi_logic_handler:accept_callback_return(), cowboy_req:req(), state()}.
 handle_type_accepted(Req, #state{operation_id = OperationID,
-                                 accept_callback = Handler} = State) ->
-    Handler(auth, OperationID, Req, State#state.context).
+                                 accept_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(auth, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.
 
 -spec handle_type_provided(cowboy_req:req(), state()) ->
-    {cowboy_req:resp_body(), cowboy_req:req(), openapi_logic_handler:context()}.
+    {cowboy_req:resp_body(), cowboy_req:req(), state()}.
 handle_type_provided(Req, #state{operation_id = OperationID,
-                                 provide_callback = Handler} = State) ->
-    Handler(auth, OperationID, Req, State#state.context).
+                                 provide_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(auth, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.

samples/server/echo_api/erlang-server/src/openapi_body_handler.erl

@@ -186,21 +186,21 @@ content_types_provided(Req, State) ->
 -spec delete_resource(cowboy_req:req(), state()) ->
     {boolean(), cowboy_req:req(), state()}.
 delete_resource(Req, State) ->
-    case handle_type_accepted(Req, State) of
-        true ->
-            {true, Req, State};
-        _ ->
-            {false, Req, State}
-    end.
+    {Res, Req1, State} = handle_type_accepted(Req, State),
+    {true =:= Res, Req1, State}.
 
 -spec handle_type_accepted(cowboy_req:req(), state()) ->
-    boolean() | {created, iodata()} | {see_other, iodata()}.
+    { openapi_logic_handler:accept_callback_return(), cowboy_req:req(), state()}.
 handle_type_accepted(Req, #state{operation_id = OperationID,
-                                 accept_callback = Handler} = State) ->
-    Handler(body, OperationID, Req, State#state.context).
+                                 accept_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(body, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.
 
 -spec handle_type_provided(cowboy_req:req(), state()) ->
-    {cowboy_req:resp_body(), cowboy_req:req(), openapi_logic_handler:context()}.
+    {cowboy_req:resp_body(), cowboy_req:req(), state()}.
 handle_type_provided(Req, #state{operation_id = OperationID,
-                                 provide_callback = Handler} = State) ->
-    Handler(body, OperationID, Req, State#state.context).
+                                 provide_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(body, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.

samples/server/echo_api/erlang-server/src/openapi_form_handler.erl

@@ -104,21 +104,21 @@ content_types_provided(Req, State) ->
 -spec delete_resource(cowboy_req:req(), state()) ->
     {boolean(), cowboy_req:req(), state()}.
 delete_resource(Req, State) ->
-    case handle_type_accepted(Req, State) of
-        true ->
-            {true, Req, State};
-        _ ->
-            {false, Req, State}
-    end.
+    {Res, Req1, State} = handle_type_accepted(Req, State),
+    {true =:= Res, Req1, State}.
 
 -spec handle_type_accepted(cowboy_req:req(), state()) ->
-    boolean() | {created, iodata()} | {see_other, iodata()}.
+    { openapi_logic_handler:accept_callback_return(), cowboy_req:req(), state()}.
 handle_type_accepted(Req, #state{operation_id = OperationID,
-                                 accept_callback = Handler} = State) ->
-    Handler(form, OperationID, Req, State#state.context).
+                                 accept_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(form, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.
 
 -spec handle_type_provided(cowboy_req:req(), state()) ->
-    {cowboy_req:resp_body(), cowboy_req:req(), openapi_logic_handler:context()}.
+    {cowboy_req:resp_body(), cowboy_req:req(), state()}.
 handle_type_provided(Req, #state{operation_id = OperationID,
-                                 provide_callback = Handler} = State) ->
-    Handler(form, OperationID, Req, State#state.context).
+                                 provide_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(form, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.

samples/server/echo_api/erlang-server/src/openapi_header_handler.erl

@@ -78,21 +78,21 @@ content_types_provided(Req, State) ->
 -spec delete_resource(cowboy_req:req(), state()) ->
     {boolean(), cowboy_req:req(), state()}.
 delete_resource(Req, State) ->
-    case handle_type_accepted(Req, State) of
-        true ->
-            {true, Req, State};
-        _ ->
-            {false, Req, State}
-    end.
+    {Res, Req1, State} = handle_type_accepted(Req, State),
+    {true =:= Res, Req1, State}.
 
 -spec handle_type_accepted(cowboy_req:req(), state()) ->
-    boolean() | {created, iodata()} | {see_other, iodata()}.
+    { openapi_logic_handler:accept_callback_return(), cowboy_req:req(), state()}.
 handle_type_accepted(Req, #state{operation_id = OperationID,
-                                 accept_callback = Handler} = State) ->
-    Handler(header, OperationID, Req, State#state.context).
+                                 accept_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(header, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.
 
 -spec handle_type_provided(cowboy_req:req(), state()) ->
-    {cowboy_req:resp_body(), cowboy_req:req(), openapi_logic_handler:context()}.
+    {cowboy_req:resp_body(), cowboy_req:req(), state()}.
 handle_type_provided(Req, #state{operation_id = OperationID,
-                                 provide_callback = Handler} = State) ->
-    Handler(header, OperationID, Req, State#state.context).
+                                 provide_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(header, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.

samples/server/echo_api/erlang-server/src/openapi_logic_handler.erl

@@ -2,17 +2,24 @@
 
 -include_lib("kernel/include/logger.hrl").
 
+-type accept_callback_return() ::
+        stop
+        | boolean()
+        | {true, iodata()}
+        | {created, iodata()}
+        | {see_other, iodata()}.
 -type api_key_callback() ::
     fun((openapi_api:operation_id(), binary()) -> {true, context()} | {false, iodata()}).
 -type accept_callback() ::
     fun((atom(), openapi_api:operation_id(), cowboy_req:req(), context()) ->
-            boolean() | {created, iodata()} | {see_other, iodata()}).
+            {accept_callback_return(), cowboy_req:req(), context()}).
 -type provide_callback() ::
     fun((atom(), openapi_api:operation_id(), cowboy_req:req(), context()) ->
             {cowboy_req:resp_body(), cowboy_req:req(), context()}).
--type context() :: #{binary() => any()}.
+-type context() :: #{_ := _}.
 
--export_type([context/0, api_key_callback/0, accept_callback/0, provide_callback/0]).
+-export_type([context/0, api_key_callback/0,
+              accept_callback_return/0, accept_callback/0, provide_callback/0]).
 
 -optional_callbacks([api_key_callback/2]).
 
@@ -20,7 +27,7 @@
     {true, context()} | {false, iodata()}.
 
 -callback accept_callback(atom(), openapi_api:operation_id(), cowboy_req:req(), context()) ->
-    boolean() | {created, iodata()} | {see_other, iodata()}.
+    {accept_callback_return(), cowboy_req:req(), context()}.
 
 -callback provide_callback(atom(), openapi_api:operation_id(), cowboy_req:req(), context()) ->
     {cowboy_req:resp_body(), cowboy_req:req(), context()}.
@@ -36,14 +43,14 @@ api_key_callback(OperationID, ApiKey) ->
     {true, #{}}.
 
 -spec accept_callback(atom(), openapi_api:operation_id(), cowboy_req:req(), context()) ->
-    {cowboy:http_status(), cowboy:http_headers(), json:encode_value()}.
+    {accept_callback_return(), cowboy_req:req(), context()}.
 accept_callback(Class, OperationID, Req, Context) ->
     ?LOG_ERROR(#{what => "Got not implemented request to process",
                  class => Class,
                  operation_id => OperationID,
                  request => Req,
                  context => Context}),
-    {501, #{}, #{}}.
+    {false, Req, Context}.
 
 -spec provide_callback(atom(), openapi_api:operation_id(), cowboy_req:req(), context()) ->
     {cowboy_req:resp_body(), cowboy_req:req(), context()}.

samples/server/echo_api/erlang-server/src/openapi_path_handler.erl

@@ -78,21 +78,21 @@ content_types_provided(Req, State) ->
 -spec delete_resource(cowboy_req:req(), state()) ->
     {boolean(), cowboy_req:req(), state()}.
 delete_resource(Req, State) ->
-    case handle_type_accepted(Req, State) of
-        true ->
-            {true, Req, State};
-        _ ->
-            {false, Req, State}
-    end.
+    {Res, Req1, State} = handle_type_accepted(Req, State),
+    {true =:= Res, Req1, State}.
 
 -spec handle_type_accepted(cowboy_req:req(), state()) ->
-    boolean() | {created, iodata()} | {see_other, iodata()}.
+    { openapi_logic_handler:accept_callback_return(), cowboy_req:req(), state()}.
 handle_type_accepted(Req, #state{operation_id = OperationID,
-                                 accept_callback = Handler} = State) ->
-    Handler(path, OperationID, Req, State#state.context).
+                                 accept_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(path, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.
 
 -spec handle_type_provided(cowboy_req:req(), state()) ->
-    {cowboy_req:resp_body(), cowboy_req:req(), openapi_logic_handler:context()}.
+    {cowboy_req:resp_body(), cowboy_req:req(), state()}.
 handle_type_provided(Req, #state{operation_id = OperationID,
-                                 provide_callback = Handler} = State) ->
-    Handler(path, OperationID, Req, State#state.context).
+                                 provide_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(path, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.

samples/server/echo_api/erlang-server/src/openapi_query_handler.erl

@@ -168,21 +168,21 @@ content_types_provided(Req, State) ->
 -spec delete_resource(cowboy_req:req(), state()) ->
     {boolean(), cowboy_req:req(), state()}.
 delete_resource(Req, State) ->
-    case handle_type_accepted(Req, State) of
-        true ->
-            {true, Req, State};
-        _ ->
-            {false, Req, State}
-    end.
+    {Res, Req1, State} = handle_type_accepted(Req, State),
+    {true =:= Res, Req1, State}.
 
 -spec handle_type_accepted(cowboy_req:req(), state()) ->
-    boolean() | {created, iodata()} | {see_other, iodata()}.
+    { openapi_logic_handler:accept_callback_return(), cowboy_req:req(), state()}.
 handle_type_accepted(Req, #state{operation_id = OperationID,
-                                 accept_callback = Handler} = State) ->
-    Handler(query, OperationID, Req, State#state.context).
+                                 accept_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(query, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.
 
 -spec handle_type_provided(cowboy_req:req(), state()) ->
-    {cowboy_req:resp_body(), cowboy_req:req(), openapi_logic_handler:context()}.
+    {cowboy_req:resp_body(), cowboy_req:req(), state()}.
 handle_type_provided(Req, #state{operation_id = OperationID,
-                                 provide_callback = Handler} = State) ->
-    Handler(query, OperationID, Req, State#state.context).
+                                 provide_callback = Handler,
+                                 context = Context} = State) ->
+    {Res, Req1, Context1} = Handler(query, OperationID, Req, Context),
+    {Res, Req1, State#state{context = Context1}}.