appium-espresso-driver 3.0.0 → 3.2.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [3.2.0](https://github.com/appium/appium-espresso-driver/compare/v3.1.0...v3.2.0) (2024-07-15)
+
+### Features
+
+* Add proper info to the /status API response ([#1022](https://github.com/appium/appium-espresso-driver/issues/1022)) ([4602a6f](https://github.com/appium/appium-espresso-driver/commit/4602a6fe4a03915a96db9f33dfa7f5b0d77e121d))
+
+## [3.1.0](https://github.com/appium/appium-espresso-driver/compare/v3.0.0...v3.1.0) (2024-07-11)
+
+### Features
+
+* Publish Espresso server library to JitPack ([#1021](https://github.com/appium/appium-espresso-driver/issues/1021)) ([9445667](https://github.com/appium/appium-espresso-driver/commit/94456673880e591808e06db57da1d21ec823ec0c))
+
 ## [3.0.0](https://github.com/appium/appium-espresso-driver/compare/v2.44.2...v3.0.0) (2024-07-10)
 
 ### ⚠ BREAKING CHANGES

package/espresso-server/library/build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     id("com.android.library")
     kotlin("android")
+    `maven-publish`
 }
 
 val appiumCompileSdk: String by project
@@ -51,6 +52,22 @@ android {
         targetSdk = appiumTargetSdk.toInt()
         unitTests.isReturnDefaultValues = true
     }
+
+    publishing {
+        singleVariant("release") {
+            withSourcesJar()
+        }
+    }
+}
+
+publishing {
+    publications {
+        register<MavenPublication>("release") {
+            afterEvaluate {
+                from(components["release"])
+            }
+        }
+    }
 }
 
 dependencies {

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/handlers/Status.kt

@@ -16,11 +16,22 @@
 
 package io.appium.espressoserver.lib.handlers
 
+import androidx.test.platform.app.InstrumentationRegistry
+import io.appium.espressoserver.lib.helpers.getEspressoServerVersion
 import io.appium.espressoserver.lib.model.AppiumParams
+import io.appium.espressoserver.lib.model.BuildInfo
 
-class Status : RequestHandler<AppiumParams, Void?>, NoSessionCommandHandler {
 
-    override fun handleInternal(params: AppiumParams): Void? {
-        return null
+class Status : RequestHandler<AppiumParams, io.appium.espressoserver.lib.model.Status>, NoSessionCommandHandler {
+
+    override fun handleInternal(params: AppiumParams): io.appium.espressoserver.lib.model.Status {
+        return io.appium.espressoserver.lib.model.Status(
+            ready = true,
+            message = "The server is ready to accept new connections",
+            build = BuildInfo(
+                version = getEspressoServerVersion(),
+                packageName = InstrumentationRegistry.getInstrumentation().targetContext.packageName
+            )
+        )
     }
 }

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/helpers/Version.kt

@@ -0,0 +1,7 @@
+package io.appium.espressoserver.lib.helpers
+
+// This value is updated automatically by the NPM versioning script
+// It should be in sync with the NPM module version from package.json
+private const val VERSION = "3.2.0"
+
+fun getEspressoServerVersion() = VERSION

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/http/Router.kt

@@ -21,6 +21,7 @@ import com.google.gson.JsonParseException
 import fi.iki.elonen.NanoHTTPD.Method
 import io.appium.espressoserver.lib.handlers.*
 import io.appium.espressoserver.lib.handlers.PointerEventHandler.TouchType.*
+import io.appium.espressoserver.lib.handlers.Status
 import io.appium.espressoserver.lib.handlers.TouchAction
 import io.appium.espressoserver.lib.handlers.exceptions.*
 import io.appium.espressoserver.lib.helpers.AndroidLogger

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/model/AppiumParams.kt

@@ -16,6 +16,7 @@
 
 package io.appium.espressoserver.lib.model
 
+import com.google.gson.annotations.Expose
 import io.appium.espressoserver.lib.handlers.exceptions.AppiumException
 
 
@@ -23,7 +24,8 @@ const val SESSION_ID_PARAM_NAME = "sessionId"
 const val ELEMENT_ID_PARAM_NAME = "elementId"
 
 open class AppiumParams {
-    var uriParams:MutableMap<String, String>? = null
+    @Expose(serialize = false, deserialize = true)
+    private var uriParams: MutableMap<String, String>? = null
 
     val sessionId: String?
         get() = getUriParameterValue(SESSION_ID_PARAM_NAME)

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/model/Location.kt

@@ -16,4 +16,7 @@
 
 package io.appium.espressoserver.lib.model
 
-data class Location(var x: Int? = null, var y: Int? = null) : AppiumParams()
+data class Location(
+    val x: Int,
+    val y: Int
+)

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/model/Rect.kt

@@ -18,12 +18,12 @@ package io.appium.espressoserver.lib.model
 
 import android.graphics.Rect
 
-class Rect(
-    var x: Int? = null,
-    var y: Int? = null,
-    var width: Int? = null,
-    var height: Int? = null
-) : AppiumParams() {
+data class Rect(
+    var x: Int,
+    var y: Int,
+    var width: Int,
+    var height: Int
+) {
     companion object {
         fun fromBounds(bounds: Rect): io.appium.espressoserver.lib.model.Rect =
             io.appium.espressoserver.lib.model.Rect(

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/model/Size.kt

@@ -19,4 +19,4 @@ package io.appium.espressoserver.lib.model
 data class Size(
     val width: Int,
     val height: Int
-) : AppiumParams()
+)

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/model/Status.kt

@@ -0,0 +1,28 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appium.espressoserver.lib.model
+
+data class Status(
+    val ready: Boolean,
+    val message: String,
+    val build: BuildInfo
+)
+
+data class BuildInfo(
+    val version: String,
+    val packageName: String
+)

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/model/WindowRect.kt

@@ -21,4 +21,4 @@ data class WindowRect(
     val height: Int,
     val x: Int,
     val y: Int
-) : AppiumParams()
+)

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/model/WindowSize.kt

@@ -19,4 +19,4 @@ package io.appium.espressoserver.lib.model
 data class WindowSize(
     val width: Int,
     val height: Int
-) : AppiumParams()
+)

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-espresso-driver",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-espresso-driver",
-      "version": "3.0.0",
+      "version": "3.2.0",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^12.4.0",
@@ -42,6 +42,7 @@
         "mocha": "^10.0.0",
         "rimraf": "^5.0.0",
         "semantic-release": "^24.0.0",
+        "semver": "^7.3.7",
         "sinon": "^17.0.0",
         "ts-node": "^10.9.1",
         "typescript": "^5.4.2",
@@ -764,13 +765,13 @@
       }
     },
     "node_modules/appium-android-driver": {
-      "version": "9.7.4",
-      "resolved": "https://registry.npmjs.org/appium-android-driver/-/appium-android-driver-9.7.4.tgz",
-      "integrity": "sha512-hOjcpFT57PrhzxglrG7KpIJSXHVQ9Hlw5yGcRC4RpymBvUZjcvWflvord6oaYb0juGV/7X0d7NltrX2jPAUhhg==",
+      "version": "9.7.5",
+      "resolved": "https://registry.npmjs.org/appium-android-driver/-/appium-android-driver-9.7.5.tgz",
+      "integrity": "sha512-A/XU3RiueOp6RCtfJSfJ16iRwmNNLb98zNjBbTOnPetWWav9nEIEGkZzuDNdMEtBv4xviFXH/4wsdnUWtHKTFw==",
       "dependencies": {
         "@appium/support": "^5.0.3",
         "@colors/colors": "^1.6.0",
-        "appium-adb": "^12.3.0",
+        "appium-adb": "^12.5.0",
         "appium-chromedriver": "^5.5.1",
         "asyncbox": "^3.0.0",
         "axios": "^1.x",
@@ -1223,9 +1224,9 @@
       }
     },
     "node_modules/compare-versions": {
-      "version": "6.1.0",
-      "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-6.1.0.tgz",
-      "integrity": "sha512-LNZQXhqUvqUTotpZ00qLSaify3b4VFD588aRr8MKFw4CMUr98ytzCW5wDH5qx/DEY5kCDXcbcRuCqL0szEf2tg=="
+      "version": "6.1.1",
+      "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-6.1.1.tgz",
+      "integrity": "sha512-4hm4VPpIecmlg59CHXnRDnqGplJFrbLG4aFEl5vl6cK1u76ws3LLvX7ikFnTDl5vo39sjWD6AaDPYodJp/NNHg=="
     },
     "node_modules/compress-commons": {
       "version": "6.0.2",
@@ -2026,9 +2027,9 @@
       }
     },
     "node_modules/io.appium.settings": {
-      "version": "5.12.5",
-      "resolved": "https://registry.npmjs.org/io.appium.settings/-/io.appium.settings-5.12.5.tgz",
-      "integrity": "sha512-yZQ/bkv4W1BYde5oVvlMwtPgYUWs+iFXeGjGGw8nZbWHCWbF2IzwlZx6yWpGCgEr1CM9Wc9YNoggiMUD/wPsSQ==",
+      "version": "5.12.6",
+      "resolved": "https://registry.npmjs.org/io.appium.settings/-/io.appium.settings-5.12.6.tgz",
+      "integrity": "sha512-BFLzG0s7o6rR2Wfkzn72HEHmbLxZEpKG32VrvZmgJdZcO4kRoKyYkDVZRwvzDEEs+qk42OzsLdFZDLf8s5gJaw==",
       "dependencies": {
         "@appium/logger": "^1.3.0",
         "asyncbox": "^3.0.0",

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "3.0.0",
+  "version": "3.2.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -98,9 +98,11 @@
     "lint:server": "cd espresso-server && ./gradlew lint || cd ..",
     "lint:fix": "npm run lint -- --fix",
     "prepare": "npm run rebuild",
+    "sync-version": "node ./scripts/sync-version.js --package-version=${npm_package_version}",
     "test": "npm run test:node",
     "test:node": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.js\"",
     "test:server": "cd espresso-server && ./gradlew test --stacktrace || cd ..",
+    "version": "npm run sync-version && npm run build:server",
     "e2e-test": "mocha --exit --timeout 5m \"./test/functional/**/*-specs.js\""
   },
   "peerDependencies": {
@@ -130,6 +132,7 @@
     "rimraf": "^5.0.0",
     "semantic-release": "^24.0.0",
     "sinon": "^17.0.0",
+    "semver": "^7.3.7",
     "ts-node": "^10.9.1",
     "typescript": "^5.4.2",
     "webdriverio": "^8.0.2",

package/scripts/sync-version.js

@@ -0,0 +1,47 @@
+const path = require('node:path');
+const { logger, fs } = require('appium/support');
+const semver = require('semver');
+
+const LOG = logger.getLogger('VersionSync');
+
+const ROOT_DIR = path.resolve(__dirname, '..');
+const ESPRESSO_SERVER_ROOT = path.join(ROOT_DIR, 'espresso-server');
+const VERSION_FILE = path.join(
+  ESPRESSO_SERVER_ROOT, 'library', 'src', 'main', 'java',
+  'io', 'appium', 'espressoserver',
+  'lib', 'helpers', 'Version.kt'
+);
+const VERSION_PATTERN = /VERSION\s*=\s*"([0-9.]+)"/;
+
+function parseArgValue (argName) {
+  const argNamePattern = new RegExp(`^--${argName}\\b`);
+  for (let i = 1; i < process.argv.length; ++i) {
+    const arg = process.argv[i];
+    if (argNamePattern.test(arg)) {
+      return arg.includes('=') ? arg.split('=')[1] : process.argv[i + 1];
+    }
+  }
+  return null;
+}
+
+async function syncModuleVersion () {
+  const origContent = await fs.readFile(VERSION_FILE, 'utf8');
+  const espressoVersionMatch = VERSION_PATTERN.exec(origContent);
+  if (!espressoVersionMatch) {
+    throw new Error(`Could not parse Espresso module version from '${VERSION_FILE}'`);
+  }
+  const packageVersion = parseArgValue('package-version');
+  if (!packageVersion) {
+    throw new Error('No package version argument (use `--package-version=xxx`)');
+  }
+  if (!semver.valid(packageVersion)) {
+    throw new Error(
+      `Invalid version specified '${packageVersion}'. Version should be in the form '1.2.3'`
+    );
+  }
+  const updatedContent = origContent.replace(espressoVersionMatch[1], packageVersion);
+  await fs.writeFile(VERSION_FILE, updatedContent, 'utf8');
+  LOG.info(`Synchronized module version '${packageVersion}' to '${VERSION_FILE}'`);
+}
+
+(async () => await syncModuleVersion())();