YAML: Define macro to hold the supported yaml version.

The idea is to remove this from the code and make it defined by the automake scripts.
Eventually the version could be read from the yaml source when added.
This is needed to validate the YAML version used by plugins when registering
to the JSONRPC manager to avoid ABI compatibility issues.

Author: brbzull0

build/yaml-cpp.m4

@@ -82,6 +82,7 @@ fi
 AC_SUBST([YAMLCPP_INCLUDES])
 AC_SUBST([YAMLCPP_LIBS])
 AC_SUBST([YAMLCPP_LDFLAGS])
+AC_DEFINE([YAMLCPP_LIB_VERSION], ["0.7.0"], [yamlcpp library version])
 
 ])
 

doc/developer-guide/api/functions/TSRPCRegister.en.rst

@@ -69,7 +69,7 @@ Description
 
     .. code-block:: cpp
 
-        TSRPCProviderHandle info = TSRPCRegister("FooBar's Plugin!", "0.6.3");
+        TSRPCProviderHandle info = TSRPCRegister("FooBar's Plugin!", "0.7.0");
         ...
         TSRPCRegisterMethodHandler("my_join_string_handler", &func, info);
 

doc/developer-guide/jsonrpc/jsonrpc-handler-development.en.rst

@@ -202,7 +202,7 @@ RPC method registration and implementation examples
         #include <ts/ts.h>
 
         namespace {
-            static const std::string MY_YAML_VERSION{"0.6.3"};
+            static const std::string MY_YAML_VERSION{"0.7.0"};
         }
 
         void
@@ -231,7 +231,7 @@ RPC method registration and implementation examples
         {
             ...
             // Check-in to make sure we are compliant with the YAML version in TS.
-            TSRPCProviderHandle rpcRegistrationInfo = TSRPCRegister("My plugin's info", "0.6.3");
+            TSRPCProviderHandle rpcRegistrationInfo = TSRPCRegister("My plugin's info", "0.7.0");
             if (rpcRegistrationInfo == nullptr) {
                 TSError("[%s] RPC handler registration failed, yaml version not supported.", PLUGIN_NAME);
             }
@@ -250,7 +250,7 @@ RPC method registration and implementation examples
         #include <ts/ts.h>
 
         namespace {
-            static const std::string MY_YAML_VERSION{"0.6.3"};
+            static const std::string MY_YAML_VERSION{"0.7.0"};
         }
 
         int
@@ -286,7 +286,7 @@ RPC method registration and implementation examples
         {
             // ...
             // Check-in to make sure we are compliant with the YAML version in TS.
-            TSRPCProviderHandle rpcRegistrationInfo = TSRPCRegister("My plugin's info", "0.6.3");
+            TSRPCProviderHandle rpcRegistrationInfo = TSRPCRegister("My plugin's info", "0.7.0");
             if (rpcRegistrationInfo == nullptr) {
                 TSError("[%s] RPC handler registration failed, yaml version not supported.", PLUGIN_NAME);
             }

src/traffic_server/InkAPI.cc

@@ -10356,13 +10356,8 @@ TSRPCRegister(const char *provider_name, const char *yaml_version)
 
   // We want to make sure that plugins are using the same yaml library version as we use internally. Plugins have to cast the TSYaml
   // to the YAML::Node, in order for them to make sure the version compatibility they need to register here and make sure the
-  // version is ok.
-
-  // IMPORTANT: YAML library version should be available to query from here. This could
-  // be an issue if the user specify their own library and it's a different version
-  // This should be discussed, can we guarantee not changing the YAML version in minor
-  // releases can only change it in major versions.
-  if (std::string_view{yaml_version} != "0.6.3") {
+  // version is the same.
+  if (std::string_view{yaml_version} != YAMLCPP_LIB_VERSION) {
     return nullptr;
   }
 

tests/gold_tests/jsonrpc/plugins/jsonrpc_plugin_handler_test.cc

@@ -37,7 +37,7 @@ namespace
 {
 static constexpr char PLUGIN_NAME[] = "jsonrpc_plugin_handler_test";
 
-static const std::string MY_YAML_VERSION{"0.6.3"};
+static const std::string MY_YAML_VERSION{"0.7.0"};
 static const std::string RPC_PROVIDER_NAME{"RPC Plugin test"};
 } // namespace