Cleanup linter annotations for remote dev domain

- Cleanup/update noinspection and fix other minor issues

ee/app/finders/remote_development/cluster_agents_finder.rb

@@ -13,6 +13,7 @@ def self.fetch_agents(filter, namespace, user)
       when :unmapped
         validate_user_can_read_namespace_agent_mappings!(user: user, namespace: namespace)
 
+        # noinspection RailsParamDefResolve -- A symbol is a valid argument for 'select'
         existing_mapped_agents =
           RemoteDevelopmentNamespaceClusterAgentMapping
             .for_namespaces([namespace.id])

ee/app/graphql/mutations/remote_development/workspaces/create.rb

@@ -106,7 +106,7 @@ def resolve(args)
             end
           end
 
-          # noinspection RubyNilAnalysis
+          # noinspection RubyNilAnalysis - This is because the superclass #current_user uses #[], which can return nil
           track_usage_event(:users_creating_workspaces, current_user.id)
 
           service = ::RemoteDevelopment::Workspaces::CreateService.new(current_user: current_user)

ee/app/graphql/resolvers/remote_development/workspaces_for_agent_resolver.rb

@@ -4,7 +4,6 @@ module Resolvers
   module RemoteDevelopment
     class WorkspacesForAgentResolver < ::Resolvers::BaseResolver
       include ResolvesIds
-      # noinspection RubyResolve - likely due to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       include Gitlab::Graphql::Authorize::AuthorizeResource
 
       type Types::RemoteDevelopment::WorkspaceType.connection_type, null: true

ee/app/models/remote_development/workspace.rb

@@ -4,7 +4,6 @@ module RemoteDevelopment
   class Workspace < ApplicationRecord
     include IgnorableColumns
     include Sortable
-    # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
     include RemoteDevelopment::Workspaces::States
     include ::Gitlab::Utils::StrongMemoize
 
@@ -80,6 +79,7 @@ def workspaces_count_for_current_user_and_agent
         .by_agent_ids(cluster_agent_id)
         .count
     end
+
     strong_memoize_attr :workspaces_count_for_current_user_and_agent
 
     def workspaces_count_for_current_agent
@@ -88,11 +88,13 @@ def workspaces_count_for_current_agent
         .by_agent_ids(cluster_agent_id)
         .count
     end
+
     strong_memoize_attr :workspaces_count_for_current_agent
 
     def exceeds_workspaces_per_user_quota?
       return unless remote_development_agent_config
 
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       quota = remote_development_agent_config.workspaces_per_user_quota
       return true if quota == 0
       return false if quota == -1
@@ -103,6 +105,7 @@ def exceeds_workspaces_per_user_quota?
     def exceeds_workspaces_quota?
       return unless remote_development_agent_config
 
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       quota = remote_development_agent_config.workspaces_quota
       return true if quota == 0
       return false if quota == -1
@@ -159,21 +162,27 @@ def enforce_permanent_termination
     def enforce_quotas
       agent_config = remote_development_agent_config
       if exceeds_workspaces_per_user_quota?
+        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         errors.add :base,
-          format(s_('RemoteDevelopment|You cannot create a workspace because you already have "%{count}" existing workspaces for the given agent with a per user quota of "%{quota}" workspaces'),
+          format(
+            s_('RemoteDevelopment|You cannot create a workspace because you already have "%{count}" existing workspaces for the given agent with a per user quota of "%{quota}" workspaces'),
             count: workspaces_count_for_current_user_and_agent,
-            quota: agent_config.workspaces_per_user_quota)
+            quota: agent_config.workspaces_per_user_quota
+          )
       elsif exceeds_workspaces_quota?
+        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         errors.add :base,
-          format(s_('RemoteDevelopment|You cannot create a workspace because there are already "%{count}" existing workspaces for the given agent with a total quota of "%{quota}" workspaces'),
+          format(
+            s_('RemoteDevelopment|You cannot create a workspace because there are already "%{count}" existing workspaces for the given agent with a total quota of "%{quota}" workspaces'),
             count: workspaces_count_for_current_agent,
-            quota: agent_config.workspaces_quota)
+            quota: agent_config.workspaces_quota
+          )
       end
     end
+
     # rubocop:enable Layout/LineLength  -- Long messages for UI
 
     def touch_desired_state_updated_at
-      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       self.desired_state_updated_at = Time.current.utc
     end
   end

ee/app/policies/remote_development/workspace_policy.rb

@@ -3,9 +3,6 @@
 module RemoteDevelopment
   # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-25400
   class WorkspacePolicy < BasePolicy
-    # TODO: This policy should be updated/replaced with a new authorization scheme based on runners.
-    #       See https://gitlab.com/groups/gitlab-org/-/epics/10272
-
     condition(:can_access_workspaces_feature) { user&.can?(:access_workspaces_feature, :global) }
     condition(:can_admin_cluster_agent_for_workspace) { user&.can?(:admin_cluster, workspace.agent) }
     condition(:can_admin_owned_workspace) { workspace_owner? && has_developer_access_to_workspace_project? }

