TAN-3815 - Community monitor backend

back/app/controllers/web_api/v1/ideas_controller.rb

@@ -179,7 +179,7 @@ def create
     input.phase_ids = [phase.id] if phase_ids.empty?
 
     # NOTE: Needs refactor allow_anonymous_participation? so anonymous_participation can be allow or force
-    if phase.native_survey? && phase.allow_anonymous_participation?
+    if phase.pmethod.supports_survey_form? && phase.allow_anonymous_participation?
       input.anonymous = true
     end
     input.author ||= current_user

back/app/controllers/web_api/v1/phases_controller.rb

@@ -74,8 +74,8 @@ def survey_results
   end
 
   def submission_count
-    count = if @phase.native_survey?
-      @phase.ideas.native_survey.published.count
+    count = if @phase.pmethod.supports_survey_form?
+      @phase.ideas.supports_survey.published.count
     else
       @phase.ideas.transitive.published.count
     end

back/app/controllers/web_api/v1/projects_controller.rb

@@ -127,7 +127,7 @@ def index_for_areas
   # Returns all non-draft projects that are visible to user, for the selected topics.
   # Ordered by created_at, newest first.
   def index_for_topics
-    projects = policy_scope(Project)
+    projects = policy_scope(Project).not_hidden
     projects = projects
       .not_draft
       .with_some_topics(params[:topics])
@@ -317,6 +317,22 @@ def destroy_participation_data
     ).serializable_hash, status: :ok
   end
 
+  def community_monitor
+    settings = AppConfiguration.instance.settings
+    settings.dig('community_monitor', 'enabled') || raise(ActiveRecord::RecordNotFound)
+
+    # Find the community monitor project from config or create it
+    project_id = settings.dig('community_monitor', 'project_id')
+    project = project_id.present? ? Project.find(project_id) : create_community_monitor_project(settings)
+
+    authorize project
+    render json: WebApi::V1::ProjectSerializer.new(
+      project,
+      params: jsonapi_serializer_params,
+      include: %i[current_phase]
+    ).serializable_hash
+  end
+
   private
 
   def sidefx
@@ -375,6 +391,34 @@ def base_render_mini_index
       include: %i[project_images current_phase]
     )
   end
+
+  def create_community_monitor_project(settings)
+    multiloc_service = MultilocService.new
+    project = Project.create!(
+      hidden: true,
+      title_multiloc: multiloc_service.i18n_to_multiloc('phases.community_monitor_title'),
+      internal_role: 'community_monitor'
+    )
+    sidefx.after_create(project, current_user) if project
+
+    Phase.create!(
+      title_multiloc: multiloc_service.i18n_to_multiloc('phases.community_monitor_title'),
+      project: project,
+      participation_method: 'community_monitor_survey',
+      commenting_enabled: false, # TODO: JS - set in the participation method defaults
+      reacting_enabled: false,
+      start_at: Time.now,
+      campaigns_settings: { project_phase_started: true }, # TODO: JS - Is this correct?
+      native_survey_title_multiloc: multiloc_service.i18n_to_multiloc('phases.community_monitor_title'),
+      native_survey_button_multiloc: multiloc_service.i18n_to_multiloc('phases.native_survey_button')
+    )
+
+    # Set the ID in the settings
+    settings['community_monitor']['project_id'] = project.id
+    AppConfiguration.instance.update!(settings: settings)
+
+    project
+  end
 end
 
 WebApi::V1::ProjectsController.include(AggressiveCaching::Patches::WebApi::V1::ProjectsController)

back/app/models/idea.rb

@@ -235,6 +235,9 @@ class Idea < ApplicationRecord
     native_survey.where(publication_status: 'draft')
   }
 
+  # Equivalent to pmethod.supports_survey_form?
+  scope :supports_survey, -> { where(creation_phase: Phase.where(participation_method: %w[native_survey community_monitor_survey])) }
+
   # Filters out all the ideas for which the ParticipationMethod responds truety
   # to the given block. The block receives the ParticipationMethod object as an
   # argument

back/app/models/notifications/project_phase_started.rb

@@ -72,6 +72,7 @@ class ProjectPhaseStarted < Notification
 
     def self.make_notifications_on(activity)
       phase = activity.item
+      return [] unless phase.project.published?
 
       ProjectPolicy::InverseScope.new(phase.project, User.from_follows(phase.project.followers)).resolve.map do |recipient|
         new(recipient: recipient, phase: phase, project: phase.project)

back/app/models/notifications/project_phase_upcoming.rb

@@ -72,18 +72,15 @@ class ProjectPhaseUpcoming < Notification
 
     def self.make_notifications_on(activity)
       phase = activity.item
+      return [] unless phase.project.published?
 
-      if phase.project
-        recipients = UserRoleService.new.moderators_for phase
-        recipients.ids.map do |recipient_id|
-          new(
-            recipient_id: recipient_id,
-            phase: phase,
-            project: phase.project
-          )
-        end
-      else
-        []
+      recipients = UserRoleService.new.moderators_for phase
+      recipients.ids.map do |recipient_id|
+        new(
+          recipient_id: recipient_id,
+          phase: phase,
+          project: phase.project
+        )
       end
     end
   end

