DPL: allow GUI to run with an empty workflow (#4836)

ktf · web-flow · commit 72d2aaa7e199 · 2020-11-16T14:18:53.000+01:00
diff --git a/Framework/Core/src/DeviceSpecHelpers.cxx b/Framework/Core/src/DeviceSpecHelpers.cxx
@@ -708,7 +708,6 @@ void DeviceSpecHelpers::dataProcessorSpecs2DeviceSpecs(const WorkflowSpec& workf
   // them before assigning to a device.
   std::vector<OutputSpec> outputs;
 
-  WorkflowHelpers::verifyWorkflow(workflow);
   WorkflowHelpers::constructGraph(workflow, logicalEdges, outputs, availableForwardsInfo);
 
   // We need to instanciate one device per (me, timeIndex) in the
diff --git a/Framework/Core/src/WorkflowHelpers.cxx b/Framework/Core/src/WorkflowHelpers.cxx
@@ -755,10 +755,10 @@ void WorkflowHelpers::sortEdges(std::vector<size_t>& inEdgeIndex,
   std::sort(outEdgeIndex.begin(), outEdgeIndex.end(), outSorter);
 }
 
-void WorkflowHelpers::verifyWorkflow(const o2::framework::WorkflowSpec& workflow)
+WorkflowParsingState WorkflowHelpers::verifyWorkflow(const o2::framework::WorkflowSpec& workflow)
 {
   if (workflow.empty()) {
-    throw std::runtime_error("Empty workflow!");
+    return WorkflowParsingState::Empty;
   }
   std::set<std::string> validNames;
   std::vector<OutputSpec> availableOutputs;
@@ -799,6 +799,7 @@ void WorkflowHelpers::verifyWorkflow(const o2::framework::WorkflowSpec& workflow
       }
     }
   }
+  return WorkflowParsingState::Valid;
 }
 
 using UnifiedDataSpecType = std::variant<InputSpec, OutputSpec>;
diff --git a/Framework/Core/src/WorkflowHelpers.h b/Framework/Core/src/WorkflowHelpers.h
@@ -143,6 +143,11 @@ struct OutputObj {
   bool isdangling;
 };
 
+enum struct WorkflowParsingState : int {
+  Valid,
+  Empty,
+};
+
 /// A set of internal helper classes to manipulate a Workflow
 struct WorkflowHelpers {
   /// Topological sort for a graph of @a nodeCount nodes.
@@ -163,7 +168,7 @@ struct WorkflowHelpers {
 
   // Helper method to verify that a given workflow is actually valid e.g. that
   // it contains no empty labels.
-  static void verifyWorkflow(const WorkflowSpec& workflow);
+  [[nodiscard]] static WorkflowParsingState verifyWorkflow(const WorkflowSpec& workflow);
 
   // Depending on the workflow and the dangling inputs inside it, inject "fake"
   // devices to mark the fact we might need some extra action to make sure
diff --git a/Framework/Core/src/runDataProcessing.cxx b/Framework/Core/src/runDataProcessing.cxx
@@ -928,6 +928,8 @@ int runStateMachine(DataProcessorSpecs const& workflow,
   std::vector<ServicePreSchedule> preScheduleCallbacks;
   std::vector<ServicePostSchedule> postScheduleCallbacks;
 
+  bool guiDeployedOnce = false;
+
   while (true) {
     // If control forced some transition on us, we push it to the queue.
     if (driverControl.forcedTransitions.empty() == false) {
@@ -1025,6 +1027,10 @@ int runStateMachine(DataProcessorSpecs const& workflow,
         break;
       case DriverState::MATERIALISE_WORKFLOW:
         try {
+          auto workflowState = WorkflowHelpers::verifyWorkflow(workflow);
+          if (driverInfo.batch == true && workflowState == WorkflowParsingState::Empty) {
+            throw runtime_error("Empty workflow provided while running in batch mode.");
+          }
           DeviceSpecHelpers::dataProcessorSpecs2DeviceSpecs(workflow,
                                                             driverInfo.channelPolicies,
                                                             driverInfo.completionPolicies,
@@ -1063,6 +1069,13 @@ int runStateMachine(DataProcessorSpecs const& workflow,
         } catch (std::runtime_error& e) {
           std::cerr << "Invalid workflow: " << e.what() << std::endl;
           return 1;
+        } catch (o2::framework::RuntimeErrorRef ref) {
+          auto& e = o2::framework::error_from_ref(ref);
+#ifdef DPL_ENABLE_BACKTRACE
+          backtrace_symbols_fd(err.backtrace, err.maxBacktrace, STDERR_FILENO);
+#endif
+          std::cerr << "Invalid workflow: " << e.what << std::endl;
+          return 1;
         } catch (...) {
           std::cerr << "Unknown error while materialising workflow";
           return 1;
@@ -1107,6 +1120,7 @@ int runStateMachine(DataProcessorSpecs const& workflow,
           guiContext.window = window;
           gui_timer.data = &guiContext;
           uv_timer_start(&gui_timer, gui_callback, 0, 20);
+          guiDeployedOnce = true;
         }
         break;
       case DriverState::SCHEDULE: {
@@ -1185,10 +1199,14 @@ int runStateMachine(DataProcessorSpecs const& workflow,
           driverInfo.states.push_back(DriverState::RUNNING);
           driverInfo.states.push_back(DriverState::REDEPLOY_GUI);
           driverInfo.states.push_back(DriverState::SCHEDULE);
-        } else if (deviceSpecs.size() == 0) {
+        } else if (deviceSpecs.empty() && driverInfo.batch == true) {
           LOG(INFO) << "No device resulting from the workflow. Quitting.";
           // If there are no deviceSpecs, we exit.
           driverInfo.states.push_back(DriverState::EXIT);
+        } else if (deviceSpecs.empty() && driverInfo.batch == false && !guiDeployedOnce) {
+          // In case of an empty workflow, we need to deploy the GUI at least once.
+          driverInfo.states.push_back(DriverState::RUNNING);
+          driverInfo.states.push_back(DriverState::REDEPLOY_GUI);
         } else {
           driverInfo.states.push_back(DriverState::RUNNING);
         }

Original file line number	Diff line number	Diff line change
`@@ -755,10 +755,10 @@ void WorkflowHelpers::sortEdges(std::vector<size_t>& inEdgeIndex,`
`755`	`755`	`std::sort(outEdgeIndex.begin(), outEdgeIndex.end(), outSorter);`
`756`	`756`	`}`
`757`	`757`
`758`		`-void WorkflowHelpers::verifyWorkflow(const o2::framework::WorkflowSpec& workflow)`
	`758`	`+WorkflowParsingState WorkflowHelpers::verifyWorkflow(const o2::framework::WorkflowSpec& workflow)`
`759`	`759`	`{`
`760`	`760`	`if (workflow.empty()) {`
`761`		`- throw std::runtime_error("Empty workflow!");`
	`761`	`+ return WorkflowParsingState::Empty;`
`762`	`762`	`}`
`763`	`763`	`std::set<std::string> validNames;`
`764`	`764`	`std::vector<OutputSpec> availableOutputs;`
`@@ -799,6 +799,7 @@ void WorkflowHelpers::verifyWorkflow(const o2::framework::WorkflowSpec& workflow`
`799`	`799`	`}`
`800`	`800`	`}`
`801`	`801`	`}`
	`802`	`+ return WorkflowParsingState::Valid;`
`802`	`803`	`}`
`803`	`804`
`804`	`805`	`using UnifiedDataSpecType = std::variant<InputSpec, OutputSpec>;`