From b17a7c5751a7c125b9c09ba5388d86c8a31bdb08 Mon Sep 17 00:00:00 2001
From: Matthew Chen <charlesmchen@gmail.com>
Date: Mon, 24 Jul 2017 16:05:29 -0400
Subject: [PATCH] Review NSError usage.

// FREEBIE
---
 .../src/Contacts/ContactsUpdater.m            |  2 +-
 SignalServiceKit/src/Devices/OWSDevice.m      | 20 +++++++++++++++----
 SignalServiceKit/src/Util/OWSAnalytics.h      |  2 +-
 3 files changed, 18 insertions(+), 6 deletions(-)

diff --git a/SignalServiceKit/src/Contacts/ContactsUpdater.m b/SignalServiceKit/src/Contacts/ContactsUpdater.m
index 5026c19e5..b4583ef60 100644
--- a/SignalServiceKit/src/Contacts/ContactsUpdater.m
+++ b/SignalServiceKit/src/Contacts/ContactsUpdater.m
@@ -212,7 +212,7 @@ NS_ASSUME_NONNULL_BEGIN
               NSHTTPURLResponse *response = (NSHTTPURLResponse *)task.response;
               if (response.statusCode == 413) {
                   failure(OWSErrorWithCodeDescription(
-                      OWSErrorCodeContactsUpdaterRateLimit, OWSSignalServiceKitErrorDomain));
+                      OWSErrorCodeContactsUpdaterRateLimit, @"Contacts Intersection Rate Limit"));
               } else {
                   failure(error);
               }
diff --git a/SignalServiceKit/src/Devices/OWSDevice.m b/SignalServiceKit/src/Devices/OWSDevice.m
index 3f3e9ba6b..3d329614a 100644
--- a/SignalServiceKit/src/Devices/OWSDevice.m
+++ b/SignalServiceKit/src/Devices/OWSDevice.m
@@ -88,8 +88,8 @@ uint32_t const OWSDevicePrimaryDeviceId = 1;
                     }
                 }
                 *success = NO;
-                *error = OWSErrorWithCodeDescription(OWSErrorCodeFailedToDecodeJson,
-                    [NSString stringWithFormat:@"unable to decode date from %@", value]);
+                DDLogError(@"%@ unable to decode date from %@", self.tag, value);
+                *error = OWSErrorWithCodeDescription(OWSErrorCodeFailedToDecodeJson, @"Unable to decode date from %@");
                 return nil;
             }
                 reverseBlock:^id(id value, BOOL *success, NSError **error) {
@@ -101,8 +101,8 @@ uint32_t const OWSDevicePrimaryDeviceId = 1;
                             return result;
                         }
                     }
-                    *error = OWSErrorWithCodeDescription(OWSErrorCodeFailedToEncodeJson,
-                        [NSString stringWithFormat:@"unable to encode date from %@", value]);
+                    DDLogError(@"%@ unable to encode date from %@", self.tag, value);
+                    *error = OWSErrorWithCodeDescription(OWSErrorCodeFailedToEncodeJson, @"Unable to encode date");
                     *success = NO;
                     return nil;
                 }];
@@ -178,6 +178,18 @@ uint32_t const OWSDevicePrimaryDeviceId = 1;
     return self.deviceId == device.deviceId;
 }
 
+#pragma mark - Logging
+
++ (NSString *)tag
+{
+    return [NSString stringWithFormat:@"[%@]", self.class];
+}
+
+- (NSString *)tag
+{
+    return self.class.tag;
+}
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/SignalServiceKit/src/Util/OWSAnalytics.h b/SignalServiceKit/src/Util/OWSAnalytics.h
index 3719fcade..40620d5e8 100755
--- a/SignalServiceKit/src/Util/OWSAnalytics.h
+++ b/SignalServiceKit/src/Util/OWSAnalytics.h
@@ -56,12 +56,12 @@ typedef NSDictionary<NSString *, id> *_Nonnull (^OWSProdAssertParametersBlock)()
 #define kOWSAnalyticsParameterNSExceptionReason @"nsexception_reason"
 #define kOWSAnalyticsParameterNSExceptionClassName @"nsexception_classname"
 
+// We don't include the error description because it may have PII.
 #define AnalyticsParametersFromNSError(__nserror)                                                                      \
     ^{                                                                                                                 \
         return (@{                                                                                                     \
             kOWSAnalyticsParameterNSErrorDomain : (__nserror.domain ?: @"unknown"),                                    \
             kOWSAnalyticsParameterNSErrorCode : @(__nserror.code),                                                     \
-            kOWSAnalyticsParameterNSErrorDescription : (__nserror.description ?: @"unknown"),                          \
         });                                                                                                            \
     }