- The following are apps that will be able to receive Push Notifications from <%= SiteConfig.community_name %>. + Consumer apps are standalone mobile apps that users can use to browse <%= SiteConfig.community_name %> as an alternative to web browsers. +
++ If the app is listed as operational, it means <%= SiteConfig.community_name %> will be able to deliver push notifications directly to users' devices.
diff --git a/config/initializers/pusher.rb b/config/initializers/pusher.rb index 7b0dfbf9a..4577408a6 100644 --- a/config/initializers/pusher.rb +++ b/config/initializers/pusher.rb @@ -1,5 +1,3 @@ -require "pusher/push_notifications" - if ApplicationConfig["PUSHER_APP_ID"].present? Pusher.app_id = ApplicationConfig["PUSHER_APP_ID"] Pusher.key = ApplicationConfig["PUSHER_KEY"] @@ -7,9 +5,4 @@ if ApplicationConfig["PUSHER_APP_ID"].present? Pusher.cluster = ApplicationConfig["PUSHER_CLUSTER"] Pusher.logger = Rails.logger Pusher.encrypted = true - - Pusher::PushNotifications.configure do |config| - config.instance_id = ApplicationConfig["PUSHER_BEAMS_ID"] - config.secret_key = ApplicationConfig["PUSHER_BEAMS_KEY"] - end end diff --git a/config/routes.rb b/config/routes.rb index 5095553f4..ad8f4c6e9 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -134,10 +134,8 @@ Rails.application.routes.draw do end resources :comment_mutes, only: %i[update] resources :users, only: %i[index], defaults: { format: :json } do # internal API - constraints(-> { FeatureFlag.enabled?(:mobile_notifications) }) do - collection do - resources :devices, only: %i[create destroy] - end + collection do + resources :devices, only: %i[create destroy] end end resources :users, only: %i[update] diff --git a/config/routes/admin.rb b/config/routes/admin.rb index f54c0defb..7d2549595 100644 --- a/config/routes/admin.rb +++ b/config/routes/admin.rb @@ -14,7 +14,6 @@ namespace :admin do resources :organization_memberships, only: %i[update destroy create] resources :permissions, only: %i[index] resources :reactions, only: [:update] - resources :consumer_apps, only: %i[index new create edit update destroy] namespace :settings do resources :authentications, only: [:create] resources :campaigns, only: [:create] @@ -123,6 +122,7 @@ namespace :admin do delete :remove_user end end + resources :consumer_apps, only: %i[index new create edit update destroy] resources :events, only: %i[index create update new edit] resources :listings, only: %i[index edit update destroy] resources :listing_categories, only: %i[index edit update new create diff --git a/docs/backend/push-notifications.md b/docs/backend/push-notifications.md new file mode 100644 index 000000000..969dce15f --- /dev/null +++ b/docs/backend/push-notifications.md @@ -0,0 +1,27 @@ +--- +title: Push Notifications +--- + +# Push Notifications Delivery + +Forem instances rely on [Rpush](https://github.com/rpush/rpush) to deliver push +notifications. This decision was heavily influenced by the desire to +provide as much flexibility as possible to Creators. In order to do this, Forem +instances can register and configure a `ConsumerApp`. + +These consumer apps represent mobile applications that users use to browse and consume content +on a Forem. Authenticated users of a specific Forem instance can register a `Device` +associated to a `ConsumerApp`. With these pieces we are able to deliver +push notifications to users devices. + +The `ConsumerApp` configuration page can be found at +`/admin/apps/consumer_apps`. The official Forem apps are supported by default +and require their secret credential to be provided via ENV variable. + +## Rpush Implementation + +We use Rpush's `rpush-redis` implementation (read +[this thread](https://github.com/forem/forem/pull/12419/files#r564660917) for +the reasons why), hence all `Rpush` models are persisted in Redis. More +details about how this works +[here](https://github.com/rpush/rpush/wiki/Using-Redis). diff --git a/docs/backend/pusher.md b/docs/backend/pusher.md index 5d67b465a..4b066f96e 100644 --- a/docs/backend/pusher.md +++ b/docs/backend/pusher.md @@ -40,68 +40,3 @@ you'll need to provide those keys to the Rails application.  5. Done. - -## Mobile Push Notifications - -These steps are required only when working with the native Apps. In order to -setup Push Notifications to mobile devices you need to create a Pusher Beams -instance and retrieve its credentials - -1. [Sign up](https://dashboard.pusher.com/accounts/sign_up) or - [sign in](https://dashboard.pusher.com/) to your Pusher account. - -2. Once signed in, go in the "BEAMS" section on the left sidebar and fill in the - prompt to create a new Pusher Beams instance. - - - -3. In your new Pusher Beams instance, click the "Credentials" tab. - -  - -4. Change your keys accordingly (name of Pusher key -> name of our application - key): - -```text -Instance ID -> PUSHER_BEAMS_ID -Instance Key -> PUSHER_BEAMS_KEY -``` - -5. Done. You now have your server configured to use Pusher Beams. - -However, in order to send Push Notifications to devices you'll need to do some -platform specific configuration as well. - -### Firebase for Android Push Notifications - -1. Sign up or Sign in to [Firebase](https://firebase.google.com/) - -2. Add a new project. Google Analytics doesn't need to be configured for this - Push Notifications to work. - - - - - -3. Add Android support for your iOS app - - - - - -4. Download the `google-services.json` file (to be used in the Android app) - - - -5. Finish off the next steps (not required at this moment). Now head over to - your Firebase project's settings page and copy the Server key from the "Cloud - Messaging" tab - - - -6. Now back in your Pusher Beams page account add the Server key from the - previous step under the "Settings" tab - - - -7. Done. diff --git a/docs/backend/readme.md b/docs/backend/readme.md index 553924150..d09a2e2d7 100644 --- a/docs/backend/readme.md +++ b/docs/backend/readme.md @@ -19,6 +19,7 @@ items: - notification.md - scheduled-jobs.md - metrics.md + - push-notifications.md - tracking.md - service-objects.md --- diff --git a/spec/requests/devices_spec.rb b/spec/requests/devices_spec.rb index 1fd390a38..69fd04850 100644 --- a/spec/requests/devices_spec.rb +++ b/spec/requests/devices_spec.rb @@ -5,7 +5,6 @@ RSpec.describe "Devices", type: :request do let(:consumer_app) { create(:consumer_app) } before do - allow(FeatureFlag).to receive(:enabled?).with(:mobile_notifications).and_return(true) sign_in user end diff --git a/spec/routing/devices_routes_spec.rb b/spec/routing/devices_routes_spec.rb deleted file mode 100644 index 6e67f1c5c..000000000 --- a/spec/routing/devices_routes_spec.rb +++ /dev/null @@ -1,42 +0,0 @@ -require "rails_helper" - -RSpec.describe "User devices routes", type: :routing do - it "renders the user devices routes if the mobile_notifications feature flag is enabled", :aggregate_failures do - allow(FeatureFlag).to receive(:enabled?).twice.with(:mobile_notifications).and_return(true) - - expect(post: devices_path).to route_to( - controller: "devices", - action: "create", - format: :json, - locale: nil, - ) - - expect(delete: "#{devices_path}/1").to route_to( - controller: "devices", - action: "destroy", - id: "1", - format: :json, - locale: nil, - ) - end - - it "does not render the user devices routes if the mobile_notifications feature flag is disabled", - :aggregate_failures do - allow(FeatureFlag).to receive(:enabled?).at_least(:twice).with(:mobile_notifications).and_return(false) - - expect(post: devices_path).not_to route_to( - controller: "devices", - action: "create", - format: :json, - locale: nil, - ) - - expect(delete: "#{devices_path}/1").not_to route_to( - controller: "devices", - action: "destroy", - id: "1", - format: :json, - locale: nil, - ) - end -end diff --git a/spec/services/notifications/new_comment/send_spec.rb b/spec/services/notifications/new_comment/send_spec.rb index 528803160..8a930063c 100644 --- a/spec/services/notifications/new_comment/send_spec.rb +++ b/spec/services/notifications/new_comment/send_spec.rb @@ -97,22 +97,4 @@ RSpec.describe Notifications::NewComment::Send, type: :service do expect(Notification.where(notifiable_type: "Comment", notifiable_id: child_comment.id, organization_id: organization.id)).to be_any end - - it "sends Push Notifications using Pusher Beams when configured" do - allow(ApplicationConfig).to receive(:[]).with("PUSHER_BEAMS_KEY").and_return("x" * 64) - allow(ApplicationConfig).to receive(:[]).with("APP_PROTOCOL").and_return("http://") - allow(ApplicationConfig).to receive(:[]).with("APP_DOMAIN").and_return("localhost:3000") - - allow(Pusher::PushNotifications).to receive(:publish_to_interests) - - comment_sent = child_comment - described_class.call(comment_sent) - - channels = ["user-notifications-#{user2.id}", "user-notifications-#{user.id}"] - payload = described_class.new(comment_sent).__send__(:push_notification_payload) - expect(Pusher::PushNotifications).to have_received(:publish_to_interests) do |block| - expect(block[:interests]).to match_array(channels) - expect(block[:payload]).to eq(payload) - end - end end diff --git a/spec/services/push_notifications/send_spec.rb b/spec/services/push_notifications/send_spec.rb index fc8a31672..3f763e11a 100644 --- a/spec/services/push_notifications/send_spec.rb +++ b/spec/services/push_notifications/send_spec.rb @@ -20,18 +20,8 @@ RSpec.describe PushNotifications::Send, type: :service do } end - context "with feature flag set to false/off" do - before { allow(FeatureFlag).to receive(:enabled?).with(:mobile_notifications).and_return(false) } - - it "does nothing if the feature flag is disabled" do - expect { described_class.call(**params) } - .not_to change { Rpush::Client::Redis::Notification.all.count } - end - end - context "with no devices for user" do before do - allow(FeatureFlag).to receive(:enabled?).with(:mobile_notifications).and_return(true) user.devices.delete end @@ -44,7 +34,6 @@ RSpec.describe PushNotifications::Send, type: :service do context "with devices for one user" do before do - allow(FeatureFlag).to receive(:enabled?).with(:mobile_notifications).and_return(true) allow(ApplicationConfig).to receive(:[]).with("RPUSH_IOS_PEM").and_return("dGVzdGluZw==") allow(ApplicationConfig).to receive(:[]).with("COMMUNITY_NAME").and_return("Forem") create(:device, user: user) @@ -67,7 +56,6 @@ RSpec.describe PushNotifications::Send, type: :service do context "with devices for multiple users" do before do - allow(FeatureFlag).to receive(:enabled?).with(:mobile_notifications).and_return(true) allow(ApplicationConfig).to receive(:[]).with("RPUSH_IOS_PEM").and_return("dGVzdGluZw==") allow(ApplicationConfig).to receive(:[]).with("COMMUNITY_NAME").and_return("Forem") create(:device, user: user) diff --git a/vendor/cache/pusher-push-notifications-2.0.1.gem b/vendor/cache/pusher-push-notifications-2.0.1.gem deleted file mode 100644 index 10b893007..000000000 Binary files a/vendor/cache/pusher-push-notifications-2.0.1.gem and /dev/null differ