killbill-kpm-ui 1.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c7ab1958f7682e1709819cb222d376118b0df25
-  data.tar.gz: 5bcb62502ce425428aafcd7c7f8b836e7b8fd0be
+  metadata.gz: 525be1974e3fff33c6523e2042ee3c6510e40c7c
+  data.tar.gz: 0c8ca1aac74c3d99e1908a1b829561d96dfbf8a2
 SHA512:
-  metadata.gz: d2c0cc082907faa196de41f2ee58e179a28706ad22013b667f3ee0e060d2da7ddcf2deadb18a5595b9bbae45426937159910e013beb07f82b97e76bc01d7dae6
-  data.tar.gz: 8f4d5ef2d2f24785759cb223d419758e7c8f246f39e9ecf62de1226870945bc7bf3c38e203e8d46fc6f9045e6c5f14732927ae433fdb43ac30d54f2cc7ba606e
+  metadata.gz: ec09d119fb4f1a3355530918236e83c32c4ed12775dc705e23888100cde1bedfeb8ac3f9ea5a64f56dd007e9bc652838fb4ea91e26d7845a2d9f62f3ee3e3d3c
+  data.tar.gz: 873f1e309fff26406e1022c85c23a1cf97f80e3f8dc2bf9bebfa1fabdf90645a25aa906e90c0876c812b5f20a2b02d491fcf7fa2cd3ca20337564584e91d5c35

data/README.md

@@ -13,7 +13,8 @@ Kill Bill compatibility
 | 0.1.y          | 0.16.z            |
 | 0.2.y          | 0.18.z (Rails 4)  |
 | 0.3.y          | 0.18.z (Rails 5)  |
-| 1.x.y          | 0.19.z            |
+| 1.x.y          | 0.20.z (Rails 5)  |
+| 2.x.y          | 0.22.z            |
 
 Testing
 -------

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,14 +16,11 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
-
 load 'rails/tasks/statistics.rake'
 
-
-
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'
@@ -33,5 +32,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/app/assets/javascripts/kpm/logs_refresh.js

@@ -0,0 +1,48 @@
+function refreshLogLine(log) {
+    var table = window.logsDataTable;
+    if (table === null) {
+        return;
+    }
+
+    var levelLabel = 'success';
+    if (log['level'] === 'ERROR') {
+        levelLabel = 'danger';
+    } else if (log['level'] === 'WARNING') {
+        levelLabel = 'warning';
+    }
+
+    var newDate = new Date();
+    newDate.setTime(log['time']);
+    var newRow = $('<tr>')
+        .append($('<td>').text(newDate.toISOString()))
+        .append($('<td>')
+            .append($('<span>')
+                .attr('class', 'label label-' + levelLabel)
+                .text(log['level'])
+            )
+        )
+        .append($('<td>')
+            .append($('<pre>')
+                .text(log['message'])
+            )
+        );
+
+    // Enforce ordering on refresh to remove oldest entry (expected at the bottom)
+    table.order([0, 'desc']).draw();
+
+    // length needs to match pageLength in initializer
+    if (table.column(0).data().length >= 100) {
+        table.row($('tr:last')).remove();
+    }
+
+    table.rows.add(newRow).draw();
+}
+
+function refreshLogs(url) {
+    var source = new EventSource(url);
+    source.addEventListener('refresh', function (e) {
+        if (e['data'] !== 'heartbeat') {
+            refreshLogLine(JSON.parse(e.data));
+        }
+    });
+}

data/app/assets/stylesheets/kpm/nodes_info.css

@@ -0,0 +1,23 @@
+#nodes-table th:first-of-type,
+#nodes-table td:first-of-type,
+#logs-table th:first-of-type,
+#logs-table td:first-of-type {
+    padding-left: 8px;
+}
+
+#nodes-table ul {
+    list-style-type: none;
+    margin: 0;
+    padding: 0;
+}
+
+#logs-table pre {
+    white-space: pre-wrap; /* css-3 */
+    white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
+    white-space: -o-pre-wrap; /* Opera 7 */
+    word-wrap: break-word; /* Internet Explorer 5.5+ */
+}
+
+#logs-form {
+    margin-bottom: 15px;
+}

data/app/controllers/kpm/engine_controller.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module KPM
   class EngineController < ApplicationController
-
     layout :get_layout
 
     def get_layout
@@ -17,13 +18,12 @@ module KPM
     def options_for_klient
       user = current_tenant_user
       {
-          :username => user[:username],
-          :password => user[:password],
-          :session_id => user[:session_id],
-          :api_key => user[:api_key],
-          :api_secret => user[:api_secret]
+        :username => user[:username],
+        :password => user[:password],
+        :session_id => user[:session_id],
+        :api_key => user[:api_key],
+        :api_secret => user[:api_secret]
       }
     end
-
   end
 end

data/app/controllers/kpm/nodes_info_controller.rb

@@ -1,14 +1,21 @@
+# frozen_string_literal: true
+
 require 'kpm/client'
 
 module KPM
   class NodesInfoController < EngineController
