marty 8.0.0 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba9d8e9da88bf08b792bd49d882e4320dc0e68f338ab5ed35577a4c1c741ae90
-  data.tar.gz: b9b76371c794c41b8383c52a30d03d0ecccbfc428bfe88f598c8ec6778e4e63f
+  metadata.gz: ef38a20a14482c03a791b80eb8743f9764151a8e8d09c682c76ffeea62d76828
+  data.tar.gz: 480f31e3d956e235fd4941be08c209c05a7c338d3fbdeb6d2b85a4d4af7b0c28
 SHA512:
-  metadata.gz: ddf969f74e26013d76713537bcddeba889983d83d80ea60d5ace5cb92cc44a77096e73a356524def77ca10a00b473574fa9a94acffbfa1182bbc61c0927b413f
-  data.tar.gz: 4a3f20060711fc70cce936e90197f88a1256f1c814d4cf2fbadde12b28715eeffde3c096e92db1c1a7693d9ad268966e77e4aa2b1ee20b3d7078e93838869f78
+  metadata.gz: 5263a4562cfa44272654a399ef3f5e2f52cb95e27fd027c130b0477b93dad83d1b83631d5efc8946344ed5485ef5b654980282882580fd472687fd99d6b71ddc
+  data.tar.gz: 07e53433346be6dbd718fa631aa7535179ec944139ebbcb6fd69ef9b5182a175dad233df397ca14300581da995d553a667dbb0126e6f988ea3e5339e4fc365aa

data/.gitlab-ci.yml

@@ -10,7 +10,14 @@ before_script:
   - RAILS_ENV=test bundle exec rails db:create db:migrate
 
 .base-test:
+  # Cancel if new commits where pushed
+  interruptible: true
+  # Run only when there is an MR
+  only:
+    - merge_requests
+
   stage: test
+
   # Use only the following CI runners
   tags:
     - gitlabci-runner-eks-shared-dev

data/app/assets/javascripts/marty/cable.js

@@ -0,0 +1,12 @@
+//= require action_cable
+//= require_self
+
+(function() {
+  this.RailsApp || (this.RailsApp = {});
+
+  if (window.location.port === "") {
+    RailsApp.cable = ActionCable.createConsumer(`ws://${window.location.hostname}/cable`);
+  } else {
+    RailsApp.cable = ActionCable.createConsumer(`ws://${window.location.hostname}:${window.location.port}/cable`);
+  }
+}).call(this);

data/app/assets/stylesheets/marty/codemirror/notifications.css

@@ -0,0 +1,4 @@
+.notification-counter {
+  color: red;
+  font-weight: 400;
+}

data/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ::ActionCable::Channel::Base
+  end
+end

data/app/channels/application_cable/connection.rb

@@ -0,0 +1,17 @@
+module ApplicationCable
+  class Connection < ::ActionCable::Connection::Base
+    identified_by :current_user
+
+    def connect
+      self.current_user = find_verified_user
+    end
+
+    private
+
+    def find_verified_user
+      return unless cookies.signed[:user_id].present?
+
+      ::Marty::User.find_by(id: cookies.signed[:user_id])
+    end
+  end
+end

data/app/channels/marty/notification_channel.rb

@@ -0,0 +1,8 @@
+module Marty
+  class NotificationChannel < ::ApplicationCable::Channel
+    def subscribed
+      reject && return unless current_user.present?
+      stream_from "marty_notifications_#{current_user.id}"
+    end
+  end
+end

data/app/components/marty/auth_app.rb

@@ -2,6 +2,8 @@
 #
 # == Extending Marty::AuthApp
 # DOCFIX
+require 'marty/notifications/window'
+
 class Marty::AuthApp < Marty::SimpleApp
   client_class do |c|
     c.include :auth_app
@@ -12,22 +14,54 @@ class Marty::AuthApp < Marty::SimpleApp
     [].tap do |menu|
       user = Mcfly.whodunnit
       if !user.nil?
-        menu << '->' << {
-          text: user.name,
-          tooltip: 'Current user',
-          menu: user_menu,
-          name: 'sign_out',
-        }
+        menu <<
+          '->' <<
+          notification_menu_item <<
+          current_user_menu_item(user)
       else
         menu << '->' << :sign_in
       end
     end
   end
 
+  def notification_menu_item
+    :notifications_window
+  end
+
+  def current_user_menu_item(user)
+    {
+      text: user.name,
+      tooltip: 'Current user',
+      menu: user_menu,
+      name: 'sign_out',
+    }
+  end
+
   def user_menu
     [:sign_out, :toggle_dark_mode]
   end
 
+  def unread_notifications_count
+    user = Mcfly.whodunnit
+
+    return 0 unless user.present?
+
+    user.unread_web_notifications_count
+  end
+
+  action :notifications_window do |c|
+    c.icon_cls = 'fa fa-bell gylph '
+    c.tooltip = 'Show notifications'
+
+    c.text = nil
+
+    notifications_count = unread_notifications_count
+
+    next if notifications_count.zero?
+
+    c.text = "<span class='notification-counter'>#{notifications_count}</span>"
+  end
+
   action :sign_in do |c|
     c.icon_cls = 'fa fa-sign-in-alt gylph'
   end
