Flutter driver commands #8

Jayarams99 · 2023-05-08T17:21:01Z

Hi I am new to Flutter driver, I need help on how we can do the following.

After assigning an element using flutter finder ,If I use ele.getText() or ele.isDisplayed() error is thrown as not implemented. Let me know how we can achieve the above statement
How can we use findelements to find multiple elements
How can we get element attributes

harshhhh15 · 2023-05-10T10:10:54Z

Text and Visibility check:
The getText() and isDisplayed() methods are not implemented in the Element class of Flutter Driver. Instead, you can use the getTextFinder() and waitFor() methods to retrieve the text of an element and check if it is visible.

final element = find.byValueKey('my_element_key');
final textFinder = find.descendant(of: element, matching: find.text('my_text'));

await driver.waitFor(element);
final text = await driver.getText(textFinder);
print(text);

await driver.waitFor(element);
final isVisible = await driver.waitFor(element).isPresent;
print(isVisible);

Finding Multiple Elements:
To find multiple elements, you can use the findAll() method, which returns a list of Element objects that match a given Finder:

final elements = await driver.findAll(find.byValueKey('my_element_key'));

This will return a list of all elements that have a ValueKey with the value 'my_element_key'.

Getting Element Attributes:
You can use the getDiagnostics() method of an element to retrieve its attributes. This method returns a Future<String> that contains a string representation of the element and its properties.

final element = find.byValueKey('my_element_key');
final diagnostics = await driver.getDiagnostics(element);

print(diagnostics);

This will print out a string representation of the element and its attributes, including its type, size, and location on the screen. You can also use regular expressions to extract specific attributes from the diagnostic output.

final element = find.byValueKey('my_element_key');
final diagnostics = await driver.getDiagnostics(element);

final regex = RegExp(r'width=(\d+)');
final match = regex.firstMatch(diagnostics);
final width = match.group(1);

print('Element width is $width');

This code extracts the width attribute of the element from the diagnostic output and prints it to the console.

Jayarams99 · 2023-05-10T11:32:39Z

Please let me know if the same commands work in Java

ashwithpoojary98 · 2023-05-10T14:44:20Z

Yes it should work in java as well

Jayarams99 · 2023-05-12T18:13:05Z

Thanks will try them, Can we also initialise element using @findby appium field decorators

MohamedElbannaQC · 2023-05-30T12:22:40Z

I couldn't access these commands while using Java - any help ?

ashwithpoojary98 · 2023-05-30T15:20:29Z

Yes, We can execute all the commands

MohamedElbannaQC · 2023-05-31T11:09:17Z

@ashwithpoojary98 how can i use them in java ? is there any example ?

ashwithpoojary98 · 2023-06-02T03:41:57Z

Yes,
DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setCapability("deviceName", "emulator-5554");
capabilities.setCapability("platformName", "Android");
capabilities.setCapability("noReset", true);
capabilities.setCapability("app", "");
capabilities.setCapability("automationName", "Flutter");
driver = new AppiumDriver(new URL("http://0.0.0.0:4723/wd/hub"), capabilities);
driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(30));

driver.execute('flutter:checkHealth');
similarly, u can execute all the above commands

yyuanmeme · 2023-09-19T04:40:46Z

Text and Visibility check:
The getText() and isDisplayed() methods are not implemented in the Element class of Flutter Driver. Instead, you can use the getTextFinder() and waitFor() methods to retrieve the text of an element and check if it is visible.
final element = find.byValueKey('my_element_key');
final textFinder = find.descendant(of: element, matching: find.text('my_text'));

await driver.waitFor(element);
final text = await driver.getText(textFinder);
print(text);

await driver.waitFor(element);
final isVisible = await driver.waitFor(element).isPresent;
print(isVisible);
Finding Multiple Elements:
To find multiple elements, you can use the findAll() method, which returns a list of Element objects that match a given Finder:
final elements = await driver.findAll(find.byValueKey('my_element_key'));
This will return a list of all elements that have a ValueKey with the value 'my_element_key'.

Getting Element Attributes:
You can use the getDiagnostics() method of an element to retrieve its attributes. This method returns a Future<String> that contains a string representation of the element and its properties.
final element = find.byValueKey('my_element_key');
final diagnostics = await driver.getDiagnostics(element);

print(diagnostics);
This will print out a string representation of the element and its attributes, including its type, size, and location on the screen. You can also use regular expressions to extract specific attributes from the diagnostic output.
final element = find.byValueKey('my_element_key');
final diagnostics = await driver.getDiagnostics(element);

final regex = RegExp(r'width=(\d+)');
final match = regex.firstMatch(diagnostics);
final width = match.group(1);

print('Element width is $width');
This code extracts the width attribute of the element from the diagnostic output and prints it to the console.

my appiumdriver don't have findAll() api? and i use the getText() api if the element doesn't exist the code will run forever,can't stop.

this is my code:

