Note subscriptions db table

app/controllers/api/notes_controller.rb

@@ -401,6 +401,8 @@ def add_comment(note, text, event, notify: true)
       note.comments.map(&:author).uniq.each do |user|
         UserMailer.note_comment_notification(comment, user).deliver_later if notify && user && user != current_user && user.visible?
       end
+
+      NoteSubscription.find_or_create_by(:note => note, :user => current_user) if current_user
     end
   end
 end

app/models/note.rb

@@ -23,6 +23,8 @@ class Note < ApplicationRecord
 
   has_many :comments, -> { left_joins(:author).where(:visible => true, :users => { :status => [nil, "active", "confirmed"] }).order(:created_at) }, :class_name => "NoteComment", :foreign_key => :note_id
   has_many :all_comments, -> { left_joins(:author).order(:created_at) }, :class_name => "NoteComment", :foreign_key => :note_id, :inverse_of => :note
+  has_many :subscriptions, :class_name => "NoteSubscription"
+  has_many :subscribers, :through => :subscriptions, :source => :user
 
   validates :id, :uniqueness => true, :presence => { :on => :update },
                  :numericality => { :on => :update, :only_integer => true }

app/models/note_subscription.rb

@@ -0,0 +1,20 @@
+# == Schema Information
+#
+# Table name: note_subscriptions
+#
+#  user_id :bigint(8)        not null, primary key
+#  note_id :bigint(8)        not null, primary key
+#
+# Indexes
+#
+#  index_note_subscriptions_on_note_id  (note_id)
+#
+# Foreign Keys
+#
+#  fk_rails_...  (note_id => notes.id)
+#  fk_rails_...  (user_id => users.id)
+#
+class NoteSubscription < ApplicationRecord
+  belongs_to :user
+  belongs_to :note
+end

app/models/user.rb

@@ -66,6 +66,8 @@ class User < ApplicationRecord
   has_and_belongs_to_many :changeset_subscriptions, :class_name => "Changeset", :join_table => "changesets_subscribers", :foreign_key => "subscriber_id"
   has_many :note_comments, :foreign_key => :author_id, :inverse_of => :author
   has_many :notes, :through => :note_comments
+  has_many :note_subscriptions, :class_name => "NoteSubscription"
+  has_many :subscribed_notes, :through => :note_subscriptions, :source => :note
 
   has_many :oauth2_applications, :class_name => Doorkeeper.config.application_model.name, :as => :owner
   has_many :access_grants, :class_name => Doorkeeper.config.access_grant_model.name, :foreign_key => :resource_owner_id

db/migrate/20241022141247_create_note_subscriptions.rb

@@ -0,0 +1,8 @@
+class CreateNoteSubscriptions < ActiveRecord::Migration[7.2]
+  def change
+    create_table :note_subscriptions, :primary_key => [:user_id, :note_id] do |t|
+      t.references :user, :foreign_key => true, :index => false
+      t.references :note, :foreign_key => true
+    end
+  end
+end

db/structure.sql

@@ -1051,6 +1051,16 @@ CREATE SEQUENCE public.note_comments_id_seq
 ALTER SEQUENCE public.note_comments_id_seq OWNED BY public.note_comments.id;
 
 
+--
+-- Name: note_subscriptions; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.note_subscriptions (
+    user_id bigint NOT NULL,
+    note_id bigint NOT NULL
+);
+
+
 --
 -- Name: notes; Type: TABLE; Schema: public; Owner: -
 --
@@ -2010,6 +2020,14 @@ ALTER TABLE ONLY public.note_comments
     ADD CONSTRAINT note_comments_pkey PRIMARY KEY (id);
 
 
+--
+-- Name: note_subscriptions note_subscriptions_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.note_subscriptions
+    ADD CONSTRAINT note_subscriptions_pkey PRIMARY KEY (user_id, note_id);
+
+
 --
 -- Name: notes notes_pkey; Type: CONSTRAINT; Schema: public; Owner: -
 --
