Merge branch 'pedropombeiro/344918/graphql-deprecate-runner-active-filter' into 'master'

GraphQL: Deprecate active filter for Runners resolver

See merge request gitlab-org/gitlab!79018

app/graphql/resolvers/ci/runners_resolver.rb

@@ -9,7 +9,12 @@ module Resolvers
 
       argument :active, ::GraphQL::Types::Boolean,
                required: false,
-               description: 'Filter runners by active (true) or paused (false) status.'
+               description: 'Filter runners by `active` (true) or `paused` (false) status.',
+               deprecated: { reason: :renamed, replacement: 'paused', milestone: '14.8' }
+
+      argument :paused, ::GraphQL::Types::Boolean,
+               required: false,
+               description: 'Filter runners by `paused` (true) or `active` (false) status.'
 
       argument :status, ::Types::Ci::RunnerStatusEnum,
                required: false,
@@ -41,8 +46,11 @@ module Resolvers
       protected
 
       def runners_finder_params(params)
+        # Give preference to paused argument over the deprecated 'active' argument
+        paused = params.fetch(:paused, params[:active] ? !params[:active] : nil)
+
         {
-          active: params[:active],
+          active: paused.nil? ? nil : !paused,
           status_status: params[:status]&.to_s,
           type_type: params[:type],
           tag_name: params[:tag_list],

doc/api/graphql/reference/index.md

@@ -376,7 +376,8 @@ four standard [pagination arguments](#connection-pagination-arguments):
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
-| <a id="queryrunnersactive"></a>`active` | [`Boolean`](#boolean) | Filter runners by active (true) or paused (false) status. |
+| <a id="queryrunnersactive"></a>`active` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated** in 14.8. This was renamed. Use: `paused`. |
+| <a id="queryrunnerspaused"></a>`paused` | [`Boolean`](#boolean) | Filter runners by `paused` (true) or `active` (false) status. |
 | <a id="queryrunnerssearch"></a>`search` | [`String`](#string) | Filter by full token or partial text in description field. |
 | <a id="queryrunnerssort"></a>`sort` | [`CiRunnerSort`](#cirunnersort) | Sort order of results. |
 | <a id="queryrunnersstatus"></a>`status` | [`CiRunnerStatus`](#cirunnerstatus) | Filter runners by status. |
@@ -11213,8 +11214,9 @@ four standard [pagination arguments](#connection-pagination-arguments):
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
-| <a id="grouprunnersactive"></a>`active` | [`Boolean`](#boolean) | Filter runners by active (true) or paused (false) status. |
+| <a id="grouprunnersactive"></a>`active` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated** in 14.8. This was renamed. Use: `paused`. |
 | <a id="grouprunnersmembership"></a>`membership` | [`RunnerMembershipFilter`](#runnermembershipfilter) | Control which runners to include in the results. |
+| <a id="grouprunnerspaused"></a>`paused` | [`Boolean`](#boolean) | Filter runners by `paused` (true) or `active` (false) status. |
 | <a id="grouprunnerssearch"></a>`search` | [`String`](#string) | Filter by full token or partial text in description field. |
 | <a id="grouprunnerssort"></a>`sort` | [`CiRunnerSort`](#cirunnersort) | Sort order of results. |
 | <a id="grouprunnersstatus"></a>`status` | [`CiRunnerStatus`](#cirunnerstatus) | Filter runners by status. |

spec/graphql/resolvers/ci/runners_resolver_spec.rb

@@ -43,34 +43,99 @@ RSpec.describe Resolvers::Ci::RunnersResolver do
     # Only thing we can do is to verify that args from the resolver is correctly transformed to params of the Finder and we return the Finder's result back.
     describe 'Allowed query arguments' do
       let(:finder) { instance_double(::Ci::RunnersFinder) }
-      let(:args) do
-        {
-          active: true,
-          status: 'active',
-          type: :instance_type,
-          tag_list: ['active_runner'],
-          search: 'abc',
-          sort: :contacted_asc
-        }
+
+      context 'with active filter' do
+        let(:args) do
+          {
+            active: true,
+            status: 'active',
+            type: :instance_type,
+            tag_list: ['active_runner'],
+            search: 'abc',
+            sort: :contacted_asc
+          }
+        end
+
+        let(:expected_params) do
+          {
+            active: true,
+            status_status: 'active',
+            type_type: :instance_type,
+            tag_name: ['active_runner'],
+            preload: { tag_name: nil },
+            search: 'abc',
+            sort: 'contacted_asc'
+          }
+        end
+
+        it 'calls RunnersFinder with expected arguments' do
+          expect(::Ci::RunnersFinder).to receive(:new).with(current_user: user, params: expected_params).once.and_return(finder)
+          allow(finder).to receive(:execute).once.and_return([:execute_return_value])
+
+          expect(subject.items.to_a).to eq([:execute_return_value])
+        end
+      end
+
+      context 'with both active and paused filter' do
+        let(:args) do
+          {
+            active: true,
+            paused: true
+          }
+        end
+
+        let(:expected_params) do
+          {
+            active: false,
+            preload: { tag_name: nil }
+          }
+        end
+
+        it 'calls RunnersFinder with expected arguments' do
+          expect(::Ci::RunnersFinder).to receive(:new).with(current_user: user, params: expected_params).once.and_return(finder)
+          allow(finder).to receive(:execute).once.and_return([:execute_return_value])
+
+          expect(subject.items.to_a).to eq([:execute_return_value])
+        end
       end
 
-      let(:expected_params) do
-        {
-          active: true,
-          status_status: 'active',
-          type_type: :instance_type,
-          tag_name: ['active_runner'],
-          preload: { tag_name: nil },
-          search: 'abc',
-          sort: 'contacted_asc'
-        }
+      context 'with paused filter' do
+        let(:args) do
+          { paused: true }
+        end
+
+        let(:expected_params) do
+          {
+            active: false,
+            preload: { tag_name: nil }
+          }
+        end
+
+        it 'calls RunnersFinder with expected arguments' do
+          expect(::Ci::RunnersFinder).to receive(:new).with(current_user: user, params: expected_params).once.and_return(finder)
+          allow(finder).to receive(:execute).once.and_return([:execute_return_value])
+
+          expect(subject.items.to_a).to eq([:execute_return_value])
+        end
       end
 
-      it 'calls RunnersFinder with expected arguments' do
-        allow(::Ci::RunnersFinder).to receive(:new).with(current_user: user, params: expected_params).once.and_return(finder)
-        allow(finder).to receive(:execute).once.and_return([:execute_return_value])
+      context 'with neither paused or active filters' do
+        let(:args) do
+          {}
+        end
+
+        let(:expected_params) do
+          {
+            preload: { tag_name: nil }
+          }
+        end
+
+        it 'calls RunnersFinder with expected arguments' do
+          expect(::Ci::RunnersFinder).to receive(:new).with(current_user: user, params: expected_params).once.and_return(finder)
+          allow(finder).to receive(:execute).once.and_return([:execute_return_value])
 
-        expect(subject.items.to_a).to eq([:execute_return_value])
+          expect(subject.items.to_a).to eq([:execute_return_value])
+        end
       end
     end
   end