Release v2.1.1

documentation/docs/05-changelog.md

@@ -1,4 +1,10 @@
 ## CHANGELOG
+### v2.1.1
+10/15/2019
+### Bug Fixes
+- Fixes a bug where users were being double counted on mobile platforms
+- Fixes a bug which send incomplete telemetry events.
+
 ### v.2.1.0
 09/20/2019
 ##### New Features

sdkproject/Assets/Mapbox/Core/Plugins/iOS/MapboxMetricsClient.m

@@ -1,6 +1,6 @@
 #import <MapboxMobileEvents/MapboxMobileEvents.h>
 
-void initialize(const char* accessToken, const char* userAgentBase, const char* hostSDKVersion) {    
+void initialize(const char* accessToken, const char* userAgentBase, const char* hostSDKVersion) {
     [[MMEEventsManager sharedManager] initializeWithAccessToken:[NSString stringWithUTF8String:accessToken] 
                                                   userAgentBase:[NSString stringWithUTF8String:userAgentBase]
                                                   hostSDKVersion:[NSString stringWithUTF8String:hostSDKVersion]];
@@ -12,4 +12,7 @@ void sendTurnstileEvent() {
 
 void setLocationCollectionState(bool enable) {
 	[MMEEventsManager sharedManager].metricsEnabled = enable;
-}
+}
+void setSkuId(const char* skuId){
+    [MMEEventsManager sharedManager].skuId = [NSString stringWithUTF8String:skuId];
+}

sdkproject/Assets/Mapbox/Core/Plugins/iOS/MapboxMobileEvents/include/MapboxMobileEvents/MMEConstants.h

@@ -1,4 +1,5 @@
 #import <Foundation/Foundation.h>
+#import "MMETypes.h"
 
 extern NSString * const MMEAPIClientBaseURL;
 extern NSString * const MMEAPIClientBaseAPIURL;
@@ -14,7 +15,6 @@ extern NSString * const MMEAPIClientAttachmentsHeaderFieldContentTypeValue;
 extern NSString * const MMEAPIClientHeaderFieldContentEncodingKey;
 extern NSString * const MMEAPIClientHTTPMethodPost;
 extern NSString * const MMEAPIClientHTTPMethodGet;
-extern NSString * const MMEErrorDomain;
 
 // Debug types
 extern NSString * const MMEDebugEventType;
@@ -29,29 +29,18 @@ extern NSString * const MMEDebugEventTypeBackgroundTask;
 extern NSString * const MMEDebugEventTypeMetricCollection;
 extern NSString * const MMEDebugEventTypeLocationManager;
 extern NSString * const MMEDebugEventTypeTelemetryMetrics;
+extern NSString * const MMEDebugEventTypeCertPinning;
 
 // Event types
 extern NSString * const MMEEventTypeAppUserTurnstile;
 extern NSString * const MMEEventTypeTelemetryMetrics;
 extern NSString * const MMEEventTypeMapLoad;
-extern NSString * const MMEEventTypeMapTap;
-extern NSString * const MMEEventTypeMapDragEnd;
 extern NSString * const MMEEventTypeLocation;
 extern NSString * const MMEEventTypeVisit;
 extern NSString * const MMEEventTypeLocalDebug;
 extern NSString * const MMEventTypeOfflineDownloadStart;
 extern NSString * const MMEventTypeOfflineDownloadEnd;
 
-// Gestures
-extern NSString * const MMEEventGestureSingleTap;
-extern NSString * const MMEEventGestureDoubleTap;
-extern NSString * const MMEEventGestureTwoFingerSingleTap;
-extern NSString * const MMEEventGestureQuickZoom;
-extern NSString * const MMEEventGesturePanStart;
-extern NSString * const MMEEventGesturePinchStart;
-extern NSString * const MMEEventGestureRotateStart;
-extern NSString * const MMEEventGesturePitchStart;
-
 // Event keys
 extern NSString * const MMEEventKeyArrivalDate;
 extern NSString * const MMEEventKeyDepartureDate;
@@ -60,13 +49,13 @@ extern NSString * const MMEEventKeyLongitude;
 extern NSString * const MMEEventKeyZoomLevel;
 extern NSString * const MMEEventKeyMaxZoomLevel;
 extern NSString * const MMEEventKeyMinZoomLevel;
-extern NSString * const MMEEventKeyGestureID;
 extern NSString * const MMEEventKeyEvent;
 extern NSString * const MMEEventKeyCreated;
 extern NSString * const MMEEventKeyStyleURL;
-extern NSString * const MMEEventKeyVendorID;
+extern NSString * const MMEEventKeyVendorId;
 extern NSString * const MMEEventKeyModel;
 extern NSString * const MMEEventKeyDevice;
+extern NSString * const MMEEventKeySkuId;
 extern NSString * const MMEEventKeyEnabledTelemetry;
 extern NSString * const MMEEventKeyOperatingSystem;
 extern NSString * const MMEEventKeyResolution;
@@ -86,8 +75,11 @@ extern NSString * const MMEEventSDKIdentifier;
 extern NSString * const MMEEventSDKVersion;
 extern NSString * const MMEEventKeyLocalDebugDescription;
 extern NSString * const MMEEventKeyErrorCode;
+extern NSString * const MMEEventKeyErrorDomain;
 extern NSString * const MMEEventKeyErrorDescription;
 extern NSString * const MMEEventKeyErrorFailureReason;
+extern NSString * const MMEEventKeyErrorNoReason;
+extern NSString * const MMEEventKeyErrorNoDomain;
 extern NSString * const MMEEventKeyFailedRequests;
 extern NSString * const MMEEventKeyHeader;
 extern NSString * const MMEEventKeyPlatform;
@@ -132,13 +124,74 @@ extern NSString * const MMEEventUnknown;
 
 extern NSString * const MMEResponseKey;
 
-// SDK event source
+/*! @brief SDK event source */
 extern NSString * const MMEEventSource;
 
-// Log reporter HTML
-extern NSString * const MMELoggerHTML;
-extern NSString * const MMELoggerShareableHTML;
+#pragma mark - mobile.crash Keys
+
+extern NSString * const MMEEventMobileCrash;
+extern NSString * const MMEEventKeyOSVersion;
+extern NSString * const MMEEventKeyBuildType;
+extern NSString * const MMEEventKeyIsSilentCrash;
+extern NSString * const MMEEventKeyStackTrace;
+extern NSString * const MMEEventKeyStackTraceHash;
+extern NSString * const MMEEventKeyInstallationId;
+extern NSString * const MMEEventKeyThreadDetails;
+extern NSString * const MMEEventKeyAppId;
+extern NSString * const MMEEventKeyAppVersion;
+extern NSString * const MMEEventKeyAppStartDate;
+extern NSString * const MMEEventKeyCustomData;
+
+#pragma mark - MMEErrorDomain
+
+/*! @brief NSErrorDomain for MapboxMobileEvents */
+extern NSErrorDomain const MMEErrorDomain;
+
+/*! @brief MMEErrorDomain Error Numbers
+    - MMENoError: No Error
+    - MMEErrorException for exceptions
+    - MMEErrorEventInit for errors when initlizing events
+    - MMEErrorEventInitMissingKey if the event attributes dictionary does not include the event key,
+    - MMEErrorEventInitException if an exception occured durring initWithAttributes:error:,
+    - MMEErrorEventInitInvalid if the provided eventAttributes cannot be converted to JSON objects
+*/
+typedef NS_ENUM(NSInteger, MMEErrorNumber) {
+    MMENoError = 0,
+    MMEErrorException = 10001,
+    MMEErrorEventInit = 10002,
+    MMEErrorEventInitMissingKey = 10003,
+    MMEErrorEventInitException  = 10004,
+    MMEErrorEventInitInvalid    = 10005,
+    MMEErrorEventEncoding = 10006,
+    MMEErrorEventCounting = 10007
+};
+
+/*! @brief key for MMEErrorEventInit userInfo dictionary containing the attributes which failed to create the event */
+extern NSString * const MMEErrorEventAttributesKey;
+
+/*! @brief key for MMEErrorDomain userInfo dictionary containing the underlying exception which triggered the error */
+extern NSString * const MMEErrorUnderlyingExceptionKey;
+
+#pragma mark - Deprecated
+
+extern NSString * const MMEErrorDescriptionKey; MME_DEPRECATED_MSG("Use NSLocalizedDescriptionKey")
+
+extern NSString * const MMEEventKeyVendorID MME_DEPRECATED_MSG("Use MMEEventKeyVendorId");
+extern NSString * const MMEEventKeyInstallationID MME_DEPRECATED_MSG("Use MMEEventKeyInstallationId");
+extern NSString * const MMEEventKeyAppID MME_DEPRECATED_MSG("Use MMEEventKeyInstallationId");
 
-@interface MMEConstants: NSObject
+extern NSString * const MMELoggerHTML MME_DEPRECATED;
+extern NSString * const MMELoggerShareableHTML MME_DEPRECATED;
 
-@end
+extern NSString * const MMEEventKeyGestureId MME_DEPRECATED;
+extern NSString * const MMEEventKeyGestureID MME_DEPRECATED;
+extern NSString * const MMEEventGestureSingleTap MME_DEPRECATED;
+extern NSString * const MMEEventGestureDoubleTap MME_DEPRECATED;
+extern NSString * const MMEEventGestureTwoFingerSingleTap MME_DEPRECATED;
+extern NSString * const MMEEventGestureQuickZoom MME_DEPRECATED;
+extern NSString * const MMEEventGesturePanStart MME_DEPRECATED;
+extern NSString * const MMEEventGesturePinchStart MME_DEPRECATED;
+extern NSString * const MMEEventGestureRotateStart MME_DEPRECATED;
+extern NSString * const MMEEventGesturePitchStart MME_DEPRECATED;
+extern NSString * const MMEEventTypeMapTap MME_DEPRECATED;
+extern NSString * const MMEEventTypeMapDragEnd MME_DEPRECATED;