RDK-53686 Analytics: use event to track activation state and reduce logs

Author: adrianM27

Analytics/Implementation/AnalyticsImplementation.cpp

@@ -185,8 +185,6 @@ namespace Plugin {
 
             lock.unlock();
 
-            LOGINFO("Action: %d, time valid: %s", action.type, mSysTimeValid? "true" : "false");
-
             switch (action.type) {
                 case ACTION_POPULATE_TIME_INFO:
 

Analytics/Implementation/Backend/Sift/SiftBackend.cpp

@@ -117,8 +117,6 @@ namespace WPEFramework
                     mActionQueue.pop();
                 }
 
-                LOGINFO("Action %d", action.type);
-
                 //Always get the most recent attributes
                 bool attributesValid = false;
                 bool storeConfigValid = (mStorePtr != nullptr);

Analytics/Implementation/Backend/Sift/SiftConfig.cpp

@@ -29,6 +29,8 @@
 #define PERSISTENT_STORE_ANALYTICS_NAMESPACE "Analytics"
 #define PERSISTENT_STORE_ACCOUNT_PROFILE_NAMESPACE "accountProfile"
 #define JSONRPC_THUNDER_TIMEOUT 20000
+#define THUNDER_ACCESS_DEFAULT_VALUE "127.0.0.1:9998"
+#define SIFT_PARTNER_ID_DFL  "rdk"
 
 namespace WPEFramework
 {
@@ -313,7 +315,8 @@ namespace WPEFramework
                                                             mStoreConfig(),
                                                             mUploaderConfig(),
                                                             mShell(shell),
-                                                            mSystemTime(systemTime)
+                                                            mSystemTime(systemTime),
+                                                            mAuthServiceLink(nullptr)
         {
             ASSERT(shell != nullptr);
             ParsePluginConfig();
@@ -336,19 +339,28 @@ namespace WPEFramework
                 uint32_t result = interface->Unregister(&mMonitorKeys);
                 LOGINFO("IStore status %d", result);
                 interface->Release();
-            }         
+            }
+            if (mAuthServiceLink != nullptr)
+            {
+                mAuthServiceLink->Unsubscribe(JSONRPC_THUNDER_TIMEOUT, _T("onActivationStatusChanged"));
+            }
         }
 
         bool SiftConfig::GetAttributes(SiftConfig::Attributes &attributes)
         {
-            // Get latest values from AuthService
-            GetAuthServiceValues();
-            bool timeZoneValid = GetTimeZone();
+            UpdateXboValues();
+            bool timeZoneValid = UpdateTimeZone();
 
             mMutex.lock();
-
             bool valid = false;
 
+            // If not activated, make sure xbo values are empty and do not contain any old data
+            if (!mAttributes.activated)
+            {
+                mAttributes.xboDeviceId.clear();
+                mAttributes.xboAccountId.clear();
+            }
+
             if (mAttributes.schema2Enabled)
             {
                 //Sift 2.0 requires attributes
@@ -376,41 +388,6 @@ namespace WPEFramework
                     && !mAttributes.deviceMacAddress.empty()
                     && timeZoneValid);
 
-                LOGINFO(" commonSchema: %s,"
-                        " productName: %s,"
-                        " productVersion: %s,"
-                        " loggerName: %s,"
-                        " loggerVersion: %s,"
-                        " partnerId: %s,"
-                        " activatedValid %d,"
-                        " deviceModel: %s,"
-                        " deviceType: %s,"
-                        " deviceOsName: %s,"
-                        " deviceOsVersion: %s,"
-                        " platform: %s,"
-                        " deviceManufacturer: %s,"
-                        " proposition: %s,"
-                        " deviceSerialNumber: %s,"
-                        " deviceMacAddress: %s,"
-                        " timeZoneValid: %d",
-                        mAttributes.commonSchema.c_str(),
-                        mAttributes.productName.c_str(),
-                        mAttributes.productVersion.c_str(),
-                        mAttributes.loggerName.c_str(),
-                        mAttributes.loggerVersion.c_str(),
-                        mAttributes.partnerId.c_str(),
-                        activatedValid,
-                        mAttributes.deviceModel.c_str(),
-                        mAttributes.deviceType.c_str(),
-                        mAttributes.deviceOsName.c_str(),
-                        mAttributes.deviceOsVersion.c_str(),
-                        mAttributes.platform.c_str(),
-                        mAttributes.deviceManufacturer.c_str(),
-                        mAttributes.proposition.c_str(),
-                        mAttributes.deviceSerialNumber.c_str(),
-                        mAttributes.deviceMacAddress.c_str(),
-                        timeZoneValid);
-
                 if (valid)
                 {
                     if (mAttributes.deviceType == "TV")
@@ -425,7 +402,6 @@ namespace WPEFramework
             }
             else //Sift 1.0 required attributes
             {
-
                 valid = (!mAttributes.productName.empty()
                     && !mAttributes.deviceAppName.empty()
                     && !mAttributes.deviceAppVersion.empty()
@@ -434,16 +410,6 @@ namespace WPEFramework
                     && !mAttributes.deviceOsVersion.empty()
                     && !mAttributes.deviceType.empty()
                     && timeZoneValid);
-
-                LOGINFO("%s, %s, %s, %s, %s, %s, %s, %d",
-                    mAttributes.productName.c_str(),
-                    mAttributes.deviceAppName.c_str(),
-                    mAttributes.deviceAppVersion.c_str(),
-                    mAttributes.deviceModel.c_str(),
-                    mAttributes.platform.c_str(),
-                    mAttributes.deviceOsVersion.c_str(),
-                    mAttributes.deviceType.c_str(),
-                    timeZoneValid);
             }
 
             if (valid)
@@ -492,7 +458,7 @@ namespace WPEFramework
             mKeysMap[PERSISTENT_STORE_ANALYTICS_NAMESPACE]["manufacturer"] = &mAttributes.deviceManufacturer;
             mKeysMap[PERSISTENT_STORE_ANALYTICS_NAMESPACE]["serialNumber"] = &mAttributes.deviceSerialNumber;
             mKeysMap[PERSISTENT_STORE_ANALYTICS_NAMESPACE]["entertainmentOSVersion"] = &mAttributes.productVersion;
-            //For Sift 1.0 use default values form config
+            //For Sift 1.0 use default values from config
             if (mAttributes.schema2Enabled)
             {
                 mKeysMap[PERSISTENT_STORE_ACCOUNT_PROFILE_NAMESPACE]["proposition"] = &mAttributes.proposition;
@@ -605,6 +571,61 @@ namespace WPEFramework
                 ActivatePlugin(mShell, AUTHSERVICE_CALLSIGN);
             }
 
+            // try to create AuthService jsonrpc link and register to onActivationStatusChanged event
+            mAuthServiceLink = GetThunderControllerClient(AUTHSERVICE_CALLSIGN);
+            if (mAuthServiceLink)
+            {
+                uint32_t result = mAuthServiceLink->Subscribe<JsonObject>(JSONRPC_THUNDER_TIMEOUT, _T("onActivationStatusChanged"), &SiftConfig::OnActivationStatusChanged, this);
+                if (result != Core::ERROR_NONE)
+                {
+                    LOGERR("Failed to subscribe to onActivationStatusChanged");
+                }
+
+                JsonObject params;
+                JsonObject response;
+
+                // Get partnerId from AuthService.getDeviceId
+                result = mAuthServiceLink->Invoke<JsonObject, JsonObject>(JSONRPC_THUNDER_TIMEOUT, "getDeviceId", params, response);
+                if (result == Core::ERROR_NONE && response.HasLabel("partnerId"))
+                {
+                    mMutex.lock();
+                    mAttributes.partnerId = response["partnerId"].String();
+                    LOGINFO("Got partnerId %s", mAttributes.partnerId.c_str());
+                    mMutex.unlock();
+                }
+                else
+                {
+                    LOGERR("Failed to get partnerId: %d", result);
+                }
+
+                // Get current activation status from AuthService.getActivationStatus
+                result = mAuthServiceLink->Invoke<JsonObject, JsonObject>(JSONRPC_THUNDER_TIMEOUT, "getActivationStatus", params, response);
+                if (result == Core::ERROR_NONE && response.HasLabel("status"))
+                {
+                    bool activated = false;
+                    if (response["status"].String() == "activated")
+                    {
+                        activated = true;
+                    }
+
+                    mMutex.lock();
+                    mAttributes.activated = activated;
+                    mMutex.unlock();
+                }
+                else
+                {
+                    LOGERR("Failed to get activation status");
+                }
+            }
+            else
+            {
+                LOGERR("Failed to get AuthService link");
+                mMutex.lock();
+                mAttributes.partnerId = SIFT_PARTNER_ID_DFL;
+                mAttributes.activated = false;
+                mMutex.unlock();
+            }
+
             //Activate System plugin if needed
             if (IsPluginActivated(mShell, SYSTEM_CALLSIGN) == false)
             {
@@ -745,65 +766,60 @@ namespace WPEFramework
             return result;
         }
 
-        void SiftConfig::GetAuthServiceValues()
+        void SiftConfig::UpdateXboValues()
         {
-            auto authServiceLink = std::unique_ptr<JSONRPCDirectLink>(new JSONRPCDirectLink(mShell, AUTHSERVICE_CALLSIGN));
-            if (authServiceLink == nullptr)
+            if (mAuthServiceLink == nullptr)
             {
-                LOGERR("Failed to create JSONRPCDirectLink");
                 return;
             }
 
-            JsonObject params;
-            JsonObject response;
-
-            uint32_t result = authServiceLink->Invoke<JsonObject, JsonObject>(JSONRPC_THUNDER_TIMEOUT, "getDeviceId", params, response);
-            if (result == Core::ERROR_NONE && response.HasLabel("partnerId"))
-            {
-                mMutex.lock();
-                mAttributes.partnerId = response["partnerId"].String();
-                LOGINFO("Got partnerId %s", mAttributes.partnerId.c_str());
-                mMutex.unlock();
-            }
+            // get xboAccountId and xboDeviceId from AuthService if activated and empty
+            mMutex.lock();
+            bool activated = mAttributes.activated;
+            string xboAccountId = mAttributes.xboAccountId;
+            string xboDeviceId = mAttributes.xboDeviceId;
+            mMutex.unlock();
 
-            // get activation status from AuthService.getActivationStatus
-            result = authServiceLink->Invoke<JsonObject, JsonObject>(JSONRPC_THUNDER_TIMEOUT, "getActivationStatus", params, response);
-            if (result == Core::ERROR_NONE && response.HasLabel("status") && response["status"].String() == "activated")
+            if (activated && xboAccountId.empty() )
             {
-                LOGINFO("Device is activated");
+                JsonObject params;
+                JsonObject response;
                 // get xboAccountId from AuthService.getServiceAccountId
-                result = authServiceLink->Invoke<JsonObject, JsonObject>(JSONRPC_THUNDER_TIMEOUT, "getServiceAccountId", params, response);
+                uint32_t result = mAuthServiceLink->Invoke<JsonObject, JsonObject>(JSONRPC_THUNDER_TIMEOUT, "getServiceAccountId", params, response);
                 if (result == Core::ERROR_NONE && response.HasLabel("serviceAccountId"))
                 {
                     mMutex.lock();
                     mAttributes.xboAccountId = response["serviceAccountId"].String();
                     LOGINFO("Got xboAccountId %s", mAttributes.xboAccountId.c_str());
                     mMutex.unlock();
                 }
+                else
+                {
+                    LOGERR("Failed to get xboAccountId");
+                }
+            }
 
+            if (activated && xboDeviceId.empty())
+            {
+                JsonObject params;
+                JsonObject response;
                 // get xboDeviceId from AuthService.getXDeviceId
-                result = authServiceLink->Invoke<JsonObject, JsonObject>(JSONRPC_THUNDER_TIMEOUT, "getXDeviceId", params, response);
+                uint32_t result = mAuthServiceLink->Invoke<JsonObject, JsonObject>(JSONRPC_THUNDER_TIMEOUT, "getXDeviceId", params, response);
                 if (result == Core::ERROR_NONE && response.HasLabel("xDeviceId"))
                 {
                     mMutex.lock();
                     mAttributes.xboDeviceId = response["xDeviceId"].String();
                     LOGINFO("Got xboDeviceId %s", mAttributes.xboDeviceId.c_str());
                     mMutex.unlock();
                 }
-
-                mMutex.lock();
-                mAttributes.activated = true;
-                mMutex.unlock();
-            }
-            else
-            {
-                mMutex.lock();
-                mAttributes.activated = false;
-                mMutex.unlock();
+                else
+                {
+                    LOGERR("Failed to get xboDeviceId");
+                }
             }
         }
 
-        bool SiftConfig::GetTimeZone()
+        bool SiftConfig::UpdateTimeZone()
         {
             int32_t timeZoneOffsetSec = 0;
             SystemTime::TimeZoneAccuracy accuracy = SystemTime::TimeZoneAccuracy::ACC_UNDEFINED;
@@ -813,7 +829,6 @@ namespace WPEFramework
                 accuracy = mSystemTime->GetTimeZoneOffset(timeZoneOffsetSec);
                 mMutex.lock();
                 mAttributes.deviceTimeZone = timeZoneOffsetSec * 1000;
-                LOGINFO("Got deviceTimeZone %d,  accuracy %d", mAttributes.deviceTimeZone, accuracy);
                 mMutex.unlock();
             }
 
@@ -825,6 +840,24 @@ namespace WPEFramework
             return false;
         }
 