+    helper :all
+    include ActionController::Live
 
     def index
+      @installing = !params[:i].blank?
+
       @nodes_info = ::KillBillClient::Model::NodesInfo.nodes_info(options_for_klient)
 
       # For convenience, put pure OSGI bundles at the bottom
       @nodes_info.each do |node_info|
         next if node_info.plugins_info.nil?
+
         node_info.plugins_info.sort! do |a, b|
           if osgi_bundle?(a) && !osgi_bundle?(b)
             1
@@ -20,32 +27,58 @@ module KPM
         end
       end
 
-      @logs = ::Killbill::KPM::KPMClient.get_osgi_logs(options_for_klient).reverse
+      @kb_host = params[:kb_host] || KillBillClient::API.base_uri
+      @last_event_id = params[:last_event_id]
+    end
 
-      respond_to do |format|
-        format.html
-        format.js
+    def refresh
+      response.headers['Content-Type'] = 'text/event-stream'
+
+      last_event_id_ref = Concurrent::AtomicReference.new(request.headers['Last-Event-Id'] || params[:last_event_id])
+      sse = nil
+      sse_client = nil
+      begin
+        # Kaui -> Browser
+        sse = ActionController::Live::SSE.new(response.stream, retry: 300, event: 'refresh')
+
+        # Kill Bill -> Kaui
+        sse_client = ::Killbill::KPM::KPMClient.stream_osgi_logs(sse, params[:kb_host], last_event_id_ref)
+
+        i = 0
+        # We force the browser to reconnect periodically (ensures clients don't block the server shutdown sequence)
+        while i < 6 # 30s
+          i += 1
+          # Keep the thread alive (Kill Bill should send us a heartbeat as well though)
+          # Note that we set the id as the last log id, so that we can easily resume
+          sse.write('heartbeat', id: last_event_id_ref.get)
+          sleep 5
+        end
+      rescue ActionController::Live::ClientDisconnected
+        # ignored
+      ensure
+        begin
+          begin
+            sse_client&.close
+          rescue StandardError
+            # ignored
+          end
+          sse&.close
+        ensure
+          # Clear dead DB connections
+          # Very lame, but I couldn't do better... Rails will checkout a DB connection
+          # whenever a new Thread is spawn and ActiveRecord::Base.clear_active_connections!
+          # didn't seem to do the trick: the number of active and dead connections kept growing:
+          #     connections = ActiveRecord::Base.connection_pool.instance_eval { @connections }
+          #     busy = connections.count { |c| c.in_use? }
+          #     dead = connections.count { |c| c.in_use? && !c.owner.alive? }
+          ActiveRecord::Base.connection_pool.reap
+        end
       end
     end
 
     def install_plugin
-      command_properties = [
-          build_node_command_property('forceDownload', params[:force_download] == '1')
-      ]
-      trigger_node_plugin_command('INSTALL_PLUGIN', command_properties)
-
-      redirect_to :action => :index
-    end
-
-    def install_plugin_from_fs
-      ::Killbill::KPM::KPMClient.install_plugin(params.require(:key),
-                                                params.require(:version),
-                                                params.require(:type),
-                                                params.require(:plugin).original_filename,
-                                                params.require(:plugin).read,
-                                                options_for_klient)
-
-      redirect_to :action => :index
+      trigger_node_plugin_command('INSTALL_PLUGIN')
+      redirect_to nodes_info_index_path(i: 1)
     end
 
     def uninstall_plugin
@@ -70,21 +103,25 @@ module KPM
 
     private
 
-    def trigger_node_plugin_command(command_type, command_properties=[])
+    def trigger_node_plugin_command(command_type, command_properties = [])
+      # No need to pass kbVersion -- Kill Bill will figure it out
       command_properties << build_node_command_property('pluginKey', params[:plugin_key])
       command_properties << build_node_command_property('pluginName', params[:plugin_name])
       command_properties << build_node_command_property('pluginVersion', params[:plugin_version])
+      command_properties << build_node_command_property('pluginType', params[:plugin_type])
+      command_properties << build_node_command_property('pluginUri', params[:plugin_uri])
+      command_properties << build_node_command_property('forceDownload', params[:force_download] == '1')
 
       trigger_node_command(command_type, command_properties)
     end
 
-    def trigger_node_command(command_type, command_properties=[])
+    def trigger_node_command(command_type, command_properties = [])
       node_command = ::KillBillClient::Model::NodeCommandAttributes.new
-      node_command.system_command_type = true
+      node_command.is_system_command_type = true
       node_command.node_command_type = command_type
       node_command.node_command_properties = command_properties
 
