Merge pull request #2080 from alphagov/ldeb-sc-add-form-state-machine

Add form state machine logic

Author: lfdebrux

Gemfile

@@ -84,6 +84,11 @@ gem "csv"
 # Used for sorting/ordering of pages object
 gem "acts_as_list"
 
+# Add state machine for forms
+gem "aasm", "~> 5.5"
+# Used by AASM to autocommit state changes when even method is used with bang eg. make_live!
+gem "after_commit_everywhere", "~> 1.6"
+
 group :development, :test do
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
   gem "debug", platforms: %i[mri mingw x64_mingw]

Gemfile.lock

@@ -24,6 +24,8 @@ GEM
     MailchimpMarketing (3.0.80)
       excon (>= 0.76.0, < 1)
       json (~> 2.1, >= 2.1.0)
+    aasm (5.5.1)
+      concurrent-ruby (~> 1.0)
     actioncable (8.0.2)
       actionpack (= 8.0.2)
       activesupport (= 8.0.2)
@@ -108,6 +110,9 @@ GEM
       activesupport (>= 6.1)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    after_commit_everywhere (1.6.0)
+      activerecord (>= 4.2)
+      activesupport
     ast (2.4.3)
     aws-eventstream (1.4.0)
     aws-partitions (1.1114.0)
@@ -568,8 +573,10 @@ PLATFORMS
 
 DEPENDENCIES
   MailchimpMarketing (~> 3.0)
+  aasm (~> 5.5)
   activeresource (~> 6.1)
   acts_as_list
+  after_commit_everywhere (~> 1.6)
   aws-sdk-cloudwatch (~> 1.116)
   aws-sdk-codepipeline (~> 1.101)
   axe-core-rspec

app/models/condition.rb

@@ -7,6 +7,18 @@ class Condition < ApplicationRecord
 
   before_destroy :destroy_postconditions
 
+  def save_and_update_form
+    save!
+    # TODO: https://trello.com/c/dg9CFPgp/1503-user-triggers-state-change-from-live-to-livewithdraft
+    # Will not be needed when users can trigger this event themselves through the UI
+    form.create_draft_from_live_form if form.live?
+    form.update!(question_section_completed: false)
+  end
+
+  def destroy_and_update_form!
+    destroy! && form.update!(question_section_completed: false)
+  end
+
 private
 
   def destroy_postconditions

app/models/form.rb

@@ -1,4 +1,6 @@
 class Form < ApplicationRecord
