Add support for flutter prefixed locator (#20)

* fix: find element to adhere visibilty

* Fix finder

* Support for backward compatibility

* Version bump

* Refactor find elements

* Fix typo

Author: sudharsan-selvaraj

demo-app/pubspec.lock

@@ -1,37 +1,21 @@
 # Generated by pub
 # See https://dart.dev/tools/pub/glossary#lockfile
 packages:
-  _fe_analyzer_shared:
+  a_bridge:
     dependency: transitive
     description:
-      name: _fe_analyzer_shared
-      sha256: "0b2f2bd91ba804e53a61d757b986f89f1f9eaed5b11e4b2f5a2468d86d6c9fc7"
+      name: a_bridge
+      sha256: "5acd8dd8ba187576533aa93cd27c56695b9400ad282a89ce0b23f5b998fc78f3"
       url: "https://pub.dev"
     source: hosted
-    version: "67.0.0"
-  analyzer:
-    dependency: transitive
-    description:
-      name: analyzer
-      sha256: "37577842a27e4338429a1cbc32679d508836510b056f1eedf0c8d20e39c1383d"
-      url: "https://pub.dev"
-    source: hosted
-    version: "6.4.1"
+    version: "0.0.3"
   appium_flutter_server:
     dependency: "direct dev"
     description:
       path: "../server"
       relative: true
     source: path
-    version: "0.0.13"
-  args:
-    dependency: transitive
-    description:
-      name: args
-      sha256: "7cf60b9f0cc88203c5a190b4cd62a99feea42759a7fa695010eb5de1c0b2252a"
-      url: "https://pub.dev"
-    source: hosted
-    version: "2.5.0"
+    version: "0.0.18"
   async:
     dependency: transitive
     description:
@@ -48,22 +32,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.1.1"
-  build:
-    dependency: transitive
-    description:
-      name: build
-      sha256: "80184af8b6cb3e5c1c4ec6d8544d27711700bc3e6d2efad04238c7b5290889f0"
-      url: "https://pub.dev"
-    source: hosted
-    version: "2.4.1"
-  build_config:
-    dependency: transitive
-    description:
-      name: build_config
-      sha256: bf80fcfb46a29945b423bd9aad884590fb1dc69b330a4d4700cac476af1708d1
-      url: "https://pub.dev"
-    source: hosted
-    version: "1.1.1"
   carousel_slider:
     dependency: "direct main"
     description:
@@ -80,14 +48,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.3.0"
-  checked_yaml:
-    dependency: transitive
-    description:
-      name: checked_yaml
-      sha256: feb6bed21949061731a7a75fc5d2aa727cf160b91af9a3e464c5e3a32e28b5ff
-      url: "https://pub.dev"
-    source: hosted
-    version: "2.0.3"
   clock:
     dependency: transitive
     description:
@@ -128,14 +88,22 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.0.8"
-  dart_style:
+  device_info_plus:
+    dependency: transitive
+    description:
+      name: device_info_plus
+      sha256: eead12d1a1ed83d8283ab4c2f3fca23ac4082f29f25f29dff0f758f57d06ec91
+      url: "https://pub.dev"
+    source: hosted
+    version: "10.1.0"
+  device_info_plus_platform_interface:
     dependency: transitive
     description:
-      name: dart_style
-      sha256: "99e066ce75c89d6b29903d788a7bb9369cf754f7b24bf70bf4b6d6d6b26853b9"
+      name: device_info_plus_platform_interface
+      sha256: d3b01d5868b50ae571cd1dc6e502fc94d956b665756180f7b16ead09e836fd64
       url: "https://pub.dev"
     source: hosted
-    version: "2.3.6"
+    version: "7.0.0"
   fake_async:
     dependency: transitive
     description:
@@ -193,14 +161,6 @@ packages:
     description: flutter
     source: sdk
     version: "0.0.0"
-  glob:
-    dependency: transitive
-    description:
-      name: glob
-      sha256: "0e7014b3b7d4dac1ca4d6114f82bf1782ee86745b9b42a92c9289c23d8a0ab63"
-      url: "https://pub.dev"
-    source: hosted
-    version: "2.1.2"
   hotreloader:
     dependency: transitive
     description:
@@ -238,22 +198,6 @@ packages:
     description: flutter
     source: sdk
     version: "0.0.0"
-  json_annotation:
-    dependency: transitive
-    description:
-      name: json_annotation
-      sha256: "1ce844379ca14835a50d2f019a3099f419082cfdd231cd86a142af94dd5c6bb1"
-      url: "https://pub.dev"
-    source: hosted
-    version: "4.9.0"
-  json_serializable:
-    dependency: transitive
-    description:
-      name: json_serializable
-      sha256: ea1432d167339ea9b5bb153f0571d0039607a873d6e04e0117af043f14a1fd4b
-      url: "https://pub.dev"
-    source: hosted
-    version: "6.8.0"
   leak_tracker:
     dependency: transitive
     description:
@@ -334,14 +278,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.0.0"
-  package_config:
-    dependency: transitive
-    description:
-      name: package_config
-      sha256: "1c5b77ccc91e4823a5af61ee74e6b972db1ef98c2ff5a18d3161c982a55448bd"
-      url: "https://pub.dev"
-    source: hosted
-    version: "2.1.0"
   package_info_plus:
     dependency: transitive
     description:
@@ -486,30 +422,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "5.0.2"
-  pub_semver:
-    dependency: transitive
-    description:
-      name: pub_semver
-      sha256: "40d3ab1bbd474c4c2328c91e3a7df8c6dd629b79ece4c4bd04bee496a224fb0c"
-      url: "https://pub.dev"
-    source: hosted
-    version: "2.1.4"
-  pubspec_parse:
-    dependency: transitive
-    description:
-      name: pubspec_parse
-      sha256: c799b721d79eb6ee6fa56f00c04b472dcd44a30d258fac2174a6ec57302678f8
-      url: "https://pub.dev"
-    source: hosted
-    version: "1.3.0"
-  quiver:
-    dependency: transitive
-    description:
-      name: quiver
-      sha256: b1c1ac5ce6688d77f65f3375a9abb9319b3cb32486bdc7a1e0fdf004d7ba4e47
-      url: "https://pub.dev"
-    source: hosted
-    version: "3.2.1"
   shelf:
     dependency: transitive
     description:
@@ -563,22 +475,6 @@ packages:
     description: flutter
     source: sdk
     version: "0.0.99"
-  source_gen:
-    dependency: transitive
-    description:
-      name: source_gen
-      sha256: "14658ba5f669685cd3d63701d01b31ea748310f7ab854e471962670abcf57832"
-      url: "https://pub.dev"
-    source: hosted
-    version: "1.5.0"
-  source_helper:
-    dependency: transitive
-    description:
-      name: source_helper
-      sha256: "6adebc0006c37dd63fe05bca0a929b99f06402fc95aa35bf36d67f5c06de01fd"
-      url: "https://pub.dev"
-    source: hosted
-    version: "1.3.4"
   source_span:
     dependency: transitive
     description:
@@ -811,22 +707,22 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "5.5.1"
-  xdg_directories:
+  win32_registry:
     dependency: transitive
     description:
-      name: xdg_directories
-      sha256: faea9dee56b520b55a566385b84f2e8de55e7496104adada9962e0bd11bcff1d
+      name: win32_registry
+      sha256: "10589e0d7f4e053f2c61023a31c9ce01146656a70b7b7f0828c0b46d7da2a9bb"
       url: "https://pub.dev"
     source: hosted
-    version: "1.0.4"
-  yaml:
+    version: "1.1.3"
+  xdg_directories:
     dependency: transitive
     description:
-      name: yaml
-      sha256: "75769501ea3489fca56601ff33454fe45507ea3bfb014161abc3b43ae25989d5"
+      name: xdg_directories
+      sha256: faea9dee56b520b55a566385b84f2e8de55e7496104adada9962e0bd11bcff1d
       url: "https://pub.dev"
     source: hosted
-    version: "3.1.2"
+    version: "1.0.4"
 sdks:
   dart: ">=3.4.0 <4.0.0"
   flutter: ">=3.22.0"

playground/locator-strategies.txt

@@ -9,7 +9,7 @@
 }
 
 {
-  "strategy": "text containting",
+  "strategy": "text containing",
   "selector": "Text on the element contains"
 }
 