ee/lib/remote_development/agent_config/updater.rb

 # frozen_string_literal: true
 
-# noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
 module RemoteDevelopment
   module AgentConfig
     class Updater
@@ -47,6 +46,7 @@ def self.update(value)
 
           workspaces_update_fields = { force_include_all_resources: true }
 
+          # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
           if remote_development_agent_config.dns_zone_previously_was
             workspaces_update_fields[:dns_zone] = remote_development_agent_config.dns_zone
           end

ee/lib/remote_development/namespace_cluster_agent_mappings/validations.rb

@@ -42,6 +42,7 @@ def self.traversal_ids_for_cluster_agents(cluster_agent_ids:)
           # project_namespaces_by_id must contain project.project_namespace_id as "projects" table has a
           # ON CASCADE DELETE constraint with respect to the projects table. As such, if a project can be retrieved
           # from the database, so should its project_namespace
+          # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
           project_namespace = project_namespaces_by_id[project.project_namespace_id]
 
           hash[cluster_agent_id] = project_namespace.traversal_ids

ee/lib/remote_development/settings/env_var_reader.rb

@@ -41,11 +41,12 @@ def self.read(value)
       end
 
       # @param [String] env_var_name
-      # @param [Integer,String] env_var_value_string
+      # @param [String] env_var_value_string
       # @param [Class] setting_type
       # @return [Object]
       # @raise [RuntimeError]
       def self.cast_value(env_var_name:, env_var_value_string:, setting_type:)
+        # noinspection RubyIfCanBeCaseInspection -- This cannot be a case statement - see discussion here https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148287#note_1849160293
         if setting_type == String
           env_var_value_string
         elsif setting_type == Integer

ee/lib/remote_development/workspaces/create/workspace_creator.rb

@@ -3,7 +3,6 @@
 module RemoteDevelopment
   module Workspaces
     module Create
-      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       class WorkspaceCreator
         include States
         include Messages

ee/lib/remote_development/workspaces/reconcile/persistence/workspaces_from_agent_infos_updater.rb

@@ -4,7 +4,6 @@ module RemoteDevelopment
   module Workspaces
     module Reconcile
       module Persistence
-        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         class WorkspacesFromAgentInfosUpdater
           # @param [Hash] value
           # @return [Hash]

ee/spec/features/remote_development/workspaces_dropdown_group_spec.rb

@@ -2,7 +2,6 @@
 
 require 'spec_helper'
 
-# noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
 RSpec.describe 'Remote Development workspaces dropdown group', :api, :js, feature_category: :remote_development do
   include_context 'with remote development shared fixtures'
   include_context 'file upload requests helpers'
@@ -75,6 +74,7 @@
       it 'allows navigating to the new workspace page' do
         click_link 'New workspace'
 
+        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         expect(page).to have_current_path("#{new_remote_development_workspace_path}?project=#{project.full_path}")
         expect(page).to have_css('button', text: project.name_with_namespace)
       end
@@ -138,6 +138,7 @@ def expect_workspace_state_indicator(state)
   end
 
   describe 'when viewing blob page' do
+    # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
     let(:subject) { project_blob_path(project, "#{project.default_branch}/#{devfile_path}") }
 
     it_behaves_like 'views and manages workspaces in workspaces dropdown group based on feature flag'

ee/spec/features/remote_development/workspaces_spec.rb

@@ -2,7 +2,6 @@
 
 require 'spec_helper'
 
-# noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
 RSpec.describe 'Remote Development workspaces', :api, :js, feature_category: :remote_development do
   include_context 'with remote development shared fixtures'
   include_context 'file upload requests helpers'
@@ -45,6 +44,7 @@
 
       # NAVIGATE TO WORKSPACES PAGE
 
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       visit remote_development_workspaces_path
       wait_for_requests
 
@@ -54,7 +54,7 @@
       click_button 'Select a project'
       find_by_testid("listbox-item-#{project.full_path}").click
       wait_for_requests
-      # noinspection RubyMismatchedArgumentType - TODO: Try suggestions in https://youtrack.jetbrains.com/issue/RUBY-25400/Programmatically-defined-constants-always-produce-Unresolved-reference-error#focus=Comments-27-8161148.0-0
+      # noinspection RubyMismatchedArgumentType -- Rubymine is finding the wrong `select`
       select agent.name, from: 'Cluster agent'
       fill_in 'Workspace automatically terminates after', with: '20'
       click_button 'Create workspace'

ee/spec/lib/remote_development/agent_config/updater_spec.rb

@@ -2,7 +2,6 @@
 
 require 'spec_helper'
 
-# noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
 RSpec.describe ::RemoteDevelopment::AgentConfig::Updater, feature_category: :remote_development do
   include ResultMatchers
 
@@ -99,7 +98,9 @@
           .to eq(default_resources_per_workspace_container)
         expect(config_instance.max_resources_per_workspace.deep_symbolize_keys)
           .to eq(max_resources_per_workspace)
+        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         expect(config_instance.workspaces_quota).to eq(saved_quota)
+        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         expect(config_instance.workspaces_per_user_quota).to eq(saved_quota)
 
         expect(result)

