feat: Add the necessary primitives to be able to automate split-screen apps #209

mykola-mokhnach · 2019-08-29T17:54:55Z

The change is NOT breaking.

I've added the new setting called defaultActiveApplication. By default it is set to auto and only comes to play if there is more than one active application on the screen. WDA will check if this value is set to any bundle identifier, that matches with the currently active application. It will consider this particular application as active rather than one, which is located under the default screen point. If the application with the given bundle identifier is not in the list of active apps then the default algorithm is applied. The client can list the currently active applications at any time (their PIDs and bundle ids) using the newly added apps/list endpoint.

…n apps

KazuCocoa

Looks 👍

KazuCocoa · 2019-08-30T00:35:20Z

WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -48,6 +50,7 @@ + (NSArray *)routes
    [[FBRoute POST:@"/wda/apps/activate"] respondWithTarget:self action:@selector(handleSessionAppActivate:)],
    [[FBRoute POST:@"/wda/apps/terminate"] respondWithTarget:self action:@selector(handleSessionAppTerminate:)],
    [[FBRoute POST:@"/wda/apps/state"] respondWithTarget:self action:@selector(handleSessionAppState:)],
+    [[FBRoute POST:@"/wda/apps/list"] respondWithTarget:self action:@selector(handleActiveAppsList:)],


I would keep POST, since we might want to add some additional filtering arguments to the call in the future. GET request does not allow this though

👍 make sense

This should be still get and we should pass the further filtering with query params

unfortunately selenium API does not really support passing of query parameters. Although, this endpoint is going to be put under mobile: call , so I could do that

KazuCocoa · 2019-08-30T01:12:14Z

WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -162,6 +165,11 @@ + (NSArray *)routes
  return FBResponseWithObject(@(state));
 }

+ (id<FBResponsePayload>)handleActiveAppsList:(FBRouteRequest *)request
+{
+  return FBResponseWithObject([XCUIApplication fb_activeAppsInfo]);


WDA has an endpoint to return appinfo, bundleid, process id, name and environment variables. It has not been released yet. So, what do you think of modifying here like below and remove it?

https://github.com/appium/WebDriverAgent/blob/master/WebDriverAgentLib/Commands/FBCustomCommands.m#L60

+ (id<FBResponsePayload>)handleActiveAppsList:(FBRouteRequest *)request { NSMutableArray<NSDictionary<NSString *, id> *> *result = [[NSMutableArray alloc] init]; NSArray *appsInfo = [XCUIApplication fb_activeAppsInfo]; for (NSDictionary *appInfo in appsInfo) { FBApplication *app = [FBApplication fb_activeApplicationWithDefaultBundleId:appInfo[@"bundleId"]]; NSDictionary *processArguments = @{}; if (app != nil) { processArguments = @{ @"args": app.launchArguments, @"env": app.launchEnvironment }; } [result addObject:@{ @"pid": appInfo[@"pid"] ?: @"", @"bundleId": appInfo[@"bundleId"] ?: @"", @"name": app.identifier ?: @"", @"processArguments": processArguments, }]; } return FBResponseWithObject(result); }

If ^ sounds good, I'll drop https://github.com/appium/appium/pull/13028/files for 1.15.0 release

I wanted to reduce the /list endpoint to a minimum and avoid extra calls to the accessibility if possible. Creation of FBApplication instance is already quite expensive as it touches the internal process monitoring machinery. Lets keep it at minimum for now.

👍 make sense

KazuCocoa

lgtm. I also locally tested

KazuCocoa · 2019-08-30T06:06:04Z

WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -48,6 +50,7 @@ + (NSArray *)routes
    [[FBRoute POST:@"/wda/apps/activate"] respondWithTarget:self action:@selector(handleSessionAppActivate:)],
    [[FBRoute POST:@"/wda/apps/terminate"] respondWithTarget:self action:@selector(handleSessionAppTerminate:)],
    [[FBRoute POST:@"/wda/apps/state"] respondWithTarget:self action:@selector(handleSessionAppState:)],
+    [[FBRoute POST:@"/wda/apps/list"] respondWithTarget:self action:@selector(handleActiveAppsList:)],


👍 make sense

KazuCocoa · 2019-08-30T06:06:14Z

WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -162,6 +165,11 @@ + (NSArray *)routes
  return FBResponseWithObject(@(state));
 }

