Preserve order of resource servers in config

Author: MarcialRosales

deps/rabbitmq_management/priv/www/js/oidc-oauth/helper.js

@@ -392,11 +392,12 @@ export function hasAnyResourceServerReady(oauth, onReadyCallback) {
             warnings.push(warningMessageOAuthResources(url, notCompliantResources, " not compliant"))
           }
         }
-        oauth.declared_resource_servers_count = oauth.resource_servers.length
-        oauth.resource_servers = oauth.resource_servers.filter((resource) =>
-          !notReadyServers.includes(resource.oauth_provider_url) && !notCompliantServers.includes(resource.oauth_provider_url))
+        oauth.declared_resource_servers_count = oauth.resource_servers.length;
+        oauth.resource_servers = array.sort((a, b) => a.index - b.index);oauth.resource_servers.filter((resource) =>
+          !notReadyServers.includes(resource.oauth_provider_url) && !notCompliantServers.includes(resource.oauth_provider_url));
+        oauth.resource_servers.sort((a, b) => a.index - b.index);
 
-          onReadyCallback(oauth, warnings)
+        onReadyCallback(oauth, warnings)
 
       })
   }else {

deps/rabbitmq_management/src/rabbit_mgmt_schema.erl

@@ -15,7 +15,6 @@
 ]).
 
 extract_key_as_binary({Name,_}) -> list_to_binary(Name).
-extract_value({_Name,V}) -> V.
 
 -spec translate_oauth_resource_servers([{list(), binary()}]) -> map().
 translate_oauth_resource_servers(Conf) ->
@@ -49,14 +48,18 @@ convert_list_to_binary(V) when is_list(V) ->
 convert_list_to_binary(V) ->
     V.
 
-extract_resource_server_properties(Settings) ->
-    KeyFun = fun extract_key_as_binary/1,
-    ValueFun = fun extract_value/1,
-
+extract_resource_server_properties(Settings) ->    
     OAuthResourceServers = [{Name, {list_to_atom(Key), convert_list_to_binary(V)}}
         || {["management","oauth_resource_servers", Name, Key], V} <- Settings ],
-    ?LOG_DEBUG("OAuthResourceServers: ~p", [OAuthResourceServers]),
-    maps:groups_from_list(KeyFun, ValueFun, OAuthResourceServers).
+    OAuthResourceServers1 = lists:foldl(fun ({K, Value}, Acc) ->
+        Key = list_to_binary(K),
+        Attrs = case maps:get(Key, Acc, []) of 
+            [] -> [] ++ [{index, maps:size(Acc)+1}, Value];
+            List -> List ++ [Value]
+        end,
+        maps:put(Key, Attrs, Acc) end, #{}, OAuthResourceServers),
+    ct:log("OAuthResourceServers1: ~p", [OAuthResourceServers1]),
+    OAuthResourceServers1.
 
 
 extract_resource_server_endpoint_params(Variable, Settings) ->

deps/rabbitmq_management/test/rabbit_mgmt_schema_SUITE.erl

@@ -48,6 +48,7 @@ test_with_one_resource_server(_) ->
     ],
     #{
         <<"rabbitmq1">> := [
+            {index, 1},
             {id, <<"rabbitmq1">>}
         ]
     } = translate_oauth_resource_servers(Conf).
@@ -59,10 +60,12 @@ test_with_many_resource_servers(_) ->
     ],
     #{
         <<"keycloak">> := [
+            {index, 1},
             {label, <<"Keycloak">>},
             {id, <<"keycloak">>}
         ],
         <<"uaa">> := [
+            {index, 2},
             {label, <<"Uaa">>},
             {id, <<"uaa">>}
         ]
@@ -71,23 +74,35 @@ test_with_many_resource_servers(_) ->
 test_preserve_order_when_using_many_resource_servers(_) ->
     Conf = [
         {["management","oauth_resource_servers","uaa","label"],"Uaa"},
+        {["management","oauth_resource_servers","uaa","oauth_client_id"],"uaa-client"},
         {["management","oauth_resource_servers","spring","label"],"Spring"},
-        {["management","oauth_resource_servers","keycloak","label"],"Keycloak"}        
+        {["management","oauth_resource_servers","spring","oauth_client_id"],"spring-client"},
+        {["management","oauth_resource_servers","keycloak","label"],"Keycloak"},
+        {["management","oauth_resource_servers","keycloak","oauth_client_id"],"keycloak-client"}
     ],
-    #{
-        <<"uaa">> := [
+    SortByIndex = fun({_, A}, {_, B}) -> 
+        proplists:get_value(index, A) =< proplists:get_value(index, B) end,
+
+    [
+        {<<"uaa">>, [
+            {index, 1},
             {label, <<"Uaa">>},
+            {oauth_client_id, <<"uaa-client">>},
             {id, <<"uaa">>}
-        ],
-         <<"spring">> := [
+        ]},
+        {<<"spring">>, [
+            {index, 2},
             {label, <<"Spring">>},
-            {id, <<"spring">>}
-        ],
-            <<"keycloak">> := [
+            {oauth_client_id, <<"spring-client">>},
+            {id, <<"spring">>}            
+        ]},
+        {<<"keycloak">>, [
+            {index, 3},
             {label, <<"Keycloak">>},
-            {id, <<"keycloak">>}
-        ]
-    } = translate_oauth_resource_servers(Conf).
+            {oauth_client_id, <<"keycloak-client">>},
+            {id, <<"keycloak">>}            
+        ]}
+     ] = lists:sort(SortByIndex, maps:to_list(translate_oauth_resource_servers(Conf))).
 
 cert_filename(Conf) ->
     string:concat(?config(data_dir, Conf), "certs/cert.pem").