feat: auto-dismiss the stale Screen Broadcasting alert during broadcast start/stop

WebDriverAgentLib/Commands/FBScreenCaptureCommands.m

@@ -72,12 +72,32 @@ + (NSArray *)routes
       }
     }
   }
+  NSMutableArray<NSString *> *dismissButtonLabels = [NSMutableArray array];
+  id dismissLabelsArg = request.arguments[@"dismissButtonLabels"];
+  if ([dismissLabelsArg isKindOfClass:NSArray.class]) {
+    for (id label in (NSArray *)dismissLabelsArg) {
+      if ([label isKindOfClass:NSString.class] && [(NSString *)label length] > 0) {
+        [dismissButtonLabels addObject:label];
+      }
+    }
+  }
+  NSMutableArray<NSString *> *goToApplicationButtonLabels = [NSMutableArray array];
+  id goToApplicationLabelsArg = request.arguments[@"goToApplicationButtonLabels"];
+  if ([goToApplicationLabelsArg isKindOfClass:NSArray.class]) {
+    for (id label in (NSArray *)goToApplicationLabelsArg) {
+      if ([label isKindOfClass:NSString.class] && [(NSString *)label length] > 0) {
+        [goToApplicationButtonLabels addObject:label];
+      }
+    }
+  }
   NSNumber *restoreArg = request.arguments[@"restoreForegroundApp"];
   BOOL restoreForegroundApp = [restoreArg isKindOfClass:NSNumber.class] ? restoreArg.boolValue : YES;
 
   NSError *error;
   if (![FBBroadcastManager.sharedInstance startBroadcastWithTimeout:timeout
                                                 confirmButtonLabels:confirmButtonLabels
+                                                dismissButtonLabels:dismissButtonLabels
+                                        goToApplicationButtonLabels:goToApplicationButtonLabels
                                                restoreForegroundApp:restoreForegroundApp
                                                               error:&error]) {
     if ([error.domain isEqualToString:FBBroadcastManagerErrorDomain]) {
@@ -97,8 +117,29 @@ + (NSArray *)routes
 
 + (id<FBResponsePayload>)handleStopBroadcast:(FBRouteRequest *)request
 {
+  NSMutableArray<NSString *> *dismissButtonLabels = [NSMutableArray array];
+  id dismissLabelsArg = request.arguments[@"dismissButtonLabels"];
+  if ([dismissLabelsArg isKindOfClass:NSArray.class]) {
+    for (id label in (NSArray *)dismissLabelsArg) {
+      if ([label isKindOfClass:NSString.class] && [(NSString *)label length] > 0) {
+        [dismissButtonLabels addObject:label];
+      }
+    }
+  }
+  NSMutableArray<NSString *> *goToApplicationButtonLabels = [NSMutableArray array];
+  id goToApplicationLabelsArg = request.arguments[@"goToApplicationButtonLabels"];
+  if ([goToApplicationLabelsArg isKindOfClass:NSArray.class]) {
+    for (id label in (NSArray *)goToApplicationLabelsArg) {
+      if ([label isKindOfClass:NSString.class] && [(NSString *)label length] > 0) {
+        [goToApplicationButtonLabels addObject:label];
+      }
+    }
+  }
+
   NSError *error;
-  if (![FBBroadcastManager.sharedInstance stopBroadcastWithError:&error]) {
+  if (![FBBroadcastManager.sharedInstance stopBroadcastWithDismissButtonLabels:dismissButtonLabels
+                                                   goToApplicationButtonLabels:goToApplicationButtonLabels
+                                                                          error:&error]) {
     return FBResponseWithStatus([FBCommandStatus timeoutErrorWithMessage:error.localizedDescription traceback:nil]);
   }
   return FBResponseWithObject([FBBroadcastManager.sharedInstance statusDictionary]);

WebDriverAgentLib/Utilities/FBBroadcastManager.h

@@ -55,24 +55,54 @@ typedef NS_ERROR_ENUM(FBBroadcastManagerErrorDomain, FBBroadcastManagerError) {
 
  @param timeout The overall time budget in seconds for the broadcast to reach the connected state
  @param confirmButtonLabels Labels to look for on the system confirmation sheet
+ @param dismissButtonLabels Labels for dismissing the system's stale "Screen Broadcasting" alert
+ that SpringBoard posts whenever a broadcast ends, which otherwise blocks the picker dance from
+ completing. Defaults to ["OK"] when empty/nil
+ @param goToApplicationButtonLabels Labels for the alert's other button. Together with
+ dismissButtonLabels this anchors the alert's identity: it is only treated as the Screen
+ Broadcasting alert, and auto-dismissed, when one button matches dismissButtonLabels and the
+ other matches this list. Defaults to ["Go to Application"] when empty/nil
  @param restoreForegroundApp YES to re-activate the previously active application afterwards
  @param error If there is an error, upon return contains an NSError describing the problem
  @return NO in case of a failure
  */
 - (BOOL)startBroadcastWithTimeout:(NSTimeInterval)timeout
               confirmButtonLabels:(NSArray<NSString *> *)confirmButtonLabels
+              dismissButtonLabels:(nullable NSArray<NSString *> *)dismissButtonLabels
+      goToApplicationButtonLabels:(nullable NSArray<NSString *> *)goToApplicationButtonLabels
              restoreForegroundApp:(BOOL)restoreForegroundApp
                             error:(NSError **)error;
 
 /**
  Asks the extension to finish the broadcast and waits for it to disconnect.
- Idempotent when no broadcast is running.
+ Idempotent when no broadcast is running. Equivalent to calling
+ stopBroadcastWithDismissButtonLabels:goToApplicationButtonLabels:error: with nil for both
+ label lists.
 
  @param error If there is an error, upon return contains an NSError describing the problem
  @return NO in case of a failure
  */
 - (BOOL)stopBroadcastWithError:(NSError **)error;
 
+/**
+ Asks the extension to finish the broadcast and waits for it to disconnect, then makes a
+ best-effort attempt to dismiss the system's stale "Screen Broadcasting" alert that SpringBoard
+ posts once the broadcast ends. Idempotent when no broadcast is running.
+
+ @param dismissButtonLabels Labels for dismissing the system's stale "Screen Broadcasting" alert.
+ Defaults to ["OK"] when empty/nil
+ @param goToApplicationButtonLabels Labels for the alert's other button. Together with
+ dismissButtonLabels this anchors the alert's identity: it is only treated as the Screen
+ Broadcasting alert, and auto-dismissed, when one button matches dismissButtonLabels and the
+ other matches this list. Defaults to ["Go to Application"] when empty/nil
+ @param error If there is an error, upon return contains an NSError describing the problem
+ @return NO in case of a failure. The alert-dismissal attempt is best-effort and never causes
+ this to return NO by itself
+ */
+- (BOOL)stopBroadcastWithDismissButtonLabels:(nullable NSArray<NSString *> *)dismissButtonLabels
+                 goToApplicationButtonLabels:(nullable NSArray<NSString *> *)goToApplicationButtonLabels
+                                        error:(NSError **)error;
+
 /** Notifies the manager that a capture session started (sends SESSION_ADD when connected). */
 - (void)notifySessionAdded:(FBVideoStreamSession *)session;