Write hearing type to VACOLS when converting legacy hearings

app/mappers/hearing_mapper.rb

@@ -3,6 +3,7 @@
 module HearingMapper
   class InvalidHoldOpenError < StandardError; end
   class InvalidAodError < StandardError; end
+  class InvalidRequestTypeError < StandardError; end
   class InvalidDispositionError < StandardError; end
   class InvalidTranscriptRequestedError < StandardError; end
   class InvalidNotesError < StandardError; end
@@ -12,6 +13,7 @@ class InvalidRepresentativeNameError < StandardError; end
   class << self
     def hearing_fields_to_vacols_codes(hearing_info)
       {
+        request_type: validate_request_type(hearing_info[:request_type], hearing_info.keys),
         scheduled_for: VacolsHelper.format_datetime_with_utc_timezone(hearing_info[:scheduled_for]),
         notes: notes_to_vacols_format(hearing_info[:notes]),
         disposition: disposition_to_vacols_format(hearing_info[:disposition], hearing_info.keys),
@@ -93,6 +95,18 @@ def notes_to_vacols_format(value)
       value[0, 1000]
     end
 
+    def validate_request_type(value, keys)
+      # request_type must be valid
+      blank_value_passed = keys.include?(:request_type) && value.blank?
+      invalid_value_passed = value.present? && VACOLS::CaseHearing::HEARING_TYPES.exclude?(value)
+
+      if blank_value_passed || invalid_value_passed
+        fail InvalidRequestTypeError, "\"#{value}\" is not a valid request type."
+      end
+
+      value
+    end
+
     def disposition_to_vacols_format(value, keys)
       vacols_code = VACOLS::CaseHearing::HEARING_DISPOSITIONS.key(value)
       # disposition cannot be nil

app/models/hearing.rb

@@ -103,6 +103,8 @@ def readable_request_type
     HEARING_TYPES[request_type.to_sym]
   end
 
+  alias original_request_type request_type
+
   def assigned_to_vso?(user)
     appeal.tasks.any? do |task|
       task.type == TrackVeteranTask.name &&

app/models/hearings/forms/base_hearing_update_form.rb

@@ -32,6 +32,8 @@ def update
 
       add_virtual_hearing_alert if show_virtual_hearing_progress_alerts?
     end
+
+    after_update_hearing
   end
 
   def hearing_alerts
@@ -46,6 +48,8 @@ def virtual_hearing_alert
 
   def update_hearing; end
 
+  def after_update_hearing; end
+
   def hearing_updates; end
 
   # Whether or not the hearing has been updated by the form.

app/models/hearings/forms/legacy_hearing_update_form.rb

@@ -12,6 +12,14 @@ def update_hearing
     HearingRepository.load_vacols_data(hearing)
   end
 
+  def after_update_hearing
+    if virtual_hearing_created?
+      hearing.update_request_type_in_vacols(VACOLS::CaseHearing::HEARING_TYPE_LOOKUP[:virtual])
+    elsif virtual_hearing_cancelled?
+      hearing.update_request_type_in_vacols(hearing.original_request_type)
+    end
+  end
+
   private
 
   def hearing_updates

app/models/hearings/virtual_hearing.rb

@@ -175,7 +175,7 @@ def assign_created_by_user
   end
 
   def associated_hearing_is_video
-    if hearing.request_type != HearingDay::REQUEST_TYPES[:video]
+    if hearing.original_request_type != HearingDay::REQUEST_TYPES[:video]
       errors.add(:hearing, "must be a video hearing")
     end
   end

app/models/legacy_hearing.rb

@@ -44,7 +44,15 @@ class LegacyHearing < CaseflowRecord
   # scheduled_for is the correct hearing date and time in Eastern Time for travel
   # board and video hearings, or in the user's (Hearing Coordinator) time zone for
   # central hearings; the transformation happens in HearingMapper.datetime_based_on_type
-  vacols_attr_accessor :scheduled_for, :request_type, :venue_key, :vacols_record, :disposition
+  vacols_attr_accessor :scheduled_for
+
+  # request_type is the current value of HEARSCHED.HEARING_TYPE in VACOLS, but one
+  # should use original_request_type or readable_request_type to make sure we
+  # consistently get the value we expect, as we are now writing to this field in
+  # VACOLS when we convert a legacy hearing to and from virtual.
+  vacols_attr_accessor :request_type
+
+  vacols_attr_accessor :venue_key, :vacols_record, :disposition
   vacols_attr_accessor :aod, :hold_open, :transcript_requested, :notes, :add_on
   vacols_attr_accessor :transcript_sent_date, :appeal_vacols_id
   vacols_attr_accessor :representative_name, :hearing_day_vacols_id
@@ -120,8 +128,8 @@ def external_id
   end
 
   def hearing_day_id_refers_to_vacols_row?
-    (request_type == HearingDay::REQUEST_TYPES[:central] && scheduled_for.to_date < Date.new(2019, 1, 1)) ||
-      (request_type == HearingDay::REQUEST_TYPES[:video] && scheduled_for.to_date < Date.new(2019, 4, 1))
+    (original_request_type == HearingDay::REQUEST_TYPES[:central] && scheduled_for.to_date < Date.new(2019, 1, 1)) ||
+      (original_request_type == HearingDay::REQUEST_TYPES[:video] && scheduled_for.to_date < Date.new(2019, 4, 1))
   end
 
   def hearing_day_id
@@ -147,15 +155,15 @@ def hearing_day
   # There is a constraint within the `HearingRepository` context that means that calling
   # `LegacyHearing#regional_office_Key` triggers an unnecessary call to VACOLS.
   def regional_office_key
-    if request_type == HearingDay::REQUEST_TYPES[:travel] || hearing_day.nil?
+    if original_request_type == HearingDay::REQUEST_TYPES[:travel] || hearing_day.nil?
       return (venue_key || appeal&.regional_office_key)
     end
 
     hearing_day&.regional_office || "C"
   end
 
   def request_type_location
-    if request_type == HearingDay::REQUEST_TYPES[:central]
+    if original_request_type == HearingDay::REQUEST_TYPES[:central]
       "Board of Veterans' Appeals in Washington, DC"
     elsif venue
       venue[:label]
@@ -225,16 +233,33 @@ def update_caseflow_and_vacols(hearing_hash)
     end
   end
 
+  def update_request_type_in_vacols(new_request_type)
+    if VACOLS::CaseHearing::HEARING_TYPES.exclude? new_request_type
+      fail HearingMapper::InvalidRequestTypeError, "\"#{new_request_type}\" is not a valid request type."
+    end
+
+    # update original_vacols_request_type if request_type is not virtual
+    if request_type != VACOLS::CaseHearing::HEARING_TYPE_LOOKUP[:virtual]
+      update!(original_vacols_request_type: request_type)
+    end
+
+    update_caseflow_and_vacols(request_type: new_request_type)
+  end
+
   def readable_location
-    if request_type == LegacyHearing::CO_HEARING
+    if original_request_type == HearingDay::REQUEST_TYPES[:central]
       return "Washington, DC"
     end
 
     regional_office_name
   end
 
   def readable_request_type
-    Hearing::HEARING_TYPES[request_type.to_sym]
+    Hearing::HEARING_TYPES[original_request_type.to_sym]
+  end
+
+  def original_request_type
+    original_vacols_request_type.presence || request_type
   end
 
   cache_attribute :cached_number_of_documents do

db/migrate/20200908050443_add_original_vacols_request_type_to_legacy_hearing.rb

@@ -0,0 +1,5 @@
+class AddOriginalVacolsRequestTypeToLegacyHearing < Caseflow::Migration
+  def change
+    add_column :legacy_hearings, :original_vacols_request_type, :string, comment: "The original request type of the hearing in VACOLS, before it was changed to Virtual"
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2020_09_04_140217) do
+ActiveRecord::Schema.define(version: 2020_09_08_050443) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -872,6 +872,7 @@
     t.bigint "created_by_id", comment: "The ID of the user who created the Legacy Hearing"
     t.bigint "hearing_day_id", comment: "The hearing day the hearing will take place on"
     t.string "military_service", comment: "Periods and circumstances of military service"
