Merge pull request #780 from code0-tech/615-last-seen-online-field-for-runtime

Detailed statuses for runtimes

Author: Taucher2003

app/graphql/types/runtime_connection_status_enum.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Types
+  class RuntimeConnectionStatusEnum < BaseEnum
+    description 'Represent all available aquila statuses'
+
+    value :CONNECTED, 'No problem with the connection to aquila', value: :connected
+    value :DISCONNECTED, 'The runtime is disconnected, cause unknown', value: :disconnected
+  end
+end

app/graphql/types/runtime_feature_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Types
+  class RuntimeFeatureType < Types::BaseObject
+    description 'Represents a runtime feature'
+
+    authorize :read_runtime
+
+    field :runtime_status, Types::RuntimeStatusType,
+          null: false, description: 'The runtime status this feature belongs to'
+
+    field :descriptions, [Types::TranslationType], null: true, description: 'Description of the function'
+    field :names, [Types::TranslationType], null: true, description: 'Name of the function'
+
+    id_field RuntimeFeature
+    timestamps
+  end
+end

app/graphql/types/runtime_status_configuration_endpoint_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Types
+  class RuntimeStatusConfigurationEndpointType < Types::BaseObject
+    description 'Detailed information about a runtime status'
+
+    authorize :read_runtime
+
+    field :endpoint, String, null: false, description: 'The endpoint URL of the runtime'
+
+    id_field ::RuntimeStatusConfiguration
+    timestamps
+  end
+end

app/graphql/types/runtime_status_configuration_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Types
+  class RuntimeStatusConfigurationType < Types::BaseUnion
+    description 'Detailed configuration about a runtime status, either: endpoint, ...'
+
+    possible_types Types::RuntimeStatusConfigurationEndpointType
+
+    def self.resolve_type(object, _context)
+      return Types::RuntimeStatusConfigurationEndpointType if object.endpoint.present?
+
+      raise "Unknown RuntimeStatusInformation type: #{object.class.name}"
+    end
+  end
+end

app/graphql/types/runtime_status_status_enum.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Types
+  class RuntimeStatusStatusEnum < Types::BaseEnum
+    description 'The enum status of the detailed status'
+
+    value :NOT_RESPONDING, 'The runtime is not responding to heartbeats', value: 'not_responding'
+    value :NOT_READY, 'The runtime is not ready to compute stuff', value: 'not_ready'
+    value :RUNNING, 'The runtime is running and healthy', value: 'running'
+    value :STOPPED, 'The runtime has been stopped', value: 'stopped'
+  end
+end

app/graphql/types/runtime_status_type.rb

@@ -1,10 +1,33 @@
 # frozen_string_literal: true
 
 module Types
-  class RuntimeStatusType < BaseEnum
-    description 'Represent all available types of statuses of a runtime'
+  class RuntimeStatusType < Types::BaseObject
+    description 'A runtime status information entry'
 
-    value :CONNECTED, 'No problem with connection, everything works as expected', value: 'connected'
-    value :DISCONNECTED, 'The runtime is disconnected, cause unknown', value: 'disconnected'
+    authorize :read_runtime
+
+    field :configurations, Types::RuntimeStatusConfigurationType.connection_type,
+          null: false,
+          description: 'The detailed configuration entries for this runtime status (only for adapters)',
+          method: :runtime_status_configurations
+    field :identifier, String,
+          null: false,
+          description: 'The unique identifier for this runtime status'
+    field :last_heartbeat, Types::TimeType,
+          null: true,
+          description: 'The timestamp of the last heartbeat received from the runtime'
+    field :runtime_features, [Types::RuntimeFeatureType],
+          null: false,
+          description: 'The set of features supported by the runtime'
+    field :status, Types::RuntimeStatusStatusEnum,
+          null: false,
+          description: 'The current status of the runtime (e.g. running, stopped)'
+    field :type, Types::RuntimeStatusTypeEnum,
+          null: false,
+          description: 'The type of runtime status information (e.g. adapter, execution)',
+          method: :status_type
+
+    id_field RuntimeStatus
+    timestamps
   end
 end

app/graphql/types/runtime_status_type_enum.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Types
+  class RuntimeStatusTypeEnum < Types::BaseEnum
+    description 'The type of runtime status'
+
+    value :ADAPTER, 'Indicates that the runtime status is related to an adapter.', value: 'adapter'
+    value :EXECUTION, 'Indicates that the runtime status is related to an execution.', value: 'execution'
+  end
+end

app/graphql/types/runtime_type.rb

@@ -16,8 +16,11 @@ class RuntimeType < Types::BaseObject
     field :namespace, Types::NamespaceType, null: true, description: 'The parent namespace for the runtime'
     field :projects, Types::NamespaceProjectType.connection_type, null: false,
                                                                   description: 'Projects associated with the runtime'
-    field :status, Types::RuntimeStatusType, null: false, description: 'The status of the runtime'
+    field :status, Types::RuntimeConnectionStatusEnum, null: false, description: 'The status of the runtime'
 
+    field :statuses, Types::RuntimeStatusType.connection_type, null: false,
+                                                               description: 'Statuses of the runtime',
+                                                               method: :runtime_statuses
     field :token, String, null: true, description: 'Token belonging to the runtime, only present on creation'
 
     expose_abilities %i[
@@ -29,6 +32,17 @@ class RuntimeType < Types::BaseObject
     id_field Runtime
     timestamps
 
+    # If the last heartbeat was within the last 10 minutes, consider the runtime as 'running'
+    def status
+      last_heartbeat = object.last_heartbeat
+
+      if last_heartbeat && last_heartbeat >= 10.minutes.ago
+        :connected
+      else
+        :disconnected
+      end
+    end
+
     def token
       object.token if object.token_previously_changed?
     end

app/grpc/concerns/grpc_stream_handler.rb

@@ -86,6 +86,7 @@ def create_enumerator(clazz, method, runtime_id, _call)
 
         begin
           y << item
+          Runtime.update(runtime_id, last_heartbeat: Time.zone.now)
         rescue GRPC::Core::CallError
           logger.info(message: 'Stream was closed from client side (probably)')
           clazz.try("#{method}_died", runtime_id)

app/grpc/flow_handler.rb

@@ -26,21 +26,14 @@ def self.update_runtime(runtime)
   end
 
   def self.update_started(runtime_id)
-    runtime = Runtime.find(runtime_id)
-    runtime.connected!
-    runtime.save
+    runtime = Runtime.find_by(id: runtime_id)
+    return if runtime.nil?
 
     logger.info(message: 'Runtime connected', runtime_id: runtime.id)
 
     update_runtime(runtime)
   end
 
-  def self.update_died(runtime_id)
-    runtime = Runtime.find(runtime_id)
-    runtime.disconnected!
-    runtime.save
-  end
-
   def self.encoders = { update: ->(grpc_object) { Tucana::Sagittarius::FlowResponse.encode(grpc_object) } }
 
   def self.decoders = { update: ->(string) { Tucana::Sagittarius::FlowResponse.decode(string) } }