Nhse o40 orkv.i141 silvermachine

.github/workflows/erlang.yml

@@ -34,3 +34,5 @@ jobs:
         run: ./rebar3 do xref, dialyzer
       - name: Run eunit
         run: ./rebar3 as gha do eunit
+      - name: Check format
+        run: ./rebar3 fmt --check

README.md

@@ -2,40 +2,11 @@
 
 ![Riak API OpenRiak Status](https://github.com/OpenRiak/riak_api/actions/workflows/erlang.yml/badge.svg?branch=openriak-4.0)
 
-This OTP application encapsulates services for presenting Riak's
-public-facing interfaces. Currently this means a generic interface for
-exposing Protocol Buffers-based services; HTTP services via Webmachine
-will be moved here at a later time.
+This OTP application encapsulates services for presenting Riak's public-facing interfaces.
 
-## Contributing
+There two APIs:
 
-We encourage contributions to `riak_api` from the community.
+- An API using protocol buffers, with a codec defined in [riak_pb](https://github.com/OpenRiak/riak_pb), with the handling of messages managed using `riak_kv_pb_*` modules within Riak KV.
+- A HTTP REST-based API (code-named Silver Machine), with the handling of requests defined using `riak_kv_ag_*` modules that implement the callbacks defined in the `riak_api_web_handler` behaviour.
 
-1. Fork the [`riak_api`](https://github.com/basho/riak_api) repository
-   on Github.
-2. Clone your fork or add the remote if you already have a clone of
-   the repository.
-
-    ```
-    git clone git@github.com:yourusername/riak_api.git
-    # or
-    git remote add mine git@github.com:yourusername/riak_api.git
-    ```
-
-3. Create a topic branch for your change.
-
-    ```
-    git checkout -b some-topic-branch
-    ```
-
-4. Make your change and commit. Use a clear and descriptive commit
-   message, spanning multiple lines if detailed explanation is needed.
-5. Push to your fork of the repository and then send a pull-request
-   through Github.
-
-    ```
-    git push mine some-topic-branch
-    ```
-
-6. A Basho engineer or community maintainer will review your patch and
-   merge it into the main repository or send you feedback.
+For further information on using [Silver Machine see the provided document](/docs/silverMachine.md).

rebar.config

@@ -4,20 +4,52 @@
 
 {erl_opts, [warnings_as_errors]}.
 
+{erlfmt, [
+    write,
+    {print_width, 80},
+    {files, [
+        "src/riak_api_web_acceptor.erl",
+        "src/riak_api_web_body.erl",
+        "src/riak_api_web_headers.erl",
+        "src/riak_api_web_security.erl",
+        "src/riak_api_web_socket.erl",
+        "src/riak_api_web.erl",
+        "src/riak_api_web_handler.erl",
+        "test/riak_api_web_acceptor_pool_drain_test.erl",
+        "test/riak_api_web_get_random.erl",
+        "test/riak_api_web_ets_store.erl",
+        "test/riak_api_web_trigger.erl",
+        "rebar.config"
+    ]},
+    {exclude_files, []}
+]}.
+
+{project_plugins, [
+    {erlfmt, {git, "https://github.com/OpenRiak/erlfmt.git", {branch, "main"}}}
+]}.
+
 {eunit_opts, [verbose]}.
 
 {deps, [
-        {riak_pb, {git, "https://github.com/OpenRiak/riak_pb.git", {branch, "openriak-3.4"}}},
-        {webmachine, {git, "https://github.com/OpenRiak/webmachine.git", {branch, "openriak-3.4"}}},
-        {mochiweb, {git, "https://github.com/OpenRiak/mochiweb.git", {branch, "openriak-3.4"}}},
-        {riak_core, {git, "https://github.com/OpenRiak/riak_core.git", {branch, "openriak-4.0"}}}
-        ]}.
+    {riak_pb,
+        {git, "https://github.com/OpenRiak/riak_pb.git",
+            {branch, "openriak-3.4"}}},
+    {riak_core,
+        {git, "https://github.com/OpenRiak/riak_core.git",
+            {branch, "openriak-4.0"}}}
+]}.
 
 {profiles, [
-    {test, [{deps, [{meck, {git, "https://github.com/OpenRiak/meck.git", {branch, "openriak-3.4"}}}]}]},
+    {test, [
+        {deps, [
+            {meck,
+                {git, "https://github.com/OpenRiak/meck.git",
+                    {branch, "openriak-3.4"}}}
+        ]}
+    ]},
     {gha, [{erl_opts, [{d, 'GITHUBEXCLUDE'}]}]}
 ]}.
 
 {dialyzer, [{plt_apps, all_deps}]}.
 
-{xref_checks,[undefined_function_calls,undefined_functions,locals_not_used]}.
+{xref_checks, [undefined_function_calls, undefined_functions, locals_not_used]}.

src/riak_api.app.src

@@ -9,9 +9,7 @@
                   stdlib,
                   ssl,
                   riak_core,
-                  riak_pb,
-                  webmachine,
-                  mochiweb
+                  riak_pb
                  ]},
   {registered, [riak_api_sup,
                 riak_api_pb_sup]},

src/riak_api_sup.erl

@@ -32,11 +32,18 @@
 -include_lib("kernel/include/logger.hrl").
 
 -define(CHILD(I, Type), {I, {I, start_link, []}, permanent, 5000, Type, [I]}).
--define(CHILD(I, Type, Args), {I, {I, start_link, Args}, permanent, 5000, Type, [I]}).
 -define(LNAME(IP, Port), lists:flatten(io_lib:format("pb://~p:~p", [IP, Port]))).
--define(PB_LISTENER(IP, Port), {?LNAME(IP, Port),
-                                {riak_api_pb_listener, start_link, [IP, Port]},
-                                permanent, 5000, worker, [riak_api_pb_listener]}).
+-define(PB_LISTENER(IP, Port),
+    #{
+        id => ?LNAME(IP, Port),
+        start => {riak_api_pb_listener, start_link, [IP, Port]},
+        restart => permanent,
+        shutdown => 5000,
+        type => worker,
+        modules => [riak_api_pb_listener]
+    }
+).
+
 %% @doc Starts the supervisor.
 -spec start_link() -> {ok, pid()} | {error, term()}.
 start_link() ->
@@ -59,11 +66,17 @@ init([]) ->
 %% Generates child specs from the HTTP/HTTPS listener configuration.
 %% @private
 web_processes([]) ->
-    ?LOG_INFO("No HTTP/HTTPS listeners were configured, HTTP connections will be disabled."),
+    ?LOG_INFO(
+        "No HTTP/HTTPS listeners were configured, "
+        "HTTP connections will be disabled."
+    ),
     [];
 web_processes(Listeners) ->
-    lists:flatten([ web_listener_spec(Scheme, Binding) ||
-                      {Scheme, Binding} <- Listeners ]).
+    lists:flatten(
+        [
+            web_listener_spec(Scheme, Binding) || {Scheme, Binding} <- Listeners
+        ]
+    ).
 
 web_listener_spec(Scheme, Binding) ->
     riak_api_web:binding_config(Scheme, Binding).