mission_builder_base.cpp

// Copyright 2024 Robin Müller
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#include "auto_apms_mission/mission_builder_base.hpp"
 
#include "auto_apms_util/exceptions.hpp"
 
namespace auto_apms_mission
{
 
const std::string MissionBuildHandlerBase::ORCHESTRATOR_EXECUTOR_NAME = _AUTO_APMS_MISSION__ORCHESTRATOR_EXECUTOR_NAME;
const std::string MissionBuildHandlerBase::MISSION_EXECUTOR_NAME = _AUTO_APMS_MISSION__MISSION_EXECUTOR_NAME;
const std::string MissionBuildHandlerBase::EVENT_MONITOR_EXECUTOR_NAME =
  _AUTO_APMS_MISSION__EVENT_MONITOR_EXECUTOR_NAME;
const std::string MissionBuildHandlerBase::EVENT_HANDLER_EXECUTOR_NAME =
  _AUTO_APMS_MISSION__EVENT_HANDLER_EXECUTOR_NAME;
 
bool MissionBuildHandlerBase::setBuildRequest(
  const std::string & build_request, const std::string & entry_point, const NodeManifest & node_manifest)
{
  if (!entry_point.empty()) {
    RCLCPP_WARN(
      logger_, "Argument entry_point is not empty. Custom entry_points are not supported and will be ignored.");
  }
  if (!node_manifest.empty()) {
    RCLCPP_WARN(
      logger_, "Argument node_manifest is not empty. Custom node manifests are not supported and will be ignored.");
  }
  try {
    mission_config_ = createMissionConfig(build_request);
  } catch (const auto_apms_util::exceptions::ResourceIdentityFormatError & e) {
    RCLCPP_WARN(logger_, "%s", e.what());
    return false;
  } catch (const auto_apms_util::exceptions::ResourceError & e) {
    RCLCPP_WARN(logger_, "%s", e.what());
    return false;
  } catch (const auto_apms_util::exceptions::YAMLFormatError & e) {
    RCLCPP_WARN(logger_, "Invalid YAML format of mission configuration '%s': %s", build_request.c_str(), e.what());
    return false;
  }
 
  // Validate all tree resource identities and replace all empty tree names with the corresponding root tree name
  auto add_tree_name_to_identity = [this](TreeResource::Identity & identity) {
    if (identity.tree_name.empty()) {
      TreeResource r(identity);
      identity.tree_name = r.getRootTreeName();
    }
  };
  try {
    for (TreeResource::Identity & identity : mission_config_.bringup) add_tree_name_to_identity(identity);
    for (TreeResource::Identity & identity : mission_config_.mission) add_tree_name_to_identity(identity);
    for (auto & [monitor_id, handler_id] : mission_config_.contingency) {
      add_tree_name_to_identity(monitor_id);
      add_tree_name_to_identity(handler_id);
    }
    for (auto & [monitor_id, handler_id] : mission_config_.emergency) {
      add_tree_name_to_identity(monitor_id);
      add_tree_name_to_identity(handler_id);
    }
    for (TreeResource::Identity & identity : mission_config_.shutdown) add_tree_name_to_identity(identity);
  } catch (const auto_apms_util::exceptions::ResourceError & e) {
    RCLCPP_WARN(logger_, "%s", e.what());
    return false;
  }
 
  return true;
}
 
MissionBuildHandlerBase::TreeDocument::TreeElement MissionBuildHandlerBase::buildTree(
  TreeDocument & doc, TreeBlackboard & bb)
{
  using namespace auto_apms_behavior_tree::model;
 
  // Load orchestrator tree
  RCLCPP_DEBUG(logger_, "Loading orchestrator tree.");
  TreeDocument::TreeElement root_tree =
    doc.newTreeFromResource("tree__internal/auto_apms_mission::orchestrator_base::MissionOrchestrator").makeRoot();
 
  RCLCPP_DEBUG(logger_, "Configuring orchestrator root blackboard.");
  configureOrchestratorRootBlackboard(bb);
 
  TreeDocument::TreeElement is_contingency_tree = doc.getTree("__IsContingency__").removeChildren();
  TreeDocument::TreeElement is_emergency_tree = doc.getTree("__IsEmergency__").removeChildren();
 
  if (mission_config_.contingency.empty()) {
    is_contingency_tree.insertNode<model::AlwaysFailure>();
  } else {
    model::Fallback fallback = is_contingency_tree.insertNode<model::Fallback>();
    for (const auto & [monitor_id, _] : mission_config_.contingency) {
      fallback.insertNode<model::ScriptCondition>().set_code("event_id == '" + monitor_id.str() + "'");
    }
  }
 
  if (mission_config_.emergency.empty()) {
    is_emergency_tree.insertNode<model::AlwaysFailure>();
  } else {
    model::Fallback fallback = is_emergency_tree.insertNode<model::Fallback>();
    for (const auto & [monitor_id, _] : mission_config_.emergency) {
      fallback.insertNode<model::ScriptCondition>().set_code("event_id == '" + monitor_id.str() + "'");
    }
  }
 
  // Bring up
  if (!mission_config_.bringup.empty()) {
    RCLCPP_DEBUG(logger_, "Creating bringup subtree.");
    TreeDocument::TreeElement bringup_tree = doc.getTree("__BringUp__");
    buildBringUp(bringup_tree, mission_config_.bringup);
    if (const BT::Result res = bringup_tree.verify(); !res) {
      throw auto_apms_behavior_tree::exceptions::TreeBuildHandlerError("Bringup tree is not valid: " + res.error());
    }
  }
 
  // Mission
  RCLCPP_DEBUG(logger_, "Creating mission subtree.");
  TreeDocument::TreeElement mission_tree = doc.getTree("__RunMission__");
  buildMission(mission_tree, mission_config_.mission);
  if (const BT::Result res = mission_tree.verify(); !res) {
    throw auto_apms_behavior_tree::exceptions::TreeBuildHandlerError("Mission tree is not valid: " + res.error());
  }
 
  // Event monitor
  if (!mission_config_.contingency.empty() || !mission_config_.emergency.empty()) {
    RCLCPP_DEBUG(logger_, "Creating event monitor subtree.");
    TreeDocument::TreeElement event_monitor_tree = doc.getTree("__MonitorEvents__");
    buildEventMonitor(event_monitor_tree, mission_config_.contingency, mission_config_.emergency);
    if (const BT::Result res = event_monitor_tree.verify(); !res) {
      throw auto_apms_behavior_tree::exceptions::TreeBuildHandlerError(
        "Event monitor tree is not valid: " + res.error());
    }
  }
 
  // Contingency Handling
  if (!mission_config_.contingency.empty()) {
    RCLCPP_DEBUG(logger_, "Creating contingency handler subtree.");
    TreeDocument::TreeElement contingency_tree = doc.getTree("__HandleContingency__");
    buildContingencyHandling(contingency_tree, mission_config_.contingency);
    if (const BT::Result res = contingency_tree.verify(); !res) {
      throw auto_apms_behavior_tree::exceptions::TreeBuildHandlerError(
        "Contingency handling tree is not valid: " + res.error());
    }
  }
 
  // Emergency Handling
  if (!mission_config_.emergency.empty()) {
    RCLCPP_DEBUG(logger_, "Creating emergency handler subtree.");
    TreeDocument::TreeElement emergency_tree = doc.getTree("__HandleEmergency__");
    buildEmergencyHandling(emergency_tree, mission_config_.emergency);
    if (const BT::Result res = emergency_tree.verify(); !res) {
      throw auto_apms_behavior_tree::exceptions::TreeBuildHandlerError(
        "Emergency handling tree is not valid: " + res.error());
    }
  }
 
  // Shut down
  if (!mission_config_.shutdown.empty()) {
    RCLCPP_DEBUG(logger_, "Creating shutdown subtree.");
    TreeDocument::TreeElement shutdown_tree = doc.getTree("__ShutDown__");
    buildShutDown(shutdown_tree, mission_config_.shutdown);
    if (const BT::Result res = shutdown_tree.verify(); !res) {
      throw auto_apms_behavior_tree::exceptions::TreeBuildHandlerError("Shutdown tree is not valid: " + res.error());
    }
  }
 
  // Write tree for debugging purposes
  // doc.writeToFile("/home/robin/Desktop/px4-ros2-env/src/dep/auto-apms/test.xml");
 
  return root_tree;
}
 
void MissionBuildHandlerBase::buildBringUp(
  TreeDocument::TreeElement & sub_tree, const std::vector<TreeResource::Identity> & trees)
{
  sub_tree.removeChildren();
  for (const TreeResource::Identity & r : trees) {
    RCLCPP_DEBUG(logger_, "Adding bringup tree '%s'.", r.str().c_str());
    sub_tree.insertTreeFromResource(r);
  }
}
 
void MissionBuildHandlerBase::buildMission(
  TreeDocument::TreeElement & sub_tree, const std::vector<TreeResource::Identity> & trees)
{
  sub_tree.removeChildren();
  for (const TreeResource::Identity & r : trees) {
    RCLCPP_DEBUG(logger_, "Adding mission tree '%s'.", r.str().c_str());
    sub_tree.insertTreeFromResource(r);
  }
}
 
void MissionBuildHandlerBase::buildEventMonitor(
  TreeDocument::TreeElement & sub_tree,
  const std::vector<std::pair<TreeResource::Identity, TreeResource::Identity>> & contingencies,
  const std::vector<std::pair<TreeResource::Identity, TreeResource::Identity>> & emergencies)
{
  std::vector<TreeResource::Identity> sorted_monitor_ids;
 
  // Emergencies have higher priority than contingencies (they are inserted to the vector first)
  for (const auto & [monitor_id, _] : emergencies) {
    sorted_monitor_ids.push_back(monitor_id);
  }
  for (const auto & [monitor_id, _] : contingencies) {
    if (!auto_apms_util::contains(sorted_monitor_ids, monitor_id)) sorted_monitor_ids.push_back(monitor_id);
  }
 
  // Assemble an extra document that holds all monitor subtrees
  TreeDocument monitor_doc;
  for (const TreeResource::Identity & monitor_id : sorted_monitor_ids) {
    if (!monitor_doc.hasTreeName(monitor_id.str())) {
      RCLCPP_DEBUG(logger_, "Adding event monitor tree '%s'.", monitor_id.str().c_str());
      RCLCPP_DEBUG(
        logger_, "Identity has file stem '%s' and tree name '%s'.", monitor_id.file_stem.c_str(),
        monitor_id.tree_name.c_str());
      monitor_doc.newTreeFromResource(monitor_id).setName(monitor_id.str());
    }
  }
 
  model::Fallback fallback = sub_tree.removeChildren().insertNode<model::Fallback>();
  for (const TreeResource::Identity & monitor_id : sorted_monitor_ids) {
    // We want the monitor to have its own blackboard, so we create a subtree node
    const std::string monitor_tree_name = monitor_id.str();
    model::SubTree subtree_node = fallback.getParentDocument().hasTreeName(monitor_tree_name)
                                    ? fallback.insertNode<model::SubTree>(monitor_tree_name)
                                    : fallback.insertNode<model::SubTree>(monitor_doc.getTree(monitor_tree_name));
    subtree_node.setConditionalScript(BT::PostCond::ON_SUCCESS, "event_id := '" + monitor_tree_name + "'");
  }
}
 
void MissionBuildHandlerBase::buildContingencyHandling(
  TreeDocument::TreeElement & sub_tree,
  const std::vector<std::pair<TreeResource::Identity, TreeResource::Identity>> & contingencies)
{
  // Assemble an extra document that holds all handler subtrees
  TreeDocument handler_doc;
  for (const auto & [_, handler_id] : contingencies) {
    if (!handler_doc.hasTreeName(handler_id.str())) {
      RCLCPP_DEBUG(logger_, "Adding contingency handler tree '%s'.", handler_id.str().c_str());
      handler_doc.newTreeFromResource(handler_id).setName(handler_id.str());
    }
  }
 
  model::ReactiveFallback fallback = sub_tree.removeChildren().insertNode<model::ReactiveFallback>();
 
  // With the highest priority (first child) we acknowledge when the event is reset (e.g. we abort the current action
  // and resume)
  fallback.insertNode<model::AlwaysFailure>()
    .setName("ResetEventHandler")
    .setConditionalScript(BT::PreCond::SUCCESS_IF, "event_id == ''");
 
  for (const auto & [monitor_id, handler_id] : contingencies) {
    model::AsyncSequence seq =
      fallback.insertNode<model::AsyncSequence>().setName("EventHandler (" + handler_id.str() + ")");
    seq.insertNode<model::ScriptCondition>().set_code("event_id == '" + monitor_id.str() + "'");
 
    // We want the handler to have its own blackboard, so we create a subtree node
    const std::string handler_tree_name = handler_id.str();
    if (seq.getParentDocument().hasTreeName(handler_tree_name)) {
      seq.insertNode<model::SubTree>(handler_tree_name);
    } else {
      // Automatically add the handler tree if it doesn't exist yet
      seq.insertNode<model::SubTree>(handler_doc.getTree(handler_tree_name));
    }
 
    // Once the contingency handler subtree is done, the tree idles as long as the respective event is still active
    seq.insertNode<model::KeepRunningUntilFailure>()
      .insertNode<model::ScriptCondition>()
      .setName("IsEventStillActive")
      .set_code("event_id == '" + monitor_id.str() + "'");
  }
}
 
void MissionBuildHandlerBase::buildEmergencyHandling(
  TreeDocument::TreeElement & sub_tree,
  const std::vector<std::pair<TreeResource::Identity, TreeResource::Identity>> & emergencies)
{
  // Assemble an extra document that holds all handler subtrees
  TreeDocument handler_doc;
  for (const auto & [_, handler_id] : emergencies) {
    if (!handler_doc.hasTreeName(handler_id.str())) {
      RCLCPP_DEBUG(logger_, "Adding emergency handler tree '%s'.", handler_id.str().c_str());
      handler_doc.newTreeFromResource(handler_id).setName(handler_id.str());
    }
  }
 
  model::ReactiveFallback fallback = sub_tree.removeChildren().insertNode<model::ReactiveFallback>();
  for (const auto & [monitor_id, handler_id] : emergencies) {
    model::AsyncSequence seq =
      fallback.insertNode<model::AsyncSequence>().setName("EventHandler (" + handler_id.str() + ")");
    seq.insertNode<model::ScriptCondition>().set_code("event_id == '" + monitor_id.str() + "'");
 
    // We want the handler to have its own blackboard, so we create a subtree node
    const std::string handler_tree_name = handler_id.str();
    if (seq.getParentDocument().hasTreeName(handler_tree_name)) {
      seq.insertNode<model::SubTree>(handler_tree_name);
    } else {
      // Automatically add the handler tree if it doesn't exist yet
      seq.insertNode<model::SubTree>(handler_doc.getTree(handler_tree_name));
    }
  }
}
 
void MissionBuildHandlerBase::buildShutDown(
  TreeDocument::TreeElement & sub_tree, const std::vector<TreeResource::Identity> & trees)
{
  sub_tree.removeChildren();
  for (const TreeResource::Identity & r : trees) {
    RCLCPP_DEBUG(logger_, "Adding shutdown tree '%s'.", r.str().c_str());
    sub_tree.insertTreeFromResource(r);
  }
}
 
void MissionBuildHandlerBase::configureOrchestratorRootBlackboard(TreeBlackboard & /*bb*/) {}
 
}  // namespace auto_apms_mission