[Time] Log refactoring.
authorPawel Andruszkiewicz <p.andruszkie@samsung.com>
Mon, 30 Nov 2015 08:58:50 +0000 (09:58 +0100)
committerHyunJin Park <hj.na.park@samsung.com>
Thu, 3 Dec 2015 01:32:55 +0000 (10:32 +0900)
[Verification] Pass rate did not change: 99.36% (470/467/3/0/0).

Change-Id: I5c1f9a7212cbd5eb636188e5a2d3ed74aaab905d
Signed-off-by: Pawel Andruszkiewicz <p.andruszkie@samsung.com>
src/time/time_instance.cc
src/time/time_manager.cc
src/time/time_utils.cc

index 2f0ce9372d147500176243507807e09f6ce06cfa..4282b1e89864f5e835c2484ffce4c33d1ce21ee0 100644 (file)
@@ -63,7 +63,7 @@ void TimeInstance::TimeUtil_getAvailableTimezones(const picojson::value& /*args*
   PlatformResult res = TimeUtilTools::GetAvailableTimezones(
       &array.first->second.get<picojson::array>());
   if (res.IsError()) {
-    ReportError(res, &out);
+    LogAndReportError(res, &out, ("Failed to get available timezones"));
     return;
   }
   ReportSuccess(result, out);
@@ -72,8 +72,8 @@ void TimeInstance::TimeUtil_getAvailableTimezones(const picojson::value& /*args*
 void TimeInstance::TimeUtil_getDateFormat(const picojson::value& args, picojson::object& out) {
   LoggerD("Entered");
   if (!args.contains("shortformat")) {
-    LoggerE("Invalid parameter passed.");
-    ReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out);
+    LogAndReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out,
+                      ("Required parameter \"shortformat\" is missing"));
     return;
   }
 
@@ -81,7 +81,7 @@ void TimeInstance::TimeUtil_getDateFormat(const picojson::value& args, picojson:
   std::string format;
   PlatformResult res = TimeUtilTools::GetDateFormat(shortformat, &format);
   if (res.IsError()) {
-    ReportError(res, &out);
+    LogAndReportError(res, &out, ("Failed to get date format."));
     return;
   }
 
@@ -98,7 +98,7 @@ void TimeInstance::TimeUtil_getTimeFormat(const picojson::value& /* args */,
   std::string format;
   PlatformResult res = TimeUtilTools::GetTimeFormat(&format);
   if (res.IsError()) {
-    ReportError(res, &out);
+    LogAndReportError(res, &out, ("Failed to get time format."));
     return;
   }
 
@@ -114,7 +114,7 @@ void TimeInstance::TimeUtil_setDateTimeChangeListener(const picojson::value& /*a
   LoggerD("Entered");
   PlatformResult res = manager_.RegisterVconfCallback(kTimeChange);
   if (res.IsError()) {
-    ReportError(res, &out);
+    LogAndReportError(res, &out, ("Failed to set date-time change listener."));
   }
   ReportSuccess(out);
 }
@@ -124,7 +124,7 @@ void TimeInstance::TimeUtil_unsetDateTimeChangeListener(const picojson::value& /
   LoggerD("Entered");
   PlatformResult res = manager_.UnregisterVconfCallback(kTimeChange);
   if (res.IsError()) {
-    ReportError(res, &out);
+    LogAndReportError(res, &out, ("Failed to remove date-time change listener."));
   }
   ReportSuccess(out);
 }
@@ -134,7 +134,7 @@ void TimeInstance::TimeUtil_setTimezoneChangeListener(const picojson::value& /*a
   LoggerD("Entered");
   PlatformResult res = manager_.RegisterVconfCallback(kTimezoneChange);
   if (res.IsError()) {
-    ReportError(res, &out);
+    LogAndReportError(res, &out, ("Failed to set timezone change listener."));
   }
   ReportSuccess(out);
 }
@@ -144,7 +144,7 @@ void TimeInstance::TimeUtil_unsetTimezoneChangeListener(const picojson::value& /
   LoggerD("Entered");
   PlatformResult res = manager_.UnregisterVconfCallback(kTimezoneChange);
   if (res.IsError()) {
-    ReportError(res, &out);
+    LogAndReportError(res, &out, ("Failed to remove timezone change listener."));
   }
   ReportSuccess(out);
 }
@@ -165,8 +165,8 @@ void TimeInstance::TZDate_GetTimezoneOffset(const picojson::value& args,
                                             picojson::object& out) {
   LoggerD("Entered");
   if (!args.contains("timezone") || !args.contains("timestamp")) {
-    LoggerE("Invalid parameter passed.");
-    ReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out);
+    LogAndReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out,
+                      ("Required parameters are missing: \"timezone\", \"timestamp\""));
     return;
   }
   const std::string& timezone_id = args.get("timezone").get<std::string>();
@@ -186,7 +186,7 @@ void TimeInstance::TZDate_GetTimezoneOffset(const picojson::value& args,
     result_obj.insert(std::make_pair("modifier", picojson::value(modifier)));
     ReportSuccess(result, out);
   } else {
-    ReportError(res, &out);
+    LogAndReportError(res, &out, ("Failed to get timezone offset."));
   }
 }
 
@@ -196,8 +196,8 @@ void TimeInstance::ToStringTemplate(const picojson::value& args,
                                     picojson::object* out) {
   LoggerD("Entered");
   if (!args.contains("timezone") || !args.contains("timestamp")) {
-    LoggerE("Invalid parameter passed.");
-    ReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), out);
+    LogAndReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), out,
+                      ("Required parameters are missing: \"timezone\", \"timestamp\""));
     return;
   }
   const std::string& timezone_id = args.get("timezone").get<std::string>();
@@ -211,7 +211,7 @@ void TimeInstance::ToStringTemplate(const picojson::value& args,
   PlatformResult res = TimeUtilTools::ToStringHelper(date, unicode_id, use_locale_fmt,
                                                      type, &result_string);
   if (res.IsError()) {
-    ReportError(res, out);
+    LogAndReportError(res, out, ("Failed to convert to string."));
     return;
   }
 
@@ -257,8 +257,8 @@ void TimeInstance::TZDate_getTimezoneAbbreviation(const picojson::value& args,
                                                   picojson::object& out) {
   LoggerD("Entered");
   if (!args.contains("timezone") || !args.contains("timestamp")) {
-    LoggerE("Invalid parameter passed.");
-    ReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out);
+    LogAndReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out,
+                      ("Required parameters are missing: \"timezone\", \"timestamp\""));
     return;
   }
   const std::string& timezone_id = args.get("timezone").get<std::string>();
@@ -270,7 +270,7 @@ void TimeInstance::TZDate_getTimezoneAbbreviation(const picojson::value& args,
   std::string result_string;
   PlatformResult res = TimeUtilTools::GetTimezoneAbbreviation(date, unicode_id, &result_string);
   if (res.IsError()) {
-    ReportError(res, &out);
+    LogAndReportError(res, &out, ("Failed to get timezone abbreviation."));
     return;
   }
 
@@ -284,8 +284,8 @@ void TimeInstance::TZDate_getTimezoneAbbreviation(const picojson::value& args,
 void TimeInstance::TZDate_isDST(const picojson::value& args, picojson::object& out) {
   LoggerD("Entered");
   if (!args.contains("timezone") || !args.contains("timestamp")) {
-    LoggerE("Invalid parameter passed.");
-    ReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out);
+    LogAndReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out,
+                      ("Required parameters are missing: \"timezone\", \"timestamp\""));
     return;
   }
   const std::string& timezone_id = args.get("timezone").get<std::string>();
@@ -297,7 +297,7 @@ void TimeInstance::TZDate_isDST(const picojson::value& args, picojson::object& o
   bool is_dst = false;
   PlatformResult res = TimeUtilTools::IsDST(date, unicode_id, &is_dst);
   if (res.IsError()) {
-    ReportError(res, &out);
+    LogAndReportError(res, &out, ("Failed to check DST."));
     return;
   }
   picojson::value result = picojson::value(picojson::object());
@@ -311,8 +311,8 @@ void TimeInstance::TZDate_getPreviousDSTTransition(const picojson::value& args,
                                                    picojson::object& out) {
   LoggerD("Entered");
   if (!args.contains("timezone") || !args.contains("timestamp")) {
-    LoggerE("Invalid parameter passed.");
-    ReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out);
+    LogAndReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out,
+                      ("Required parameters are missing: \"timezone\", \"timestamp\""));
     return;
   }
   const std::string& timezone_id = args.get("timezone").get<std::string>();
@@ -333,8 +333,8 @@ void TimeInstance::TZDate_getPreviousDSTTransition(const picojson::value& args,
 void TimeInstance::TZDate_getNextDSTTransition(const picojson::value& args, picojson::object& out) {
   LoggerD("Entered");
   if (!args.contains("timezone") || !args.contains("timestamp")) {
-    LoggerE("Invalid parameter passed.");
-    ReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out);
+    LogAndReportError(PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed."), &out,
+                      ("Required parameters are missing: \"timezone\", \"timestamp\""));
     return;
   }
   const std::string& timezone_id = args.get("timezone").get<std::string>();
index 4bc6adb8925e338797dfafcadffda27e236f70b7..2dc7bff54f536a368bb1de0237858d1dea2e5a24 100644 (file)
@@ -57,7 +57,9 @@ PlatformResult TimeManager::GetTimezoneOffset(const std::string& timezone_id,
   std::unique_ptr<TimeZone> tz (TimeZone::createTimeZone(*unicode_id));
 
   if (TimeZone::getUnknown() == *tz) {
-    return PlatformResult(ErrorCode::INVALID_VALUES_ERR, "Invalid parameter passed.");
+    return LogAndCreateResult(ErrorCode::INVALID_VALUES_ERR,
+                              "Invalid parameter passed.",
+                              ("Unknown timezone"));
   }
 
   const int32_t oneHour = 3600000;
@@ -97,8 +99,7 @@ PlatformResult TimeManager::RegisterVconfCallback(ListenerType type) {
     LOGD("registering listener on platform");
     if (0 != vconf_notify_key_changed(
         VCONFKEY_SYSTEM_TIME_CHANGED, OnTimeChangedCallback, this)) {
-      LOGE("Failed to register vconf callback");
-      return PlatformResult(ErrorCode::UNKNOWN_ERR, "Failed to register vconf callback");
+      return LogAndCreateResult(ErrorCode::UNKNOWN_ERR, "Failed to register vconf callback");
     }
   } else {
     LOGD("not registering listener on platform - already registered");
@@ -113,8 +114,7 @@ PlatformResult TimeManager::RegisterVconfCallback(ListenerType type) {
       LOGD("time zone change listener registered");
       break;
     default :
-      LOGE("Unknown type of listener");
-      return PlatformResult(ErrorCode::UNKNOWN_ERR, "Unknown type of listener");
+      return LogAndCreateResult(ErrorCode::UNKNOWN_ERR, "Unknown type of listener");
   }
   return PlatformResult(ErrorCode::NO_ERROR);
 }
@@ -131,14 +131,14 @@ PlatformResult TimeManager::UnregisterVconfCallback(ListenerType type) {
       LOGD("time zone change listener unregistered");
       break;
     default :
-      return PlatformResult(ErrorCode::UNKNOWN_ERR, "Unknown type of listener");
+      return LogAndCreateResult(ErrorCode::UNKNOWN_ERR, "Unknown type of listener");
   }
   if (!is_time_listener_registered_ && !is_timezone_listener_registered_) {
     LOGD("unregistering listener on platform");
     if (0 != vconf_ignore_key_changed(VCONFKEY_SYSTEM_TIME_CHANGED, OnTimeChangedCallback)) {
       LOGE("Failed to unregister vconf callback");
       // silent fail
-      //return PlatformResult(ErrorCode::UNKNOWN_ERR, "Failed to unregister vconf callback");
+      //return LogAndCreateResult(ErrorCode::UNKNOWN_ERR, "Failed to unregister vconf callback");
     }
   }
   return PlatformResult(ErrorCode::NO_ERROR);
index 0afbc86e6e85f6ceec12d58b09560b7d58aa9f5f..c1cc057a17d36c89e3ffb2fac644d925babd4ce7 100644 (file)
@@ -67,18 +67,21 @@ PlatformResult TimeUtilTools::IsDST(UDate timestamp,
   std::unique_ptr<icu::Calendar> calendar (Calendar::createInstance(*tz, ec));
 
   if (U_FAILURE(ec)){
-    LoggerE("Failed to create calendar instance: %d", ec);
-    return PlatformResult(ErrorCode::UNKNOWN_ERR, "Failed to create calendar instance");
+    return LogAndCreateResult(ErrorCode::UNKNOWN_ERR,
+                              "Failed to create calendar instance",
+                              ("Failed to create calendar instance: %d", ec));
   }
   calendar->setTime(timestamp, ec);
   if (U_FAILURE(ec)){
-    LoggerE("Failed to set calendar date: %d", ec);
-    return PlatformResult(ErrorCode::UNKNOWN_ERR, "Failed to set calendar date");
+    return LogAndCreateResult(ErrorCode::UNKNOWN_ERR,
+                              "Failed to set calendar date",
+                              ("Failed to set calendar date: %d", ec));
   }
   bool result = static_cast<bool>(calendar->inDaylightTime(ec));
   if (U_FAILURE(ec)){
-    LoggerE("Failed to get day light boolean: %d", ec);
-    return PlatformResult(ErrorCode::UNKNOWN_ERR, "Failed to get day light boolean");
+    return LogAndCreateResult(ErrorCode::UNKNOWN_ERR,
+                              "Failed to get day light boolean",
+                              ("Failed to get day light boolean: %d", ec));
   }
   *result_bool = result;
   return PlatformResult(ErrorCode::NO_ERROR);
@@ -108,9 +111,9 @@ PlatformResult TimeUtilTools::GetTimezoneAbbreviation(UDate date,
 
     return TimeUtilTools::ToUTF8String(str, result_string);
   }
-  LOGE("can't make SimpleDateFormat or can't get time");
-  return PlatformResult(ErrorCode::UNKNOWN_ERR,
-                        "can't make SimpleDateFormat or can't get time");
+
+  return LogAndCreateResult(ErrorCode::UNKNOWN_ERR,
+                            "Can't make SimpleDateFormat or can't get time");
 }
 
 PlatformResult TimeUtilTools::ToStringHelper(UDate date,
@@ -138,8 +141,7 @@ PlatformResult TimeUtilTools::ToStringHelper(UDate date,
     return TimeUtilTools::ToUTF8String(str, result_string);
   }
 
-  LOGE("can't make SimpleDateFormat or can't get time");
-  return PlatformResult(ErrorCode::UNKNOWN_ERR, "can't make SimpleDateFormat or can't get time");
+  return LogAndCreateResult(ErrorCode::UNKNOWN_ERR, "Can't make SimpleDateFormat or can't get time");
 }
 
 PlatformResult TimeUtilTools::ToUTF8String(const UnicodeString& uni_str,
@@ -151,8 +153,7 @@ PlatformResult TimeUtilTools::ToUTF8String(const UnicodeString& uni_str,
                                                       &std::free);
 
   if (!result_buffer) {
-    LOGE("memory allocation error");
-    return PlatformResult(ErrorCode::UNKNOWN_ERR, "memory allocation error");
+    return LogAndCreateResult(ErrorCode::UNKNOWN_ERR, "Memory allocation error");
   }
 
   memset(result_buffer.get(), 0, buffer_len);
@@ -160,8 +161,7 @@ PlatformResult TimeUtilTools::ToUTF8String(const UnicodeString& uni_str,
   uni_str.toUTF8(sink);
 
   if (sink.Overflowed()) {
-    LOGE("Converting error");
-    return PlatformResult(ErrorCode::UNKNOWN_ERR, "Converting error");
+    return LogAndCreateResult(ErrorCode::UNKNOWN_ERR, "Converting error");
   }
 
   *result_string = result_buffer.get();
@@ -354,14 +354,14 @@ PlatformResult TimeUtilTools::GetAvailableTimezones(picojson::array* available_t
         available_timezones->push_back(picojson::value(str));
         ++i;
       } else {
-        LOGE("An error occurred");
-        return PlatformResult(ErrorCode::UNKNOWN_ERR, "An error occurred");
+        return LogAndCreateResult(ErrorCode::UNKNOWN_ERR,
+                                  "An error occurred",
+                                  ("An error occurred: %d", ec));
       }
     } while ((str != nullptr) && (i < count));
   }
   else {
-    LOGE("Can't get timezones list");
-    return PlatformResult(ErrorCode::UNKNOWN_ERR, "Can't get timezones list");
+    return LogAndCreateResult(ErrorCode::UNKNOWN_ERR, "Can't get timezones list");
   }
   return PlatformResult(ErrorCode::NO_ERROR);
 }