back/app/models/permission.rb

@@ -29,6 +29,7 @@ class Permission < ApplicationRecord
     'ideation' => %w[posting_idea commenting_idea reacting_idea attending_event],
     'proposals' => %w[posting_idea commenting_idea reacting_idea attending_event],
     'native_survey' => %w[posting_idea attending_event],
+    'community_monitor_survey' => %w[posting_idea attending_event],
     'survey' => %w[taking_survey attending_event],
     'poll' => %w[taking_poll attending_event],
     'voting' => %w[voting commenting_idea attending_event],

back/app/models/phase.rb

@@ -160,7 +160,6 @@ class Phase < ApplicationRecord
   # voting?
   with_options if: :voting? do
     validates :voting_method, presence: true, inclusion: { in: VOTING_METHODS }
-    validate :validate_voting
     validates :voting_term_singular_multiloc, multiloc: { presence: false }
     validates :voting_term_plural_multiloc, multiloc: { presence: false }
     validates :autoshare_results_enabled, inclusion: { in: [true, false] }
@@ -182,12 +181,14 @@ class Phase < ApplicationRecord
     where(start_at: date)
   }
 
-  # native_survey?
-  with_options if: :native_survey? do
+  # any type of native_survey phase
+  with_options if: ->(phase) { phase.pmethod.supports_survey_form? } do
     validates :native_survey_title_multiloc, presence: true, multiloc: { presence: true }
     validates :native_survey_button_multiloc, presence: true, multiloc: { presence: true }
   end
 