+ (id<FBResponsePayload>)handleActiveAppsList:(FBRouteRequest *)request
+{
+  return FBResponseWithObject([XCUIApplication fb_activeAppsInfo]);


👍 make sense

KazuCocoa · 2019-08-30T06:08:08Z

WebDriverAgentLib/FBSpringboardApplication.m

@@ -9,18 +9,7 @@

 #import "FBSpringboardApplication.h"

-#import "FBErrorBuilder.h"


👍 deletions

umutuzgur · 2019-08-30T12:52:57Z

WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.h

@@ -69,6 +69,23 @@ NS_ASSUME_NONNULL_BEGIN
 */
 - (BOOL)fb_waitForAppElement:(NSTimeInterval)timeout;

+/**
+ Retrievs the infomration about the applications the given accessiblity elements


Good typos :D

umutuzgur · 2019-08-30T12:54:37Z

WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.m

+                                  dispatch_semaphore_signal(sem);
+                                }];
+    dispatch_semaphore_wait(sem, dispatch_time(DISPATCH_TIME_NOW, (int64_t)(1 * NSEC_PER_SEC)));
+    appInfo[@"bundleId"] = bundleId ?: @"";


Should we set it to Unknown instead of empty?

I don't have any strong opinion on that. Will set to "unknown"

umutuzgur · 2019-08-30T12:57:05Z

WebDriverAgentLib/FBApplication.m

 {
  NSArray<XCAccessibilityElement *> *activeApplicationElements = [FBXCAXClientProxy.sharedClient activeApplications];
-  XCAccessibilityElement *activeApplicationElement = [activeApplicationElements firstObject];
+  XCAccessibilityElement *activeApplicationElement = nil;
  if (activeApplicationElements.count > 1) {


Shouldn't this be now bigger than 0 instead of 1?

it is fine. If it equals to 1 then the first array element is set in else block. If the length of the array is zero then firstObject will return nil, which will lead to an exception later

umutuzgur · 2019-08-30T12:59:06Z

WebDriverAgentLib/FBApplication.m

+      NSArray<NSDictionary *> *appsInfo = [self fb_appsInfoWithAxElements:activeApplicationElements];
+      NSUInteger index = 0;
+      for (NSDictionary *appInfo in appsInfo) {
+        index++;


I'm a bit confused here. When we are iterating over the appsInfo and we find an appInfo where bundleIds are equal, we will then get index + 1 object in the activeApplicationElements. Is this intended?

good catch, we need to increment the index after the condition

feat: Add the necessary primitives to be able to automate split-scree…

a9c8904

…n apps

mykola-mokhnach requested review from umutuzgur, KazuCocoa and imurchie August 29, 2019 17:55

KazuCocoa reviewed Aug 30, 2019

View reviewed changes

Remove redundant stuff

945f167

KazuCocoa approved these changes Aug 30, 2019

View reviewed changes

KazuCocoa reviewed Aug 30, 2019

View reviewed changes

umutuzgur reviewed Aug 30, 2019

View reviewed changes

mykola-mokhnach added 2 commits August 30, 2019 16:05

Address comments

1f1f5c0

Address some compiler warnings

2055ab3

mykola-mokhnach merged commit faa95f9 into master Aug 31, 2019

mykola-mokhnach deleted the defaut_app branch August 31, 2019 06:04

KazuCocoa mentioned this pull request Sep 12, 2019

docs: add settings and caps, enforceAppInstall, activeAppDetectionPoint, defaultActiveApplication and reduceMotion appium/appium#13225

Merged

10 tasks

KazuCocoa mentioned this pull request Sep 20, 2019

chore: add CHANGELOG entry for 1.15.0 appium/appium#13264

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add the necessary primitives to be able to automate split-screen apps #209

feat: Add the necessary primitives to be able to automate split-screen apps #209

mykola-mokhnach commented Aug 29, 2019 •

edited

Loading

KazuCocoa left a comment

KazuCocoa Aug 30, 2019

mykola-mokhnach Aug 30, 2019

KazuCocoa Aug 30, 2019

umutuzgur Aug 30, 2019

mykola-mokhnach Aug 30, 2019

KazuCocoa Aug 30, 2019 •

edited

Loading

mykola-mokhnach Aug 30, 2019 •

edited

Loading

KazuCocoa Aug 30, 2019

KazuCocoa left a comment

KazuCocoa Aug 30, 2019

KazuCocoa Aug 30, 2019

KazuCocoa Aug 30, 2019

umutuzgur Aug 30, 2019

mykola-mokhnach Aug 30, 2019

umutuzgur Aug 30, 2019

mykola-mokhnach Aug 30, 2019 •

edited

Loading

umutuzgur Aug 30, 2019

mykola-mokhnach Aug 30, 2019 •

edited

Loading

umutuzgur Aug 30, 2019

mykola-mokhnach Aug 30, 2019

		@@ -9,18 +9,7 @@

		#import "FBSpringboardApplication.h"

		#import "FBErrorBuilder.h"

feat: Add the necessary primitives to be able to automate split-screen apps #209

feat: Add the necessary primitives to be able to automate split-screen apps #209

Conversation

mykola-mokhnach commented Aug 29, 2019 • edited Loading

KazuCocoa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KazuCocoa Aug 30, 2019 • edited Loading

Choose a reason for hiding this comment

mykola-mokhnach Aug 30, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KazuCocoa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mykola-mokhnach Aug 30, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mykola-mokhnach Aug 30, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mykola-mokhnach commented Aug 29, 2019 •

edited

Loading

KazuCocoa Aug 30, 2019 •

edited

Loading

mykola-mokhnach Aug 30, 2019 •

edited

Loading

mykola-mokhnach Aug 30, 2019 •

edited

Loading

mykola-mokhnach Aug 30, 2019 •

edited

Loading