ee/spec/lib/remote_development/namespace_cluster_agent_mappings/create/main_integration_spec.rb

@@ -26,8 +26,10 @@
       expect(response.dig(:payload, :namespace_cluster_agent_mapping)).not_to be_nil
 
       mapping = response.dig(:payload, :namespace_cluster_agent_mapping)
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       expect(mapping.cluster_agent_id).to eq(cluster_agent.id)
       expect(mapping.namespace_id).to eq(namespace.id)
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       expect(mapping.creator_id).to eq(creator.id)
     end
   end

ee/spec/lib/remote_development/namespace_cluster_agent_mappings/create/main_spec.rb

@@ -22,7 +22,7 @@
     end
 
     it "returns expected response" do
-      # noinspection RubyResolve -- TODO: open issue and add to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       expect do
         described_class.main(value_passed_along_steps)
       end
@@ -47,7 +47,7 @@
 
     shared_examples "rop invocation with error response" do
       it "returns expected response" do
-        # noinspection RubyResolve -- TODO: open issue and add to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues
+        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         expect do
           described_class.main(value_passed_along_steps)
         end

ee/spec/lib/remote_development/namespace_cluster_agent_mappings/create/mapping_creator_spec.rb

@@ -38,18 +38,21 @@
     end
 
     context 'when cluster agent does not exist' do
+      # noinspection RubyResolve -- Rubymine isn't finding build_stubbed
       let_it_be(:agent) { build_stubbed(:cluster_agent) }
 
       it_behaves_like 'err result', expected_error_details: "Agent can't be blank"
     end
 
     context 'when namespace does not exist' do
+      # noinspection RubyResolve -- Rubymine isn't finding build_stubbed
       let_it_be(:namespace) { build_stubbed(:group) }
 
       it_behaves_like 'err result', expected_error_details: "Namespace can't be blank"
     end
 
     context 'when user does not exist' do
+      # noinspection RubyResolve -- Rubymine isn't finding build_stubbed
       let_it_be(:user) { build_stubbed(:user) }
 
       it_behaves_like 'err result', expected_error_details: "User can't be blank"
@@ -62,8 +65,10 @@
       expect(result.unwrap).to be_a(RemoteDevelopment::Messages::NamespaceClusterAgentMappingCreateSuccessful)
       new_mapping = result.unwrap.context[:namespace_cluster_agent_mapping]
 
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       expect(new_mapping.cluster_agent_id).to be(agent.id)
       expect(new_mapping.namespace_id).to be(namespace.id)
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       expect(new_mapping.creator_id).to be(user.id)
     end
   end

ee/spec/lib/remote_development/namespace_cluster_agent_mappings/delete/main_spec.rb

@@ -21,7 +21,7 @@
     end
 
     it "returns expected response" do
-      # noinspection RubyResolve -- TODO: open issue and add to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       expect do
         described_class.main(value_passed_along_steps)
       end
@@ -46,7 +46,7 @@
 
     shared_examples "rop invocation with error response" do
       it "returns expected response" do
-        # noinspection RubyResolve -- TODO: open issue and add to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues
+        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         expect do
           described_class.main(value_passed_along_steps)
         end

ee/spec/lib/remote_development/settings/main_spec.rb

@@ -28,7 +28,7 @@
     end
 
     it "returns expected response" do
-      # noinspection RubyResolve -- TODO: open issue and add to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       expect do
         described_class.get_settings(value_passed_along_steps)
       end
@@ -45,7 +45,7 @@
 
     shared_examples "rop invocation with error response" do
       it "returns expected response" do
-        # noinspection RubyResolve -- TODO: open issue and add to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues
+        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         expect do
           described_class.get_settings(value_passed_along_steps)
         end

ee/spec/lib/remote_development/workspaces/create/creator_spec.rb

@@ -53,7 +53,7 @@
     end
 
     it "returns expected response" do
-      # noinspection RubyResolve -- TODO: open issue and add to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       expect do
         described_class.create(initial_value)
       end
@@ -70,7 +70,7 @@
 
     shared_examples "rop invocation with error response" do
       it "returns expected response" do
-        # noinspection RubyResolve -- TODO: open issue and add to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues
+        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         expect do
           described_class.create(initial_value)
         end

ee/spec/lib/remote_development/workspaces/create/main_spec.rb

@@ -30,7 +30,7 @@
     end
 
     it "returns expected response" do
-      # noinspection RubyResolve -- TODO: open issue and add to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues
+      # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
       expect do
         described_class.main(value_passed_along_steps)
       end
@@ -53,7 +53,7 @@
 
     shared_examples "rop invocation with error response" do
       it "returns expected response" do
-        # noinspection RubyResolve -- TODO: open issue and add to https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues
+        # noinspection RubyResolve - https://handbook.gitlab.com/handbook/tools-and-tips/editors-and-ides/jetbrains-ides/tracked-jetbrains-issues/#ruby-31542
         expect do
           described_class.main(value_passed_along_steps)
         end