public static void main(String[] args) {
AppiumDriver flutterDriver;
DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setCapability("deviceName", "Galaxy Note20 5G");
capabilities.setCapability("platformName", "Android");
capabilities.setCapability("noReset", true);
capabilities.setCapability("automationName", "Flutter");
try {
flutterDriver = new AndroidDriver(new URL("http://127.0.0.1:4723"), capabilities);
flutterDriver.manage().timeouts().implicitlyWait(Duration.ofSeconds(30));
appiumDriver = new AndroidDriver(new URL("http://127.0.0.1:4723"), appiumCapabilities);
FlutterFinder finder = new FlutterFinder(flutterDriver);
Thread.sleep(10000);
FlutterElement element = finder.byText("App 反饋11");
String text = element.getText();
System.out.println(text);
} catch (IOException e) {
throw new RuntimeException(e);
}

ashwithpoojary98 · 2023-09-19T05:50:30Z

@yyuanmeme attach the Appium logs

yyuanmeme · 2023-09-19T06:38:13Z

@yyuanmeme attach the Appium logs

2023-09-19 06:34:32:805 [FlutterDriver@c847 (0f49e93a)] Cached the protocol value 'W3C' for the new session 0f49e93a-d5ea-4c85-a0ba-a03400fc0281
2023-09-19 06:34:32:806 [FlutterDriver@c847 (0f49e93a)] Responding to client with driver.createSession() result: {"capabilities":{"subcommand":"server","address":"127.0.0.1","logFile":"D:\appium2.log","port":4723,"extraArgs":[],"allowCors":false,"allowInsecure":[],"basePath":"","callbackPort":4723,"debugLogSpacing":false,"denyInsecure":[],"keepAliveTimeout":600,"localTimezone":false,"loglevel":"debug","logNoColors":false,"logTimestamp":false,"longStacktrace":false,"noPermsCheck":false,"relaxedSecurityEnabled":false,"sessionOverride":false,"strictCaps":false,"useDrivers":[],"usePlugins":[],"tmpDir":"D:\Users\j_yuan\AppData\Local\Temp","platformName":"ANDROID","appActivity":"com.ctrip.ibu.myctrip.main.module.home.IBUHomeActivity","appPackage":"ctrip.english.debug","automationName":"Flutter","deviceName":"Galaxy Note20 5G","noReset":true,"fullReset":false,"fastReset":false,"skipUninstall":true}}
2023-09-19 06:34:32:810 [HTTP] <-- POST /session 200 13730 ms - 859
2023-09-19 06:34:32:810 [HTTP]
2023-09-19 06:34:32:889 [HTTP] --> POST /session/0f49e93a-d5ea-4c85-a0ba-a03400fc0281/timeouts
2023-09-19 06:34:32:889 [HTTP] {"implicit":30000}
2023-09-19 06:34:32:890 [FlutterDriver@c847 (0f49e93a)] Calling AppiumDriver.timeouts() with args: [null,null,null,null,30000,"0f49e93a-d5ea-4c85-a0ba-a03400fc0281"]
2023-09-19 06:34:32:891 [FlutterDriver] Executing Flutter driver command 'timeouts'
2023-09-19 06:34:32:892 [FlutterDriver@c847 (0f49e93a)] W3C timeout argument: {"implicit":30000}}
2023-09-19 06:34:32:892 [FlutterDriver@c847 (0f49e93a)] Set implicit wait to 30000ms
2023-09-19 06:34:32:894 [FlutterDriver@c847 (0f49e93a)] Responding to client with driver.timeouts() result: null
2023-09-19 06:34:32:895 [HTTP] <-- POST /session/0f49e93a-d5ea-4c85-a0ba-a03400fc0281/timeouts 200 6 ms - 14
2023-09-19 06:34:32:895 [HTTP]
2023-09-19 06:34:42:949 [HTTP] --> POST /session/0f49e93a-d5ea-4c85-a0ba-a03400fc0281/element/eyJ0ZXh0IjoiQXBwIOWPjemlizExIiwiZmluZGVyVHlwZSI6IkJ5VGV4dCJ9/click
2023-09-19 06:34:42:949 [HTTP] {"id":"eyJ0ZXh0IjoiQXBwIOWPjemlizExIiwiZmluZGVyVHlwZSI6IkJ5VGV4dCJ9"}
2023-09-19 06:34:42:952 [FlutterDriver@c847 (0f49e93a)] Calling AppiumDriver.click() with args: ["eyJ0ZXh0IjoiQXBwIOWPjemlizExIiwiZmluZGVyVHlwZSI6IkJ5VGV4dCJ9","0f49e93a-d5ea-4c85-a0ba-a03400fc0281"]
2023-09-19 06:34:42:953 [FlutterDriver] Executing Flutter driver command 'click'
2023-09-19 06:34:42:954 [FlutterDriver] >>> {"command":"tap","text":"App 反饋11","finderType":"ByText"}

blocked here

yyuanmeme · 2023-09-19T07:11:40Z

