Support native push notifications

Gemfile.lock

@@ -127,8 +127,8 @@ GEM
   specs:
     action_text-trix (2.1.16)
       railties
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
     autotuner (1.1.0)
     aws-eventstream (1.4.0)
@@ -337,7 +337,7 @@ GEM
     psych (5.3.1)
       date
       stringio
-    public_suffix (6.0.2)
+    public_suffix (7.0.2)
     puma (7.2.0)
       nio4r (~> 2.0)
     raabro (1.4.0)

Gemfile.saas

@@ -11,6 +11,9 @@ gem "fizzy-saas", path: "saas"
 gem "console1984", bc: "console1984"
 gem "audits1984", bc: "audits1984", branch: "flavorjones/coworker-api"
 
+# Native push notifications (iOS/Android)
+gem "action_push_native"
+
 # Telemetry
 gem "rails_structured_logging", bc: "rails-structured-logging"
 gem "sentry-ruby"

Gemfile.saas.lock

@@ -195,6 +195,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    action_push_native (0.3.1)
+      activejob (>= 8.0)
+      activerecord (>= 8.0)
+      googleauth (~> 1.14)
+      httpx (~> 1.6)
+      jwt (>= 2)
+      railties (>= 8.0)
     action_text-trix (2.1.16)
       railties
     actionpack-xml_parser (2.0.1)
@@ -208,8 +215,8 @@ GEM
       activemodel (>= 7.0)
       activemodel-serializers-xml (~> 1.0)
       activesupport (>= 7.0)
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
     anyway_config (2.7.2)
       ruby-next-core (~> 1.0)
     ast (2.4.3)
@@ -279,6 +286,12 @@ GEM
       tzinfo
     faker (3.6.0)
       i18n (>= 1.8.11, < 2)
+    faraday (2.14.0)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.2)
+      net-http (~> 0.5)
     ffi (1.17.2-aarch64-linux-gnu)
     ffi (1.17.2-aarch64-linux-musl)
     ffi (1.17.2-arm-linux-gnu)
@@ -295,8 +308,23 @@ GEM
       addressable (>= 2.5.0)
     globalid (1.3.0)
       activesupport (>= 6.1)
+    google-cloud-env (2.3.1)
+      base64 (~> 0.2)
+      faraday (>= 1.0, < 3.a)
+    google-logging-utils (0.2.0)
+    googleauth (1.16.1)
+      faraday (>= 1.0, < 3.a)
+      google-cloud-env (~> 2.2)
+      google-logging-utils (~> 0.1)
+      jwt (>= 1.4, < 4.0)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (>= 0.16, < 2.a)
     gvltools (0.4.0)
     hashdiff (1.2.1)
+    http-2 (1.1.1)
+    httpx (1.7.1)
+      http-2 (>= 1.0.0)
     i18n (1.14.8)
       concurrent-ruby (~> 1.0)
     image_processing (1.14.0)
@@ -369,6 +397,9 @@ GEM
     mocha (3.0.2)
       ruby2_keywords (>= 0.0.5)
     msgpack (1.8.0)
+    multi_json (1.19.1)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
     net-http-persistent (4.0.8)
       connection_pool (>= 2.2.4, < 4)
     net-imap (0.6.3)
@@ -403,6 +434,7 @@ GEM
     nokogiri (1.19.1-x86_64-linux-musl)
       racc (~> 1.4)
     openssl (4.0.0)
+    os (1.1.4)
     ostruct (0.6.3)
     parallel (1.27.0)
     parser (3.3.10.0)
@@ -457,7 +489,7 @@ GEM
     psych (5.3.1)
       date
       stringio
-    public_suffix (6.0.2)
+    public_suffix (7.0.2)
     puma (7.2.0)
       nio4r (~> 2.0)
     raabro (1.4.0)
@@ -546,6 +578,11 @@ GEM
     sentry-ruby (6.2.0)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+    signet (0.21.0)
+      addressable (~> 2.8)
+      faraday (>= 0.17.5, < 3.a)
+      jwt (>= 1.5, < 4.0)
+      multi_json (~> 1.10)
     sniffer (0.5.0)
       anyway_config (>= 1.0)
       dry-initializer (~> 3)
@@ -663,6 +700,7 @@ PLATFORMS
   x86_64-linux-musl
 
 DEPENDENCIES
+  action_push_native
   actionpack-xml_parser
   activeresource
   audits1984!

app/helpers/avatars_helper.rb

@@ -1,13 +1,6 @@
-require "zlib"
-
 module AvatarsHelper
-  AVATAR_COLORS = %w[
-    #AF2E1B #CC6324 #3B4B59 #BFA07A #ED8008 #ED3F1C #BF1B1B #736B1E #D07B53
-    #736356 #AD1D1D #BF7C2A #C09C6F #698F9C #7C956B #5D618F #3B3633 #67695E
-  ]
-
   def avatar_background_color(user)
-    AVATAR_COLORS[Zlib.crc32(user.to_param) % AVATAR_COLORS.size]
+    user.avatar_background_color
   end
 
   def avatar_tag(user, hidden_for_screen_reader: false, **options)

app/jobs/notification/push_job.rb

