Add disabled reason to flow

Author: Knerio

app/graphql/types/flow_type.rb

@@ -8,6 +8,10 @@ class FlowType < Types::BaseObject
 
     field :name, String, null: false, description: 'Name of the flow'
 
+    field :disabled_reason, String,
+          null: true,
+          description: 'The reason why the flow is disabled, if it is disabled'
+
     field :input_type, Types::DataTypeType,
           null: true,
           description: 'The input data type of the flow'
@@ -19,7 +23,7 @@ class FlowType < Types::BaseObject
           method: :flow_settings,
           description: 'The settings of the flow'
     field :starting_node_id, Types::GlobalIdType[::NodeFunction],
-          null: false,
+          null: true,
           description: 'The ID of the starting node of the flow'
     field :type, Types::FlowTypeType,
           null: false,
@@ -38,7 +42,7 @@ class FlowType < Types::BaseObject
     timestamps
 
     def starting_node_id
-      object.starting_node.to_global_id
+      object.starting_node&.to_global_id
     end
   end
 end

app/graphql/types/input/flow_input_type.rb

@@ -9,14 +9,17 @@ class FlowInputType < Types::BaseInputObject
 
       argument :settings, [Types::Input::FlowSettingInputType], required: false,
                                                                 description: 'The settings of the flow'
-      argument :starting_node_id, Types::GlobalIdType[::NodeFunction], required: true,
+      argument :starting_node_id, Types::GlobalIdType[::NodeFunction], required: false,
                                                                        description: 'The starting node of the flow'
 
       argument :nodes, [Types::Input::NodeFunctionInputType], required: true,
                                                               description: 'The node functions of the flow'
 
       argument :type, Types::GlobalIdType[::FlowType], required: true,
                                                        description: 'The identifier of the flow type'
+
+      argument :disabled_reason, String, required: false,
+                                         description: 'The reason why the flow is disabled, if applicable, if not set the flow is enabled'
     end
   end
 end

app/grpc/flow_handler.rb

@@ -10,7 +10,7 @@ class FlowHandler < Tucana::Sagittarius::FlowService::Service
   def self.update_runtime(runtime)
     flows = []
     runtime.project_assignments.compatible.each do |assignment|
-      assignment.namespace_project.flows.each do |flow|
+      assignment.namespace_project.flows.enabled.each do |flow|
         flows << flow.to_grpc
       end
     end

app/models/flow.rb

@@ -14,6 +14,17 @@ class Flow < ApplicationRecord
                    allow_blank: false,
                    uniqueness: { case_sensitive: false, scope: :project_id }
 
+  validates :disabled_reason, presence: false,
+                              allow_blank: true,
+                              length: { maximum: 100, minimum: 0 }
+
+  scope :enabled, -> { where(disabled_reason: nil) }
+  scope :disabled, -> { where.not(disabled_reason: nil) }
+
+  def disabled?
+    disabled_reason.present?
+  end
+
   def to_grpc
     Tucana::Shared::ValidationFlow.new(
       flow_id: id,

app/services/namespaces/projects/flows/update_service.rb

@@ -51,6 +51,7 @@ def update_flow(t)
 
         def update_flow_attributes
           flow.name = flow_input.name
+          flow.disabled_reason = flow_input.disabled_reason
         end
 
         def update_settings(t)

db/migrate/20251217134754_add_disabled_reasonto_flows.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddDisabledReasontoFlows < Code0::ZeroTrack::Database::Migration[1.0]
+  def change
+    add_column :flows, :disabled_reason, :text, null: true, default: nil
+    add_index :flows, :disabled_reason, length: 100
+  end
+end

db/schema_migrations/20251217134754

@@ -0,0 +1 @@
+4b5be2b087ebee13e1319410194a92b64672b7cf3b7b1c9abb7e8bc59d2e94e5

db/structure.sql

@@ -252,7 +252,8 @@ CREATE TABLE flows (
     starting_node_id bigint,
     name text NOT NULL,
     created_at timestamp with time zone NOT NULL,
-    updated_at timestamp with time zone NOT NULL
+    updated_at timestamp with time zone NOT NULL,
+    disabled_reason text
 );
 
 CREATE SEQUENCE flows_id_seq
@@ -1100,6 +1101,8 @@ CREATE INDEX index_flow_types_on_return_type_id ON flow_types USING btree (retur
 
 CREATE UNIQUE INDEX index_flow_types_on_runtime_id_and_identifier ON flow_types USING btree (runtime_id, identifier);
 
+CREATE INDEX index_flows_on_disabled_reason ON flows USING btree (disabled_reason);
+
 CREATE INDEX index_flows_on_flow_type_id ON flows USING btree (flow_type_id);
 
 CREATE INDEX index_flows_on_input_type_id ON flows USING btree (input_type_id);

spec/requests/graphql/mutation/namespace/projects/flows/update_mutation_spec.rb

@@ -155,6 +155,34 @@
         target_type: 'NamespaceProject'
       )
     end
+
+    context 'when flow is disabled' do
+      let(:input) do
+        {
+          flowId: flow.to_global_id.to_s,
+          flowInput: {
+            name: generate(:flow_name),
+            disabledReason: 'Some reason',
+            type: flow_type.to_global_id.to_s,
+            startingNodeId: nil,
+            settings: [],
+            nodes: [],
+          },
+        }
+      end
+
+      it 'updates flow as disabled' do
+        mutate!
+
+        updated_flow_id = graphql_data_at(:namespaces_projects_flows_update, :flow, :id)
+        expect(updated_flow_id).to be_present
+        flow = SagittariusSchema.object_from_id(updated_flow_id)
+
+        expect(flow).to be_present
+        expect(project.flows).to include(flow)
+        expect(flow.disabled_reason).to eq('Some reason')
+      end
+    end
   end
 
   context 'when removing nodes' do