After 10 minutes I got the error message：
org.openqa.selenium.TimeoutException: java.util.concurrent.TimeoutException
Build info: version: '4.11.0', revision: '040bc5406b'
System info: os.name: 'Windows 10', os.arch: 'amd64', os.version: '10.0', java.version: '17.0.7'
Driver info: io.appium.java_client.AppiumDriver
Command: [9c52e412-e35e-405a-b81e-599351976e53, clickElement {id=eyJ0ZXh0IjoiQXBwIOWPjemlizExIiwiZmluZGVyVHlwZSI6IkJ5VGV4dCJ9}]
Capabilities {appium:address: 127.0.0.1, appium:allowCors: false, appium:allowInsecure: [], appium:appActivity: com.ctrip.ibu.myctrip.main...., appium:appPackage: ctrip.english.debug, appium:automationName: Flutter, appium:basePath: , appium:callbackPort: 4723, appium:debugLogSpacing: false, appium:denyInsecure: [], appium:deviceName: Galaxy Note20 5G, appium:extraArgs: [], appium:fastReset: false, appium:fullReset: false, appium:keepAliveTimeout: 600, appium:localTimezone: false, appium:logFile: D:\appium2.log, appium:logNoColors: false, appium:logTimestamp: false, appium:loglevel: debug, appium:longStacktrace: false, appium:noPermsCheck: false, appium:noReset: true, appium:port: 4723, appium:relaxedSecurityEnabled: false, appium:sessionOverride: false, appium:skipUninstall: true, appium:strictCaps: false, appium:subcommand: server, appium:tmpDir: D:\Users\j_yuan\AppData\Loc..., appium:useDrivers: [], appium:usePlugins: [], platformName: ANDROID}
Element: [io.github.ashwith.flutter.FlutterElement@9f09019e -> unknown locator]
Session ID: 9c52e412-e35e-405a-b81e-599351976e53

the appium log is :
2023-09-19 06:44:19:234 [HTTP] <-- POST /session/9c52e412-e35e-405a-b81e-599351976e53/element/eyJ0ZXh0IjoiQXBwIOWPjemlizExIiwiZmluZGVyVHlwZSI6IkJ5VGV4dCJ9/click - - ms - -
2023-09-19 06:44:19:239 [HTTP]

ashwithpoojary98 · 2023-09-19T07:35:59Z

The text value "App 反饋11" looks like localized Chinese. Is it possible to convert it to UTF-8 format?

String value = "App 反饋11";
byte[] bytes = value.getBytes(StandardCharsets.UTF_8);
String utf8EncodedString = new String(bytes, StandardCharsets.UTF_8);

yyuanmeme · 2023-09-19T07:46:43Z

The text value "App 反饋" can be found,but "App 反饋11"text is not exitst ,So it will keep searching。
I set the wait time ,but it doesn't work? --flutterDriver.manage().timeouts().implicitlyWait(Duration.ofSeconds(30));
If the element cannot be found,Need to wait 10 minutes to get the failure reason?

ashwithpoojary98 · 2023-09-19T09:57:37Z

@yyuanmeme Yes, if the locator is not correct, it may fail to find the element. Let me check on my end to reproduce the issue.

baselalali · 2023-10-06T14:08:26Z

Which driver are you using?

await driver.waitFor(element);

My appium driver doest not suggest waitFor(element); and getText()
@harshhhh15

ashwithpoojary98 added the question Further information is requested label Jul 8, 2023

baselalali mentioned this issue Nov 12, 2023

Uncaught extension error while executing get_text appium/appium-flutter-driver#585

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Flutter driver commands #8

Flutter driver commands #8

Jayarams99 commented May 8, 2023

harshhhh15 commented May 10, 2023

Jayarams99 commented May 10, 2023

ashwithpoojary98 commented May 10, 2023

Jayarams99 commented May 12, 2023

MohamedElbannaQC commented May 30, 2023

ashwithpoojary98 commented May 30, 2023

MohamedElbannaQC commented May 31, 2023

ashwithpoojary98 commented Jun 2, 2023

yyuanmeme commented Sep 19, 2023

ashwithpoojary98 commented Sep 19, 2023

yyuanmeme commented Sep 19, 2023

yyuanmeme commented Sep 19, 2023

ashwithpoojary98 commented Sep 19, 2023

yyuanmeme commented Sep 19, 2023

ashwithpoojary98 commented Sep 19, 2023

baselalali commented Oct 6, 2023

Flutter driver commands #8

Flutter driver commands #8

Comments

Jayarams99 commented May 8, 2023

harshhhh15 commented May 10, 2023

Jayarams99 commented May 10, 2023

ashwithpoojary98 commented May 10, 2023

Jayarams99 commented May 12, 2023

MohamedElbannaQC commented May 30, 2023

ashwithpoojary98 commented May 30, 2023

MohamedElbannaQC commented May 31, 2023

ashwithpoojary98 commented Jun 2, 2023

yyuanmeme commented Sep 19, 2023

ashwithpoojary98 commented Sep 19, 2023

yyuanmeme commented Sep 19, 2023

yyuanmeme commented Sep 19, 2023

ashwithpoojary98 commented Sep 19, 2023

yyuanmeme commented Sep 19, 2023

ashwithpoojary98 commented Sep 19, 2023

baselalali commented Oct 6, 2023