-      # TODO Can we actually use node_name?
+      # TODO: Can we actually use node_name?
       local_node_only = false
 
       ::KillBillClient::Model::NodesInfo.trigger_node_command(node_command,

data/app/controllers/kpm/plugins_controller.rb

@@ -1,19 +1,48 @@
+# frozen_string_literal: true
+
 require 'kpm/client'
 
 module KPM
   class PluginsController < EngineController
-
     def index
-      begin
-        plugins = ::Killbill::KPM::KPMClient.get_available_plugins(true, options_for_klient)
-      rescue => e
-        # No connectivity, GitHub down, ...
-        Rails.logger.warn("Unable to get latest plugins, trying built-in directory: #{e.inspect}")
-        plugins = ::Killbill::KPM::KPMClient.get_available_plugins(false, options_for_klient)
+      nodes_by_kb_version, @kb_version = killbill_version
+      @warning_message = ''
+      @plugins = {}
+      if !nodes_by_kb_version.nil? && nodes_by_kb_version.size > 1
+        @warning_message = different_versions_warning_message(nodes_by_kb_version)
+      else
+        full_kb_version = nodes_by_kb_version.nil? ? 'LATEST' : nodes_by_kb_version.keys.first
+        begin
+          plugins_metadata = ::Killbill::KPM::KPMClient.get_available_plugins(full_kb_version, true, options_for_klient)
+        rescue StandardError => e
+          # No connectivity or version not in Nexus
+          Rails.logger.warn("Unable to get latest plugins for version #{full_kb_version}: #{e.inspect}")
+          plugins_metadata = ::Killbill::KPM::KPMClient.get_available_plugins('LATEST', false, options_for_klient)
+        end
+        @plugins = Hash[plugins_metadata['plugins'].sort]
       end
+    end
+
+    private
 
-      @plugins = Hash[plugins.sort]
+    def different_versions_warning_message(nodes_by_kb_version)
+      message = '<b>Warning!</b> Unable to find plugins to install, different versions of Kill Bill were found:<ul>'
+      nodes_by_kb_version.each do |version, node_name|
+        message = "#{message} <li><b>#{version}:</b> #{node_name}</li>"
+      end
+      "#{message}</ul>"
     end
 
+    def killbill_version
+      nodes_info = ::KillBillClient::Model::NodesInfo.nodes_info(options_for_klient)
+      return nil if nodes_info.blank?
+
+      first_node_version = nodes_info.first.kb_version
+      nodes_by_kb_version = {}
+      nodes_info.each do |node|
+        nodes_by_kb_version[node.kb_version] = "#{(nodes_by_kb_version[node.kb_version] || '')} #{node.node_name}"
+      end
+      [nodes_by_kb_version, first_node_version.scan(/(\d+\.\d+)(\.\d)?/).flatten[0]]
+    end
   end
 end

data/app/helpers/kpm/application_helper.rb

@@ -1,4 +1,18 @@
+# frozen_string_literal: true
+
 module KPM
   module ApplicationHelper
+    # Return true if the KPM plugin is on at least one node
+    # (INSTALL_PLUGIN and UNINSTALL_PLUGIN are handled by KPM plugin, not by the core)
+    def kpm_plugin_installed?(nodes_info)
+      nodes_info.each do |node_info|
+        next if (node_info.plugins_info || []).empty?
+
+        node_info.plugins_info.each do |plugin_info|
+          return true if plugin_info.plugin_name == 'org.kill-bill.billing.killbill-platform-osgi-bundles-kpm'
+        end
+      end
+      false
+    end
   end
 end

data/app/views/kpm/nodes_info/_logs_table.html.erb

@@ -2,42 +2,39 @@
   <thead>
   <tr>
     <th>Time</th>
-    <th>Name</th>
     <th>Level</th>
     <th>Message</th>
   </tr>
   </thead>
   <tbody>
-  <% logs.each do |log| %>
-      <tr>
-        <td>
-          <% unless log['time'].blank? %>
-              <%= DateTime.strptime(log['time'].to_s, '%Q').strftime('%Y-%m-%d %H:%M:%S') %>
-          <% end %>
-        </td>
-        <td><%= log['name'] %></td>
-        <td>
-          <% if log['level'] == 'ERROR' %>
-              <span class="label label-danger"><%= log['level'] %></span>
-          <% elsif log['level'] == 'WARNING' %>
-              <span class="label label-warning"><%= log['level'] %></span>
-          <% else %>
-              <span class="label label-success"><%= log['level'] %></span>
-          <% end %>
-        </td>
-        <td><pre><%= log['message'] %></pre></td>
-      </tr>
-  <% end %>
   </tbody>
 </table>
 
+<%= form_tag url_for, :method => 'get', :format => :js, :id => 'kb_host-form', :class => 'form-horizontal', :style => 'display: none;' do %>
+  <div id="logs-form">
+    <div class="form-inline">
+      <%= text_field_tag :kb_host, kb_host, :class => 'form-control' %>
+      <%= button_tag '', :type => 'submit', :class => 'glyphicon glyphicon-search' %>
+    </div>
+  </div>
+<% end %>
+
 <%= javascript_tag do %>
   $(document).ready(function() {
-    $('#logs-table').dataTable({
-      "dom": "<'row'r>t<'row'<'col-md-6'i><'col-md-6'p>>",
-      "pagingType": "full_numbers",
-      "pageLength": 50,
-      "ordering": false
+    window.logsDataTable = $('#logs-table').DataTable({
+      "columns": [
+        { "width": "165px" }, /* ISO String is constant in width */
+        { "width": "60px" },  /* Log levels are bounded in width */
+        null,
+      ],
+      "dom": "<'row'<'col-md-6'><'col-md-6'f>>t<'row'<'col-md-6'><'col-md-6'>>",
+      "ordering": true,
+      "pageLength": 100
     });
+
+    var kbHostForm = $('#kb_host-form').detach();
+    var leftOfSearchBox = $("#logs-table_wrapper > div:nth-child(1) > div:nth-child(1)");
+    kbHostForm.appendTo(leftOfSearchBox);
+    kbHostForm.show();
   });
 <% end %>

data/app/views/kpm/nodes_info/_nodes_table.html.erb

@@ -1,26 +1,21 @@
 <table id="nodes-table" class="table table-condensed table-striped mobile-data">
   <thead>
   <tr>
-    <th>Node name</th>
-    <th>Boot time</th>
-    <th>Updated date</th>
+    <th>Node</th>
+    <th>Uptime</th>
     <th>Kill Bill version</th>
     <th>Dependencies</th>
     <th>Plugins</th>
   </tr>
   </thead>
   <tbody>
+  <%- has_kpm_plugin = kpm_plugin_installed?(nodes_info) %>
   <% nodes_info.each do |node_info| %>
       <tr>
         <td><%= node_info.node_name %></td>
         <td>
           <% unless node_info.boot_time.blank? %>
-              <%= time_ago_in_words(DateTime.parse(node_info.boot_time)) %> ago
-          <% end %>
-        </td>
-        <td>
-          <% unless node_info.last_updated_date.blank? %>
-              <%= time_ago_in_words(DateTime.parse(node_info.last_updated_date)) %> ago
+              <%= time_ago_in_words(DateTime.parse(node_info.boot_time)) %>
           <% end %>
         </td>
         <td><%= node_info.kb_version %></td>
@@ -39,12 +34,15 @@
                     <li>
                       <%= plugin_info.plugin_name %> <%= plugin_info.version %> <span class="label label-<%= plugin_info.state == 'RUNNING' ? 'success' : (plugin_info.state == 'INSTALLED' ? 'warning' : 'danger') %>"><%= plugin_info.state %></span>
                       <% if plugin_info.state == 'RUNNING' %>
+                        <%-# If there is not plugin_key, this is most likely a pure OSGI bundle. In that case, we don't want to allow stopping it as we would lose track of it (once it's removed from the OSGI bundle registry, we don't know about it anymore) -%>
+                        <% unless plugin_info.plugin_key.nil? %>
                           <%= link_to '<i class="fa fa-pause"></i>'.html_safe, plugin_stop_path(:plugin_key => plugin_info.plugin_key, :plugin_name => plugin_info.plugin_name, :plugin_version => plugin_info.version), :method => :post, :title => 'Stop', :remote => true, :class => 'plugin-link' %>
-                          <%= link_to '<i class="fa fa-refresh"></i>'.html_safe, plugin_restart_path(:plugin_key => plugin_info.plugin_key, :plugin_name => plugin_info.plugin_name, :plugin_version => plugin_info.version), :method => :post, :title => 'Restart', :remote => true, :class => 'plugin-link' %>
+                        <% end %>
+                        <%= link_to '<i class="fa fa-refresh"></i>'.html_safe, plugin_restart_path(:plugin_key => plugin_info.plugin_key, :plugin_name => plugin_info.plugin_name, :plugin_version => plugin_info.version), :method => :post, :title => 'Restart', :remote => true, :class => 'plugin-link' %>
                       <% elsif plugin_info.state == 'INSTALLED' || plugin_info.state == 'STOPPED' %>
                           <%= link_to '<i class="fa fa-play"></i>'.html_safe, plugin_start_path(:plugin_key => plugin_info.plugin_key, :plugin_name => plugin_info.plugin_name, :plugin_version => plugin_info.version), :method => :post, :title => 'Start', :remote => true, :class => 'plugin-link' %>
                       <% end %>
-                      <% unless plugin_info.version.nil? %>
+                      <% if !plugin_info.version.nil? && has_kpm_plugin %>
                           <%= link_to '<i class="fa fa-eject"></i>'.html_safe, plugin_uninstall_path(:plugin_key => plugin_info.plugin_key, :plugin_name => plugin_info.plugin_name, :plugin_version => plugin_info.version), :method => :post, :title => 'Uninstall', :remote => true, :class => 'plugin-link' %>
                       <% end %>
                     </li>

data/app/views/kpm/nodes_info/index.html.erb

@@ -2,7 +2,15 @@
 
   <div class="column-block">
 
-    <h1>Configured instances</h1>
+    <h1>Configured instances
+      <div id="install-in-progress" class="btn btn-xs text-success" style="display: none;"><i class="fa fa-refresh"></i>&nbsp;Operation in progress</div>
+      <%= link_to('<i class="fa fa-refresh"></i>&nbsp;Operation complete, reload page'.html_safe, url_for, :id => "reload-page", :class => 'btn btn-xs text-success', :style => "display: none;") %>
+      <% if kpm_plugin_installed?(@nodes_info) %>
+        <div class="pull-right">
+          <%= link_to 'Install new plugin', plugins_path %>
+        </div>
+      <% end %>
+    </h1>
 
     <div id="nodes-table-wrapper">
       <%= render :partial => 'kpm/nodes_info/nodes_table', :locals => {:nodes_info => @nodes_info} %>
@@ -10,41 +18,22 @@
 
   </div>
 
-  <div class="column-block">
-
-    <h1><%= link_to 'Install new plugin', plugins_path %></h1>
-
-  </div>
-
   <div class="column-block">
 
     <h1>Logs</h1>
 
     <div id="logs-table-wrapper">
-      <%= render :partial => 'kpm/nodes_info/logs_table', :locals => {:logs => @logs} %>
+      <%= render :partial => 'kpm/nodes_info/logs_table', :locals => {:kb_host => @kb_host} %>
     </div>
 
   </div>
-
 </div>
 
 <%= javascript_tag do %>
   $(document).ready(function() {
-    scheduleRefresh();
-  });
-
-  function scheduleRefresh() {
-    var timer = setTimeout(refreshAll, 1500);
-
-    // Stop refreshing when user clicks through logs
-    $('#logs-table_wrapper a').one('click', function() {
-      clearTimeout(timer);
-    });
+    refreshLogs('<%= nodes_info_refresh_path(:kb_host => @kb_host, :last_event_id => @last_event_id, :format => :js) %>');
 
     $('.plugin-link').one('ajax:beforeSend', function() {
-      // Disable the refresh
-      clearTimeout(timer);
-
       // Prevent other clicks
       $('.plugin-link').removeAttr('data-remote')
                        .removeAttr('data-method')
@@ -53,16 +42,30 @@
       // Spin
       $(this).children().addClass('fa-spin');
     });
-
     $('.plugin-link').one('ajax:complete', function() {
       // Delay a bit, to give time for the plugin state to change before the next refresh
-      setTimeout(refreshAll, 6000);
+      setTimeout(fakeOperationComplete, 6000);
     });
-  }
 
-  function refreshAll() {
-    $.ajax({
-      url: "<%= nodes_info_index_path(:format => :js) %>"
-    });
-  }
+    <%- if @installing %>
+      // Prevent other clicks
+      $('.plugin-link').removeAttr('data-remote')
+                       .removeAttr('data-method')
+                       .removeAttr('href')
+      $('#nodes-table-wrapper').css({ opacity: 0.5 });
+
+      $('#install-in-progress').show();
+      $('#install-in-progress').children().addClass('fa-spin');
+
+      setTimeout(fakeOperationComplete, 6000);
+    <% end %>
+
+    function fakeOperationComplete() {
+      $('#install-in-progress').hide();
+
+      $('.plugin-link').children().removeClass('fa-spin');
+      $('#nodes-table-wrapper').fadeTo("slow", 0.5);
+      $('#reload-page').fadeIn("slow");
+    }
+  });
 <% end %>

data/app/views/kpm/plugins/_form.html.erb

@@ -1,34 +1,34 @@
-<%= form_tag plugin_install_from_fs_path, :multipart => true, :class => 'form-horizontal' do %>
+<%= form_tag plugin_install_path, :class => 'form-horizontal' do %>
     <div class="form-group">
-      <%= label_tag :key, 'Plugin key', :class => 'col-sm-2 control-label' %>
+      <%= label_tag :plugin_key, 'Plugin key', :class => 'col-sm-2 control-label' %>
       <div class="col-sm-9">
-        <%= text_field_tag :key, '', :class => 'form-control', :placeholder => 'Plugin key' %>
+        <%= text_field_tag :plugin_key, '', :class => 'form-control', :placeholder => 'Unique identifier for this plugin, e.g. myCompany:myPluginName', :required => true %>
       </div>
     </div>
     <div class="form-group">
-      <%= label_tag :version, 'Version', :class => 'col-sm-2 control-label' %>
+      <%= label_tag :plugin_version, 'Version', :class => 'col-sm-2 control-label' %>
       <div class="col-sm-9">
-        <%= text_field_tag :version, '', :class => 'form-control', :placeholder => 'Plugin version' %>
+        <%= text_field_tag :plugin_version, '', :class => 'form-control', :placeholder => 'Plugin version', :required => true %>
+      </div>
+    </div>
+    <div class="form-group">
+      <%= label_tag :plugin_uri, 'URI', :class => 'col-sm-2 control-label' %>
+      <div class="col-sm-9">
+        <%= text_field_tag :plugin_uri, '', :class => 'form-control', :placeholder => 'HTTP(S) url accessible from all Kill Bill nodes', :required => true %>
       </div>
     </div>
     <div class='form-group'>
       <div class="col-sm-offset-2 col-sm-10">
         <% %w(java ruby).each do |type| %>
             <div class="checkbox">
-              <%= label_tag :type do %>
-                  <%= radio_button_tag :type, type, (type == 'java') %>
+              <%= label_tag :plugin_type do %>
+                  <%= radio_button_tag :plugin_type, type, (type == 'java') %>
                   <%= type %>
               <% end %>
             </div>
         <% end %>
       </div>
     </div>
-    <div class="form-group">
-      <%= label_tag :plugin, 'Plugin', :class => 'col-sm-2 control-label' %>
-      <div class="col-sm-10">
-        <%= file_field_tag 'plugin', :class => 'form-control' %>
-      </div>
-    </div>
     <div class="form-group">
       <div class="col-sm-offset-2 col-sm-10">
         <%= submit_tag 'Install', :class => 'btn btn-default' %>

data/app/views/kpm/plugins/_plugins_table.html.erb

@@ -1,41 +1,25 @@
-<table id="plugins-table" class="table table-condensed table-striped mobile-data">
-  <thead>
-  <tr>
-    <th>Name</th>
-    <th>Type</th>
-    <th>Versions</th>
-    <th>Required configuration</th>
-    <th></th>
-  </tr>
-  </thead>
-  <tbody>
-  <% plugins.each do |name, details| %>
-      <tr>
-        <td><%= name %></td>
-        <td><%= details['type'] %></td>
-        <td>
-          <% unless details['versions'].nil? %>
-              <ul>
-                <% details['versions'].each do |kb_version, plugin_version| %>
-                    <li><%= kb_version %>: <%= plugin_version %></li>
-                <% end %>
-              </ul>
-          <% end %>
-        </td>
-        <td>
-          <% unless (details['require'] || []).empty? %>
-              <ul>
-                <% details['require'].each do |property| %>
-                    <li><%= property %></li>
-                <% end %>
-              </ul>
-          <% end %>
-        </td>
-        <td><%= link_to '<i class="fa fa-cloud-download"></i>'.html_safe, plugin_install_path(:plugin_key => name), :method => :post, :title => 'Install' %></td>
-      </tr>
-  <% end %>
-  </tbody>
-</table>
+<% if @warning_message.blank? %>
+  <table id="plugins-table" class="table table-condensed table-striped mobile-data">
+    <thead>
+    <tr>
+      <th>Name</th>
+      <th>Version</th>
+      <th></th>
+    </tr>
+    </thead>
+    <tbody>
+    <% plugins.each do |name, version| %>
+        <tr>
+          <td><%= name %></td>
+          <td><%= version %></td>
+          <td><%= link_to '<i class="fa fa-cloud-download"></i>'.html_safe, plugin_install_path(:plugin_key => name), :method => :post, :title => 'Install' %></td>
+        </tr>
+    <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <div class="alert alert-warning" role="alert"><%= @warning_message.html_safe %></div>
+<% end %>
 
 <%= javascript_tag do %>
   $(document).ready(function() {

data/app/views/kpm/plugins/index.html.erb

@@ -2,7 +2,7 @@
 
   <div class="column-block">
 
-    <h1>Available plugins</h1>
+    <h1>Official plugins</h1>
 
     <%= render :partial => 'kpm/plugins/plugins_table', :locals => {:plugins => @plugins} %>
 

data/config/routes.rb

@@ -1,11 +1,13 @@
-KPM::Engine.routes.draw do
+# frozen_string_literal: true
 
+KPM::Engine.routes.draw do
   root to: 'nodes_info#index'
 
-  resources :nodes_info, :only => [:index]
-  resources :plugins, :only => [:index]
+  resources :nodes_info, only: [:index]
+  resources :plugins, only: [:index]
 
   scope '/nodes_info' do
+    match '/refresh' => 'nodes_info#refresh', :via => :get, :as => 'nodes_info_refresh'
     match '/plugin/install' => 'nodes_info#install_plugin', :via => :post, :as => 'plugin_install'
     match '/plugin/install_from_fs' => 'nodes_info#install_plugin_from_fs', :via => :post, :as => 'plugin_install_from_fs'
     match '/plugin/uninstall' => 'nodes_info#uninstall_plugin', :via => :post, :as => 'plugin_uninstall'
@@ -13,5 +15,4 @@ KPM::Engine.routes.draw do
     match '/plugin/stop' => 'nodes_info#stop_plugin', :via => :post, :as => 'plugin_stop'
     match '/plugin/restart' => 'nodes_info#restart_plugin', :via => :post, :as => 'plugin_restart'
   end
-
 end

data/lib/kpm.rb

@@ -1,24 +1,24 @@
+# frozen_string_literal: true
+
 require 'kpm/engine'
 
 module KPM
-
   mattr_accessor :current_tenant_user
   mattr_accessor :layout
 
-  self.current_tenant_user = lambda { |session, user|
+  self.current_tenant_user = lambda { |_session, _user|
     {
-        :username => 'admin',
-        :password => 'password',
-        :session_id => nil,
-        :api_key => KillBillClient.api_key,
-        :api_secret => KillBillClient.api_secret
+      username: 'admin',
+      password: 'password',
+      session_id: nil,
+      api_key: KillBillClient.api_key,
+      api_secret: KillBillClient.api_secret
     }
   }
 
-  def self.config(&block)
+  def self.config
     {
-        :layout => layout || 'kpm/layouts/kpm_application',
+      layout: layout || 'kpm/layouts/kpm_application'
     }
   end
-
 end

data/lib/kpm/client.rb

@@ -1,31 +1,45 @@
+# frozen_string_literal: true
+
+require 'ld-eventsource'
+
 module Killbill
   module KPM
-
     class KPMClient < KillBillClient::Model::Resource
-
       KILLBILL_KPM_PREFIX = '/plugins/killbill-kpm'
       KILLBILL_OSGI_LOGGER_PREFIX = '/plugins/killbill-osgi-logger'
 
       class << self
+        def get_available_plugins(kb_version_maybe_snapshot, latest = true, options = {})
+          # Mostly useful for Kill Bill developers: get the latest version before the current snapshot
+          # (we rarely deploy SNAPSHOT jars)
+          captures = kb_version_maybe_snapshot.scan(/0.(\d+)(\.)?(\d+)?(-SNAPSHOT)?/)
+          # [["20", ".", "1", "-SNAPSHOT"]]
+          kb_version = if !captures.nil? && !captures.first.nil? && !captures.first[3].nil?
+                         if captures.first[2].to_i.positive?
+                           '0.' + captures.first[0] + '.' + (captures.first[2].to_i - 1).to_s
+                         else
+                           '0.' + (captures.first[0].to_i - 1).to_s + '.0'
+                         end
+                       else
+                         kb_version_maybe_snapshot
+                       end
 
-        def get_available_plugins(latest=true, options = {})
           path = "#{KILLBILL_KPM_PREFIX}/plugins"
-          response = KillBillClient::API.get path, { :latest => latest }, options
-          JSON.parse(response.body)
-        end
-
-        def get_osgi_logs(options = {})
-          response = KillBillClient::API.get KILLBILL_OSGI_LOGGER_PREFIX, {}, options
+          response = KillBillClient::API.get path, { kbVersion: kb_version, latest: latest }, options
           JSON.parse(response.body)
         end
 
-        def install_plugin(key, version, type, filename, plugin, options = {})
-          path = "#{KILLBILL_KPM_PREFIX}/plugins"
-          KillBillClient::API.post path, plugin, {:key => key, :version => version, :type => type, :filename => filename}, options.merge(:content_type => 'application/octet-stream')
+        def stream_osgi_logs(writer, host, last_event_id_ref)
+          url = host
+          url = "http://#{url}" unless url.starts_with?('http:')
+          SSE::Client.new(url + KILLBILL_OSGI_LOGGER_PREFIX, last_event_id: last_event_id_ref.get, logger: Rails.logger) do |client|
+            client.on_event do |event|
+              writer.write(event.data, id: event.id)
+              last_event_id_ref.set(event.id)
+            end
+          end
         end
       end
-
     end
-
   end
 end

data/lib/kpm/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Dependencies
 #
 # Sigh. Rails autoloads the gems specified in the Gemfile and nothing else.

data/lib/kpm/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KPM
-  VERSION = '1.0.0'
+  VERSION = '2.0.2'
 end

data/lib/tasks/kpm_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :kpm do
 #   # Task goes here

data/test/integration/navigation_test.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class NavigationTest < ActionDispatch::IntegrationTest
-
   include KPM::Engine.routes.url_helpers
 
   test 'can see the nodes info page' do
@@ -14,4 +15,3 @@ class NavigationTest < ActionDispatch::IntegrationTest
     assert_response :success
   end
 end
-

data/test/kpm_test.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class KPMTest < ActiveSupport::TestCase
-
   test 'can load KPM module' do
     assert_kind_of Module, KPM
   end

data/test/test_helper.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 # Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
 
-require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
-require "rails/test_help"
+require File.expand_path('../test/dummy/config/environment.rb', __dir__)
+require 'rails/test_help'
 
 # Filter out Minitest backtrace while allowing backtrace from other libraries
 # to be shown.
 Minitest.backtrace_filter = Minitest::BacktraceFilter.new
 
 # Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
 
 # Load fixtures from the engine
 if ActiveSupport::TestCase.respond_to?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+  ActiveSupport::TestCase.fixture_path = File.expand_path('fixtures', __dir__)
   ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
   ActiveSupport::TestCase.fixtures :all
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: killbill-kpm-ui
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: jquery-datatables-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.3'
 - !ruby/object:Gem::Dependency
-  name: jquery-datatables-rails
+  name: ld-eventsource
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: twitter-bootstrap-rails
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: font-awesome-rails
   requirement: !ruby/object:Gem::Requirement
@@ -86,22 +100,22 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: twitter-bootstrap-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -109,7 +123,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+- !ruby/object:Gem::Dependency
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,19 +179,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.88.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.88.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.6
+        version: '0'
 description: Rails UI plugin for the KPM plugin.
 email: killbilling-users@googlegroups.com
 executables: []
@@ -161,9 +217,11 @@ files:
 - Rakefile
 - app/assets/javascripts/application.js
 - app/assets/javascripts/kpm/kpm.js
+- app/assets/javascripts/kpm/logs_refresh.js
 - app/assets/stylesheets/application.css
 - app/assets/stylesheets/bootstrap_and_overrides.css
 - app/assets/stylesheets/kpm/kpm.css
+- app/assets/stylesheets/kpm/nodes_info.css
 - app/controllers/kpm/engine_controller.rb
 - app/controllers/kpm/nodes_info_controller.rb
 - app/controllers/kpm/plugins_controller.rb
@@ -172,7 +230,6 @@ files:
 - app/views/kpm/nodes_info/_logs_table.html.erb
 - app/views/kpm/nodes_info/_nodes_table.html.erb
 - app/views/kpm/nodes_info/index.html.erb
-- app/views/kpm/nodes_info/index.js.erb
 - app/views/kpm/plugins/_form.html.erb
 - app/views/kpm/plugins/_plugins_table.html.erb
 - app/views/kpm/plugins/index.html.erb
@@ -213,7 +270,6 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
-- test/dummy/log/test.log
 - test/integration/navigation_test.rb
 - test/kpm_test.rb
 - test/test_helper.rb
@@ -242,38 +298,37 @@ signing_key:
 specification_version: 4
 summary: Kill Bill KPM UI mountable engine
 test_files:
+- test/kpm_test.rb
 - test/test_helper.rb
 - test/integration/navigation_test.rb
-- test/dummy/log/test.log
-- test/dummy/config/secrets.yml
-- test/dummy/config/locales/en.yml
-- test/dummy/config/environment.rb
+- test/dummy/config.ru
+- test/dummy/bin/yarn
+- test/dummy/bin/update
+- test/dummy/bin/rake
+- test/dummy/bin/setup
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
 - test/dummy/config/routes.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/initializers/new_framework_defaults_5_1.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/killbill_client.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/boot.rb
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/killbill_client.rb
+- test/dummy/config/initializers/assets.rb
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/boot.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/new_framework_defaults_5_1.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/secrets.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/test.rb
 - test/dummy/config/application.rb
-- test/dummy/Rakefile
 - test/dummy/README.rdoc
+- test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
-- test/dummy/config.ru
-- test/dummy/bin/rake
-- test/dummy/bin/bundle
-- test/dummy/bin/update
-- test/dummy/bin/setup
-- test/dummy/bin/yarn
-- test/dummy/bin/rails
-- test/kpm_test.rb

data/app/views/kpm/nodes_info/index.js.erb

@@ -1,4 +0,0 @@
-$('#nodes-table-wrapper').html("<%= escape_javascript(render :partial => 'kpm/nodes_info/nodes_table', :locals => {:nodes_info => @nodes_info}) %>");
-$('#logs-table-wrapper').html("<%= escape_javascript(render :partial => 'kpm/nodes_info/logs_table', :locals => {:logs => @logs}) %>");
-
-scheduleRefresh();

data/test/dummy/log/test.log

@@ -1,21 +0,0 @@
----------------------------------
-KPMTest: test_can_load_KPM_module
----------------------------------
-------------------------------------------------
-NavigationTest: test_can_see_the_nodes_info_page
-------------------------------------------------
-Started GET "/kpm" for 127.0.0.1 at 2018-05-18 09:08:53 +0000
-Processing by KPM::NodesInfoController#index as HTML
-Request method='GET', uri='http://127.0.0.1:8080/1.0/kb/nodesInfo'
-accept='application/json', user-agent='killbill/2.2.3; ruby 2.4.2p198 (2017-09-14 revision 59899) [x86_64-linux]', accept-encoding='gzip;q=1.0,deflate;q=0.6,identity;q=0.3', x-killbill-apikey='bob', x-killbill-apisecret='lazar', authorization='Basic [FILTERED]'
-Completed 500 Internal Server Error in 1ms
----------------------------------------
-NavigationTest: test_can_restart_bundle
----------------------------------------
-Started POST "/kpm/nodes_info/plugin/restart?plugin_name=org.apache.felix.shell" for 127.0.0.1 at 2018-05-18 09:08:53 +0000
-Processing by KPM::NodesInfoController#restart_plugin as HTML
-  Parameters: {"plugin_name"=>"org.apache.felix.shell"}
-Request method='POST', uri='http://127.0.0.1:8080/1.0/kb/nodesInfo?localNodeOnly=false'
-accept='application/json', user-agent='killbill/2.2.3; ruby 2.4.2p198 (2017-09-14 revision 59899) [x86_64-linux]', accept-encoding='gzip;q=1.0,deflate;q=0.6,identity;q=0.3', x-killbill-apikey='bob', x-killbill-apisecret='lazar', authorization='Basic [FILTERED]', content-type='application/json', x-killbill-createdby='admin'
-requestBody='{"systemCommandType":true,"nodeCommandType":"RESTART_PLUGIN","nodeCommandProperties":[{"key":"pluginKey"},{"key":"pluginName","value":"org.apache.felix.shell"},{"key":"pluginVersion"}]}'
-Completed 500 Internal Server Error in 1ms