@@ -2498,6 +2516,13 @@ CREATE INDEX index_note_comments_on_body ON public.note_comments USING gin (to_t
 CREATE INDEX index_note_comments_on_created_at ON public.note_comments USING btree (created_at);
 
 
+--
+-- Name: index_note_subscriptions_on_note_id; Type: INDEX; Schema: public; Owner: -
+--
+
+CREATE INDEX index_note_subscriptions_on_note_id ON public.note_subscriptions USING btree (note_id);
+
+
 --
 -- Name: index_oauth_access_grants_on_application_id; Type: INDEX; Schema: public; Owner: -
 --
@@ -2953,6 +2978,14 @@ ALTER TABLE ONLY public.diary_entry_subscriptions
     ADD CONSTRAINT diary_entry_subscriptions_user_id_fkey FOREIGN KEY (user_id) REFERENCES public.users(id);
 
 
+--
+-- Name: note_subscriptions fk_rails_2c1913f293; Type: FK CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.note_subscriptions
+    ADD CONSTRAINT fk_rails_2c1913f293 FOREIGN KEY (note_id) REFERENCES public.notes(id);
+
+
 --
 -- Name: oauth_access_grants fk_rails_330c32d8d9; Type: FK CONSTRAINT; Schema: public; Owner: -
 --
@@ -2993,6 +3026,14 @@ ALTER TABLE ONLY public.active_storage_variant_records
     ADD CONSTRAINT fk_rails_993965df05 FOREIGN KEY (blob_id) REFERENCES public.active_storage_blobs(id);
 
 
+--
+-- Name: note_subscriptions fk_rails_a352f4eced; Type: FK CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.note_subscriptions
+    ADD CONSTRAINT fk_rails_a352f4eced FOREIGN KEY (user_id) REFERENCES public.users(id);
+
+
 --
 -- Name: oauth_access_grants fk_rails_b4b53e07b8; Type: FK CONSTRAINT; Schema: public; Owner: -
 --
@@ -3356,6 +3397,7 @@ INSERT INTO "schema_migrations" (version) VALUES
 ('23'),
 ('22'),
 ('21'),
+('20241022141247'),
 ('20240913171951'),
 ('20240912181413'),
 ('20240910175616'),

test/controllers/api/notes_controller_test.rb

@@ -101,10 +101,12 @@ def test_routes
       )
     end
 
-    def test_create_success
+    def test_create_anonymous_success
       assert_difference "Note.count", 1 do
         assert_difference "NoteComment.count", 1 do
-          post api_notes_path(:lat => -1.0, :lon => -1.0, :text => "This is a comment", :format => "json")
+          assert_no_difference "NoteSubscription.count" do
+            post api_notes_path(:lat => -1.0, :lon => -1.0, :text => "This is a comment", :format => "json")
+          end
         end
       end
       assert_response :success
@@ -135,7 +137,7 @@ def test_create_success
       assert_nil js["properties"]["comments"].last["user"]
     end
 
-    def test_create_fail
+    def test_create_anonymous_fail
       assert_no_difference "Note.count" do
         assert_no_difference "NoteComment.count" do
           post api_notes_path(:lon => -1.0, :text => "This is a comment")
@@ -200,14 +202,44 @@ def test_create_fail
       assert_response :bad_request
     end
 
+    def test_create_success
+      user = create(:user)
+      auth_header = bearer_authorization_header user
+      assert_difference "Note.count", 1 do
+        assert_difference "NoteComment.count", 1 do
+          assert_difference "NoteSubscription.count", 1 do
+            post api_notes_path(:lat => -1.0, :lon => -1.0, :text => "This is a comment", :format => "json"), :headers => auth_header
+          end
+        end
+      end
+      assert_response :success
+      js = ActiveSupport::JSON.decode(@response.body)
+      assert_not_nil js
+      assert_equal "Feature", js["type"]
+      assert_equal "Point", js["geometry"]["type"]
+      assert_equal [-1.0, -1.0], js["geometry"]["coordinates"]
+      assert_equal "open", js["properties"]["status"]
+      assert_equal 1, js["properties"]["comments"].count
+      assert_equal "opened", js["properties"]["comments"].last["action"]
+      assert_equal "This is a comment", js["properties"]["comments"].last["text"]
+      assert_equal user.display_name, js["properties"]["comments"].last["user"]
+
+      note = Note.last
+      subscription = NoteSubscription.last
+      assert_equal user, subscription.user
+      assert_equal note, subscription.note
+    end
+
     def test_comment_success
       open_note_with_comment = create(:note_with_comments)
       user = create(:user)
       auth_header = bearer_authorization_header user
       assert_difference "NoteComment.count", 1 do
-        assert_no_difference "ActionMailer::Base.deliveries.size" do
-          perform_enqueued_jobs do
-            post comment_api_note_path(open_note_with_comment, :text => "This is an additional comment", :format => "json"), :headers => auth_header
+        assert_difference "NoteSubscription.count", 1 do
+          assert_no_difference "ActionMailer::Base.deliveries.size" do
+            perform_enqueued_jobs do
+              post comment_api_note_path(open_note_with_comment, :text => "This is an additional comment", :format => "json"), :headers => auth_header
+            end
           end
         end
       end
@@ -222,6 +254,10 @@ def test_comment_success
       assert_equal "This is an additional comment", js["properties"]["comments"].last["text"]
       assert_equal user.display_name, js["properties"]["comments"].last["user"]
 
+      subscription = NoteSubscription.last
+      assert_equal user, subscription.user
+      assert_equal open_note_with_comment, subscription.note
+
       get api_note_path(open_note_with_comment, :format => "json")
       assert_response :success
       js = ActiveSupport::JSON.decode(@response.body)
@@ -233,7 +269,9 @@ def test_comment_success
       assert_equal "commented", js["properties"]["comments"].last["action"]
       assert_equal "This is an additional comment", js["properties"]["comments"].last["text"]
       assert_equal user.display_name, js["properties"]["comments"].last["user"]
+    end
 
+    def test_comment_with_notifications_success
       # Ensure that emails are sent to users
       first_user = create(:user)
       second_user = create(:user)
