Releases/v3.6.2 (#240)

* fix: avoid setting unused AVPlayer specific error dimension --------- Co-authored-by: Tomislav Kordic <[email protected]>
muxinc · May 3, 2024 · 4bda9c2 · 4bda9c2
1 parent ddac23a
commit 4bda9c2
Show file tree

Hide file tree

Showing 55 changed files with 272 additions and 471 deletions.
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -0,0 +1,34 @@
+agents:
+  queue: "macOS-Monterey-12-4"
+
+steps:
+  - command: "./scripts/run-baseline-unit-test-pass.sh"
+    label: ":xcode_simulator: Baseline Unit Test Pass"
+  - wait
+  - command: ".buildkite/scripts/dynamic-xcframework.sh"
+    label: ":xcode: Create Dynamic XCFramework"
+    artifact_paths:
+      - "./XCFramework/MUXSDKStats.xcframework.zip"
+  - wait
+  - command: "buildkite-agent artifact download XCFramework/MUXSDKStats.xcframework.zip XCFramework && ./scripts/run-tests-swift-package-manager-ventura.sh"
+    label: ":swift: Test Swift Package Manager Example"
+    retry:
+      automatic: true
+  - wait
+  - command: ".buildkite/scripts/static-xcframework.sh"
+    label: ":xcode: Create Static XCFramework"
+    artifact_paths:
+      - "./XCFramework/MUXSDKStats-static.xcframework.zip"
+  - wait
+  - command: "buildkite-agent artifact download XCFramework/MUXSDKStats.xcframework.zip XCFramework && ./scripts/run-tests-cocoapods-ventura.sh"
+    label: ":cocoapods: Test Cocoapods Example"
+    retry:
+      automatic: true
+  - wait
+  - command: "./scripts/version-check.sh Mux-Stats-AVPlayer.podspec MUXSDKStats.json"
+    label: ":clipboard: Validate Version Metadata"
+    branches: "releases/*"
+  - command: "./scripts/validate-podspec.sh"
+    label: ":cocoapods: Validate Podspec"
+    branches: "releases/*"
+
diff --git a/.buildkite/scripts/dynamic-xcframework.sh b/.buildkite/scripts/dynamic-xcframework.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+set -euo pipefail
+
+./scripts/create-dynamic-xcframework.sh
+cd XCFramework
+zip -ry MUXSDKStats.xcframework.zip MUXSDKStats.xcframework
diff --git a/.buildkite/scripts/static-xcframework.sh b/.buildkite/scripts/static-xcframework.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+set -euo pipefail
+
+./scripts/create-static-xcframework.sh
+cd XCFramework
+zip -ry MUXSDKStats-static.xcframework.zip MUXSDKStats.xcframework
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
diff --git a/.github/workflows/validate-release.yml b/.github/workflows/validate-release.yml
diff --git a/MUXSDKStats.json b/MUXSDKStats.json
@@ -19,5 +19,6 @@
     "3.5.0": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.5.0/MUXSDKStats.xcframework.zip",
     "3.5.1": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.5.1/MUXSDKStats.xcframework.zip",
     "3.6.0": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.6.0/MUXSDKStats.xcframework.zip",
-    "3.6.1": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.6.1/MUXSDKStats.xcframework.zip"
+    "3.6.1": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.6.1/MUXSDKStats.xcframework.zip",
+    "3.6.2": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.6.2/MUXSDKStats.xcframework.zip"
 }
diff --git a/MUXSDKStats/MUXSDKStats.xcodeproj/project.pbxproj b/MUXSDKStats/MUXSDKStats.xcodeproj/project.pbxproj
@@ -773,7 +773,7 @@
 					"@loader_path/Frameworks",
 				);
 				LOCALIZATION_PREFERS_STRING_CATALOGS = YES;
-				MARKETING_VERSION = 3.6.1;
+				MARKETING_VERSION = 3.6.2;
 				MODULEMAP_FILE = "$(SRCROOT)/MUXSDKStatsVision/module.modulemap";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu17 gnu++20";
@@ -821,7 +821,7 @@
 					"@loader_path/Frameworks",
 				);
 				LOCALIZATION_PREFERS_STRING_CATALOGS = YES;
-				MARKETING_VERSION = 3.6.1;
+				MARKETING_VERSION = 3.6.2;
 				MODULEMAP_FILE = "$(SRCROOT)/MUXSDKStatsVision/module.modulemap";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu17 gnu++20";