@@ -58,4 +92,18 @@ class Marty::AuthApp < Marty::SimpleApp
   endpoint :toggle_dark_mode do
     Netzke::Base.controller.toggle_dark_mode
   end
+
+  endpoint :mark_web_notifications_delivered do
+    user = Mcfly.whodunnit
+    deliveries = user.notification_deliveries.where(
+      delivery_type: :web,
+      state: [:sent]
+    )
+
+    deliveries.each(&:set_delivered!)
+  end
+
+  component :notifications_window do |c|
+    c.klass = ::Marty::Notifications::Window
+  end
 end

data/app/components/marty/auth_app/client/auth_app.js

@@ -91,5 +91,58 @@
 
   netzkeOnToggleDarkMode: function() {
       this.server.toggleDarkMode(() => { window.location.href = "/" });
+  },
+
+  netzkeOnNotificationsWindow: function () {
+    this.netzkeLoadComponent("notifications_window", {
+      callback: function (w) {
+        w.show();
+
+        this.server.markWebNotificationsDelivered();
+
+        var notificationsButton = this.menuBar.items.items.find(
+          function(item) { return item.name === "notificationsWindow" }
+        );
+
+        notificationsButton.setText(''); // Remove the counter
+      },
+    });
+  },
+
+  netzkeInitComponentCallback: function() {
+    try {
+      var subscription = RailsApp.cable.subscriptions.subscriptions.find(
+        (sub) => sub.identifier === '{"channel":"Marty::NotificationChannel"}'
+      )
+
+      // In case if component is initialized twice
+      if (subscription) {
+        return
+      }
+
+      RailsApp.cable.subscriptions.create(
+        'Marty::NotificationChannel',
+        {
+          received: (data) => {
+            var notificationsButton = this.menuBar.items.items.find(
+              function(item) { return item.name === "notificationsWindow" }
+            );
+
+            if (data.unread_notifications_count > 0) {
+              notificationsButton.setText(
+                `<span class='notification-counter'>${data.unread_notifications_count}</span>`
+              );
+            } else {
+              notificationsButton.setText('');
+            }
+          }
+        }
+      );
+    }
+    catch(error) {
+      console.log('ActionCable connection failed')
+      console.error(error);
+    }
   }
 }
+

data/app/components/marty/main_auth_app.rb

@@ -13,6 +13,8 @@ require 'marty/promise_view'
 require 'marty/reporting'
 require 'marty/scripting'
 require 'marty/user_view'
+require 'marty/notifications/config_view'
+require 'marty/notifications/deliveries_view'
 
 class Marty::MainAuthApp < Marty::AuthApp
   extend ::Marty::Permissions
@@ -86,7 +88,7 @@ class Marty::MainAuthApp < Marty::AuthApp
         :config_view,
         :reload_scripts,
         :load_seed,
-      ] + background_jobs_menu + log_menu + api_menu
+      ] + background_jobs_menu + notifications_menu + log_menu + api_menu
     }
   end
 
@@ -121,6 +123,22 @@ class Marty::MainAuthApp < Marty::AuthApp
     ]
   end
 
+  def notifications_menu
+    disabled = !(self.class.has_perm?(:admin) ||
+                 self.class.has_perm?(:user_manager))
+    [
+      {
+        text: 'Notifications',
+        icon_cls: 'fa fa-bell glyph',
+        disabled: disabled,
+        menu: [
+          :notifications_config_view,
+          :notifications_deliveries_view,
+        ]
+      },
+    ]
+  end
+
   def warped
     Marty::Util.warped?
   end
@@ -319,6 +337,25 @@ class Marty::MainAuthApp < Marty::AuthApp
     a.disabled = !self.class.has_perm?(:admin)
   end
 
+  # action 'Notifications::ConfigView' do |a|
+  action :notifications_config_view do |a|
+    a.text     = 'User Notification Rules'
+    a.tooltip  = 'Configure notification rules for users'
+    a.handler  = :netzke_load_component_by_action
+    a.icon_cls = 'fa fa-sliders-h glyph'
+    a.disabled = !(self.class.has_perm?(:admin) ||
+                   self.class.has_perm?(:user_manager))
+  end
+
+  action :notifications_deliveries_view do |a|
+    a.text     = 'Notificaiton messages'
+    a.tooltip  = 'Show all notification messages'
+    a.handler  = :netzke_load_component_by_action
+    a.icon_cls = 'fa fa-list glyph'
+    a.disabled = !(self.class.has_perm?(:admin) ||
+                   self.class.has_perm?(:dev))
+  end
+
   ######################################################################
 
   def bg_command(subcmd)
@@ -408,6 +445,7 @@ class Marty::MainAuthApp < Marty::AuthApp
   component :config_view
 
   component :data_grid_view
+
   component :data_grid_user_view
 
   component :import_type_view
