Merge pull request #91 from smartmobilefactory/feature/SentrySDK

Sentry smf logger integration and breadcrumbs integration.

Author: kmeinh

Sentry/SentrySDK+SMFLogger.swift

@@ -14,33 +14,9 @@ class SentrySDK: NSObject {
 
 	fileprivate static var shared			: SentrySDK?
 
-	fileprivate static let plistSentryDsn	= "SentryDsn"
-
-	fileprivate static let isDebugBuild		: Bool = {
-		#if DEBUG
-		return true
-		#else
-		return false
-		#endif
-	}()
-
-	fileprivate static let environment		: String = {
-		#if ALPHA
-		return "alpha"
-		#endif
-
-		#if BETA
-		return "beta"
-		#endif
-
-		#if LIVE
-		return "live"
-		#endif
-	}()
-
 	// MARK: - Private properties
 
-	fileprivate var isInitialized			= false
+	fileprivate var isInitialized					= false
 
 	// MARK: - Public properties
 
@@ -62,15 +38,7 @@ class SentrySDK: NSObject {
 	///
 	/// - Parameters:
 	///   - configuration: sentry dsn string
-	static func setup(sentryDsn: String? = nil) {
-
-		// Get the Sentry dsn
-		let idFromPlist = Bundle.main.object(forInfoDictionaryKey: SentrySDK.plistSentryDsn) as? String
-
-		guard let _sentryDsn = (sentryDsn ?? idFromPlist) else {
-			assertionFailure("Error: You have to set the `\(SentrySDK.plistSentryDsn)` key in the info plist.")
-			return
-		}
+	static func setup(configuration: SentrySDK.Configuration) {
 
 		// Make sure SentrySDK is not setup in a debug build
 		guard (self.isDebugBuild == false) else {
@@ -81,9 +49,18 @@ class SentrySDK: NSObject {
 		let instance = (self.shared ?? SentrySDK())
 
 		do {
-			Client.shared = try Client(dsn: _sentryDsn)
+			Client.shared = try Client(dsn: configuration.sentryDSN)
 			Client.shared?.beforeSerializeEvent = { (event: Event) in
-				event.environment = self.environment
+				event.environment = SentrySDK.Configuration.environment
+
+				if	(configuration.enableSMFLogUpload == true),
+					let loggerContents = Logger.logFilesContent(maxSize: configuration.smfLogUploadMaxSize) {
+						event.message = loggerContents
+				}
+			}
+
+			if (configuration.enableBreadcrumbs == true) {
+				Client.shared?.enableAutomaticBreadcrumbTracking()
 			}
 
 			try Client.shared?.startCrashHandler()
@@ -105,3 +82,64 @@ class SentrySDK: NSObject {
 		fatalError("This is a test crash to trigger a crash report in Sentry Dashboard")
 	}
 }
+
+extension SentrySDK {
+
+	struct Configuration {
+		fileprivate static let plistSentryDsn	= "SentryDsn"
+
+		fileprivate static let isDebugBuild		: Bool = {
+			#if DEBUG
+			return true
+			#else
+			return false
+			#endif
+		}()
+
+		fileprivate static let environment		: String = {
+			#if ALPHA
+			return "alpha"
+			#endif
+
+			#if BETA
+			return "beta"
+			#endif
+
+			#if LIVE
+			return "live"
+			#endif
+		}()
+
+		fileprivate var sentryDSN			: String	= ""
+		fileprivate var enableSMFLogUpload	: Bool		= true
+		fileprivate var enableBreadcrumbs	: Bool		= true
+		fileprivate var smfLogUploadMaxSize	: Int		= 5000
+
+		/// Initializes a SentrySDK Configuration
+		///
+		///	- Parameters:
+		///		- sentryDSN: supply this manually if you dont want it in the info.plist
+		///		- enableSMFLogUpload: true if you want the SMFLogger logs to be submitted with a crash
+		///		- enableBreadcrumbs: true if you want Sentry to attach the last user interaction before a crash
+		///		- smfLogUploadMaxSize: The max count of characters which should be uploaded
+		init(sentryDSN: String? = nil, enableSMFLogUpload: Bool = true, smfLogUploadMaxSize: Int = 5000, smfEnableBreadcrumbs: Bool = true) {
+
+			// Get the Sentry DSN
+			let dsnFromPlist = Bundle.main.object(forInfoDictionaryKey: SentrySDK.Configuration.plistSentryDsn) as? String
+
+			guard let _sentryDsn = (sentryDSN ?? dsnFromPlist) else {
+				assertionFailure("Error: You have to set the `\(SentrySDK.Configuration.plistSentryDsn)` key in the info plist or specify your own when initializing teh SDK.")
+				return
+			}
+
+			self.sentryDSN				= _sentryDsn
+			self.enableBreadcrumbs		= smfEnableBreadcrumbs
+			self.enableSMFLogUpload		= enableSMFLogUpload
+			self.smfLogUploadMaxSize	= smfLogUploadMaxSize
+		}
+
+		static var `default`: SentrySDK.Configuration {
+			return Configuration()
+		}
+	}
+}