Add serialized warnings array to JSON output

src/tyr/route_serializer_valhalla.cc

@@ -6,6 +6,7 @@
 #include "odin/util.h"
 #include "proto_conversions.h"
 #include "tyr/serializers.h"
+#include "proto/info.pb.h"
 
 using namespace valhalla;
 using namespace valhalla::midgard;
@@ -537,6 +538,9 @@ std::string serialize(const Api& api) {
 
     // summary time/distance and other stats
     summary(api, i, writer);
+
+    // get serialized warnings
+    valhalla::tyr::serializeWarnings(api, writer);
 
     writer.end_object(); // trip
 

src/tyr/serializers.cc

@@ -25,6 +25,7 @@
 #include "proto/incidents.pb.h"
 #include "proto/options.pb.h"
 #include "proto/trip.pb.h"
+#include "proto/info.pb.h"
 
 using namespace valhalla;
 using namespace valhalla::baldr;
@@ -157,6 +158,18 @@ void openlr(const valhalla::Api& api, int route_index, rapidjson::writer_wrapper
   writer.end_array();
 }
 
+void serializeWarnings(const valhalla::Api& api, rapidjson::writer_wrapper_t& writer){
+    valhalla::Info warning;
+    writer.start_array("warnings");
+    writer.start_object();
+    for(int i = 0; i < warning.warnings_size(); i++){
+       writer(std::to_string(i), warning.warnings(i).description());
+    }
+    writer("warning_count", std::to_string(warning.warnings_size()));
+    writer.end_object();
+    writer.end_array();
+}
+
 std::string serializePbf(Api& request) {
   // if they dont want to select the parts just pick the obvious thing they would want based on action
   PbfFieldSelector selection = request.options().pbf_field_selector();

src/worker.cc

@@ -16,6 +16,7 @@
 #include "sif/costfactory.h"
 #include "thor/worker.h"
 #include "worker.h"
+#include "proto/info.pb.h"
 
 #include <boost/property_tree/ptree.hpp>
 #include <cpp-statsd-client/StatsdClient.hpp>
@@ -616,6 +617,11 @@ void from_json(rapidjson::Document& doc, Options::Action action, Api& api) {
   // auto_shorter is deprecated and will be turned into
   // shortest=true costing option. maybe remove in v4?
   if (costing_str == "auto_shorter") {
+
+    // add warnign for auto shorter
+    valhalla::Info info;
+    info.add_warnings()->set_description("auto shorter is deprecated and will be turned into the shotest costing option");
+
     costing_str = "auto";
     rapidjson::SetValueByPointer(doc, "/costing", "auto");
     auto json_options = rapidjson::GetValueByPointer(doc, "/costing_options/auto_shorter");
@@ -628,6 +634,11 @@ void from_json(rapidjson::Document& doc, Options::Action action, Api& api) {
   // hov costing is deprecated and will be turned into auto costing with
   // include_hov2=true costing option.
   if (costing_str == "hov") {
+
+    // add warning for hov costing
+    valhalla::Info info;
+    info.add_warnings()->set_description("hov costing is deprecated and will be turned into auto costing with hov2=true costing option");
+
     costing_str = "auto";
     rapidjson::SetValueByPointer(doc, "/costing", "auto");
     auto json_options = rapidjson::GetValueByPointer(doc, "/costing_options/hov");
@@ -640,6 +651,11 @@ void from_json(rapidjson::Document& doc, Options::Action action, Api& api) {
   // auto_data_fix is deprecated and will be turned into
   // ignore all the things costing option. maybe remove in v4?
   if (costing_str == "auto_data_fix") {
+
+    // warning for auto data fix
+    valhalla::Info info;
+    info.add_warnings()->set_description("auto_data_fix is deprecated and will be turned to ignore all the things costing option");
+
     costing_str = "auto";
     rapidjson::SetValueByPointer(doc, "/costing", "auto");
     auto json_options = rapidjson::GetValueByPointer(doc, "/costing_options/auto_data_fix");

valhalla/tyr/serializers.h

@@ -16,6 +16,7 @@
 #include <valhalla/meili/match_result.h>
 #include <valhalla/midgard/gridded_data.h>
 #include <valhalla/proto/api.pb.h>
+#include <valhalla/proto/info.pb.h>
 #include <valhalla/thor/costmatrix.h>
 #include <valhalla/tyr/actor.h>
 
@@ -117,6 +118,13 @@ void openlr(const valhalla::Api& api, int route_index, rapidjson::writer_wrapper
  */
 std::string serializePbf(Api& request);
 
+/**
+ * @brief Turns warnings into json
+ * @param request The protobuf warnings object
+ * @return json string
+ */
+void serializeWarnings(const valhalla::Api& api, rapidjson::writer_wrapper_t& writer);
+
 } // namespace tyr
 } // namespace valhalla