consider elementWaitTimeout from capabilities (#23)

* consider elementWaitTimeout from capabilities

Co-authored-by: tw-manjesh <[email protected]>
Co-authored-by: rahul-kumar-sdet <[email protected]>
Co-authored-by: akshathamkanavi <[email protected]>
Co-authored-by: purniram <[email protected]>
Co-authored-by: dharsanasridharan <[email protected]>

* update release version

* fixed comments

---------

Co-authored-by: tw-manjesh <[email protected]>
Co-authored-by: rahul-kumar-sdet <[email protected]>
Co-authored-by: akshathamkanavi <[email protected]>
Co-authored-by: purniram <[email protected]>
Co-authored-by: dharsanasridharan <[email protected]>

Author: 6 people

demo-app/pubspec.lock

@@ -15,7 +15,7 @@ packages:
       path: "../server"
       relative: true
     source: path
-    version: "0.0.20"
+    version: "0.0.21"
   archive:
     dependency: transitive
     description:

server/analysis_options.yaml

@@ -1,4 +1,7 @@
 include: package:flutter_lints/flutter.yaml
+linter:
+  rules:
+    - non_constant_identifier_names
 
 # Additional information about this file can be found at
 # https://dart.dev/guides/language/analysis-options

server/lib/src/driver.dart

@@ -1,5 +1,6 @@
 import 'package:appium_flutter_server/src/exceptions/no_driver_exception.dart';
 import 'package:appium_flutter_server/src/models/session.dart';
+import 'package:appium_flutter_server/src/utils/flutter_settings.dart';
 import 'package:appium_flutter_server/src/utils/test_utils.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:integration_test/integration_test.dart';
@@ -14,6 +15,7 @@ class FlutterDriver {
   bool _isCameraMocked = false;
   final Map<String, String> _savedFiles = {};
   String? _activeMockImage;
+  FlutterSettings settings = FlutterSettings();
 
   FlutterDriver._();
 
@@ -40,6 +42,7 @@ class FlutterDriver {
 
   String initializeSession(Map<String, dynamic> capabilities) {
     _session = Session(generateUUID(), capabilities);
+    settings.updateSetting(capabilities);
     return _session!.sessionId;
   }
 
@@ -57,6 +60,7 @@ class FlutterDriver {
 
   void resetSession() {
     _session = null;
+    settings.reset();
   }
 
   void setCameraMocked(bool value) {

server/lib/src/runner.dart

@@ -11,7 +11,7 @@ import 'package:package_info_plus/package_info_plus.dart';
 const MAX_TEST_DURATION_SECS = 24 * 60 * 60;
 // Need a better way to fetch this for automated release, this needs to be updated along with version bump
 // Can stay for now as it is not a breaking change
-const serverVersion = '0.0.21';
+const serverVersion = '0.0.22';
 
 
 void initializeTest({Widget? app, Function? callback}) async {

server/lib/src/utils/element_helper.dart

@@ -10,6 +10,7 @@ import 'package:appium_flutter_server/src/models/api/drag_drop.dart';
 import 'package:appium_flutter_server/src/models/api/gesture.dart';
 import 'package:appium_flutter_server/src/models/api/find_element.dart';
 import 'package:appium_flutter_server/src/models/session.dart';
+import 'package:appium_flutter_server/src/utils/flutter_settings.dart';
 import 'package:flutter/gestures.dart';
 import 'package:flutter/rendering.dart';
 import 'package:flutter/widgets.dart';
@@ -26,7 +27,6 @@ const defaultScrollDelta = 64.0;
 /// Default maximum number of drags during scrolling.
 const defaultScrollMaxIteration = 15;
 
-const Duration defaultWaitTimeout = Duration(seconds: 5);
 
 class ElementHelper {
   static Future<Finder> findElement(Finder by, {String? contextId}) async {
@@ -52,7 +52,7 @@ class ElementHelper {
     final FinderResult<Element> elements = finder.evaluate();
     if (evaluatePresence) {
       await waitForElementExist(FlutterElement.fromBy(finder),
-          timeout: defaultWaitTimeout);
+          timeout: Duration(milliseconds: FlutterDriver.instance.settings.getSetting('flutterElementWaitTimeout')));
 
       if (elements.isEmpty) {
         throw ElementNotFoundException("Unable to locate element");
@@ -496,7 +496,7 @@ class ElementHelper {
     Finder elementToFind = await locateElement(finder, evaluatePresence: false);
 
     await waitForElementExist(FlutterElement.fromBy(scrollViewElement),
-        timeout: defaultWaitTimeout);
+        timeout: Duration(milliseconds: FlutterDriver.instance.settings.getSetting('flutterElementWaitTimeout')));
     AxisDirection direction;
     if (scrollDirection == null) {
       if (scrollViewElement.evaluate().first.widget is Scrollable) {

server/lib/src/utils/flutter_settings.dart

@@ -0,0 +1,32 @@
+class FlutterSettings {
+  Map<String, dynamic> _settings = {};
+
+  FlutterSettings() {
+    _setDefaultSetting();
+  }
+
+  _setDefaultSetting() {
+    _settings = {
+      'flutterElementWaitTimeout': 5000
+    };
+  }
+
+  updateSetting(Map<String, dynamic> capabilities) {
+    // if the capability sent by user is present in the settings, then update it.
+    // Else the capability is not known to flutter server and ignore
+    capabilities.forEach((settingName, value) {
+    if (_settings[settingName] != null) {
+        _settings[settingName] = value;
+    }
+    });
+  }
+
+  dynamic getSetting(String settingName) {
+    return _settings[settingName];
+  }
+
+  // Called at the end of session
+  reset() {
+    _setDefaultSetting();
+  }
+}

server/pubspec.yaml

@@ -1,6 +1,6 @@
 name: appium_flutter_server
 description: "Appium Flutter server using Integration Test package for testing Flutter apps with Appium"
-version: 0.0.21
+version: 0.0.22
 homepage: "https://github.com/AppiumTestDistribution/appium-flutter-server"
 
 environment: