gerrit.automotivelinux Code Review - AGL/meta-agl-devel.git/blob

   1 Fix event argument JSON
   2
   3 It was discovered while trying to use some of the capabilities events
   4 that the argument JSON was incorrectly formatted, with instances of
   5 all or part of it being double-quoted as strings with escaping.  A
   6 couple instances of this had previously been worked around by hacks
   7 involving reparsing all or some parts of the arguments a second time
   8 with a JSON parser, but it seems better to fix it at the source so
   9 that the events match documentation and are usable as is.
  10
  11 Note that it is ATM not clear if all affected event argument payloads
  12 are correct, e.g. LocalMediaSource may need some more work.
  13
  14 Upstream-Status: Pending
  15
  16 Signed-off-by: Scott Murray <scott.murray@konsulko.com>
  17
  18 diff --git a/src/plugins/aasb-client/AlexaCapabilityDirectiveRouterImpl.cpp b/src/plugins/aasb-client/AlexaCapabilityDirectiveRouterImpl.cpp
  19 index 6aea920..23ed90c 100644
  20 --- a/src/plugins/aasb-client/AlexaCapabilityDirectiveRouterImpl.cpp
  21 +++ b/src/plugins/aasb-client/AlexaCapabilityDirectiveRouterImpl.cpp
  22 @@ -17,6 +17,8 @@
  23
  24  #include <sstream>
  25
  26 +#include <json-c/json.h>
  27 +
  28  #include <aasb/Consts.h>
  29
  30  #include "AlexaConsts.h"
  31 @@ -322,7 +324,16 @@ void AlexaCapabilityDirectiveRouterImpl::processTemplateRuntimeAction(
  32
  33      json_object* argsJ = json_object_new_object();
  34      json_object* actionJ = json_object_new_string(vshlCapabilityAction.c_str());
  35 -    json_object* payloadJ = json_object_new_string(payload.c_str());
  36 +    json_object* payloadJ = NULL;
  37 +    if(payload.length()) {
  38 +        payloadJ = json_tokener_parse(payload.c_str());
  39 +    } else {
  40 +        payloadJ = json_object_new_string("");
  41 +    }
  42 +    if(!payloadJ) {
  43 +        m_logger->log(Level::ERROR, TAG, "Unable to parse payload JSON: " + payload);
  44 +        return;
  45 +    }
  46      json_object_object_add(argsJ, agl::alexa::JSON_ATTR_ACTION.c_str(), actionJ);
  47      json_object_object_add(argsJ, agl::alexa::JSON_ATTR_PAYLOAD.c_str(), payloadJ);
  48
  49 @@ -343,24 +354,40 @@ void AlexaCapabilityDirectiveRouterImpl::processCBLAction(
  50      const std::string& payload) {
  51      m_logger->log(Level::DEBUG, TAG, "Processing CBL action: " + action);
  52
  53 -    json_object* eventDataJ = json_object_new_object();
  54 +    json_object* payloadJ = NULL;
  55 +    if(payload.length()) {
  56 +        payloadJ = json_tokener_parse(payload.c_str());
  57 +    } else {
  58 +        payloadJ = json_object_new_string("");
  59 +    }
  60 +    if(!payloadJ) {
  61 +        m_logger->log(Level::ERROR, TAG, "Unable to parse payload JSON: " + payload);
  62 +        return;
  63 +    }
  64 +    // The payload string may already be of the form of a document like
  65 +    // "{ "payload" : { ... } }", the simplest way to handle that is to use
  66 +    // it as the event json_object if that's the case, that way we avoid
  67 +    // having to worry about copying.
  68 +    json_object* eventDataJ = NULL;
  69 +    if(json_object_object_get_ex(payloadJ, "payload", NULL)) {
  70 +        eventDataJ = payloadJ;
  71 +    } else {
  72 +        eventDataJ = json_object_new_object();
  73 +        json_object_object_add(eventDataJ, JSON_ATTR_PAYLOAD.c_str(), payloadJ);
  74 +    }
  75      json_object* vaIdJ = json_object_new_string(m_alexaVoiceAgentId.c_str());
  76 -
  77      json_object_object_add(eventDataJ, JSON_ATTR_VOICEAGENT_ID.c_str(), vaIdJ);
  78
  79      int observers = 0;
  80      if (action == aasb::bridge::ACTION_CBL_CODEPAIR_RECEIVED) {
  81          m_logger->log(Level::INFO, TAG, "CBL codepair received: " + payload);
  82 -        json_object* payloadJ = json_object_new_string(payload.c_str());
  83 -        json_object_object_add(eventDataJ, JSON_ATTR_PAYLOAD.c_str(), payloadJ);
  84          observers = m_cblCodePairReceivedEvent->publishEvent(eventDataJ);
  85      } else if (action == aasb::bridge::ACTION_CBL_CODEPAIR_EXPIRED) {
  86          m_logger->log(Level::INFO, TAG, "CBL codepair expired: " + payload);
  87 -        json_object* payloadJ = json_object_new_string(payload.c_str());
  88 -        json_object_object_add(eventDataJ, JSON_ATTR_PAYLOAD.c_str(), payloadJ);
  89          observers = m_cblCodePairExpiredEvent->publishEvent(eventDataJ);
  90      } else {
  91          m_logger->log(Level::INFO, TAG, "Unhandled action: " + action);
  92 +        json_object_put(eventDataJ);
  93      }
  94
  95      std::stringstream logMsg;
  96 diff --git a/src/plugins/dispatchers/local-voice-control/car-control/CarControlDispatcher.cpp b/src/plugins/dispatchers/local-voice-control/car-control/CarControlDispatcher.cpp
  97 index 096f72f..75108d4 100644
  98 --- a/src/plugins/dispatchers/local-voice-control/car-control/CarControlDispatcher.cpp
  99 +++ b/src/plugins/dispatchers/local-voice-control/car-control/CarControlDispatcher.cpp
 100 @@ -72,7 +72,16 @@ void CarControlDispatcher::onReceivedDirective(
 101
 102      json_object* argsJ = json_object_new_object();
 103      json_object* actionJ = json_object_new_string(vshlCapabilityAction.c_str());
 104 -    json_object* payloadJ = json_object_new_string(payload.c_str());
 105 +    json_object* payloadJ = NULL;
 106 +    if(payload.length()) {
 107 +        payloadJ = json_tokener_parse(payload.c_str());
 108 +    } else {
 109 +        payloadJ = json_object_new_string("");
 110 +    }
 111 +    if(!payloadJ) {
 112 +        m_logger->log(Level::ERROR, TAG, "Unable to parse payload JSON: " + payload);
 113 +        return;
 114 +    }
 115      json_object_object_add(argsJ, agl::alexa::JSON_ATTR_ACTION.c_str(), actionJ);
 116      json_object_object_add(argsJ, agl::alexa::JSON_ATTR_PAYLOAD.c_str(), payloadJ);
 117
 118 diff --git a/src/plugins/dispatchers/localmediasource/LocalMediaSourceDispatcher.cpp b/src/plugins/dispatchers/localmediasource/LocalMediaSourceDispatcher.cpp
 119 index c261a56..04ac10c 100644
 120 --- a/src/plugins/dispatchers/localmediasource/LocalMediaSourceDispatcher.cpp
 121 +++ b/src/plugins/dispatchers/localmediasource/LocalMediaSourceDispatcher.cpp
 122 @@ -71,7 +71,16 @@ void LocalMediaSourceDispatcher::onReceivedDirective(
 123
 124      json_object* argsJ = json_object_new_object();
 125      json_object* actionJ = json_object_new_string(vshlCapabilityAction.c_str());
 126 -    json_object* payloadJ = json_object_new_string(payload.c_str());
 127 +    json_object* payloadJ = NULL;
 128 +    if(payload.length()) {
 129 +        payloadJ = json_tokener_parse(payload.c_str());
 130 +    } else {
 131 +        payloadJ = json_object_new_string("");
 132 +    }
 133 +    if(!payloadJ) {
 134 +        m_logger->log(Level::ERROR, TAG, "Unable to parse payload JSON: " + payload);
 135 +        return;
 136 +    }
 137      json_object_object_add(argsJ, agl::alexa::JSON_ATTR_ACTION.c_str(), actionJ);
 138      json_object_object_add(argsJ, agl::alexa::JSON_ATTR_PAYLOAD.c_str(), payloadJ);
 139
 140 diff --git a/src/plugins/dispatchers/navigation/NavigationDispatcher.cpp b/src/plugins/dispatchers/navigation/NavigationDispatcher.cpp
 141 index 55a6017..283b42b 100644
 142 --- a/src/plugins/dispatchers/navigation/NavigationDispatcher.cpp
 143 +++ b/src/plugins/dispatchers/navigation/NavigationDispatcher.cpp
 144 @@ -68,7 +68,16 @@ void NavigationDispatcher::onReceivedDirective(
 145
 146      json_object* argsJ = json_object_new_object();
 147      json_object* actionJ = json_object_new_string(vshlCapabilityAction.c_str());
 148 -    json_object* payloadJ = json_object_new_string(payload.c_str());
 149 +    json_object* payloadJ = NULL;
 150 +    if(payload.length()) {
 151 +        payloadJ = json_tokener_parse(payload.c_str());
 152 +    } else {
 153 +        payloadJ = json_object_new_string("");
 154 +    }
 155 +    if(!payloadJ) {
 156 +        m_logger->log(Level::ERROR, TAG, "Unable to parse payload JSON: " + payload);
 157 +        return;
 158 +    }
 159      json_object_object_add(argsJ, agl::alexa::JSON_ATTR_ACTION.c_str(), actionJ);
 160      json_object_object_add(argsJ, agl::alexa::JSON_ATTR_PAYLOAD.c_str(), payloadJ);
 161
 162 diff --git a/src/plugins/dispatchers/phonecall/PhoneCallDispatcher.cpp b/src/plugins/dispatchers/phonecall/PhoneCallDispatcher.cpp
 163 index 29ad96a..3432892 100644
 164 --- a/src/plugins/dispatchers/phonecall/PhoneCallDispatcher.cpp
 165 +++ b/src/plugins/dispatchers/phonecall/PhoneCallDispatcher.cpp
 166 @@ -86,7 +86,16 @@ void PhoneCallDispatcher::onReceivedDirective(
 167
 168      json_object* argsJ = json_object_new_object();
 169      json_object* actionJ = json_object_new_string(vshlCapabilityAction.c_str());
 170 -    json_object* payloadJ = json_object_new_string(payload.c_str());
 171 +    json_object* payloadJ = NULL;
 172 +    if(payload.length()) {
 173 +        payloadJ = json_tokener_parse(payload.c_str());
 174 +    } else {
 175 +        payloadJ = json_object_new_string("");
 176 +    }
 177 +    if(!payloadJ) {
 178 +        m_logger->log(Level::ERROR, TAG, "Unable to parse payload JSON: " + payload);
 179 +        return;
 180 +    }
 181      json_object_object_add(argsJ, agl::alexa::JSON_ATTR_ACTION.c_str(), actionJ);
 182      json_object_object_add(argsJ, agl::alexa::JSON_ATTR_PAYLOAD.c_str(), payloadJ);
 183