Add version endpoint

And reload page if version has changed

Author: MarcialRosales

deps/rabbitmq_management/priv/www/js/main.js

@@ -91,7 +91,7 @@ function getAccessToken() {
 function start_app_login () {
   app = new Sammy.Application(function () {
     this.get('/', function () {})
-    this.get('#/', function () {})
+    this.get('#/', function () {})    
     if (!oauth.enabled || !oauth.oauth_disable_basic_auth) {
       this.put('#/login', function() {
         set_basic_auth(this.params['username'], this.params['password'])
@@ -115,6 +115,7 @@ function start_app_login () {
 
 
 function check_login () {
+  check_etag()
   user = JSON.parse(sync_get('/whoami'));
   if (user == false || user.error) {
     clear_auth();
@@ -1863,10 +1864,11 @@ function get_chart_range_type(arg) {
     return 'basic';
 }
 
-function check_etag(etag) {
-    lastEtag = get_pref('etag')    
-    if (!lastEtag || lastEtag != etag) {
-        store_pref('etag', etag)
+function check_etag() {
+    let curVersion = sync_get('/version')
+    let storedVersion = get_pref('version')    
+    if (!storedVersion || storedVersion != curVersion) {
+        store_pref('version', curVersion)
         location.reload()
     }
 }

deps/rabbitmq_management/src/rabbit_mgmt_dispatcher.erl

@@ -208,5 +208,6 @@ dispatcher() ->
      {"/auth/attempts/:node/source",                           rabbit_mgmt_wm_auth_attempts, [by_source]},
      {"/login",                                                rabbit_mgmt_wm_login, []},
      {"/config/effective",                                     rabbit_mgmt_wm_environment, []},
-     {"/auth/hash_password/:password",                         rabbit_mgmt_wm_hash_password, []}
+     {"/auth/hash_password/:password",                         rabbit_mgmt_wm_hash_password, []},
+     {"/version",                                              rabbit_mgmt_wm_version, []}
     ].

deps/rabbitmq_management/src/rabbit_mgmt_oauth_bootstrap.erl

@@ -19,21 +19,12 @@ bootstrap_oauth(Req0, State) ->
     AuthSettings = rabbit_mgmt_wm_auth:authSettings(),
     Dependencies = oauth_dependencies(),
     JSContent = import_dependencies(Dependencies) ++ 
-                check_etag() ++
                 set_oauth_settings(AuthSettings) ++ 
                 set_token_auth(AuthSettings, Req0) ++ 
                 export_dependencies(Dependencies),                
     {ok, cowboy_req:reply(200, #{<<"content-type">> => <<"text/javascript; charset=utf-8">>}, 
         JSContent, Req0), State}.
 
-check_etag() ->    
-    ETag = case {rabbit:product_name(), rabbit:product_version()} of
-        {undefined, _} -> rabbit:base_product_version();
-        {_, undefined} -> rabbit:base_product_version();
-        {_,_} -> rabbit:product_name() ++ " " ++ rabbit:product_version()
-    end,
-    ["check_etag('" ++ ETag ++ "');"].
-
 set_oauth_settings(AuthSettings) ->    
     JsonAuthSettings = rabbit_json:encode(rabbit_mgmt_format:format_nulls(AuthSettings)),
     ["set_oauth_settings(", JsonAuthSettings, ");"].

deps/rabbitmq_management/src/rabbit_mgmt_wm_version.erl

@@ -0,0 +1,38 @@
+%% This Source Code Form is subject to the terms of the Mozilla Public
+%% License, v. 2.0. If a copy of the MPL was not distributed with this
+%% file, You can obtain one at https://mozilla.org/MPL/2.0/.
+%%
+%% Copyright (c) 2007-2024 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
+%%
+
+-module(rabbit_mgmt_wm_version).
+
+-export([init/2]).
+-export([to_json/2, content_types_provided/2]).
+-export([variances/2]).
+
+-include_lib("rabbit_common/include/rabbit.hrl").
+-include_lib("rabbitmq_management_agent/include/rabbit_mgmt_records.hrl").
+
+%%--------------------------------------------------------------------
+
+init(Req, _State) ->
+    {cowboy_rest, rabbit_mgmt_headers:set_no_cache_headers(
+        rabbit_mgmt_headers:set_common_permission_headers(Req, ?MODULE), ?MODULE), 
+        #context{}}.
+
+variances(Req, Context) ->
+    {[<<"accept-encoding">>, <<"origin">>], Req, Context}.
+
+content_types_provided(ReqData, Context) ->
+   {rabbit_mgmt_util:responder_map(to_json), ReqData, Context}.
+
+to_json(ReqData, Context) ->   
+    Version = case rabbit:product_version() of
+        undefined -> rabbit:base_product_version();
+        V -> V
+    end,
+    rabbit_mgmt_util:reply(list_to_binary(Version), ReqData, Context).
+
+%%--------------------------------------------------------------------
+