release/FY25Q1.3.0 (#23456) (#23475)

* 🔀 Squash merge jcroteau/APPEALS-54136-zeitwerk-autoloader-transition * 🔀 Squash merge jcroteau/APPEALS-60112-fix-db-migrate-up-and-down-tasks Co-authored-by: Jeremy Croteau <[email protected]>
department-of-veterans-affairs · Nov 14, 2024 · 5e0f952 · 5e0f952
1 parent 57e0f68
commit 5e0f952
Show file tree

Hide file tree

Showing 144 changed files with 806 additions and 648 deletions.
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -41,6 +41,8 @@ checks:
 plugins:
   brakeman:
     enabled: true
+    exclude_patterns:
+      - 'lib/helpers/war_room/DtaDooDescriptionRemediationByReportLoad.rb'
   bundler-audit:
     enabled: true
   duplication:
@@ -51,13 +53,13 @@ plugins:
         javascript:
           mass_threshold: 81
     exclude_patterns:
-    - 'db/migrate/*'
-    - 'db/etl_migrate/*'
     - 'app/controllers/idt/api/v2/appeals_controller.rb'
-    - 'spec/controllers/idt/api/v2/appeals_controller_spec.rb'
+    - 'db/etl_migrate/*'
+    - 'db/migrate/*'
+    - 'spec/controllers/decision_reviews_controller_spec.rb'
     - 'spec/controllers/idt/api/appeals_controller_spec.rb'
+    - 'spec/controllers/idt/api/v2/appeals_controller_spec.rb'
     - 'spec/controllers/tasks_controller_spec.rb'
-    - 'spec/controllers/decision_reviews_controller_spec.rb'
     - 'spec/models/hearings/conference_link_spec.rb'
   eslint:
     enabled: true
@@ -79,10 +81,18 @@ plugins:
       Attribute:
         enabled: false
     exclude_patterns:
-    - 'db/migrate/*'
-    - 'db/etl_migrate/*'
     - 'app/jobs/dispatch_email_job.rb'
     - 'app/mailers/dispatch_mailer.rb'
+    - 'db/etl_migrate/*'
+    - 'db/migrate/*'
+    - 'lib/helpers/sanitizers.rb'
+    - 'lib/helpers/war_room/claim_label_change.rb'
+    - 'lib/helpers/war_room/DtaDooDescriptionRemediationByReportLoad.rb'
+    - 'lib/helpers/war_room/dupp_ep_claims_sync_status_update_can_clr.rb'
+    - 'lib/helpers/war_room/hearings_info_migration.rb'
+    - 'lib/helpers/war_room/payee_code_update.rb'
+    - 'lib/helpers/war_room/remand_dta_or_doo_higher_level_review.rb'
+    - 'lib/helpers/war_room/report_load_end_product_sync.rb'
   rubocop:
     enabled: true
     channel: rubocop-0-83
@@ -116,15 +126,14 @@ plugins:
             - "spec/feature/**/*.rb"
 
 exclude_patterns:
-  - 'db/schema.rb'
-  - 'db/etl_schema.rb'
-  - 'db/seeds.rb'
-  - 'db/scripts/*'
-  - 'node_modules/**/*'
   - 'app/mappers/zip_code_to_lat_lng_mapper.rb'
-  - 'tmp/**/*'
   - 'app/assets/**/*'
-  - 'client/test/data/camoQueueConfigData.js'
   - 'client/app/intake/components/mockData/issueListProps.js'
+  - 'client/test/data/camoQueueConfigData.js'
+  - 'db/etl_schema.rb'
+  - 'db/schema.rb'
+  - 'db/scripts/*'
+  - 'db/seeds.rb'
   - 'db/seeds/*'
-
+  - 'node_modules/**/*'
+  - 'tmp/**/*'
diff --git a/.gitignore b/.gitignore
@@ -41,6 +41,7 @@ tags
 !.dockerignore
 !.fasterer.yml
 !.reek.yml
+!.rubocop
 !/.circleci/config.yml
 
 # React on Rails

diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,6 +1,7 @@
 require:
   - rubocop-performance
   - rubocop-rails
+  - .rubocop/custom_cop/top_level_constants_per_file.rb
 
 AllCops:
   Exclude:
@@ -102,9 +103,9 @@ Metrics/MethodLength:
   Max: 20
   Exclude:
     - app/jobs/middleware/job_sentry_scope_middleware.rb
-    - lib/helpers/unrecognized_appellant.rb
+    - lib/helpers/war_room/unrecognized_appellant.rb
     - lib/helpers/duplicate_veteran_checker.rb
-    - lib/helpers/report_load_end_product_sync.rb
+    - lib/helpers/war_room/report_load_end_product_sync.rb
     - lib/helpers/claim_label_change.rb
     - "spec/**/*"
 
@@ -213,7 +214,7 @@ Layout/LineLength:
   Max: 120
   Exclude:
     - lib/helpers/duplicate_veteran_checker.rb
-    - lib/helpers/report_load_end_product_sync.rb
+    - lib/helpers/war_room/report_load_end_product_sync.rb
 
 
 Layout/MultilineMethodCallIndentation:
@@ -224,3 +225,11 @@ Layout/EmptyLinesAroundAttributeAccessor:
 
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
+
+CustomCop/TopLevelConstantsPerFile:
+  Enabled: true
+  Include:
+    - 'app/**/*'
+    - 'lib/**/*'
+  Exclude:
+    - '**/*[^.rb]' # exclude non-.rb files (ex: .rake files)
diff --git a/.rubocop/custom_cop/top_level_constants_per_file.rb b/.rubocop/custom_cop/top_level_constants_per_file.rb
@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module CustomCop
+    class TopLevelConstantsPerFile < RuboCop::Cop::Cop
+      MSG = "Multiple top-level constants detected in one file. The autoloader expects one top-level constant per file."
+
+      def investigate(processed_source)
+        return unless processed_source
+
+        # If more than one top-level constant in the file, add offense on the second one
+        if top_level_constant_nodes.size > 1
+          add_offense(top_level_constant_nodes[1], message: MSG)
+        end
+      end
+
+      private
+
+      def top_level_constant_nodes
+        @top_level_constant_nodes ||=
+          processed_source.ast.each_node(:class, :module).select { |node| top_level_constant?(node) }
+      end
+
+      def top_level_constant?(node)
+        # node is not nested within a class or module node?
+        node.ancestors.none? { |ancestor| ancestor.class_type? || ancestor.module_type? }
+      end
+    end
+  end
+end
diff --git a/Gemfile b/Gemfile
@@ -17,7 +17,7 @@ gem "bgs", git: "https://github.com/department-of-veterans-affairs/ruby-bgs.git"
 gem "bootsnap", require: false
 gem "browser"
 gem "business_time", "~> 0.9.3"
-gem "caseflow", git: "https://github.com/department-of-veterans-affairs/caseflow-commons", ref: "9bd3635fbd8094d25160669f38d8699e2f1d7a98"
+gem "caseflow", git: "https://github.com/department-of-veterans-affairs/caseflow-commons", ref: "dbd86859856d161d84b0bba4d67a8b62e4684996"
 gem "connect_mpi", git: "https://github.com/department-of-veterans-affairs/connect-mpi.git", ref: "a3a58c64f85b980a8b5ea6347430dd73a99ea74c"
 gem "connect_vbms", git: "https://github.com/department-of-veterans-affairs/connect_vbms.git", ref: "9807d9c9f0f3e3494a60b6693dc4f455c1e3e922"
 gem "console_tree_renderer", git: "https://github.com/department-of-veterans-affairs/console-tree-renderer.git", tag: "v0.1.1"

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 GIT
   remote: https://github.com/department-of-veterans-affairs/caseflow-commons
-  revision: 9bd3635fbd8094d25160669f38d8699e2f1d7a98
-  ref: 9bd3635fbd8094d25160669f38d8699e2f1d7a98
+  revision: dbd86859856d161d84b0bba4d67a8b62e4684996
+  ref: dbd86859856d161d84b0bba4d67a8b62e4684996
   specs:
     caseflow (0.4.8)
       aws-sdk-s3

diff --git a/app/controllers/api/v3/issues/vacols/veterans_controller.rb b/app/controllers/api/v3/issues/vacols/veterans_controller.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # :reek:InstanceVariableAssumption
-class Api::V3::Issues::Vacols::VeteransController < Api::V3::BaseController
+class Api::V3::Issues::VACOLS::VeteransController < Api::V3::BaseController
   # The max amount of Issues that can be paginated on a single page
   DEFAULT_UPPER_BOUND_PER_PAGE = ENV["REQUEST_ISSUE_DEFAULT_UPPER_BOUND_PER_PAGE"].to_i
   include ApiV3FeatureToggleConcern
@@ -56,7 +56,7 @@ def show
                             # Disallow page(0) since page(0) == page(1) in kaminari. This is to avoid confusion.
                             (page.nil? || page <= 0) ? page = 1 : page ||= 1
 
-                            render_vacols_issues(Api::V3::Issues::Vacols::VbmsVacolsDtoBuilder.new(@veteran, page,
+                            render_vacols_issues(Api::V3::Issues::VACOLS::VbmsVacolsDtoBuilder.new(@veteran, page,
                                                                                                    per_page))
                           end
   end

diff --git a/app/controllers/hearings/schedule_hearing_tasks_controller.rb b/app/controllers/hearings/schedule_hearing_tasks_controller.rb
@@ -9,7 +9,7 @@ class Hearings::ScheduleHearingTasksController < ApplicationController
   before_action :verify_edit_hearing_schedule_access
 
   def index
-    task_pager = Hearings::ScheduleHearingTaskPager.new(
+    task_pager = ScheduleHearingTaskPager.new(
       assignee: HearingsManagement.singleton,
       tab_name: allowed_params[Constants.QUEUE_CONFIG.TAB_NAME_REQUEST_PARAM],
       page: allowed_params[Constants.QUEUE_CONFIG.PAGE_NUMBER_REQUEST_PARAM].to_i,

diff --git a/app/controllers/test_seeds_controller.rb → ...controllers/test/test_seeds_controller.rb b/app/controllers/test_seeds_controller.rb → ...controllers/test/test_seeds_controller.rb
diff --git a/app/controllers/user_info_controller.rb b/app/controllers/user_info_controller.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class UserInfoController < ApplicationController
-  include BgsService
+  include BGSServiceConcern
 
   before_action :deny_non_bva_admins, only: [:represented_organizations]
 

diff --git a/app/exceptions/standard_error.rb b/app/exceptions/standard_error.rb
diff --git a/app/jobs/application_job.rb b/app/jobs/application_job.rb
@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../exceptions/standard_error"
-
 class ApplicationJob < ActiveJob::Base
   class InvalidJobPriority < StandardError; end
 

diff --git a/app/jobs/file_number_not_found_fix_job.rb b/app/jobs/file_number_not_found_fix_job.rb
@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
-require_relative "../../lib/helpers/fix_file_number_wizard"
-require_relative "../../lib/helpers/duplicate_veteran_checker"
-
 class FileNumberNotFoundFixJob < CaseflowJob
   include MasterSchedulerInterface
-  ASSOCIATED_OBJECTS = FixFileNumberWizard::ASSOCIATIONS
 
   queue_with_priority :low_priority
   application_attr :intake
 
+  class FixfileNumberCollections
+    ASSOCIATED_OBJECTS = FixFileNumberWizard::ASSOCIATIONS
+    def self.get_collections(veteran)
+      ASSOCIATED_OBJECTS.map do |klass|
+        FixFileNumberWizard::Collection.new(klass, veteran.ssn)
+      end
+    end
+  end
+
   def initialize
     @stuck_job_report_service = StuckJobReportService.new
     @start_time = nil
@@ -109,13 +114,3 @@ def self.call(ssn)
     end
   end
 end
-
-# created this class below so as to mock FixFileNumberWizard::Collection instance
-class FixfileNumberCollections
-  ASSOCIATED_OBJECTS = FixFileNumberWizard::ASSOCIATIONS
-  def self.get_collections(veteran)
-    ASSOCIATED_OBJECTS.map do |klass|
-      FixFileNumberWizard::Collection.new(klass, veteran.ssn)
-    end
-  end
-end
diff --git a/app/models/appeal.rb b/app/models/appeal.rb
@@ -10,7 +10,7 @@
 # rubocop:disable Metrics/ClassLength
 class Appeal < DecisionReview
   include BeaamAppealConcern
-  include BgsService
+  include BGSServiceConcern
   include Taskable
   include PrintsTaskTree
   include HasTaskHistory

diff --git a/app/models/bgs_attorney.rb b/app/models/bgs_attorney.rb
@@ -4,7 +4,7 @@
 # who might not already be associated with a record (hence the use of a different model/table)
 
 class BgsAttorney < CaseflowRecord
-  include BgsService
+  include BGSServiceConcern
 
   delegate :address,
            :address_line_1,

diff --git a/app/models/bgs_power_of_attorney.rb b/app/models/bgs_power_of_attorney.rb
@@ -2,7 +2,7 @@
 
 class BgsPowerOfAttorney < CaseflowRecord
   include AssociatedBgsRecord
-  include BgsService
+  include BGSServiceConcern
 
   has_many :claimants, primary_key: :claimant_participant_id, foreign_key: :participant_id
   has_one :representative, primary_key: :poa_participant_id, foreign_key: :participant_id

diff --git a/app/models/concerns/appeal_concern.rb b/app/models/concerns/appeal_concern.rb
@@ -113,7 +113,7 @@ def accessible?
     # this is used for calling BGSService.can_access? to fix VSO access that is being blocked
     # by BGS returning false for veteran.accessible? when they should indeed have access to the appeal.
     # does this VSO have access to this appeal? check if current user is one of the reps on the appeal.
-    # if so return true, if not then do the BgsService.can_access? path.
+    # if so return true, if not then do the BGSService.can_access? path.
     user = RequestStore[:current_user]
     assigned_to_vso?(user) || user_represents_claimant_not_veteran?(user) || bgs.can_access?(veteran_file_number)
   end

diff --git a/app/models/concerns/associated_bgs_record.rb b/app/models/concerns/associated_bgs_record.rb
@@ -3,7 +3,7 @@
 module AssociatedBgsRecord
   extend ActiveSupport::Concern
 
-  include BgsService
+  include BGSServiceConcern
 
   module ClassMethods
     # bgs_attr_accessor will lazy load the underlying data from BGS upon first call

diff --git a/app/models/concerns/bgs_service.rb → app/models/concerns/bgs_service_concern.rb b/app/models/concerns/bgs_service.rb → app/models/concerns/bgs_service_concern.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module BgsService
+module BGSServiceConcern
   extend ActiveSupport::Concern
 
   private

diff --git a/app/models/end_product_update.rb b/app/models/end_product_update.rb
@@ -3,7 +3,7 @@
 # This is for updating the claim label for end products established from Caseflow
 
 class EndProductUpdate < CaseflowRecord
-  include BgsService
+  include BGSServiceConcern
 
   belongs_to :end_product_establishment, optional: false
   belongs_to :original_decision_review, polymorphic: true, optional: false

diff --git a/app/models/hearings/schedule_hearing_task_pager.rb b/app/models/hearings/schedule_hearing_task_pager.rb
@@ -3,7 +3,7 @@
 ##
 # Basically the TaskPager, but has a required filter by regional key.
 
-class Hearings::ScheduleHearingTaskPager < TaskPager
+class ScheduleHearingTaskPager < TaskPager
   attr_accessor :regional_office_key
 
   def initialize(args)

diff --git a/app/models/legacy_appeal.rb b/app/models/legacy_appeal.rb
@@ -10,7 +10,7 @@
 class LegacyAppeal < CaseflowRecord
   include AppealConcern
   include AssociatedVacolsModel
-  include BgsService
+  include BGSServiceConcern
   include CachedAttributes
   include AddressMapper
   include Taskable

diff --git a/app/models/organization.rb b/app/models/organization.rb
@@ -7,7 +7,6 @@ class Organization < CaseflowRecord
   has_many :users, through: :organizations_users
   has_many :membership_requests
   has_many :non_admin_users, -> { non_admin }, class_name: "OrganizationsUser"
-  require_dependency "dvc_team"
 
   validates :name, presence: true
   validates :url, presence: true, uniqueness: true

diff --git a/app/models/organizations/business_line.rb b/app/models/organizations/business_line.rb
@@ -1085,5 +1085,3 @@ def where_clause_from_array(table_class, column, values_array)
   end
   # rubocop:enable Metrics/ClassLength
 end
-
-require_dependency "vha_business_line"
diff --git a/app/models/person.rb b/app/models/person.rb
@@ -2,7 +2,7 @@
 
 class Person < CaseflowRecord
   include AssociatedBgsRecord
-  include BgsService
+  include BGSServiceConcern
   include EventConcern
 
   has_many :advance_on_docket_motions

diff --git a/app/models/power_of_attorney.rb b/app/models/power_of_attorney.rb
@@ -14,7 +14,7 @@
 class PowerOfAttorney
   include ActiveModel::Model
   include AssociatedVacolsModel
-  include BgsService
+  include BGSServiceConcern
 
   vacols_attr_accessor  :vacols_representative_type,
                         :vacols_representative_name,

diff --git a/app/models/queue_tab.rb b/app/models/queue_tab.rb
@@ -235,12 +235,3 @@ def assignee_is_organization
     errors.add(:assignee, COPY::QUEUE_TAB_NON_ORGANIZATION_ASSIGNEE_MESSAGE) unless assignee.is_a?(Organization)
   end
 end
-
-require_dependency "assigned_tasks_tab"
-require_dependency "completed_tasks_tab"
-require_dependency "on_hold_tasks_tab"
-require_dependency "organization_assigned_tasks_tab"
-require_dependency "organization_completed_tasks_tab"
-require_dependency "organization_on_hold_tasks_tab"
-require_dependency "organization_tracking_tasks_tab"
-require_dependency "organization_unassigned_tasks_tab"
-Original file line number
+Diff line change
@@ Expand Up @@
       end
       # rubocop:enable Metrics/ClassLength
     end
-    require_dependency "vha_business_line"