Merge branch 'master' into feat/1777-no-session-update-for-dropped-events

kevinrenskers · kevinrenskers · commit 4af64f6938ed · 2022-11-15T11:26:15.000+01:00
* master: build(deps): bump github/codeql-action from 2.1.31 to 2.1.32 (#2386) build(deps): bump fastlane from 2.210.1 to 2.211.0 (#2385) ref: json serialization error reporting (#2355) release: 7.31.0 ref: Fix outdated comment in SessionTracker (#2381) fix: Do not delete the app state (#2382) build: Split Swift and Clang format for pre-commit (#2380)
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -22,7 +22,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@c3b6fce4ee2ca25bc1066aa3bf73962fda0e8898 # pin@v2
+        uses: github/codeql-action/init@4238421316c33d73aeea2801274dd286f157c2bb # pin@v2
         with:
           languages: ${{ matrix.language }}
 
@@ -35,4 +35,4 @@ jobs:
           -destination platform="iOS Simulator,OS=latest,name=iPhone 11 Pro"
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@c3b6fce4ee2ca25bc1066aa3bf73962fda0e8898 # pin@v2
+        uses: github/codeql-action/analyze@4238421316c33d73aeea2801274dd286f157c2bb # pin@v2
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -16,10 +16,18 @@ repos:
 
   - repo: local
     hooks:
-      - id: clang-format
-        name: Clang Format
+      - id: format-clang
+        name: Format ObjC, ObjC++, C, and C++
         entry: make
         language: system
-        types_or: ["objective-c", "objective-c++", "c", "c++", "swift" ]
+        types_or: ["objective-c", "objective-c++", "c", "c++"]
         args:
-          - "format"
+          - "format-clang"
+          
+      - id: format-swift
+        name: Format Swift
+        entry: make
+        language: system
+        types_or: ["swift" ]
+        args:
+          - "format-swift"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+### Fixes
+
+- Don't increase session's error count for dropped events (#2374)
+
+## 7.31.0
+
 ### Features
 
 - Store breadcrumbs to disk for OOM events (#2347)
@@ -10,7 +16,7 @@
 ### Fixes
 
 - Too long flush duration (#2370)
-- Don't increase session's error count for dropped events (#2374)
+- Do not delete the app state when OOM tracking is disabled. The app state is needed to determine the app start type on the next app start. (#2382)
 
 ## 7.30.2
 
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -17,17 +17,17 @@ GEM
     artifactory (3.0.15)
     atomos (0.1.3)
     aws-eventstream (1.2.0)
-    aws-partitions (1.644.0)
-    aws-sdk-core (3.159.0)
+    aws-partitions (1.660.0)
+    aws-sdk-core (3.167.0)
       aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.525.0)
-      aws-sigv4 (~> 1.1)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.5)
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-kms (1.58.0)
-      aws-sdk-core (~> 3, >= 3.127.0)
+    aws-sdk-kms (1.59.0)
+      aws-sdk-core (~> 3, >= 3.165.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.114.0)
-      aws-sdk-core (~> 3, >= 3.127.0)
+    aws-sdk-s3 (1.117.1)
+      aws-sdk-core (~> 3, >= 3.165.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.4)
     aws-sigv4 (1.5.2)
@@ -86,7 +86,7 @@ GEM
     escape (0.0.4)
     ethon (0.15.0)
       ffi (>= 1.15.0)
-    excon (0.93.0)
+    excon (0.94.0)
     faraday (1.10.2)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -116,7 +116,7 @@ GEM
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
     fastimage (2.2.6)
-    fastlane (2.210.1)
+    fastlane (2.211.0)
       CFPropertyList (>= 2.3, < 4.0.0)
       addressable (>= 2.8, < 3.0.0)
       artifactory (~> 3.0)
@@ -161,9 +161,9 @@ GEM
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    google-apis-androidpublisher_v3 (0.29.0)
-      google-apis-core (>= 0.9.0, < 2.a)
-    google-apis-core (0.9.0)
+    google-apis-androidpublisher_v3 (0.31.0)
+      google-apis-core (>= 0.9.1, < 2.a)
+    google-apis-core (0.9.1)
       addressable (~> 2.5, >= 2.5.1)
       googleauth (>= 0.16.2, < 2.a)
       httpclient (>= 2.8.1, < 3.a)
@@ -172,10 +172,10 @@ GEM
       retriable (>= 2.0, < 4.a)
       rexml
       webrick
-    google-apis-iamcredentials_v1 (0.15.0)
-      google-apis-core (>= 0.9.0, < 2.a)
-    google-apis-playcustomapp_v1 (0.11.0)
-      google-apis-core (>= 0.9.0, < 2.a)
+    google-apis-iamcredentials_v1 (0.16.0)
+      google-apis-core (>= 0.9.1, < 2.a)
+    google-apis-playcustomapp_v1 (0.12.0)
+      google-apis-core (>= 0.9.1, < 2.a)
     google-apis-storage_v1 (0.19.0)
       google-apis-core (>= 0.9.0, < 2.a)
     google-cloud-core (1.6.0)
@@ -184,15 +184,15 @@ GEM
     google-cloud-env (1.6.0)
       faraday (>= 0.17.3, < 3.0)
     google-cloud-errors (1.3.0)
-    google-cloud-storage (1.43.0)
+    google-cloud-storage (1.44.0)
       addressable (~> 2.8)
       digest-crc (~> 0.4)
       google-apis-iamcredentials_v1 (~> 0.1)
       google-apis-storage_v1 (~> 0.19.0)
       google-cloud-core (~> 1.6)
       googleauth (>= 0.16.2, < 2.a)
       mini_mime (~> 1.0)
-    googleauth (1.2.0)
+    googleauth (1.3.0)
       faraday (>= 0.17.3, < 3.a)
       jwt (>= 1.4, < 3.0)
       memoist (~> 0.16)
diff --git a/Makefile b/Makefile
@@ -22,14 +22,17 @@ lint:
 	swiftlint
 .PHONY: lint
 
-# Format all h,c,cpp and m files
-format:
+format: format-clang format-swift
+
+# Format ObjC, ObjC++, C, and C++
+format-clang:
 	@find . -type f \( -name "*.h" -or -name "*.hpp" -or -name "*.c" -or -name "*.cpp" -or -name "*.m" -or -name "*.mm" \) -and \
 		! \( -path "**.build/*" -or -path "**Build/*" -or -path "**/Carthage/Checkouts/*"  -or -path "**/libs/**" \) \
 		| xargs clang-format -i -style=file
 
+# Format Swift
+format-swift:
 	swiftlint --fix
-.PHONY: format
 
 test:
 	@echo "--> Running all tests"
diff --git a/Samples/iOS-Swift/iOS-Swift.xcodeproj/project.pbxproj b/Samples/iOS-Swift/iOS-Swift.xcodeproj/project.pbxproj
@@ -1096,7 +1096,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 7.30.2;
+				MARKETING_VERSION = 7.31.0;
 				PRODUCT_BUNDLE_IDENTIFIER = "io.sentry.sample.iOS-Swift";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				PROVISIONING_PROFILE_SPECIFIER = "match Development io.sentry.sample.iOS-Swift";
@@ -1125,7 +1125,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 7.30.2;
+				MARKETING_VERSION = 7.31.0;
 				PRODUCT_BUNDLE_IDENTIFIER = "io.sentry.sample.iOS-Swift";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				PROVISIONING_PROFILE_SPECIFIER = "match AppStore io.sentry.sample.iOS-Swift";
@@ -1770,7 +1770,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 7.30.2;
+				MARKETING_VERSION = 7.31.0;
 				PRODUCT_BUNDLE_IDENTIFIER = "io.sentry.sample.iOS-Swift.Clip";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				PROVISIONING_PROFILE_SPECIFIER = "match Development io.sentry.sample.iOS-Swift.Clip";
@@ -1805,7 +1805,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 7.30.2;
+				MARKETING_VERSION = 7.31.0;
 				PRODUCT_BUNDLE_IDENTIFIER = "io.sentry.sample.iOS-Swift.Clip";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				PROVISIONING_PROFILE_SPECIFIER = "match AppStore io.sentry.sample.iOS-Swift.Clip";
diff --git a/Sentry.podspec b/Sentry.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "Sentry"
-  s.version      = "7.30.2"
+  s.version      = "7.31.0"
   s.summary      = "Sentry client for cocoa"
   s.homepage     = "https://github.com/getsentry/sentry-cocoa"
   s.license      = "mit"
diff --git a/Sources/Configuration/Sentry.xcconfig b/Sources/Configuration/Sentry.xcconfig
@@ -28,7 +28,7 @@ MACH_O_TYPE = mh_dylib
 FRAMEWORK_VERSION = A
 
 PRODUCT_NAME = Sentry
-CURRENT_PROJECT_VERSION = 7.30.2
+CURRENT_PROJECT_VERSION = 7.31.0
 INFOPLIST_FILE = Sources/Sentry/Info.plist
 PRODUCT_BUNDLE_IDENTIFIER = io.sentry.Sentry
 ALWAYS_SEARCH_USER_PATHS = NO
diff --git a/Sources/Sentry/Public/SentryError.h b/Sources/Sentry/Public/SentryError.h
@@ -15,6 +15,10 @@ typedef NS_ENUM(NSInteger, SentryError) {
 };
 
 SENTRY_EXTERN NSError *_Nullable NSErrorFromSentryError(SentryError error, NSString *description);
+SENTRY_EXTERN NSError *_Nullable NSErrorFromSentryErrorWithUnderlyingError(
+    SentryError error, NSString *description, NSError *underlyingError);
+SENTRY_EXTERN NSError *_Nullable NSErrorFromSentryErrorWithException(
+    SentryError error, NSString *description, NSException *exception);
 
 SENTRY_EXTERN NSString *const SentryErrorDomain;
 
diff --git a/Sources/Sentry/SentryAppStartTracker.m b/Sources/Sentry/SentryAppStartTracker.m
@@ -285,10 +285,6 @@ - (void)stop
     [NSNotificationCenter.defaultCenter removeObserver:self
                                                   name:UIApplicationDidEnterBackgroundNotification
                                                 object:nil];
-
-#    if SENTRY_HAS_UIKIT
-    [self.appStateManager stop];
-#    endif
 }
 
 - (void)dealloc
diff --git a/Sources/Sentry/SentryAppStateManager.m b/Sources/Sentry/SentryAppStateManager.m
@@ -114,8 +114,6 @@ - (void)stop
             removeObserver:self
                       name:SentryNSNotificationCenterWrapper.willTerminateNotificationName
                     object:nil];
-
-        [self deleteAppState];
     }
 }
 