+    t.string "original_vacols_request_type", comment: "The original request type of the hearing in VACOLS, before it was changed to Virtual"
     t.boolean "prepped", comment: "Determines whether the judge has checked the hearing as prepped"
     t.text "summary", comment: "Summary of hearing"
     t.datetime "updated_at", comment: "Timestamp when record was last updated."

docs/schema/caseflow.csv

@@ -669,6 +669,7 @@ legacy_hearings,created_by_id,integer (8) FK,,,x,,x,The ID of the user who creat
 legacy_hearings,hearing_day_id,integer (8),,,,,x,The hearing day the hearing will take place on
 legacy_hearings,id,integer (8) PK,x,x,,,,
 legacy_hearings,military_service,string,,,,,,Periods and circumstances of military service
+legacy_hearings,original_vacols_request_type,string,,,,,,"The original request type of the hearing in VACOLS, before it was changed to Virtual"
 legacy_hearings,prepped,boolean,,,,,,Determines whether the judge has checked the hearing as prepped
 legacy_hearings,summary,text,,,,,,Summary of hearing
 legacy_hearings,updated_at,datetime,,,,,x,Timestamp when record was last updated.
@@ -975,7 +976,6 @@ tasks,assigned_at,datetime,,,,,,
 tasks,assigned_by_id,integer FK,,,x,,,
 tasks,assigned_to_id,integer ∗ FK,x,,x,,x,
 tasks,assigned_to_type,string ∗,x,,,,x,
-tasks,cancelled_by_id,integer,,,,,,ID of user that cancelled the task. Backfilled from versions table. Can be nil if task was cancelled before this column was added or if there is no user logged in when the task is cancelled
 tasks,closed_at,datetime,,,,,,
 tasks,created_at,datetime ∗,x,,,,,
 tasks,id,integer (8) PK,x,x,,,,

