Merge branch 'alexives/263792/add_graphql_for_snippet_replication' into 'master'

Add graphql Api for Snippet Replication

See merge request gitlab-org/gitlab!47448

doc/api/graphql/reference/gitlab_schema.graphql

@@ -8416,6 +8416,37 @@ type GeoNode {
   """
   selectiveSyncType: String
 
+  """
+  Find snippet repository registries on this Geo node. Available only when
+  feature flag `geo_snippet_repository_replication` is enabled
+  """
+  snippetRepositoryRegistries(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Filters registries by their ID
+    """
+    ids: [ID!]
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+  ): SnippetRepositoryRegistryConnection
+
   """
   Indicates if this secondary node will replicate blobs in Object Storage
   """
@@ -20545,6 +20576,86 @@ type SnippetPermissions {
   updateSnippet: Boolean!
 }
 
+"""
+Represents the Geo sync and verification state of a snippet repository
+"""
+type SnippetRepositoryRegistry {
+  """
+  Timestamp when the SnippetRepositoryRegistry was created
+  """
+  createdAt: Time
+
+  """
+  ID of the SnippetRepositoryRegistry
+  """
+  id: ID!
+
+  """
+  Error message during sync of the SnippetRepositoryRegistry
+  """
+  lastSyncFailure: String
+
+  """
+  Timestamp of the most recent successful sync of the SnippetRepositoryRegistry
+  """
+  lastSyncedAt: Time
+
+  """
+  Timestamp after which the SnippetRepositoryRegistry should be resynced
+  """
+  retryAt: Time
+
+  """
+  Number of consecutive failed sync attempts of the SnippetRepositoryRegistry
+  """
+  retryCount: Int
+
+  """
+  ID of the Snippet Repository
+  """
+  snippetRepositoryId: ID!
+
+  """
+  Sync state of the SnippetRepositoryRegistry
+  """
+  state: RegistryState
+}
+
+"""
+The connection type for SnippetRepositoryRegistry.
+"""
+type SnippetRepositoryRegistryConnection {
+  """
+  A list of edges.
+  """
+  edges: [SnippetRepositoryRegistryEdge]
+
+  """
+  A list of nodes.
+  """
+  nodes: [SnippetRepositoryRegistry]
+
+  """
+  Information to aid in pagination.
+  """
+  pageInfo: PageInfo!
+}
+
+"""
+An edge in a connection.
+"""
+type SnippetRepositoryRegistryEdge {
+  """
+  A cursor for use in pagination.
+  """
+  cursor: String!
+
+  """
+  The item at the end of the edge.
+  """
+  node: SnippetRepositoryRegistry
+}
+
 """
 Common sort values
 """

doc/api/graphql/reference/gitlab_schema.json

@@ -23361,6 +23361,77 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "snippetRepositoryRegistries",
+              "description": "Find snippet repository registries on this Geo node. Available only when feature flag `geo_snippet_repository_replication` is enabled",
+              "args": [
+                {
+                  "name": "ids",
+                  "description": "Filters registries by their ID",
+                  "type": {
+                    "kind": "LIST",
+                    "name": null,
+                    "ofType": {
+                      "kind": "NON_NULL",
+                      "name": null,
+                      "ofType": {
+                        "kind": "SCALAR",
+                        "name": "ID",
+                        "ofType": null
+                      }
+                    }
+                  },
+                  "defaultValue": null
+                },
+                {
+                  "name": "after",
+                  "description": "Returns the elements in the list that come after the specified cursor.",
+                  "type": {
+                    "kind": "SCALAR",
+                    "name": "String",
+                    "ofType": null
+                  },
+                  "defaultValue": null
+                },
+                {
+                  "name": "before",
+                  "description": "Returns the elements in the list that come before the specified cursor.",
+                  "type": {
+                    "kind": "SCALAR",
+                    "name": "String",
+                    "ofType": null
+                  },
+                  "defaultValue": null
+                },
+                {
+                  "name": "first",
+                  "description": "Returns the first _n_ elements from the list.",
+                  "type": {
+                    "kind": "SCALAR",
+                    "name": "Int",
+                    "ofType": null
+                  },
+                  "defaultValue": null
+                },
+                {
+                  "name": "last",
+                  "description": "Returns the last _n_ elements from the list.",
+                  "type": {
+                    "kind": "SCALAR",
+                    "name": "Int",
+                    "ofType": null
+                  },
+                  "defaultValue": null
+                }
+              ],
+              "type": {
+                "kind": "OBJECT",
+                "name": "SnippetRepositoryRegistryConnection",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "syncObjectStorage",
               "description": "Indicates if this secondary node will replicate blobs in Object Storage",
@@ -59635,6 +59706,251 @@
           "enumValues": null,
           "possibleTypes": null
         },