@@ -124,7 +122,6 @@ - (void)dealloc
     // In dealloc it's safe to unsubscribe for all, see
     // https://developer.apple.com/documentation/foundation/nsnotificationcenter/1413994-removeobserver
     [NSNotificationCenter.defaultCenter removeObserver:self];
-    [self deleteAppState];
 }
 
 /**
@@ -199,11 +196,6 @@ - (void)storeCurrentAppState
     [self.fileManager storeAppState:[self buildCurrentAppState]];
 }
 
-- (void)deleteAppState
-{
-    [self.fileManager deleteAppState];
-}
-
 #endif
 
 @end
diff --git a/Sources/Sentry/SentryError.m b/Sources/Sentry/SentryError.m
@@ -4,11 +4,30 @@
 
 NSString *const SentryErrorDomain = @"SentryErrorDomain";
 
-NSError *_Nullable NSErrorFromSentryError(SentryError error, NSString *description)
+NSError *_Nullable _SentryError(SentryError error, NSDictionary *userInfo)
 {
-    NSMutableDictionary *userInfo = [NSMutableDictionary new];
-    [userInfo setValue:description forKey:NSLocalizedDescriptionKey];
     return [NSError errorWithDomain:SentryErrorDomain code:error userInfo:userInfo];
 }
 
+NSError *_Nullable NSErrorFromSentryErrorWithUnderlyingError(
+    SentryError error, NSString *description, NSError *underlyingError)
+{
+    return _SentryError(error,
+        @ { NSLocalizedDescriptionKey : description, NSUnderlyingErrorKey : underlyingError });
+}
+
+NSError *_Nullable NSErrorFromSentryErrorWithException(
+    SentryError error, NSString *description, NSException *exception)
+{
+    return _SentryError(error, @ {
+        NSLocalizedDescriptionKey :
+            [NSString stringWithFormat:@"%@ (%@)", description, exception.reason],
+    });
+}
+
+NSError *_Nullable NSErrorFromSentryError(SentryError error, NSString *description)
+{
+    return _SentryError(error, @ { NSLocalizedDescriptionKey : description });
+}
+
 NS_ASSUME_NONNULL_END
diff --git a/Sources/Sentry/SentryMeta.m b/Sources/Sentry/SentryMeta.m
@@ -5,7 +5,7 @@ @implementation SentryMeta
 // Don't remove the static keyword. If you do the compiler adds the constant name to the global
 // symbol table and it might clash with other constants. When keeping the static keyword the
 // compiler replaces all occurrences with the value.
-static NSString *versionString = @"7.30.2";
+static NSString *versionString = @"7.31.0";
 static NSString *sdkName = @"sentry.cocoa";
 
 + (NSString *)versionString
diff --git a/Sources/Sentry/SentrySerialization.m b/Sources/Sentry/SentrySerialization.m
@@ -17,16 +17,33 @@ @implementation SentrySerialization
 + (NSData *_Nullable)dataWithJSONObject:(NSDictionary *)dictionary
                                   error:(NSError *_Nullable *_Nullable)error
 {
+// We'll do this whether we're handling an exception or library error
+#define SENTRY_HANDLE_ERROR(__sentry_error)                                                        \
+    SENTRY_LOG_ERROR(@"Invalid JSON: %@", __sentry_error);                                         \
+    *error = __sentry_error;                                                                       \
+    return nil;
+
     NSData *data = nil;
-    if ([NSJSONSerialization isValidJSONObject:dictionary] != NO) {
+
+#if defined(DEBUG) || defined(TEST) || defined(TESTCI)
+    @try {
+#else
+    if ([NSJSONSerialization isValidJSONObject:dictionary]) {
+#endif
         data = [NSJSONSerialization dataWithJSONObject:dictionary options:0 error:error];
-    } else {
-        SENTRY_LOG_ERROR(@"Invalid JSON.");
+#if defined(DEBUG) || defined(TEST) || defined(TESTCI)
+    } @catch (NSException *exception) {
         if (error) {
-            *error = NSErrorFromSentryError(
-                kSentryErrorJsonConversionError, @"Event cannot be converted to JSON");
+            SENTRY_HANDLE_ERROR(NSErrorFromSentryErrorWithException(
+                kSentryErrorJsonConversionError, @"Event cannot be converted to JSON", exception));
         }
     }
+#else
+    } else if (error) {
+        SENTRY_HANDLE_ERROR(NSErrorFromSentryErrorWithUnderlyingError(
+            kSentryErrorJsonConversionError, @"Event cannot be converted to JSON", *error));
+    }
+#endif
 
     return data;
 }
diff --git a/Sources/Sentry/SentrySessionTracker.m b/Sources/Sentry/SentrySessionTracker.m
@@ -139,10 +139,11 @@ - (void)endCachedSession
  * regardless of whether your app uses scenes, see
  * https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622956-applicationdidbecomeactive.
  *
- * We can't start the session in this method because we don't know if a background task or a hybrid
- * SDK initialized the SDK. Hybrid SDKs must only post this notification if they are running in the
- * foreground because the auto session tracking logic doesn't support background tasks. Posting the
- * notification from the background would mess up the session stats.
+ * Hybrid SDKs must only post this notification if they are running in the foreground because the
+ * auto session tracking logic doesn't support background tasks. Posting the notification from the
+ * background would mess up the session stats. Hybrid SDKs must only post this notification if they
+ * are running in the foreground because the auto session tracking logic doesn't support background
+ * tasks. Posting the notification from the background would mess up the session stats.
  */
 - (void)didBecomeActive
 {
diff --git a/Sources/Sentry/include/SentryAppStateManager.h b/Sources/Sentry/include/SentryAppStateManager.h
@@ -35,8 +35,6 @@ SENTRY_NO_INIT
 
 - (void)storeCurrentAppState;
 
-- (void)deleteAppState;
-
 - (void)updateAppState:(void (^)(SentryAppState *))block;
 
 #endif
diff --git a/Tests/SentryTests/Helper/SentryAppStateManagerTests.swift b/Tests/SentryTests/Helper/SentryAppStateManagerTests.swift
diff --git a/Tests/SentryTests/Helper/SentrySerializationTests.swift b/Tests/SentryTests/Helper/SentrySerializationTests.swift
diff --git a/Tests/SentryTests/Integrations/Performance/AppStartTracking/SentryAppStartTrackerTests.swift b/Tests/SentryTests/Integrations/Performance/AppStartTracking/SentryAppStartTrackerTests.swift
diff --git a/Tests/SentryTests/Protocol/SentryNSErrorTests.swift b/Tests/SentryTests/Protocol/SentryNSErrorTests.swift