@@ -917,7 +917,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.6.1;
+				MARKETING_VERSION = 3.6.2;
 				MODULEMAP_FILE = "$(SRCROOT)/MUXSDKStatsTv/module.modulemap";
 				ONLY_ACTIVE_ARCH = NO;
 				PRODUCT_BUNDLE_IDENTIFIER = com.mux.stats.tvos.MUXSDKStatsTv;
@@ -951,7 +951,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.6.1;
+				MARKETING_VERSION = 3.6.2;
 				MODULEMAP_FILE = "$(SRCROOT)/MUXSDKStatsTv/module.modulemap";
 				PRODUCT_BUNDLE_IDENTIFIER = com.mux.stats.tvos.MUXSDKStatsTv;
 				PRODUCT_NAME = MUXSDKStats;
@@ -1134,7 +1134,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.6.1;
+				MARKETING_VERSION = 3.6.2;
 				ONLY_ACTIVE_ARCH = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = com.mux.stats.ios.MUXSDKStats;
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -1168,7 +1168,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.6.1;
+				MARKETING_VERSION = 3.6.2;
 				ONLY_ACTIVE_ARCH = NO;
 				PRODUCT_BUNDLE_IDENTIFIER = com.mux.stats.ios.MUXSDKStats;
 				PRODUCT_NAME = "$(TARGET_NAME)";

diff --git a/MUXSDKStats/MUXSDKStats/MUXSDKCustomerCustomDataStore.h b/MUXSDKStats/MUXSDKStats/MUXSDKCustomerCustomDataStore.h
@@ -13,6 +13,8 @@
 #import <Foundation/Foundation.h>
 #if TVOS
 #import <MuxCore/MuxCoreTv.h>
+#elif TARGET_OS_VISION
+#import <MuxCore/MuxCoreVision.h>
 #else
 #import <MuxCore/MuxCore.h>
 #endif

diff --git a/MUXSDKStats/MUXSDKStats/MUXSDKCustomerPlayerDataStore.h b/MUXSDKStats/MUXSDKStats/MUXSDKCustomerPlayerDataStore.h
@@ -13,6 +13,8 @@
 #import <Foundation/Foundation.h>
 #if TVOS
 #import <MuxCore/MuxCoreTv.h>
+#elif TARGET_OS_VISION
+#import <MuxCore/MuxCoreVision.h>
 #else
 #import <MuxCore/MuxCore.h>
 #endif

diff --git a/MUXSDKStats/MUXSDKStats/MUXSDKCustomerVideoDataStore.h b/MUXSDKStats/MUXSDKStats/MUXSDKCustomerVideoDataStore.h
@@ -13,6 +13,8 @@
 #import <Foundation/Foundation.h>
 #if TVOS
 #import <MuxCore/MuxCoreTv.h>
+#elif TARGET_OS_VISION
+#import <MuxCore/MuxCoreVision.h>
 #else
 #import <MuxCore/MuxCore.h>
 #endif

diff --git a/MUXSDKStats/MUXSDKStats/MUXSDKCustomerViewDataStore.h b/MUXSDKStats/MUXSDKStats/MUXSDKCustomerViewDataStore.h
@@ -13,6 +13,8 @@
 #import <Foundation/Foundation.h>
 #if TVOS
 #import <MuxCore/MuxCoreTv.h>
+#elif TARGET_OS_VISION
+#import <MuxCore/MuxCoreVision.h>
 #else
 #import <MuxCore/MuxCore.h>
 #endif

diff --git a/MUXSDKStats/MUXSDKStats/MUXSDKPlayerBinding.m b/MUXSDKStats/MUXSDKStats/MUXSDKPlayerBinding.m
@@ -14,7 +14,7 @@
 
 // SDK constants.
 NSString *const MUXSDKPluginName = @"apple-mux";
-NSString *const MUXSDKPluginVersion = @"3.6.1";
+NSString *const MUXSDKPluginVersion = @"3.6.2";
 NSString *const MUXSessionDataPrefix = @"io.litix.data.";
 
 // Min number of seconds between timeupdate events. (100ms)