+        void SiftConfig::OnActivationStatusChanged(const JsonObject& parameters)
+        {
+            std::string parametersString;
+            parameters.ToString(parametersString);
+            LOGINFO("OnActivationStatusChanged: %s", parametersString.c_str());
+            bool activated = false;
+            if (parameters.HasLabel("newActivationStatus") && parameters["newActivationStatus"].String() == "activated")
+            {
+                activated = true;
+            }
+
+            mMutex.lock();
+            mAttributes.activated = activated;
+            mAttributes.xboAccountId.clear();
+            mAttributes.xboDeviceId.clear();
+            mMutex.unlock();
+        }
+
         void SiftConfig::ActivatePlugin(PluginHost::IShell *shell, const char *callSign)
         {
             JsonObject joParams;
@@ -874,6 +907,20 @@ namespace WPEFramework
             return state == PluginHost::IShell::ACTIVATED;
         }
 
+        std::shared_ptr<WPEFramework::JSONRPC::LinkType<WPEFramework::Core::JSON::IElement>> SiftConfig::GetThunderControllerClient(std::string callsign)
+        {
+            std::string thunderAccessValue = THUNDER_ACCESS_DEFAULT_VALUE;
+            char *thunderAccessValueEnv = getenv("THUNDER_ACCESS_VALUE");
+            if (NULL != thunderAccessValueEnv)
+            {
+                thunderAccessValue = thunderAccessValueEnv;
+            }
+
+            std::string query = "token=" + sThunderSecurityToken;
+            Core::SystemInfo::SetEnvironment(_T("THUNDER_ACCESS"), (_T(thunderAccessValue)));
+            return std::make_shared<WPEFramework::JSONRPC::LinkType<WPEFramework::Core::JSON::IElement>>(callsign, "", false, query);
+        }
+
         void SiftConfig::MonitorKeys::ValueChanged(const string& ns, const string& key, const string& value)
         {
             auto it = mCallbacks.find(ns);

Analytics/Implementation/Backend/Sift/SiftConfig.h

@@ -128,12 +128,14 @@ namespace WPEFramework
             void InitializeKeysMap();
             void Initialize();
             void ParsePluginConfig();
-
             uint32_t GetValueFromPersistent(const string &ns, const string &key, string &value);
-            void GetAuthServiceValues();
-            bool GetTimeZone();
+            void UpdateXboValues();
+            bool UpdateTimeZone();
+            void OnActivationStatusChanged(const JsonObject& parameters);
+
             static void ActivatePlugin(PluginHost::IShell *shell, const char *callSign);
             static bool IsPluginActivated(PluginHost::IShell *shell, const char *callSign);
+            static std::shared_ptr<WPEFramework::JSONRPC::LinkType<WPEFramework::Core::JSON::IElement>> GetThunderControllerClient(std::string callsign="");
 
             std::thread mInitializationThread;
             Core::Sink<MonitorKeys> mMonitorKeys;
@@ -144,6 +146,7 @@ namespace WPEFramework
             PluginHost::IShell *mShell;
             std::map<std::string, std::map<std::string, std::string*>> mKeysMap;
             SystemTimePtr mSystemTime;
+            std::shared_ptr<WPEFramework::JSONRPC::LinkType<WPEFramework::Core::JSON::IElement>> mAuthServiceLink;
         };
 
         typedef std::unique_ptr<SiftConfig> SiftConfigPtr;