Merge branch 'ajk-globalid-metrics' into 'master'

[GraphQL] Metrics: use Global-ID scalar

See merge request gitlab-org/gitlab!36100

app/graphql/mutations/metrics/dashboard/annotations/delete.rb

@@ -9,8 +9,7 @@ module Mutations
 
           authorize :delete_metrics_dashboard_annotation
 
-          argument :id,
-                  GraphQL::ID_TYPE,
+          argument :id, ::Types::GlobalIDType[::Metrics::Dashboard::Annotation],
                   required: true,
                   description: 'The global ID of the annotation to delete'
 

doc/api/graphql/reference/gitlab_schema.graphql

@@ -5265,7 +5265,7 @@ input DeleteAnnotationInput {
   """
   The global ID of the annotation to delete
   """
-  id: ID!
+  id: MetricsDashboardAnnotationID!
 }
 
 """
@@ -13465,6 +13465,11 @@ type MetricsDashboardAnnotationEdge {
   node: MetricsDashboardAnnotation
 }
 
+"""
+Identifier of Metrics::Dashboard::Annotation
+"""
+scalar MetricsDashboardAnnotationID
+
 """
 Represents a milestone
 """

doc/api/graphql/reference/gitlab_schema.json

@@ -14404,7 +14404,7 @@
                 "name": null,
                 "ofType": {
                   "kind": "SCALAR",
-                  "name": "ID",
+                  "name": "MetricsDashboardAnnotationID",
                   "ofType": null
                 }
               },
@@ -37039,6 +37039,16 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "SCALAR",
+          "name": "MetricsDashboardAnnotationID",
+          "description": "Identifier of Metrics::Dashboard::Annotation",
+          "fields": null,
+          "inputFields": null,
+          "interfaces": null,
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "OBJECT",
           "name": "Milestone",

spec/requests/api/graphql/mutations/metrics/dashboard/annotations/create_spec.rb

@@ -101,9 +101,7 @@ RSpec.describe Mutations::Metrics::Dashboard::Annotations::Create do
           graphql_mutation(:create_annotation, variables)
         end
 
-        it_behaves_like 'a mutation that returns top-level errors' do
-          let(:match_errors) { include(/is not a valid Global ID/) }
-        end
+        it_behaves_like 'an invalid argument to the mutation', argument_name: :environment_id
       end
     end
   end
@@ -190,9 +188,7 @@ RSpec.describe Mutations::Metrics::Dashboard::Annotations::Create do
         graphql_mutation(:create_annotation, variables)
       end
 
-      it_behaves_like 'a mutation that returns top-level errors' do
-        let(:match_errors) { include(/is not a valid Global ID/) }
-      end
+      it_behaves_like 'an invalid argument to the mutation', argument_name: :cluster_id
     end
   end
 
@@ -213,35 +209,26 @@ RSpec.describe Mutations::Metrics::Dashboard::Annotations::Create do
     it_behaves_like 'a mutation that returns top-level errors', errors: [described_class::ANNOTATION_SOURCE_ARGUMENT_ERROR]
   end
 
-  context 'when a non-cluster or environment id is provided' do
-    let(:gid) { { environment_id: project.to_global_id.to_s } }
-    let(:mutation) do
-      variables = {
-        starting_at: starting_at,
-        ending_at: ending_at,
-        dashboard_path: dashboard_path,
-        description: description
-      }.merge!(gid)
-
-      graphql_mutation(:create_annotation, variables)
-    end
-
-    before do
-      project.add_developer(current_user)
-    end
+  [:environment_id, :cluster_id].each do |arg_name|
+    context "when #{arg_name} is given an ID of the wrong type" do
+      let(:gid) { global_id_of(project) }
+      let(:mutation) do
+        variables = {
+          starting_at: starting_at,
+          ending_at: ending_at,
+          dashboard_path: dashboard_path,
+          description: description,
+          arg_name => gid
+        }
 
-    describe 'non-environment id' do
-      it_behaves_like 'a mutation that returns top-level errors' do
-        let(:match_errors) { include(/does not represent an instance of Environment/) }
+        graphql_mutation(:create_annotation, variables)
       end
-    end
-
-    describe 'non-cluster id' do
-      let(:gid) { { cluster_id: project.to_global_id.to_s } }
 
-      it_behaves_like 'a mutation that returns top-level errors' do
-        let(:match_errors) { include(/does not represent an instance of Clusters::Cluster/) }
+      before do
+        project.add_developer(current_user)
       end
+
+      it_behaves_like 'an invalid argument to the mutation', argument_name: arg_name
     end
   end
 end

spec/requests/api/graphql/mutations/metrics/dashboard/annotations/delete_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe Mutations::Metrics::Dashboard::Annotations::Delete do
       let(:variables) { { id: GitlabSchema.id_from_object(project).to_s } }
 
       it_behaves_like 'a mutation that returns top-level errors' do
-        let(:match_errors) { eq(["#{variables[:id]} is not a valid ID for #{annotation.class}."]) }
+        let(:match_errors) { contain_exactly(include('invalid value for id')) }
       end
     end