feat: changes from code review

Author: raphael-goetz

app/graphql/types/query_type.rb

@@ -43,7 +43,7 @@ class QueryType < Types::BaseObject
     field :users, Types::UserType.connection_type, null: false, description: 'Find users'
 
     field :global_runtimes, Types::RuntimeType.connection_type, null: false, description: 'Find runtimes'
-    field :velorum_models, [Types::VelorumModelType], null: false, description: 'Find models available through Velorum'
+    field :velorum, Types::VelorumType, null: false, description: 'Get Velorum information'
 
     def application
       {}
@@ -87,8 +87,8 @@ def global_runtimes
       Runtime.where(namespace: nil)
     end
 
-    def velorum_models
-      ::Velorum::ModelsService.new.execute
+    def velorum
+      {}
     end
 
     def current_authentication

app/graphql/types/velorum_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Types
+  class VelorumType < Types::BaseObject
+    description 'Represents Velorum integration information'
+
+    field :enabled, Boolean, null: false, description: 'Whether Velorum is enabled'
+    field :models, [Types::VelorumModelType], null: false, description: 'Find models available through Velorum'
+
+    def enabled
+      config[:enabled]
+    end
+
+    def models
+      ::Velorum::ModelsService.new(config: config).execute
+    end
+
+    private
+
+    def config
+      Sagittarius::Configuration.config[:velorum]
+    end
+  end
+end

app/services/velorum/models_service.rb

@@ -8,12 +8,7 @@ def initialize(client: nil, config: Sagittarius::Configuration.config[:velorum])
     end
 
     def execute
-      unless config[:enabled]
-        raise GraphQL::ExecutionError.new(
-          'Velorum is disabled',
-          extensions: { code: 'VELORUM_DISABLED' }
-        )
-      end
+      return [] unless config[:enabled]
 
       client.models.models
     end

config/sagittarius.example.yml

@@ -29,7 +29,7 @@ rails:
 velorum:
   enabled: true
   host: 'localhost:50052'
-  security_token:
+  jwt_secret:
   jwt_ttl_minutes: 8
 
 application_setting_overrides: {}

docs/graphql/object/query.md

@@ -14,7 +14,7 @@ Root Query type
 | `globalRuntimes` | [`RuntimeConnection!`](../object/runtimeconnection.md) | Find runtimes |
 | `organizations` | [`OrganizationConnection!`](../object/organizationconnection.md) | Find organizations |
 | `users` | [`UserConnection!`](../object/userconnection.md) | Find users |
-| `velorumModels` | [`[VelorumModel!]!`](../object/velorummodel.md) | Find models available through Velorum |
+| `velorum` | [`Velorum!`](../object/velorum.md) | Get Velorum information |
 
 ## Fields with arguments
 

docs/graphql/object/velorum.md

@@ -0,0 +1,12 @@
+---
+title: Velorum
+---
+
+Represents Velorum integration information
+
+## Fields without arguments
+
+| Name | Type | Description |
+|------|------|-------------|
+| `enabled` | [`Boolean!`](../scalar/boolean.md) | Whether Velorum is enabled |
+| `models` | [`[VelorumModel!]!`](../object/velorummodel.md) | Find models available through Velorum |

lib/sagittarius/configuration.rb

@@ -55,7 +55,7 @@ def self.defaults
         velorum: {
           enabled: true,
           host: 'localhost:50052',
-          security_token: nil,
+          jwt_secret: nil,
           jwt_ttl_minutes: 8,
         },
         application_setting_overrides: {},

lib/sagittarius/velorum/client.rb

@@ -1,19 +1,15 @@
 # frozen_string_literal: true
 
-require 'base64'
-require 'json'
-require 'openssl'
-
 module Sagittarius
   module Velorum
     class Client
       def initialize(
         host: Sagittarius::Configuration.config[:velorum][:host],
-        security_token: ENV.fetch('VELORUM_SECURITY_TOKEN', Sagittarius::Configuration.config[:velorum][:security_token]),
+        jwt_secret: Sagittarius::Configuration.config[:velorum][:jwt_secret],
         jwt_ttl_minutes: Sagittarius::Configuration.config[:velorum][:jwt_ttl_minutes]
       )
         @host = host
-        @security_token = security_token
+        @jwt_secret = jwt_secret
         @jwt_ttl_minutes = jwt_ttl_minutes
       end
 
@@ -23,7 +19,7 @@ def models
 
       private
 
-      attr_reader :host, :security_token, :jwt_ttl_minutes
+      attr_reader :host, :jwt_secret, :jwt_ttl_minutes
 
       def stub
         @stub ||= Tucana::Velorum::InfoService::Stub.new(host, :this_channel_is_insecure)
@@ -36,9 +32,7 @@ def authentication_metadata
       end
 
       def jwt
-        if security_token.to_s.empty?
-          raise ArgumentError, 'VELORUM_SECURITY_TOKEN or velorum.security_token must be configured'
-        end
+        raise ArgumentError, 'velorum.jwt_secret must be configured' if jwt_secret.to_s.empty?
 
         header = {
           alg: 'HS256',
@@ -50,7 +44,7 @@ def jwt
           exp: now + jwt_ttl_minutes.to_i.minutes.to_i,
         }
         body = [header, payload].map { |part| base64_url_encode(part.to_json) }.join('.')
-        signature = OpenSSL::HMAC.digest('SHA256', security_token, body)
+        signature = OpenSSL::HMAC.digest('SHA256', jwt_secret, body)
 
         "#{body}.#{base64_url_encode(signature)}"
       end

spec/graphql/types/query_type_spec.rb

@@ -14,7 +14,7 @@
       users
       user
       global_runtimes
-      velorum_models
+      velorum
       namespace
     ]
   end

spec/graphql/types/velorum_type_spec.rb

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