TAN-3815 - Community monitor backend #10365

jamesspeake · 2025-02-18T12:01:30Z

Changes in a nutshell:

hidden project - flagged using both internal_role: 'community_monitor and a new field hidden: true on project
- this field is then used to hide the project from lists of projects in various places
exclude emails/followers/notifications being created for hidden projects
new feature flag community_monitor which also stores the project ID for this project
hidden project has a single phase with a new community_monitor_survey participation method which inherits from native survey
new endpoint to get/create this project/phase
as community_monitor_survey currently inherits most things from native_survey I have removed phase.native_survey? everywhere and used phase.pmethod.supports_survey_form? - in line with us wanting to delegate as much as possible to the participation method
- This is also added as an attribute on the phase serializer so the front-end can use it (separate PR)

Changelog

Technical

Added APIs, participation method and model changes for new community monitor survey
Prevented native_surveys from creating idea followers

…t copy and seeds

…or form

…oject

…itor-hidden-project-2-hidden [TAN-3815] Changed method of hiding project to use hidden: true

jamesspeake · 2025-02-21T14:46:20Z

back/app/models/phase.rb

@@ -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


Made this more generic so any participation method can now implement it's own validation rules

# Conflicts: # back/engines/commercial/multi_tenancy/db/seeds/tenants.rb

…d check for last page being present

…ixed assignees

jamesspeake · 2025-02-27T09:23:19Z

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


Did not add an index here as for booleans I don't think it often gets used

jamesspeake · 2025-02-27T09:27:03Z

back/app/services/idea_custom_fields_service.rb

+
+    # Check the last field is a page
+    if @participation_method.supports_pages_in_form? && fields.last[:input_type] != 'page'
+      errors["#{fields.length - 1}"] = { structure: [{ error: "Last field must be of type 'page'" }] }
+    end
+


This is unrelated, but noticed this logic was missing

jamesspeake · 2025-02-27T09:28:59Z

back/app/services/projects_finder_service.rb

@@ -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')


This turned out to be unneeded as it was double returning all the fields

jamesspeake · 2025-02-27T09:30:49Z

back/engines/commercial/idea_assignment/app/services/idea_assignment/idea_assignment_service.rb

@@ -25,7 +25,7 @@ def clean_assignees_for_project!(project)
    end

    def automatically_assigned_idea_assignee(idea)
-      return if idea.participation_method_on_creation.instance_of?(ParticipationMethod::NativeSurvey)
+      return unless idea.participation_method_on_creation.automatically_assign_idea?


Changed so that we can check multiple participation methods

jamesspeake · 2025-02-27T09:33:28Z

back/lib/participation_method/base.rb

+    def form_logic_enabled?
+      false
+    end
+


Not actually used at the moment, but will be used for community monitor

jamesspeake · 2025-02-27T09:35:07Z

back/lib/participation_method/native_survey.rb

-          input_type: 'page',
-          page_layout: 'default'
-        ),
+        start_page_field(custom_form),


Now shared between methods. Suspect there may be some overlap here with Edwin's work

jamesspeake · 2025-02-27T09:50:56Z

back/spec/lib/participation_method/community_monitor_survey_spec.rb

This is mainly a copy of native survey, but differences are likely to be introduced later

# Conflicts: # back/db/structure.sql

jamesspeake added 30 commits February 11, 2025 10:37

[TAN-3815] Added hidden community monitor project

44aec87

[TAN-3815] Added native_survey_method column

1667276

[TAN-3815] Test fix

7924cd0

[TAN-3815] Added DB migration for native_survey_method

557125b

[TAN-3815] Fixed tests

dfcf6b3

[TAN-3815] Added model tests for community_monitor phase

d1d2b20

[TAN-3815] Rubocop fix

bc4f5b9

[TAN-3815] Added feature flag

45860ab

[TAN-3815] Added native_survey_method attribute to phase serializer

f76c55e

[TAN-3815] Added native_survey_method attribute to public API, projec…

1508955

…t copy and seeds

[TAN-3815] Created native_survey_method classes

faa7d76

[TAN-3815] Fixed feature flag for community monitor phase

0e2e0b8

[TAN-3815] Added different form and allowed types for community_monit…

bc8cd55

…or form

[TAN-3815] Added multilocs to community monitor project creation

e36b26e

[TAN-3815] Added comment

0cf1592

Merge branch 'master' into TAN-3815-community-monitor-hidden-project

e519018

Merge branch 'master' into TAN-3815-community-monitor-hidden-project

7b5bc0e