spec/mappers/hearing_mapper_spec.rb

@@ -107,28 +107,44 @@
   end
 
   context ".hearing_fields_to_vacols_codes" do
+    let!(:user) { create(:user, :with_vacols_attorney_record) }
+    let(:scheduled_datetime) { Time.zone.now + 2.weeks }
+    let!(:scheduled_datetime_formatted) { VacolsHelper.format_datetime_with_utc_timezone(scheduled_datetime) }
+
     subject { HearingMapper.hearing_fields_to_vacols_codes(info) }
 
     context "when all values are present" do
       let(:info) do
-        { notes: "test notes",
-          aod: "none",
-          transcript_requested: false,
+        { request_type: "V",
+          scheduled_for: scheduled_datetime,
+          notes: "test notes",
           disposition: "postponed",
           hold_open: 60,
+          aod: "none",
           add_on: false,
-          representative_name: "test name" }
+          transcript_requested: false,
+          representative_name: "test name",
+          folder_nr: "1234567",
+          room: "3",
+          bva_poc: "TESTVALUE",
+          judge_id: user.id }
       end
 
       it "should convert to Vacols values" do
         result = subject
+        expect(result[:request_type]).to eq "V"
+        expect(result[:scheduled_for]).to eq scheduled_datetime_formatted
         expect(result[:notes]).to eq "test notes"
-        expect(result[:aod]).to eq :N
-        expect(result[:transcript_requested]).to eq :N
         expect(result[:disposition]).to eq :P
         expect(result[:hold_open]).to eq 60
+        expect(result[:aod]).to eq :N
         expect(result[:add_on]).to eq :N
+        expect(result[:transcript_requested]).to eq :N
         expect(result[:representative_name]).to eq "test name"
+        expect(result[:folder_nr]).to eq "1234567"
+        expect(result[:room]).to eq "3"
+        expect(result[:bva_poc]).to eq "TESTVALUE"
+        expect(result[:judge_id]).to eq user.vacols_attorney_id
       end
     end
 
@@ -173,6 +189,15 @@
       end
     end
 
+    context "when request_type is not valid" do
+      let(:info) do
+        { request_type: "NOPE" }
+      end
+      it "raises InvalidRequestTypeError error" do
+        expect { subject }.to raise_error(HearingMapper::InvalidRequestTypeError)
+      end
+    end
+
     context "when aod is not valid" do
       let(:info) do
         { aod: :foo }
@@ -209,6 +234,15 @@
       end
     end
 
+    context "when request_type is empty" do
+      let(:info) do
+        { request_type: nil }
+      end
+      it "raises InvalidRequestTypeError error" do
+        expect { subject }.to raise_error(HearingMapper::InvalidRequestTypeError)
+      end
+    end
+
     context "when aod is false" do
       let(:info) do
         { aod: false }

spec/models/legacy_hearing_spec.rb

@@ -559,4 +559,65 @@
       end
     end
   end
+
+  context "update_request_type_in_vacols" do
+    let(:new_request_type) { nil }
+
+    subject { hearing.update_request_type_in_vacols(new_request_type) }
+
+    context "request type in VACOLS is not virtual" do
+      let(:request_type) { VACOLS::CaseHearing::HEARING_TYPE_LOOKUP[:central] }
+
+      context "new request type is virtual" do
+        let(:new_request_type) { VACOLS::CaseHearing::HEARING_TYPE_LOOKUP[:virtual] }
+
+        it "saves the request type from VACOLS to original_vacols_request_type" do
+          expect(hearing.original_vacols_request_type).to be_nil
+
+          subject
+
+          expect(hearing.original_vacols_request_type).to eq request_type
+        end
+
+        it "updates HEARSCHED.HEARING_TYPE in VACOLS" do
+          expect(hearing.request_type).to eq request_type
+
+          subject
+
+          expect(hearing.request_type).to eq new_request_type
+        end
+      end
+
+      context "new request type is invalid" do
+        let(:new_request_type) { "INVALID" }
+
+        it "raises an InvalidRequestTypeError" do
+          expect { subject }.to raise_error(HearingMapper::InvalidRequestTypeError)
+        end
+      end
+    end
+
+    context "request type in VACOLS is virtual" do
+      let(:request_type) { VACOLS::CaseHearing::HEARING_TYPE_LOOKUP[:virtual] }
+      let(:new_request_type) { VACOLS::CaseHearing::HEARING_TYPE_LOOKUP[:central] }
+
+      before { hearing.update!(original_vacols_request_type: new_request_type) }
+
+      it "doesn't change original_vacols_request_type" do
+        expect(hearing.original_vacols_request_type).to eq new_request_type
+
+        subject
+
+        expect(hearing.original_vacols_request_type).to eq new_request_type
+      end
+
+      it "updates HEARSCHED.HEARING_TYPE in VACOLS" do
+        expect(hearing.request_type).to eq request_type
+
+        subject
+
+        expect(hearing.request_type).to eq new_request_type
+      end
+    end
+  end
 end