Merge pull request #696 from code0-tech/copilot/add-metadata-to-graphql

Add metadata query to GraphQL API

Author: Taucher2003

VERSION

@@ -0,0 +1 @@
+0.0.0

app/graphql/types/metadata_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Types
+  class MetadataType < Types::BaseObject
+    description 'Application metadata'
+
+    field :extensions, [GraphQL::Types::String], null: false, description: 'List of loaded extensions'
+    field :version, GraphQL::Types::String, null: false, description: 'Application version'
+  end
+end

app/graphql/types/query_type.rb

@@ -22,6 +22,8 @@ class QueryType < Types::BaseObject
     field :application_settings, Types::ApplicationSettingsType, null: true,
                                                                  description: 'Get global application settings'
 
+    field :metadata, Types::MetadataType, null: false, description: 'Get application metadata'
+
     field :echo, GraphQL::Types::String, null: false, description: 'Field available for use to test API access' do
       argument :message, GraphQL::Types::String, required: true, description: 'String to echo as response'
     end
@@ -65,6 +67,13 @@ def application_settings
       ApplicationSetting.current
     end
 
+    def metadata
+      {
+        version: Sagittarius::Version,
+        extensions: Sagittarius::Extensions.active.map(&:to_s),
+      }
+    end
+
     def echo(message:)
       message
     end

config/application.rb

@@ -11,6 +11,7 @@
 require_relative '../lib/sagittarius/utils'
 require_relative '../lib/sagittarius/extensions'
 require_relative '../lib/sagittarius/configuration'
+require_relative '../lib/sagittarius/version'
 
 module Sagittarius
   class Application < Rails::Application

docs/graphql/object/metadata.md

@@ -0,0 +1,13 @@
+---
+title: Metadata
+---
+
+Application metadata
+
+## Fields without arguments
+
+| Name | Type | Description |
+|------|------|-------------|
+| `extensions` | [`[String!]!`](../scalar/string.md) | List of loaded extensions |
+| `version` | [`String!`](../scalar/string.md) | Application version |
+

docs/graphql/object/query.md

@@ -12,6 +12,7 @@ Root Query type
 | `currentAuthentication` | [`Authentication`](../union/authentication.md) | Get the currently logged in authentication |
 | `currentUser` | [`User`](../object/user.md) | Get the currently logged in user |
 | `globalRuntimes` | [`RuntimeConnection!`](../object/runtimeconnection.md) | Find runtimes |
+| `metadata` | [`Metadata!`](../object/metadata.md) | Get application metadata |
 | `organizations` | [`OrganizationConnection!`](../object/organizationconnection.md) | Find organizations |
 | `userAbilities` | [`InstanceUserAbilities!`](../object/instanceuserabilities.md) | Abilities for the current user on this Instance |
 | `users` | [`UserConnection!`](../object/userconnection.md) | Find users |

lib/sagittarius/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sagittarius
+  Version = File.read(File.expand_path('../../VERSION', __dir__)).strip.freeze
+end

spec/graphql/types/metadata_type_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Types::MetadataType do
+  let(:fields) do
+    %w[
+      version
+      extensions
+    ]
+  end
+
+  it { expect(described_class.graphql_name).to eq('Metadata') }
+  it { expect(described_class).to have_graphql_fields(fields) }
+end

spec/graphql/types/query_type_spec.rb

@@ -9,6 +9,7 @@
       currentAuthentication
       currentUser
       echo
+      metadata
       organization
       organizations
       users

spec/requests/graphql/query/metadata_query_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'metadata Query' do
+  include GraphqlHelpers
+
+  let(:query) do
+    <<~QUERY
+      query {
+        metadata {
+          version
+          extensions
+        }
+      }
+    QUERY
+  end
+
+  before { post_graphql query }
+
+  it 'returns the application version' do
+    expect(graphql_data_at(:metadata, :version)).to eq(Sagittarius::Version)
+  end
+
+  it 'returns the list of active extensions' do
+    expected_extensions = Sagittarius::Extensions.active.map(&:to_s)
+    expect(graphql_data_at(:metadata, :extensions)).to match_array(expected_extensions)
+  end
+
+  it 'does not require authentication' do
+    expect(graphql_errors).to be_nil
+  end
+end