@@ -247,9 +285,11 @@ def test_comment_success
       auth_header = bearer_authorization_header third_user
 
       assert_difference "NoteComment.count", 1 do
-        assert_difference "ActionMailer::Base.deliveries.size", 2 do
-          perform_enqueued_jobs do
-            post comment_api_note_path(note_with_comments_by_users, :text => "This is an additional comment", :format => "json"), :headers => auth_header
+        assert_difference "NoteSubscription.count", 1 do
+          assert_difference "ActionMailer::Base.deliveries.size", 2 do
+            perform_enqueued_jobs do
+              post comment_api_note_path(note_with_comments_by_users, :text => "This is an additional comment", :format => "json"), :headers => auth_header
+            end
           end
         end
       end
@@ -264,6 +304,10 @@ def test_comment_success
       assert_equal "This is an additional comment", js["properties"]["comments"].last["text"]
       assert_equal third_user.display_name, js["properties"]["comments"].last["user"]
 
+      subscription = NoteSubscription.last
+      assert_equal third_user, subscription.user
+      assert_equal note_with_comments_by_users, subscription.note
+
       email = ActionMailer::Base.deliveries.find { |e| e.to.first == first_user.email }
       assert_not_nil email
       assert_equal 1, email.to.length
@@ -290,6 +334,43 @@ def test_comment_success
       ActionMailer::Base.deliveries.clear
     end
 
+    def test_comment_twice_success
+      open_note_with_comment = create(:note_with_comments)
+      user = create(:user)
+      auth_header = bearer_authorization_header user
+      assert_difference "NoteComment.count", 1 do
+        assert_difference "NoteSubscription.count", 1 do
+          assert_no_difference "ActionMailer::Base.deliveries.size" do
+            perform_enqueued_jobs do
+              post comment_api_note_path(open_note_with_comment, :text => "This is an additional comment", :format => "json"), :headers => auth_header
+            end
+          end
+        end
+      end
+      assert_response :success
+      js = ActiveSupport::JSON.decode(@response.body)
+      assert_not_nil js
+      assert_equal 2, js["properties"]["comments"].count
+
+      subscription = NoteSubscription.last
+      assert_equal user, subscription.user
+      assert_equal open_note_with_comment, subscription.note
+
+      assert_difference "NoteComment.count", 1 do
+        assert_no_difference "NoteSubscription.count" do
+          assert_no_difference "ActionMailer::Base.deliveries.size" do
+            perform_enqueued_jobs do
+              post comment_api_note_path(open_note_with_comment, :text => "This is a second additional comment", :format => "json"), :headers => auth_header
+            end
+          end
+        end
+      end
+      assert_response :success
+      js = ActiveSupport::JSON.decode(@response.body)
+      assert_not_nil js
+      assert_equal 3, js["properties"]["comments"].count
+    end
+
     def test_comment_fail
       open_note_with_comment = create(:note_with_comments)
 
@@ -346,7 +427,9 @@ def test_close_success
 
       auth_header = bearer_authorization_header user
 
-      post close_api_note_path(open_note_with_comment, :text => "This is a close comment", :format => "json"), :headers => auth_header
+      assert_difference "NoteSubscription.count", 1 do
+        post close_api_note_path(open_note_with_comment, :text => "This is a close comment", :format => "json"), :headers => auth_header
+      end
       assert_response :success
       js = ActiveSupport::JSON.decode(@response.body)
       assert_not_nil js
@@ -358,6 +441,10 @@ def test_close_success
       assert_equal "This is a close comment", js["properties"]["comments"].last["text"]
       assert_equal user.display_name, js["properties"]["comments"].last["user"]
 
+      subscription = NoteSubscription.last
+      assert_equal user, subscription.user
+      assert_equal open_note_with_comment, subscription.note
+
       get api_note_path(open_note_with_comment.id, :format => "json")
       assert_response :success
       js = ActiveSupport::JSON.decode(@response.body)
@@ -400,7 +487,9 @@ def test_reopen_success
 
       auth_header = bearer_authorization_header user
 
-      post reopen_api_note_path(closed_note_with_comment, :text => "This is a reopen comment", :format => "json"), :headers => auth_header
+      assert_difference "NoteSubscription.count", 1 do
+        post reopen_api_note_path(closed_note_with_comment, :text => "This is a reopen comment", :format => "json"), :headers => auth_header
+      end
       assert_response :success
       js = ActiveSupport::JSON.decode(@response.body)
       assert_not_nil js
@@ -412,6 +501,10 @@ def test_reopen_success
       assert_equal "This is a reopen comment", js["properties"]["comments"].last["text"]
       assert_equal user.display_name, js["properties"]["comments"].last["user"]
 
+      subscription = NoteSubscription.last
+      assert_equal user, subscription.user
+      assert_equal closed_note_with_comment, subscription.note
+
       get api_note_path(closed_note_with_comment, :format => "json")
       assert_response :success
       js = ActiveSupport::JSON.decode(@response.body)