server/lib/src/appium_test_bindings.dart

@@ -23,4 +23,7 @@ class AppiumTestWidgetsFlutterBinding
 
   @override
   TestBindingEventSource get pointerEventSource => TestBindingEventSource.test;
+
+  @override
+  bool get registerTestTextInput => true;
 }

server/lib/src/handler/find_elements.dart

@@ -20,26 +20,17 @@ class FindElementstHandler extends RequestHandler {
     FindElementModel model =
         FindElementModel.fromJson(await request.body.asJson);
 
-    final String method = model.strategy;
-    final String selector = model.selector;
     final String? contextId = model.context == "" ? null : model.context;
 
-    if (contextId == null) {
-      log('"method: $method, selector: $selector');
-    } else {
-      log('"method: $method, selector: $selector, contextId: $contextId');
-    }
-
     Session? session = FlutterDriver.instance.getSessionOrThrow();
-    final Finder by = ElementLookupStrategy.values
-        .firstWhere((val) => val.name == method)
-        .toFinder(selector);
+    final Finder by =
+        await ElementHelper.locateElement(model, evaluatePresence: false);
     List<Finder> matchedByList = [];
     try {
       matchedByList =
           await ElementHelper.findElements(by, contextId: contextId);
     } on ElementNotFoundException catch (e) {
-      log("Got an exception while looking for multiple matches using method: $method, selector: $selector");
+      log("Got an exception while looking for multiple matches using method: ${model.strategy}, selector: ${model.selector}");
       log(e);
       return AppiumResponse(session!.sessionId, matchedByList);
     }

server/lib/src/internal/element_lookup_strategy.dart

@@ -8,17 +8,14 @@ enum ElementLookupStrategy {
   BY_TOOLTIP,
   BY_TEXT,
   BY_TEXT_CONTAINING,
+  BY_TYPE,
+  BY_ICON_POINT,
+  BY_ICON_NAME
   // BY_ICON,
   // BY_ELEMENT_PREDICATE,
   // BY_SUBTYPE,
-  BY_TYPE,
   // BY_WIDGET,
   //BY_WIDGET_PREDICATE,
-
-  //Custom Selectors
-  //BY_WIDGET_NAME,
-  BY_ICON_POINT,
-  BY_ICON_NAME
 }
 
 var a = Icons.accessible;
@@ -65,34 +62,33 @@ extension ElementLookupStrategyExtension on ElementLookupStrategy {
   String get name {
     switch (this) {
       case ElementLookupStrategy.BY_KEY:
-        return 'key';
+        return '-flutter key';
       case ElementLookupStrategy.BY_SEMANTICS_LABEL:
-        return 'semantics label';
+        return '-flutter semantics label';
       case ElementLookupStrategy.BY_TOOLTIP:
-        return 'tooltip';
+        return '-flutter tooltip';
       case ElementLookupStrategy.BY_TEXT:
-        return 'text';
+        return '-flutter text';
       case ElementLookupStrategy.BY_TEXT_CONTAINING:
-        return 'text containting';
-
+        return '-flutter text containing';
       case ElementLookupStrategy.BY_TYPE:
-        return 'type';
+        return '-flutter type';
       case ElementLookupStrategy.BY_ICON_POINT:
-        return 'icon point';
+        return '-flutter icon point';
       case ElementLookupStrategy.BY_ICON_NAME:
-        return 'icon name';
+        return '-flutter icon name';
       // case ElementLookupStrategy.BY_ICON:
-      //   return 'icon';
+      //   return '-flutter icon';
       // case ElementLookupStrategy.BY_ELEMENT_PREDICATE:
-      //   return 'element predicate';
+      //   return '-flutter element predicate';
       // case ElementLookupStrategy.BY_SUBTYPE:
-      //   return 'subtype';
+      //   return '-flutter subtype';
       // case ElementLookupStrategy.BY_TYPE:
-      //   return 'type';
+      //   return '-flutter type';
       // case ElementLookupStrategy.BY_WIDGET:
-      //   return 'widget';
+      //   return '-flutter widget';
       // case ElementLookupStrategy.BY_WIDGET_PREDICATE:
-      //   return 'widget predicate';
+      //   return '-flutter widget predicate';
     }
   }
 }