@@ -649,30 +649,23 @@ - (MUXSDKPlayerData *)getPlayerData {
     #endif
 
     // Derived from the player.
-    NSMutableArray *errors = [NSMutableArray new];
-    NSString *defaultMsg = nil;
-    NSInteger errorCode = 0;
     if (_player.error) {
-        [errors addObject:[self buildError:@"p"
-                                    domain:_player.error.domain
-                                      code:_player.error.code
-                                   message:_player.error.localizedDescription]];
-        defaultMsg = _player.error.localizedDescription;
-        errorCode = _player.error.code;
+        NSInteger errorCode = _player.error.code;
+        if (errorCode != 0 && errorCode != NSNotFound) {
+            [playerData setPlayerErrorCode:[NSString stringWithFormat:@"%ld", (long)errorCode]];
+        }
+        NSString *errorLocalizedDescription = _player.error.localizedDescription;
+        if (errorLocalizedDescription != nil) {
+            [playerData setPlayerErrorMessage:errorLocalizedDescription];
+        }
     } else if (_playerItem && _playerItem.error) {
-        [errors addObject:[self buildError:@"i"
-                                    domain:_playerItem.error.domain
-                                      code:_playerItem.error.code
-                                   message:_playerItem.error.localizedDescription]];
-        defaultMsg = _playerItem.error.localizedDescription;
-        errorCode = _playerItem.error.code;
-        // Append the full error log.
-        for (AVPlayerItemErrorLogEvent *event in _playerItem.errorLog.events) {
-            [errors addObject:[self buildError:@"l"
-                                        domain:event.errorDomain
-                                          code:event.errorStatusCode
-                                       message:(event.errorComment ? event.errorComment : @"")]];
-
+        NSInteger errorCode = _playerItem.error.code;
+        if (errorCode != 0 && errorCode != NSNotFound) {
+            [playerData setPlayerErrorCode:[NSString stringWithFormat:@"%ld", (long)errorCode]];
+        }
+        NSString *errorLocalizedDescription = _playerItem.error.localizedDescription;
+        if (errorLocalizedDescription != nil) {
+            [playerData setPlayerErrorMessage:errorLocalizedDescription];
         }
     } else {
         // Not sure if both checks are necessary here as when rate is 0 we expect to be paused and vice versa.
@@ -686,21 +679,6 @@ - (MUXSDKPlayerData *)getPlayerData {
             [self setPlayerPlayheadTime:ms onPlayerData:playerData];
         }
     }
-
-    if ([errors count] > 0 && defaultMsg) {
-        // Hard coded default value for now. Error codes on iOS have no meaning for now.
-        // We'll reclassify/recode errors on the backend as we learn more.
-        [playerData setPlayerErrorCode:[NSString stringWithFormat:@"%ld", (long)errorCode]];
-        [playerData setPlayerErrorMessage:defaultMsg];
-        NSError *error = nil;
-        NSData *jsonData = [NSJSONSerialization dataWithJSONObject:errors
-                                                           options:0
-                                                             error:&error];
-        if (!error) {
-            [playerData setPlayeriOSErrorData:[[NSString alloc] initWithData:jsonData
-                                                                    encoding:NSUTF8StringEncoding]];
-        }
-    }
 
     // Only report program time metrics if this is a live stream
     if (_playbackIsLivestream) {
@@ -742,15 +720,6 @@ - (void) setPlayerPlayheadTime:(float) playheadTimeMs onPlayerData:(MUXSDKPlayer
     [playerData setPlayerPlayheadTime:[NSNumber numberWithLongLong:[timeMs longLongValue]]];
 }
 
-- (NSDictionary *)buildError:(NSString *)level domain:(NSString *)domain code:(NSInteger)code message:(NSString *)message {
-    return @{
-             @"l": level,
-             @"d": domain,
-             @"c": [NSString stringWithFormat:@"%ld", (long)code],
-             @"m": (message == nil ? @"n/a" : message),
-             };
-}
-
 - (BOOL)isPlayerOK {
     if (!_player) {
         NSLog(@"MUXSDK-ERROR - Mux failed to find the AVPlayer for player name: %@", _name);

diff --git a/MUXSDKStats/MUXSDKStats/MUXSDKPlayerBindingManager.h b/MUXSDKStats/MUXSDKStats/MUXSDKPlayerBindingManager.h
@@ -13,6 +13,8 @@
 #import <Foundation/Foundation.h>
 #if TVOS
 #import <MuxCore/MuxCoreTv.h>
+#elif TARGET_OS_VISION
+#import <MuxCore/MuxCoreVision.h>
 #else
 #import <MuxCore/MuxCore.h>
 #endif

diff --git a/Mux-Stats-AVPlayer.podspec b/Mux-Stats-AVPlayer.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name             = 'Mux-Stats-AVPlayer'
 
-  s.version          = '3.6.1'
+  s.version          = '3.6.2'
   s.source           = { :git => 'https://github.com/muxinc/mux-stats-sdk-avplayer.git',
                          :tag => "v#{s.version}" }