+  validate :validate_phase_participation_method
+
   scope :published, lambda {
     joined = includes(project: { admin_publication: :parent })
     joined.where(
@@ -256,11 +257,6 @@ def voting?
     participation_method == 'voting'
   end
 
-  # Used for validations (which are hard to delegate through the participation method)
-  def native_survey?
-    participation_method == 'native_survey'
-  end
-
   def pmethod
     reload_participation_method if !@pmethod
     @pmethod
@@ -371,6 +367,8 @@ def reload_participation_method
       ParticipationMethod::Proposals.new(self)
     when 'native_survey'
       ParticipationMethod::NativeSurvey.new(self)
+    when 'community_monitor_survey'
+      ParticipationMethod::CommunityMonitorSurvey.new(self)
     when 'document_annotation'
       ParticipationMethod::DocumentAnnotation.new(self)
     when 'survey'
@@ -390,8 +388,9 @@ def set_presentation_mode
     self.presentation_mode ||= 'card'
   end
 
-  def validate_voting
-    Factory.instance.voting_method_for(self).validate_phase
+  # Delegate any rules specific to a method to the participation method itself
+  def validate_phase_participation_method
+    pmethod.validate_phase
   end
 end
 

back/app/models/project.rb

@@ -23,6 +23,7 @@
 #  followers_count              :integer          default(0), not null
 #  preview_token                :string           not null
 #  header_bg_alt_text_multiloc  :jsonb
+#  hidden                       :boolean          default(FALSE), not null
 #
 # Indexes
 #
@@ -88,7 +89,7 @@ class Project < ApplicationRecord
   after_save :reassign_moderators, if: :folder_changed?
   after_commit :clear_folder_changes, if: :folder_changed?
 
-  INTERNAL_ROLES = %w[open_idea_box].freeze
+  INTERNAL_ROLES = %w[open_idea_box community_monitor].freeze
 
   validates :title_multiloc, presence: true, multiloc: { presence: true }
   validates :description_multiloc, multiloc: { presence: false, html: true }
@@ -97,6 +98,8 @@ class Project < ApplicationRecord
   validates :internal_role, inclusion: { in: INTERNAL_ROLES, allow_nil: true }
   validate :admin_publication_must_exist, unless: proc { Current.loading_tenant_template } # TODO: This should always be validated!
 
+  scope :not_hidden, -> { where(hidden: false) }
+
   pg_search_scope :search_by_all,
     against: %i[title_multiloc description_multiloc description_preview_multiloc slug],
     using: { tsearch: { prefix: true } }
@@ -142,7 +145,7 @@ class Project < ApplicationRecord
 
   alias project_id id
 
-  delegate :ever_published?, :never_published?, to: :admin_publication, allow_nil: true
+  delegate :published?, :ever_published?, :never_published?, to: :admin_publication, allow_nil: true
 
   class << self
     def search_ids_by_all_including_patches(term)
@@ -223,6 +226,10 @@ def refresh_preview_token
     self.preview_token = self.class.generate_preview_token
   end
 
+  def hidden?
+    hidden
+  end
+
   private
 
   def admin_publication_must_exist

back/app/policies/admin_publication_policy.rb

@@ -5,7 +5,7 @@ class Scope < ApplicationPolicy::Scope
     def resolve
       AdminPublication
         .publication_types
-        .map { |klass| scope.where(publication: scope_for(klass)) } # scope per publication type
+        .map { |klass| scope.where(publication: klass == Project ? scope_for(klass).not_hidden : scope_for(klass)) } # scope per publication type
         .reduce(&:or) # joining partial scopes
     end
   end

back/app/policies/project_policy.rb

@@ -185,6 +185,10 @@ def active_moderator?
     UserRoleService.new.can_moderate_project? record, user
   end
 
+  def community_monitor?
+    active_moderator?
+  end
+
   private
 
   def update_status?

back/app/serializers/web_api/v1/phase_serializer.rb

@@ -69,6 +69,10 @@ class WebApi::V1::PhaseSerializer < WebApi::V1::BaseSerializer
     object.custom_form_persisted?
   end
 
+  attribute :supports_survey_form do |phase|
+    phase.pmethod.supports_survey_form?
+  end
+
   belongs_to :project
 
   has_one :user_basket, if: proc { |object, params|

back/app/services/project_copy_service.rb

@@ -335,6 +335,7 @@ def yml_phases(shift_timestamps: 0, timeline_start_at: nil)
         yml_phase['document_annotation_embed_url'] = phase.document_annotation_embed_url
       end
 
+      # TODO: JS - Needed for community monitor?
       if yml_phase['participation_method'] == 'native_survey'
         yml_phase['native_survey_title_multiloc'] = phase.native_survey_title_multiloc
         yml_phase['native_survey_button_multiloc'] = phase.native_survey_button_multiloc

back/app/services/projects_finder_service.rb

@@ -1,6 +1,6 @@
 class ProjectsFinderService
   def initialize(projects, user = nil, params = {})
-    @projects = projects
+    @projects = projects.not_hidden
     @user = user
     @page_size = (params.dig(:page, :size) || 500).to_i
     @page_number = (params.dig(:page, :number) || 1).to_i
@@ -22,7 +22,7 @@ def participation_possible
     subquery = projects_with_active_phase(subquery)
       .joins('INNER JOIN phases AS active_phases ON active_phases.project_id = projects.id')
       .where.not(phases: { participation_method: 'information' })
-      .select('projects.*, projects.created_at AS projects_created_at, projects.id AS projects_id')
+      .select('projects.created_at AS projects_created_at, projects.id AS projects_id')
 
     # Perform the SELECT DISTINCT on the outer query and order first by the end date of the active phase,
     # second by project created_at, and third by project ID.

back/app/services/side_fx_idea_service.rb

@@ -166,13 +166,19 @@ def scrape_facebook(idea)
   end
 
   def create_followers(idea, user)
-    Follower.find_or_create_by(followable: idea, user: user)
+    return if idea.project.hidden?
+
+    Follower.find_or_create_by(followable: idea, user: user) if create_idea_follower?(idea)
     Follower.find_or_create_by(followable: idea.project, user: user)
     return if !idea.project.in_folder?
 
     Follower.find_or_create_by(followable: idea.project.folder, user: user)
   end
 
+  def create_idea_follower?(idea)
+    idea.creation_phase ? idea.creation_phase.pmethod.follow_idea_on_idea_submission? : true # Defaults for true for ideas without a creation_phase
+  end
+
   def serialize_idea(frozen_idea)
     serialized_idea = clean_time_attributes(frozen_idea.attributes)
     serialized_idea['location_point'] = serialized_idea['location_point'].to_s

back/config/locales/en.yml

@@ -126,6 +126,7 @@ en:
     open_idea_phase_title: Current phase
     native_survey_title: Survey
     native_survey_button: Take the survey
+    community_monitor_title: Community monitor
   events:
     council_meeting_title: Council Meeting
     council_meeting_description: >

back/config/routes.rb

@@ -192,6 +192,7 @@
           get 'finished_or_archived', action: 'index_finished_or_archived'
           get 'for_followed_item', action: 'index_for_followed_item'
           get 'with_active_participatory_phase', action: 'index_with_active_participatory_phase'
+          get 'community_monitor', action: 'community_monitor'
         end
 
         resource :review, controller: 'project_reviews'

back/config/schemas/settings.schema.json.erb

@@ -1360,6 +1360,32 @@
             }
           }
         }
+      },
+
+      "community_monitor": {
+        "type": "object",
+        "title": "Community Monitor",
+        "description": "Long running public survey.",
+        "additionalProperties": false,
+        "required": [
+          "allowed",
+          "enabled"
+        ],
+        "properties": {
+          "allowed": {
+            "type": "boolean",
+            "default": false
+          },
+          "enabled": {
+            "type": "boolean",
+            "default": false
+          },
+          "project_id": {
+            "title": "The ID of the required hidden project",
+            "description": "Do not edit unless you know what you're doing. This is usually set by the system",
+            "type": "string"
+          }
+        }
       }
     },
   "dependencies": {

back/db/migrate/20250219104523_add_hidden_to_projects.rb

@@ -0,0 +1,5 @@
+class AddHiddenToProjects < ActiveRecord::Migration[7.0]
+  def change
+    add_column :projects, :hidden, :boolean, default: false, null: false
+  end
+end