Merge pull request #726 from code0-tech/721-application-settings-and-metadata-should-be-nested-in-one-field-idk-why

Create an application type for metadata and version

Author: Taucher2003

app/graphql/types/application_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Types
+  class ApplicationType < Types::BaseObject
+    description 'Represents the application instance'
+
+    field :metadata, Types::MetadataType, null: false,
+                                          description: 'Metadata about the application'
+
+    field :settings, Types::ApplicationSettingsType, null: true,
+                                                     description: 'Global application settings'
+
+    def metadata
+      {}
+    end
+
+    def settings
+      ApplicationSetting.current
+    end
+  end
+end

app/graphql/types/metadata_type.rb

@@ -6,5 +6,13 @@ class MetadataType < Types::BaseObject
 
     field :extensions, [GraphQL::Types::String], null: false, description: 'List of loaded extensions'
     field :version, GraphQL::Types::String, null: false, description: 'Application version'
+
+    def extensions
+      Sagittarius::Extensions.active
+    end
+
+    def version
+      Sagittarius::Version
+    end
   end
 end

app/graphql/types/query_type.rb

@@ -19,10 +19,8 @@ class QueryType < Types::BaseObject
     field :current_user, Types::UserType, null: true, description: 'Get the currently logged in user'
     # rubocop:enable GraphQL/ExtractType
 
-    field :application_settings, Types::ApplicationSettingsType, null: true,
-                                                                 description: 'Get global application settings'
-
-    field :metadata, Types::MetadataType, null: false, description: 'Get application metadata'
+    field :application, Types::ApplicationType, null: false,
+                                                description: 'Get application information'
 
     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'
@@ -67,15 +65,8 @@ def nodes(ids:)
       ids.map { |id| context.schema.object_from_id(id, context) }
     end
 
-    def application_settings
-      ApplicationSetting.current
-    end
-
-    def metadata
-      {
-        version: Sagittarius::Version,
-        extensions: Sagittarius::Extensions.active.map(&:to_s),
-      }
+    def application
+      {}
     end
 
     def echo(message:)

docs/graphql/object/application.md

@@ -0,0 +1,13 @@
+---
+title: Application
+---
+
+Represents the application instance
+
+## Fields without arguments
+
+| Name | Type | Description |
+|------|------|-------------|
+| `metadata` | [`Metadata!`](../object/metadata.md) | Metadata about the application |
+| `settings` | [`ApplicationSettings`](../object/applicationsettings.md) | Global application settings |
+

docs/graphql/object/query.md

@@ -8,11 +8,10 @@ Root Query type
 
 | Name | Type | Description |
 |------|------|-------------|
-| `applicationSettings` | [`ApplicationSettings`](../object/applicationsettings.md) | Get global application settings |
+| `application` | [`Application!`](../object/application.md) | Get application information |
 | `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 |

spec/graphql/types/application_type_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe SagittariusSchema.types['Application'] do
+  let(:fields) do
+    %w[
+      settings
+      metadata
+    ]
+  end
+
+  it { expect(described_class.graphql_name).to eq('Application') }
+  it { expect(described_class).to have_graphql_fields(fields) }
+end

spec/graphql/types/query_type_spec.rb

@@ -5,11 +5,10 @@
 RSpec.describe SagittariusSchema.types['Query'] do
   let(:fields) do
     %w[
-      applicationSettings
+      application
       currentAuthentication
       currentUser
       echo
-      metadata
       organization
       organizations
       users

spec/requests/graphql/query/application_query_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'application Query' do
+  include GraphqlHelpers
+
+  let(:query) do
+    <<~QUERY
+      query {
+        application {
+          settings {
+            userRegistrationEnabled
+            organizationCreationRestricted
+          }
+          metadata {
+            version
+            extensions
+          }
+        }
+      }
+    QUERY
+  end
+
+  let(:current_user) { nil }
+
+  before do
+    post_graphql(query, current_user: current_user)
+  end
+
+  context 'when querying application settings' do
+    let(:current_user) { create(:user, :admin) }
+
+    it 'returns the application settings' do
+      settings = graphql_data_at(:application, :settings)
+
+      expect(settings['userRegistrationEnabled'])
+        .to eq(ApplicationSetting.current['user_registration_enabled'])
+      expect(settings['organizationCreationRestricted'])
+        .to eq(ApplicationSetting.current['organization_creation_restricted'])
+    end
+  end
+
+  it 'returns null application settings because of permissions' do
+    settings = graphql_data_at(:application, :settings)
+    expect(settings).to be_nil
+  end
+
+  it 'returns the application version' do
+    expect(graphql_data_at(:application, :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(:application, :metadata, :extensions)).to match_array(expected_extensions)
+  end
+
+  it 'does not require authentication' do
+    expect(graphql_errors).to be_nil
+  end
+end