@@ -420,6 +458,14 @@ class Marty::MainAuthApp < Marty::AuthApp
     c.disabled = Marty::Util.warped? || !self.class.has_posting_perm?
   end
 
+  component :notifications_config_view do |c|
+    c.klass = ::Marty::Notifications::ConfigView
+  end
+
+  component :notifications_deliveries_view do |c|
+    c.klass = ::Marty::Notifications::DeliveriesView
+  end
+
   component :posting_window
 
   component :promise_view

data/app/components/marty/notifications/config_view.rb

@@ -0,0 +1,56 @@
+module Marty
+  module Notifications
+    class ConfigView < Marty::Grid
+      include Marty::Extras::Layout
+
+      has_marty_permissions create: [:admin, :user_manager],
+                            read:   [:admin, :user_manager],
+                            update: [:admin, :user_manager],
+                            delete: [:admin, :user_manager]
+
+      def configure(c)
+        super
+
+        c.attributes = [:event_type, :recipient__name, :delivery_type, :state, :text]
+
+        c.title ||= I18n.t('notifications_config', default: 'Notifications Configuration')
+        c.model = 'Marty::Notifications::Config'
+        c.editing = :in_form
+        c.paging = :pagination
+        c.store_config.merge!(
+          sorters: [{ property: :id, direction: 'DESC', }]
+        )
+      end
+
+      attribute :event_type do |c|
+        c.width = 200
+        enum_column(c, ::Marty::Notifications::EventType, nil, false)
+      end
+
+      attribute :recipient__name do |c|
+        c.width = 200
+      end
+
+      attribute :delivery_type do |c|
+        enum_column(c, model::AVAILABLE_TYPES, nil, false)
+        c.width = 70
+      end
+
+      attribute :state do |c|
+        enum_column(c, model.state_machines[:state].states.map(&:value), nil, false)
+        c.width = 70
+        c.label = I18n.t('notifications_config_state', default: 'On/Off')
+      end
+
+      attribute :text do |c|
+        c.width = 400
+        c.label = I18n.t('notifications_config_text', default: 'Message text')
+        c.setter = lambda do |record, value|
+          next record.text = '' if value.nil?
+
+          record.text = value
+        end
+      end
+    end
+  end
+end

data/app/components/marty/notifications/deliveries_view.rb

@@ -0,0 +1,50 @@
+module Marty
+  module Notifications
+    class DeliveriesView < Marty::Grid
+      ROLES_WITH_ACCESS = [:admin, :dev]
+
+      has_marty_permissions read: ROLES_WITH_ACCESS,
+                            create: nil,
+                            update: nil,
+                            delete: ROLES_WITH_ACCESS
+
+      def configure(c)
+        super
+
+        c.header = false
+        c.model = 'Marty::Notifications::Delivery'
+        c.attributes = [:created_at, :notification__event_type, :recipient__name,
+                        :state, :delivery_type, :text, :error_text]
+        c.store_config.merge!(
+          sorters: [{ property: :id, direction: 'DESC' }],
+          page_size: 30
+        )
+
+        c.scope = ->(arel) { arel.includes(:notification).includes(:recipient) }
+      end
+
+      attribute :notification__event_type do |config|
+        config.width = 150
+        config.label = 'Event'
+      end
+
+      attribute :recipient__name do |config|
+        config.width = 150
+        config.label = 'Recipient'
+      end
+
+      attribute :text do |config|
+        config.width = 400
+
+        config.getter = lambda do |record|
+          [record.notification.text, record.text].join(', ')
+        end
+      end
+
+      attribute :error_text do |config|
+        config.width = 300
+        config.label = 'Error'
+      end
+    end
+  end
+end

data/app/components/marty/notifications/grid_view.rb

@@ -0,0 +1,56 @@
+module Marty
+  module Notifications
+    class GridView < Marty::Grid
+      has_marty_permissions read: :any,
+                            create: nil,
+                            update: nil,
+                            delete: nil
+
+      def configure(c)
+        super
+
+        c.header = false
+        c.model = 'Marty::Notifications::Delivery'
+        c.attributes = [:created_at, :notification__event_type, :text, :error_text]
+        c.store_config.merge!(
+          sorters: [{ property: :created_at, direction: 'DESC' }],
+          page_size: 30
+        )
+
+        c.scope = ->(arel) { arel.includes(:notification) }
+      end
+
+      def get_records(params)
+        model.where(
+          delivery_type: :web,
+          state: [:sent, :delivered],
+          recipient_id: Mcfly.whodunnit
+        ).scoping do
+          super
+        end
+      end
+
+      def default_bbar
+        []
+      end
+
+      attribute :notification__event_type do |config|
+        config.width = 150
+        config.label = 'Event'
+      end
+
+      attribute :text do |config|
+        config.width = 300
+
+        config.getter = lambda do |record|
+          [record.notification.text, record.text].join(', ')
+        end
+      end
+
+      attribute :error_text do |config|
+        config.width = 300
+        config.label = 'Error'
+      end
+    end
+  end
+end