[TAN-3815] Added form_builder_config attribute to phase

c006832

[TAN-3815] Removed hidden as a visible_to

a0d5aa2

[TAN-3815] Added constraints to community monitor fields

87bd42d

[TAN-3815] Removed private attribute

37a6773

[TAN-3815] Added default project_id: nil to community monitor app config

bd2abdc

[TAN-3815] Moved hidden attribute to admin publication

c9b0d4d

[TAN-3815] Removed form_builder_config from API

92de3fe

[TAN-3815] Fixed tests

e6c65d8

Merge branch 'master' into TAN-3815-community-monitor-hidden-project

ef10676

[TAN-3815] Changed permissions for community monitor

7af6681

[TAN-3815] Added outline tests for native_survey_method

f65673c

[TAN-3815] Added admin publication tests and fixed other tests

8e88d85

[TAN-3815] changed check for .present?

2aa1064

jamesspeake marked this pull request as ready for review February 19, 2025 08:16

jamesspeake and others added 8 commits February 19, 2025 10:40

[TAN-3815] Fixed community_monitor phase tests

e269c3a

[TAN-3815] Changed method of hiding project to use hidden: true on pr…

0c8783a

…oject

[TAN-3815] Removed unneeded projects.* in projects finder

528916f

[TAN-3815] Fixed tests and moved validation to the participation method

4176e35

[TAN-3815] Fixed phase validation

a2776e0

[TAN-3815] Changed how hidden projects works

34f0270

[TAN-3815] Rubocop fix

bdc6522

Merge pull request #10385 from CitizenLabDotCo/TAN-3815-community-mon…

94aebb1

…itor-hidden-project-2-hidden [TAN-3815] Changed method of hiding project to use hidden: true

jamesspeake added this to the Community Monitor milestone Feb 21, 2025

jamesspeake commented Feb 21, 2025

View reviewed changes

jamesspeake added 6 commits February 21, 2025 15:32

Merge branch 'master' into TAN-3815-community-monitor-hidden-project-2

772b8fd

# Conflicts: # back/engines/commercial/multi_tenancy/db/seeds/tenants.rb

[TAN-3815] Added participation method tests

072d08a

[TAN-3815] Fixed survey results to work for new participation method

3b63b20

[TAN-3815] Added tests for community monitor survey results

3d817d9

[TAN-3815] Added tests for community monitor survey update_all + adde…

f650cf5

…d check for last page being present

[TAN-3815] Added tests for community monitor survey idea creation + f…

33b6fac

…ixed assignees

jamesspeake commented Feb 27, 2025

View reviewed changes

jamesspeake added 4 commits February 27, 2025 10:06

[TAN-3815] Last changes after own review

4577759

Merge branch 'master' into TAN-3815-community-monitor-hidden-project-2

d6cd458

# Conflicts: # back/db/structure.sql

[TAN-3815] Rubocop fixes

2e28c55

[TAN-3815] Rerun migrations

4f75390

jamesspeake requested review from sebastienhoorens and amanda-anderson February 27, 2025 11:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TAN-3815 - Community monitor backend #10365

TAN-3815 - Community monitor backend #10365

jamesspeake commented Feb 18, 2025 •

edited

Loading

jamesspeake Feb 21, 2025

jamesspeake Feb 27, 2025

jamesspeake Feb 27, 2025

jamesspeake Feb 27, 2025

jamesspeake Feb 27, 2025 •

edited

Loading

jamesspeake Feb 27, 2025

jamesspeake Feb 27, 2025

jamesspeake Feb 27, 2025

TAN-3815 - Community monitor backend #10365

Are you sure you want to change the base?

TAN-3815 - Community monitor backend #10365

Conversation

jamesspeake commented Feb 18, 2025 • edited Loading

Changelog

Technical

jamesspeake Feb 21, 2025

Choose a reason for hiding this comment

jamesspeake Feb 27, 2025

Choose a reason for hiding this comment

jamesspeake Feb 27, 2025

Choose a reason for hiding this comment

jamesspeake Feb 27, 2025

Choose a reason for hiding this comment

jamesspeake Feb 27, 2025 • edited Loading

Choose a reason for hiding this comment

jamesspeake Feb 27, 2025

Choose a reason for hiding this comment

jamesspeake Feb 27, 2025

Choose a reason for hiding this comment

jamesspeake Feb 27, 2025

Choose a reason for hiding this comment

jamesspeake commented Feb 18, 2025 •

edited

Loading

jamesspeake Feb 27, 2025 •

edited

Loading