Backend changes to allow disabling ranked choice on a per-round basis

Author: nbudin

app/graphql/types/signup_round_automation_action.rb

@@ -0,0 +1,7 @@
+class Types::SignupRoundAutomationAction < Types::BaseEnum
+  description "An action to take when a signup round opens."
+
+  value "EXECUTE_RANKED_CHOICE",
+        "Execute any pending ranked choices as allowed by this signup round",
+        value: "execute_ranked_choice"
+end

app/graphql/types/signup_round_type.rb

@@ -10,6 +10,9 @@ class SignupRoundType < Types::BaseObject
       signup automation.
     MARKDOWN
 
+    field :automation_action, Types::SignupRoundAutomationAction, null: true do
+      description "The action to take when this signup round opens."
+    end
     field :convention, Types::ConventionType, null: false, description: "The convention this SignupRound is in."
     field :created_at, Types::DateType, null: false, description: "When this SignupRound was first created."
     field :executed_at, Types::DateType do

app/javascript/enumTypes.json

@@ -951,6 +951,23 @@
       }
     ]
   },
+  "SignupRoundAutomationAction": {
+    "kind": "ENUM",
+    "name": "SignupRoundAutomationAction",
+    "description": "An action to take when a signup round opens.",
+    "interfaces": null,
+    "possibleTypes": null,
+    "fields": null,
+    "inputFields": null,
+    "enumValues": [
+      {
+        "name": "EXECUTE_RANKED_CHOICE",
+        "description": "Execute any pending ranked choices as allowed by this signup round",
+        "isDeprecated": false,
+        "deprecationReason": null
+      }
+    ]
+  },
   "SignupState": {
     "kind": "ENUM",
     "name": "SignupState",

app/javascript/graphqlTypes.generated.ts

@@ -5821,6 +5821,8 @@ export type SignupRequestsPagination = PaginationInterface & {
  */
 export type SignupRound = {
   __typename: 'SignupRound';
+  /** The action to take when this signup round opens. */
+  automation_action?: Maybe<SignupRoundAutomationAction>;
   /** The convention this SignupRound is in. */
   convention: Convention;
   /** When this SignupRound was first created. */
@@ -5861,6 +5863,12 @@ export type SignupRoundRanked_Choice_Decisions_PaginatedArgs = {
   sort?: InputMaybe<Array<SortInput>>;
 };
 
+/** An action to take when a signup round opens. */
+export enum SignupRoundAutomationAction {
+  /** Execute any pending ranked choices as allowed by this signup round */
+  ExecuteRankedChoice = 'EXECUTE_RANKED_CHOICE'
+}
+
 /** An input for creating or modifying SignupRounds. */
 export type SignupRoundInput = {
   /** The maximum number of signups allowed during this signup round */

app/models/signup_round.rb

@@ -4,6 +4,7 @@
 # Table name: signup_rounds
 #
 #  id                    :bigint           not null, primary key
+#  automation_action     :text
 #  executed_at           :datetime
 #  maximum_event_signups :text             not null
 #  ranked_choice_order   :text
@@ -23,13 +24,16 @@
 # rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective
 
 class SignupRound < ApplicationRecord
+  AUTOMATION_ACTIONS = Types::SignupRoundAutomationAction.values.values.map(&:value).freeze
   RANKED_CHOICE_ORDERS = Types::RankedChoiceOrder.values.values.map(&:value).freeze
 
   belongs_to :convention
   has_many :ranked_choice_decisions, dependent: :restrict_with_exception
 
+  validates :automation_action, inclusion: { in: AUTOMATION_ACTIONS, allow_nil: true }
   validates :ranked_choice_order, inclusion: { in: RANKED_CHOICE_ORDERS, allow_nil: true }
   validates :start, { uniqueness: { scope: :convention_id } }
+  validate :automation_action_must_be_allowed
 
   scope :due_at, ->(time) { where("executed_at IS NULL AND (start IS NULL OR start <= ?)", time) }
   scope :currently_due, -> { due_at(Time.zone.now) }
@@ -42,7 +46,7 @@ def self.execute_currently_due_rounds!
 
   def execute!
     transaction do
-      if convention.signup_automation_mode == "ranked_choice"
+      if convention.signup_automation_mode == "ranked_choice" && automation_action == "execute_ranked_choice"
         ExecuteRankedChoiceSignupRoundService.new(signup_round: self, whodunit: nil).call!
       end
 
@@ -69,4 +73,15 @@ def serpentine_ranked_choice_order?
       false
     end
   end
+
+  private
+
+  def automation_action_must_be_allowed
+    return unless automation_action
+
+    return unless automation_action == "execute_ranked_choice" && convention.signup_automation_mode != "ranked_choice"
+    errors.add :base,
+               "The execute_ranked_choice action is only allowed in conventions that use the ranked_choice signup \
+automation mode."
+  end
 end

db/migrate/20250906190727_add_automation_action_to_signup_rounds.rb

@@ -0,0 +1,12 @@
+class AddAutomationActionToSignupRounds < ActiveRecord::Migration[8.0]
+  def change
+    add_column :signup_rounds, :automation_action, :text
+
+    reversible { |dir| dir.up { execute <<~SQL } }
+          UPDATE signup_rounds SET automation_action = 'execute_ranked_choice'
+          FROM conventions
+          WHERE signup_rounds.convention_id = conventions.id
+          AND conventions.signup_automation_mode = 'ranked_choice'
+        SQL
+  end
+end

db/structure.sql

@@ -1,6 +1,7 @@
 SET statement_timeout = 0;
 SET lock_timeout = 0;
 SET idle_in_transaction_session_timeout = 0;
+SET transaction_timeout = 0;
 SET client_encoding = 'UTF8';
 SET standard_conforming_strings = on;
 SELECT pg_catalog.set_config('search_path', '', false);
@@ -9,6 +10,13 @@ SET xmloption = content;
 SET client_min_messages = warning;
 SET row_security = off;
 
+--
+-- Name: public; Type: SCHEMA; Schema: -; Owner: -
+--
+
+-- *not* creating schema, since initdb creates it
+
+
 --
 -- Name: pg_trgm; Type: EXTENSION; Schema: -; Owner: -
 --
@@ -2656,6 +2664,7 @@ CREATE TABLE public.signup_rounds (
     updated_at timestamp(6) without time zone NOT NULL,
     ranked_choice_order text,
     executed_at timestamp without time zone,
+    automation_action text,
     CONSTRAINT chk_rails_4c92d587c4 CHECK (((maximum_event_signups = ANY (ARRAY['not_yet'::text, 'not_now'::text, 'unlimited'::text])) OR ((maximum_event_signups)::integer >= 1)))
 );
 
@@ -6125,6 +6134,7 @@ ALTER TABLE ONLY public.cms_files_pages
 SET search_path TO "$user", public;
 
 INSERT INTO "schema_migrations" (version) VALUES
+('20250906190727'),
 ('20250324175507'),
 ('20250324172627'),
 ('20250203173940'),

schema.graphql

@@ -7439,6 +7439,11 @@ In conventions that use automated signups (e.g. ranked-choice signups), signup r
 signup automation.
 """
 type SignupRound {
+  """
+  The action to take when this signup round opens.
+  """
+  automation_action: SignupRoundAutomationAction
+
   """
   The convention this SignupRound is in.
   """
@@ -7506,6 +7511,16 @@ type SignupRound {
   updated_at: Date!
 }
 
+"""
+An action to take when a signup round opens.
+"""
+enum SignupRoundAutomationAction {
+  """
+  Execute any pending ranked choices as allowed by this signup round
+  """
+  EXECUTE_RANKED_CHOICE
+}
+
 """
 An input for creating or modifying SignupRounds.
 """

schema.json

@@ -33114,6 +33114,18 @@
           "interfaces": [],
           "possibleTypes": null,
           "fields": [
+            {
+              "name": "automation_action",
+              "description": "The action to take when this signup round opens.",
+              "type": {
+                "kind": "ENUM",
+                "name": "SignupRoundAutomationAction",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null,
+              "args": []
+            },
             {
               "name": "convention",
               "description": "The convention this SignupRound is in.",
@@ -33307,6 +33319,23 @@
           "inputFields": null,
           "enumValues": null
         },
+        {
+          "kind": "ENUM",
+          "name": "SignupRoundAutomationAction",
+          "description": "An action to take when a signup round opens.",
+          "interfaces": null,
+          "possibleTypes": null,
+          "fields": null,
+          "inputFields": null,
+          "enumValues": [
+            {
+              "name": "EXECUTE_RANKED_CHOICE",
+              "description": "Execute any pending ranked choices as allowed by this signup round",
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ]
+        },
         {
           "kind": "INPUT_OBJECT",
           "name": "SignupRoundInput",

test/factories/root_sites.rb

@@ -23,7 +23,7 @@
 FactoryBot.define do
   factory :root_site do
     site_name { "The Root Site" }
-    association :root_page, factory: :page
-    association :default_layout, factory: :cms_layout
+    root_page factory: :page
+    default_layout factory: :cms_layout
   end
 end