@@ -0,0 +1,5 @@
+class Notification::PushJob < ApplicationJob
+  def perform(notification)
+    notification.push
+  end
+end

app/jobs/push_notification_job.rb

@@ -2,6 +2,6 @@ class PushNotificationJob < ApplicationJob
   discard_on ActiveJob::DeserializationError
 
   def perform(notification)
-    NotificationPusher.new(notification).push
+    notification.push
   end
 end

app/models/notification.rb

@@ -1,5 +1,5 @@
 class Notification < ApplicationRecord
-  include PushNotifiable
+  include Notification::Pushable
 
   belongs_to :account, default: -> { user.account }
   belongs_to :user
@@ -27,6 +27,7 @@ class Notification < ApplicationRecord
   after_destroy_commit -> { broadcast_remove_to user, :notifications }
 
   delegate :notifiable_target, to: :source
+  delegate :identity, to: :user
 
   class << self
     def read_all

app/models/notification/default_payload.rb

@@ -0,0 +1,57 @@
+class Notification::DefaultPayload
+  attr_reader :notification
+
+  delegate :card, to: :notification
+
+  def initialize(notification)
+    @notification = notification
+  end
+
+  def to_h
+    { title: title, body: body, url: url }
+  end
+
+  def title
+    "New notification"
+  end
+
+  def body
+    "You have a new notification"
+  end
+
+  def url
+    notifications_url
+  end
+
+  def category
+    "default"
+  end
+
+  def high_priority?
+    false
+  end
+
+  def base_url
+    Rails.application.routes.url_helpers.root_url(**url_options.except(:script_name)).chomp("/")
+  end
+
+  def avatar_url
+    Rails.application.routes.url_helpers.user_avatar_url(notification.creator, **url_options)
+  end
+
+  private
+    def card_url(card)
+      Rails.application.routes.url_helpers.card_url(card, **url_options)
+    end
+
+    def notifications_url
+      Rails.application.routes.url_helpers.notifications_url(**url_options)
+    end
+
+    def url_options
+      base_options = Rails.application.routes.default_url_options.presence ||
+        Rails.application.config.action_mailer.default_url_options ||
+        {}
+      base_options.merge(script_name: notification.account.slug)
+    end
+end

app/models/notification/event_payload.rb

@@ -0,0 +1,67 @@
+class Notification::EventPayload < Notification::DefaultPayload
+  include ExcerptHelper
+
+  def title
+    case event.action
+    when "comment_created"
+      "RE: #{card_title}"
+    else
+      card_title
+    end
+  end
+
+  def body
+    case event.action
+    when "comment_created"
+      format_excerpt(event.eventable.body, length: 200)
+    when "card_assigned"
+      "Assigned to you by #{event.creator.name}"
+    when "card_published"
+      "Added by #{event.creator.name}"
+    when "card_closed"
+      card.closure ? "Moved to Done by #{event.creator.name}" : "Closed by #{event.creator.name}"
+    when "card_reopened"
+      "Reopened by #{event.creator.name}"
+    else
+      event.creator.name
+    end
+  end
+
+  def url
+    case event.action
+    when "comment_created"
+      card_url_with_comment_anchor(event.eventable)
+    else
+      card_url(card)
+    end
+  end
+
+  def category
+    case event.action
+    when "card_assigned" then "assignment"
+    when "comment_created" then "comment"
+    else "card"
+    end
+  end
+
+  def high_priority?
+    event.action.card_assigned?
+  end
+
+  private
+    def event
+      notification.source
+    end
+
+    def card_title
+      card.title.presence || "Card #{card.number}"
+    end
+
+    def card_url_with_comment_anchor(comment)
+      Rails.application.routes.url_helpers.card_url(
+        comment.card,
+        anchor: ActionView::RecordIdentifier.dom_id(comment),
+        **url_options
+      )
+    end
+end

app/models/notification/mention_payload.rb

@@ -0,0 +1,28 @@
+class Notification::MentionPayload < Notification::DefaultPayload
+  include ExcerptHelper
+
+  def title
+    "#{mention.mentioner.first_name} mentioned you"
+  end
+
+  def body
+    format_excerpt(mention.source.mentionable_content, length: 200)
+  end
+
+  def url
+    card_url(card)
+  end
+
+  def category
+    "mention"
+  end
+
+  def high_priority?
+    true
+  end
+
+  private
+    def mention
+      notification.source
+    end
+end

app/models/notification/push_target.rb

@@ -0,0 +1,17 @@
+class Notification::PushTarget
+  attr_reader :notification
+
+  delegate :card, to: :notification
+
+  def self.process(notification)
+    new(notification).process
+  end
+
+  def initialize(notification)
+    @notification = notification
+  end
+
+  def process
+    raise NotImplementedError
+  end
+end

app/models/notification/push_target/web.rb

@@ -0,0 +1,12 @@
+class Notification::PushTarget::Web < Notification::PushTarget
+  def process
+    if subscriptions.any?
+      Rails.configuration.x.web_push_pool.queue(notification.payload.to_h, subscriptions)
+    end
+  end
+
+  private
+    def subscriptions
+      @subscriptions ||= notification.user.push_subscriptions
+    end
+end