+        {
+          "kind": "OBJECT",
+          "name": "SnippetRepositoryRegistry",
+          "description": "Represents the Geo sync and verification state of a snippet repository",
+          "fields": [
+            {
+              "name": "createdAt",
+              "description": "Timestamp when the SnippetRepositoryRegistry was created",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Time",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "id",
+              "description": "ID of the SnippetRepositoryRegistry",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "ID",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "lastSyncFailure",
+              "description": "Error message during sync of the SnippetRepositoryRegistry",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "lastSyncedAt",
+              "description": "Timestamp of the most recent successful sync of the SnippetRepositoryRegistry",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Time",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "retryAt",
+              "description": "Timestamp after which the SnippetRepositoryRegistry should be resynced",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Time",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "retryCount",
+              "description": "Number of consecutive failed sync attempts of the SnippetRepositoryRegistry",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Int",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "snippetRepositoryId",
+              "description": "ID of the Snippet Repository",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "ID",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "state",
+              "description": "Sync state of the SnippetRepositoryRegistry",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "ENUM",
+                "name": "RegistryState",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [
+
+          ],
+          "enumValues": null,
+          "possibleTypes": null
+        },
+        {
+          "kind": "OBJECT",
+          "name": "SnippetRepositoryRegistryConnection",
+          "description": "The connection type for SnippetRepositoryRegistry.",
+          "fields": [
+            {
+              "name": "edges",
+              "description": "A list of edges.",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "LIST",
+                "name": null,
+                "ofType": {
+                  "kind": "OBJECT",
+                  "name": "SnippetRepositoryRegistryEdge",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "nodes",
+              "description": "A list of nodes.",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "LIST",
+                "name": null,
+                "ofType": {
+                  "kind": "OBJECT",
+                  "name": "SnippetRepositoryRegistry",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "pageInfo",
+              "description": "Information to aid in pagination.",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "OBJECT",
+                  "name": "PageInfo",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [
+
+          ],
+          "enumValues": null,
+          "possibleTypes": null
+        },
+        {
+          "kind": "OBJECT",
+          "name": "SnippetRepositoryRegistryEdge",
+          "description": "An edge in a connection.",
+          "fields": [
+            {
+              "name": "cursor",
+              "description": "A cursor for use in pagination.",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "String",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "node",
+              "description": "The item at the end of the edge.",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "OBJECT",
+                "name": "SnippetRepositoryRegistry",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            }
+          ],
+          "inputFields": null,
+          "interfaces": [
+
+          ],
+          "enumValues": null,
+          "possibleTypes": null
+        },
         {
           "kind": "ENUM",
           "name": "Sort",

doc/api/graphql/reference/index.md

@@ -1384,6 +1384,7 @@ Autogenerated return type of EpicTreeReorder.
 | `selectiveSyncNamespaces` | NamespaceConnection | The namespaces that should be synced, if `selective_sync_type` == `namespaces` |
 | `selectiveSyncShards` | String! => Array | The repository storages whose projects should be synced, if `selective_sync_type` == `shards` |
 | `selectiveSyncType` | String | Indicates if syncing is limited to only specific groups, or shards |
+| `snippetRepositoryRegistries` | SnippetRepositoryRegistryConnection | Find snippet repository registries on this Geo node. Available only when feature flag `geo_snippet_repository_replication` is enabled |
 | `syncObjectStorage` | Boolean | Indicates if this secondary node will replicate blobs in Object Storage |
 | `terraformStateVersionRegistries` | TerraformStateVersionRegistryConnection | Find terraform state version registries on this Geo node |
 | `url` | String | The user-facing URL for this Geo node |
@@ -2990,6 +2991,21 @@ Represents how the blob content should be displayed.
 | `reportSnippet` | Boolean! | Indicates the user can perform `report_snippet` on this resource |
 | `updateSnippet` | Boolean! | Indicates the user can perform `update_snippet` on this resource |
 
+### SnippetRepositoryRegistry
+
+Represents the Geo sync and verification state of a snippet repository.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `createdAt` | Time | Timestamp when the SnippetRepositoryRegistry was created |
+| `id` | ID! | ID of the SnippetRepositoryRegistry |
+| `lastSyncFailure` | String | Error message during sync of the SnippetRepositoryRegistry |
+| `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the SnippetRepositoryRegistry |
+| `retryAt` | Time | Timestamp after which the SnippetRepositoryRegistry should be resynced |
+| `retryCount` | Int | Number of consecutive failed sync attempts of the SnippetRepositoryRegistry |
+| `snippetRepositoryId` | ID! | ID of the Snippet Repository |
+| `state` | RegistryState | Sync state of the SnippetRepositoryRegistry |
+
 ### StatusAction
 
 | Field | Type | Description |

ee/app/finders/geo/snippet_repository_registry_finder.rb

+# frozen_string_literal: true
+
+module Geo
+  class SnippetRepositoryRegistryFinder
+    include FrameworkRegistryFinder
+  end
+end

ee/app/graphql/resolvers/geo/snippet_repository_registries_resolver.rb

+# frozen_string_literal: true
+
+module Resolvers
+  module Geo
+    class SnippetRepositoryRegistriesResolver < BaseResolver
+      type ::Types::Geo::GeoNodeType.connection_type, null: true
+
+      include RegistriesResolver
+    end
+  end
+end

ee/app/graphql/types/geo/geo_node_type.rb

@@ -30,6 +30,11 @@ module Types
             null: true,
             resolver: ::Resolvers::Geo::PackageFileRegistriesResolver,
             description: 'Package file registries of the GeoNode'
+      field :snippet_repository_registries, ::Types::Geo::SnippetRepositoryRegistryType.connection_type,
+            null: true,
+            resolver: ::Resolvers::Geo::SnippetRepositoryRegistriesResolver,
+            description: 'Find snippet repository registries on this Geo node',
+            feature_flag: :geo_snippet_repository_replication
       field :terraform_state_version_registries, ::Types::Geo::TerraformStateVersionRegistryType.connection_type,
             null: true,
             resolver: ::Resolvers::Geo::TerraformStateVersionRegistriesResolver,

ee/app/graphql/types/geo/snippet_repository_registry_type.rb

+# frozen_string_literal: true
+
+module Types
+  module Geo
+    # rubocop:disable Graphql/AuthorizeTypes because it is included
+    class SnippetRepositoryRegistryType < BaseObject
+      include ::Types::Geo::RegistryType
+
+      graphql_name 'SnippetRepositoryRegistry'
+      description 'Represents the Geo sync and verification state of a snippet repository'
+
+      field :snippet_repository_id, GraphQL::ID_TYPE, null: false, description: 'ID of the Snippet Repository'
+    end
+  end
+end

ee/changelogs/unreleased/alexives-263792-add_graphql_for_snippet_repository_replication.yml

+---
+title: Add graphql for snippet registries
+merge_request: 47448
+author:
+type: added

ee/spec/finders/geo/snippet_repository_registry_finder_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Geo::SnippetRepositoryRegistryFinder do
+  it_behaves_like 'a framework registry finder', :geo_snippet_repository_registry
+end

ee/spec/graphql/resolvers/geo/snippet_repository_registries_resolver_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Resolvers::Geo::SnippetRepositoryRegistriesResolver do
+  it_behaves_like 'a Geo registries resolver', :geo_snippet_repository_registry
+end

ee/spec/graphql/types/geo/geo_node_type_spec.rb

@@ -12,7 +12,8 @@ RSpec.describe GitlabSchema.types['GeoNode'] do
       container_repositories_max_capacity sync_object_storage
       selective_sync_type selective_sync_shards selective_sync_namespaces
       minimum_reverification_interval merge_request_diff_registries
-      package_file_registries terraform_state_version_registries
+      package_file_registries snippet_repository_registries
+      terraform_state_version_registries
     ]
 
     expect(described_class).to have_graphql_fields(*expected_fields)

ee/spec/requests/api/graphql/geo/registries_spec.rb

@@ -17,6 +17,13 @@ RSpec.describe 'Gets registries' do
     registry_foreign_key_field_name: 'packageFileId'
   }
 
+  it_behaves_like 'gets registries for', {
+    field_name: 'snippetRepositoryRegistries',
+    registry_class_name: 'SnippetRepositoryRegistry',
+    registry_factory: :geo_snippet_repository_registry,
+    registry_foreign_key_field_name: 'snippetRepositoryId'
+  }
+
   it_behaves_like 'gets registries for', {
     field_name: 'terraformStateVersionRegistries',
     registry_class_name: 'TerraformStateVersionRegistry',