+  include FormStateMachine
+
   has_many :pages, -> { order(position: :asc) }, dependent: :destroy
 
   enum :submission_type, {
@@ -9,9 +11,29 @@ class Form < ApplicationRecord
 
   after_create :set_external_id
 
+  def has_draft_version
+    draft? || live_with_draft? || archived_with_draft?
+  end
+
+  def has_live_version
+    live? || live_with_draft?
+  end
+
+  def has_been_archived
+    archived? || archived_with_draft?
+  end
+
+  def ready_for_live
+    task_status_service.mandatory_tasks_completed?
+  end
+
 private
 
   def set_external_id
     update(external_id: id)
   end
+
+  def task_status_service
+    @task_status_service ||= TaskStatusService.new(form: self)
+  end
 end

app/models/page.rb

@@ -13,6 +13,27 @@ class Page < ApplicationRecord
 
   ANSWER_TYPES_WITH_SETTINGS = %w[selection text date address name].freeze
 
+  def destroy_and_update_form!
+    form = self.form
+    destroy! && form.update!(question_section_completed: false)
+  end
+
+  def save_and_update_form
+    return true unless has_changes_to_save?
+
+    save!
+    # TODO: https://trello.com/c/dg9CFPgp/1503-user-triggers-state-change-from-live-to-livewithdraft
+    # Will not be needed when users can trigger this event themselves through the UI
+    form.create_draft_from_live_form! if form.live?
+    form.create_draft_from_archived_form! if form.archived?
+
+    form.update!(question_section_completed: false)
+    check_conditions.destroy_all if answer_type_changed_from_selection
+    check_conditions.destroy_all if answer_settings_changed_from_only_one_option
+
+    true
+  end
+
 private
 
   def destroy_secondary_skip_conditions
@@ -28,4 +49,15 @@ def destroy_secondary_skip_conditions
       .filter { |condition| condition.check_page_id != condition.routing_page_id }
       .each(&:destroy!)
   end
+
+  def answer_type_changed_from_selection
+    answer_type_previously_was&.to_sym == :selection && answer_type&.to_sym != :selection
+  end
+
+  def answer_settings_changed_from_only_one_option
+    from_only_one_option = ActiveModel::Type::Boolean.new.cast(answer_settings_previously_was.try(:[], "only_one_option"))
+    to_multiple_options = !ActiveModel::Type::Boolean.new.cast(answer_settings.try(:[], "only_one_option"))
+
+    from_only_one_option && to_multiple_options
+  end
 end

app/services/condition_repository.rb

@@ -20,7 +20,7 @@ def create!(form_id:,
         exit_page_heading:,
         exit_page_markdown:,
       )
-      save_to_database!(condition)
+      update_and_save_to_database!(condition)
       condition
     end
 
@@ -34,7 +34,7 @@ def save!(record)
       condition = Api::V1::ConditionResource.new(record.attributes, true)
       condition.prefix_options = record.prefix_options
       condition.save!
-      save_to_database!(condition)
+      update_and_save_to_database!(condition)
       condition
     end
 
@@ -44,7 +44,7 @@ def destroy(record)
 
       begin
         condition.destroy # rubocop:disable Rails/SaveBang
-        Condition.destroy(record.id)
+        Condition.find(record.id).destroy_and_update_form!
       rescue ActiveResource::ResourceNotFound, ActiveRecord::RecordNotFound
         # ActiveRecord::Persistence#destroy doesn't raise an error
         # if record has already been destroyed, let's emulate that
@@ -58,5 +58,11 @@ def destroy(record)
     def save_to_database!(record)
       Condition.upsert(record.database_attributes)
     end
+
+    def update_and_save_to_database!(record)
+      condition = Condition.find_or_initialize_by(id: record.id)
+      condition.assign_attributes(record.database_attributes)
+      condition.save_and_update_form
+    end
   end
 end

app/services/form_repository.rb

@@ -28,27 +28,31 @@ def save!(record)
       form = Api::V1::FormResource.new(record.attributes, true)
       form.save!
       save_to_database!(form)
+      db_form = Form.find(record.id)
+      db_form.create_draft_from_live_form! if db_form.live?
+      db_form.create_draft_from_archived_form! if db_form.archived?
       form
     end
 
     def make_live!(record)
       form = Api::V1::FormResource.new(record.attributes, true)
-
+      save_to_database!(form)
+      save_pages_to_database!(form, form.pages) if Form.find(record.id).pages.empty?
       response = form.make_live!
       form.from_json(response.body)
-
-      save_to_database!(form)
+      Form.find(record.id).make_live!
 
       form
     end
 
     def archive!(record)
       form = Api::V1::FormResource.new(record.attributes, true)
 
+      save_to_database!(form)
       response = form.archive!
       form.from_json(response.body)
+      Form.find(record.id).archive_live_form!
 
-      save_to_database!(form)
       form
     end
 

app/services/page_repository.rb

@@ -26,15 +26,15 @@ def create!(form_id:,
         guidance_markdown:,
         answer_type:,
       )
-      save_to_database!(page)
+      update_and_save_to_database!(page)
       page
     end
 
     def save!(record)
       page = Api::V1::PageResource.new(record.attributes, true)
       page.prefix_options = record.prefix_options
       page.save!
-      save_to_database!(page)
+      update_and_save_to_database!(page)
       page
     end
 
@@ -44,7 +44,7 @@ def destroy(record)
 
       begin
         page.destroy # rubocop:disable Rails/SaveBang
-        Page.destroy(record.id)
+        Page.find(record.id).destroy_and_update_form!
       rescue ActiveResource::ResourceNotFound, ActiveRecord::RecordNotFound
         # ActiveRecord::Persistence#destroy doesn't raise an error
         # if record has already been destroyed, let's emulate that
@@ -58,7 +58,7 @@ def move_page(record, direction)
       page.prefix_options = record.prefix_options
 
       page.move_page(direction)
-      save_to_database!(page)
+      update_and_save_to_database!(page)
 
       page
     end
@@ -101,5 +101,27 @@ def save_to_database!(record)
 
       save_routing_conditions_to_database!(record)
     end
+
+    def update_and_save_to_database!(record)
+      attributes = record.database_attributes
+
+      begin
+        # transaction is required to be able to retry after catching exception
+        ActiveRecord::Base.transaction do
+          page = Page.find_or_initialize_by(id: record.id)
+          page.assign_attributes(**attributes)
+          page.save_and_update_form
+        end
+      # we get an exception if the form does not already exist in the database
+      rescue ActiveRecord::RecordInvalid => e
+        raise unless e.message.include? "Form must exist"
+
+        find_form_and_save_to_database!(record)
+
+        retry
+      end
+
+      save_routing_conditions_to_database!(record)
+    end
   end
 end

app/services/task_status_service.rb

@@ -0,0 +1,100 @@
+class TaskStatusService
+  def initialize(form:)
+    @form = form
+  end
+
+  def mandatory_tasks_completed?
+    incomplete_tasks.empty?
+  end
+
+  def incomplete_tasks
+    { missing_pages: pages_status,
+      missing_what_happens_next: what_happens_next_status,
+      missing_privacy_policy_url: privacy_policy_status,
+      missing_contact_details: support_contact_details_status,
+      share_preview_not_completed: share_preview_status }.reject { |_k, v| v == :completed }.map { |k, _v| k }
+  end
+
+  def task_statuses
+    {
+      name_status:,
+      pages_status:,
+      declaration_status:,
+      what_happens_next_status:,
+      payment_link_status:,
+      privacy_policy_status:,
+      support_contact_details_status:,
+      receive_csv_status:,
+      share_preview_status:,
+      make_live_status:,
+    }
+  end
+
+private
+
+  def name_status
+    :completed
+  end
+
+  def pages_status
+    return :completed if @form.question_section_completed && @form.pages.any?
+    return :in_progress if @form.pages.any?
+
+    :not_started
+  end
+
+  def declaration_status
+    return :completed if @form.declaration_section_completed
+    return :in_progress if @form.declaration_text.present?
+
+    :not_started
+  end
+
+  def what_happens_next_status
+    return :completed if @form.what_happens_next_markdown.present?
+
+    :not_started
+  end
+
+  def payment_link_status
+    return :completed if @form.payment_url.present?
+
+    :optional
+  end
+
+  def privacy_policy_status
+    return :completed if @form.privacy_policy_url.present?
+
+    :not_started
+  end
+
+  def support_contact_details_status
+    return :completed if @form.support_email.present? || @form.support_phone.present? || (@form.support_url_text.present? && @form.support_url)
+
+    :not_started
+  end
+
+  def receive_csv_status
+    return :completed if @form.email_with_csv?
+
+    :optional
+  end
+
+  def share_preview_status
+    return :cannot_start unless @form.pages.any?
+    return :completed if @form.share_preview_completed?
+
+    :not_started
+  end
+
+  def make_live_status
+    return make_live_status_for_draft if @form.has_draft_version
+    return :not_started if @form.has_been_archived
+
+    :completed if @form.has_live_version
+  end
+
+  def make_live_status_for_draft
+    mandatory_tasks_completed? ? :not_started : :cannot_start
+  end
+end