Incremental steps to support Android XR

.github/jobs/android.yml

@@ -9,23 +9,61 @@ jobs:
   timeoutInMinutes: 30
 
   pool:
-    vmImage: macos-13
+    vmImage: macos-latest
 
   steps:
+  - task: JavaToolInstaller@0
+    displayName: 'Set up JDK 17'
+    inputs:
+      versionSpec: '17'
+      jdkArchitectureOption: 'x64'
+      jdkSourceOption: 'PreInstalled'
+
   - script: |
-      echo Install Android image
-      export JAVA_HOME=$JAVA_HOME_8_X64
-      echo 'y' | $ANDROID_HOME/tools/bin/sdkmanager --install 'system-images;android-27;default;x86_64'
-      echo 'y' | $ANDROID_HOME/tools/bin/sdkmanager --licenses
-      echo Create AVD
-      $ANDROID_HOME/tools/bin/avdmanager create avd -n Pixel_API_27 -d pixel -k 'system-images;android-27;default;x86_64'
+      echo "Install NDK and Android SDK"
+      # Use Java 17 which is compatible with modern Android tooling
+      export JAVA_HOME=$JAVA_HOME_17_X64
+      export PATH=$JAVA_HOME/bin:$PATH
+
+      echo "Java version:"
+      java -version
+
+      # Use cmdline-tools instead of deprecated tools/bin path
+      echo "y" | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --install "ndk;$(ndkVersion)"
+      echo "y" | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --install "platforms;android-35"
+      echo "y" | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --install "build-tools;35.0.0"
+      echo "y" | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --install "system-images;android-35;google_apis;x86_64"
+      echo "y" | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses
+      echo "Create AVD with Pixel 2 profile and optimized memory"
+      echo "no" | $ANDROID_HOME/cmdline-tools/latest/bin/avdmanager create avd -n Pixel_2_API_35 -d pixel_2 -k "system-images;android-35;google_apis;x86_64"
+      # Optimize AVD for CI - reduce memory and disk size
+      echo "hw.ramSize=1024" >> ~/.android/avd/Pixel_2_API_35.avd/config.ini
+      echo "disk.dataPartition.size=2G" >> ~/.android/avd/Pixel_2_API_35.avd/config.ini
+      echo "hw.gpu.enabled=yes" >> ~/.android/avd/Pixel_2_API_35.avd/config.ini
+      echo "hw.gpu.mode=swiftshader_indirect" >> ~/.android/avd/Pixel_2_API_35.avd/config.ini
     displayName: 'Install Android Emulator'
 
   - script: |
-      echo Start emulator
-      nohup $ANDROID_HOME/emulator/emulator -avd Pixel_API_27 -gpu host -no-window -no-audio -no-boot-anim 2>&1 &
+      export JAVA_HOME=$JAVA_HOME_17_X64
+      export PATH=$JAVA_HOME/bin:$PATH
+
+      echo Start emulator with optimized settings
+      nohup $ANDROID_HOME/emulator/emulator -avd Pixel_2_API_35 -gpu swiftshader_indirect -no-window -no-audio -no-boot-anim -no-snapshot-save -memory 1024 -partition-size 2048 2>&1 &
       echo Wait for emulator
-      $ANDROID_HOME/platform-tools/adb wait-for-device shell 'while [[ -z $(getprop sys.boot_completed) ]]; do echo '.'; sleep 1; done'
+      $ANDROID_HOME/platform-tools/adb wait-for-device shell 'while [[ -z $(getprop sys.boot_completed) ]]; do echo "Waiting for boot..."; sleep 2; done'
+
+      # Additional wait for package manager to be ready
+      echo "Waiting for package manager..."
+      $ANDROID_HOME/platform-tools/adb shell 'while [[ -z $(pm list packages 2>/dev/null) ]]; do sleep 2; done'
+
+      # Disable animations for test stability
+      $ANDROID_HOME/platform-tools/adb shell settings put global window_animation_scale 0
+      $ANDROID_HOME/platform-tools/adb shell settings put global transition_animation_scale 0
+      $ANDROID_HOME/platform-tools/adb shell settings put global animator_duration_scale 0
+
+      # Increase ADB timeout
+      export ADB_INSTALL_TIMEOUT=120
+
       $ANDROID_HOME/platform-tools/adb devices
     displayName: 'Start Android Emulator'
 
@@ -35,17 +73,24 @@ jobs:
       workingDirectory: 'Tests/UnitTests/Android'
       options: '-PabiFilters=x86_64 -PjsEngine=${{parameters.jsEngine}} -PndkVersion=$(ndkVersion)'
       tasks: 'connectedAndroidTest'
-      jdkVersionOption: 1.17
+      jdkVersionOption: '1.17'
     displayName: 'Run Connected Android Test'
+    retryCountOnTaskFailure: 2
 
   - script: |
+      # Dump test failure details when tests fail
+      if [ -f ./app/build/outputs/androidTest-results/connected/TEST-*.xml ]; then
+        echo "=== Test Results Summary ==="
+        grep -h "testcase\|failure" ./app/build/outputs/androidTest-results/connected/TEST-*.xml || true
+      fi
+      # Dump logcat output which contains our detailed error messages
       find ./app/build/outputs/androidTest-results -name "*.txt" -print0 | while IFS= read -r -d '' file; do
-        echo "cat \"$file\""
-        cat "$file"
+        echo "=== Logcat Output from: $file ==="
+        cat "$file" | grep -E "(FAILED|TEST FAILURES|Error:|Stack:|JsRuntimeHost)" || cat "$file"
       done
     workingDirectory: 'Tests/UnitTests/Android'
     condition: succeededOrFailed()
-    displayName: 'Dump logcat from Test Results'
+    displayName: 'Dump test failure details and logcat'
 
   - task: PublishBuildArtifacts@1
     inputs:

CMakeLists.txt

@@ -14,7 +14,7 @@ FetchContent_Declare(arcana.cpp
     GIT_TAG c726dbe58713eda65bfb139c257093c43479b894)
 FetchContent_Declare(AndroidExtensions
     GIT_REPOSITORY https://github.com/BabylonJS/AndroidExtensions.git
-    GIT_TAG        7d88a601fda9892791e7b4e994e375e049615688)
+    GIT_TAG        f7ed149b5360cc8a4908fece66607c5ce1e6095b)
 FetchContent_Declare(asio
     GIT_REPOSITORY https://github.com/chriskohlhoff/asio.git
     GIT_TAG f693a3eb7fe72a5f19b975289afc4f437d373d9c)
@@ -49,6 +49,19 @@ set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
+if(APPLE)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fobjc-arc")
+    if(NOT CMAKE_BUILD_TYPE OR CMAKE_BUILD_TYPE STREQUAL "Debug")
+        if(NOT DEFINED JSRUNTIMEHOST_NATIVE_SANITIZERS)
+            set(JSRUNTIMEHOST_NATIVE_SANITIZERS "address,undefined")
+        endif()
+        if(JSRUNTIMEHOST_NATIVE_SANITIZERS)
+            message(STATUS "macOS sanitizers enabled: ${JSRUNTIMEHOST_NATIVE_SANITIZERS}")
+            add_compile_options("-fsanitize=${JSRUNTIMEHOST_NATIVE_SANITIZERS}" "-fno-omit-frame-pointer")
+            add_link_options("-fsanitize=${JSRUNTIMEHOST_NATIVE_SANITIZERS}")
+        endif()
+    endif()
+endif()
 
 # --------------------------------------------------
 # Options
@@ -81,6 +94,21 @@ set_property(TARGET arcana PROPERTY FOLDER Dependencies)
 if(JSRUNTIMEHOST_POLYFILL_XMLHTTPREQUEST)
     FetchContent_MakeAvailable_With_Message(UrlLib)
     set_property(TARGET UrlLib PROPERTY FOLDER Dependencies)
+    if(APPLE)
+        FetchContent_GetProperties(UrlLib)
+        if(UrlLib_POPULATED)
+            target_compile_options(UrlLib PRIVATE -fobjc-arc)
+            set(_urllib_objc_sources
+                "${UrlLib_SOURCE_DIR}/Source/UrlRequest_Apple.mm"
+                "${UrlLib_SOURCE_DIR}/Source/WebSocket_Apple.mm"
+                "${UrlLib_SOURCE_DIR}/Source/WebSocket_Apple_ObjC.m")
+            foreach(_file IN LISTS _urllib_objc_sources)
+                if(EXISTS "${_file}")
+                    set_source_files_properties("${_file}" PROPERTIES COMPILE_FLAGS "-fobjc-arc")
+                endif()
+            endforeach()
+        endif()
+    endif()
 endif()
 
 if(BABYLON_DEBUG_TRACE)

Core/Node-API/CMakeLists.txt

@@ -32,6 +32,9 @@ if(NAPI_BUILD_ABI)
             npm(install --no-package-lock --silent WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 
             file(GLOB_RECURSE ANDROID_ARCHIVE "${CMAKE_CURRENT_BINARY_DIR}/node_modules/${V8_PACKAGE_NAME}/${aar_path}/*.aar")
+            if(NOT ANDROID_ARCHIVE)
+                message(FATAL_ERROR "Could not find archive at ${CMAKE_CURRENT_BINARY_DIR}/node_modules/${V8_PACKAGE_NAME}/${aar_path}/*.aar")
+            endif()
             file(ARCHIVE_EXTRACT INPUT ${ANDROID_ARCHIVE} DESTINATION ${output_directory} PATTERNS jni)
             message(STATUS "Extracting ${V8_PACKAGE_NAME} archive - done")
 
@@ -56,7 +59,8 @@ if(NAPI_BUILD_ABI)
         if(ANDROID)
             set(V8_PACKAGE_NAME "jsc-android")
             set(JSC_ANDROID_DIR "${CMAKE_CURRENT_BINARY_DIR}/${V8_PACKAGE_NAME}")
-            napi_install_android_package(jsc "dist/org/webkit/android-jsc" ${JSC_ANDROID_DIR})
+            # Use android-jsc-intl for full intl support
+            napi_install_android_package(jsc "dist/org/webkit/android-jsc-intl" ${JSC_ANDROID_DIR})
 
             # Add `JavaScriptCore` prefix to the include path
             file(RENAME "${JSC_ANDROID_DIR}/include" "${JSC_ANDROID_DIR}/JavaScriptCore")

Core/Node-API/package-jsc.json

@@ -1,5 +1,5 @@
 {
   "dependencies": {
-    "jsc-android": "250231.0.0"
+    "jsc-android": "294992.0.0"
   }
 }

README.md

@@ -10,7 +10,7 @@ polyfills that consumers can include if required.
 
 ## **Building - All Development Platforms**
 
-**Required Tools:** [git](https://git-scm.com/), [CMake](https://cmake.org/), [node.js](https://nodejs.org/en/)
+**Required Tools:** [git](https://git-scm.com/), [CMake 3.29 or newer](https://cmake.org/), [node.js 20.x or newer](https://nodejs.org/en/)
 
 The first step for all development environments and targets is to clone this repository. 
 
@@ -32,9 +32,9 @@ npm install
 _Follow the steps from [All Development Platforms](#all-development-platforms) before proceeding._
 
 **Required Tools:**
-[Android Studio](https://developer.android.com/studio), [Node.js](https://nodejs.org/en/download/), [Ninja](https://ninja-build.org/)
+[Android Studio](https://developer.android.com/studio) with Android NDK 28.2.13676358 and API level 35 SDK platforms installed, [Node.js 20.x or newer](https://nodejs.org/en/download/), [Ninja](https://ninja-build.org/)
 
-The minimal requirement target is Android 5.0.
+The minimal requirement target is Android 10.0, which has [~95%](https://gs.statcounter.com/android-version-market-share/mobile-tablet/worldwide) active device coverage globally. Android 10 support covers Meta Quest 1 (and newer), HTC Vive Focus 2 (and newer), and Pico 3 (and newer).
 
 Only building with Android Studio is supported. CMake is not used directly. Instead, Gradle
 is used for building and CMake is automatically invocated for building the native part.
@@ -68,4 +68,4 @@ Security Response Center (MSRC) at [[email protected]](mailto:secure@microsof
 You should receive a response within 24 hours. If for some reason you do not, please 
 follow up via email to ensure we received your original message. Further information, 
 including the [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can 
-be found in the [Security TechCenter](https://technet.microsoft.com/en-us/security/default).
+be found in the [Security TechCenter](https://technet.microsoft.com/en-us/security/default).

Tests/CMakeLists.txt

@@ -1,2 +1,10 @@
-add_subdirectory(UnitTests)
+set(JSRUNTIMEHOST_OUTPUT_DIR "${CMAKE_SOURCE_DIR}/build/Tests/UnitTests/dist")
+set(JSRUNTIMEHOST_OUTPUT_DIR "${JSRUNTIMEHOST_OUTPUT_DIR}" CACHE INTERNAL "Output directory for bundled unit test scripts")
+file(MAKE_DIRECTORY "${JSRUNTIMEHOST_OUTPUT_DIR}")
+file(REMOVE_RECURSE "${CMAKE_CURRENT_SOURCE_DIR}/UnitTests/dist")
+
+set(ENV{JSRUNTIMEHOST_BUNDLE_OUTPUT} "${JSRUNTIMEHOST_OUTPUT_DIR}")
 npm(install --silent)
+unset(ENV{JSRUNTIMEHOST_BUNDLE_OUTPUT})
+
+add_subdirectory(UnitTests)

Tests/UnitTests/Android/app/build.gradle

@@ -7,36 +7,56 @@ if (project.hasProperty("jsEngine")) {
     jsEngine = project.property("jsEngine")
 }
 
+def targetApiLevel = 35
+def requiredNdkVersion = project.findProperty("ndkVersion") ?: "28.2.13676358"
+
 android {
     namespace 'com.jsruntimehost.unittests'
-    compileSdk 33
-    ndkVersion = "23.1.7779620"
-    if (project.hasProperty("ndkVersion")) {
-        ndkVersion = project.property("ndkVersion")
-    }
+    compileSdk targetApiLevel
+    ndkVersion = requiredNdkVersion
 
     defaultConfig {
         applicationId "com.jsruntimehost.unittests"
         minSdk 21
-        targetSdk 33
+        targetSdk targetApiLevel
         versionCode 1
         versionName "1.0"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
 
         externalNativeBuild {
             cmake {
-                arguments (
+                arguments(
                     "-DANDROID_STL=c++_shared",
                     "-DNAPI_JAVASCRIPT_ENGINE=${jsEngine}",
                     "-DJSRUNTIMEHOST_CORE_APPRUNTIME_V8_INSPECTOR=ON"
                 )
             }
         }
 
-        if (project.hasProperty("abiFilters")) {
-            ndk {
-                abiFilters project.getProperty("abiFilters")
+        ndk {
+            def abiFiltersProp = project.findProperty("abiFilters")?.toString()
+            if (abiFiltersProp) {
+                def propFilters = abiFiltersProp.split(',').collect { it.trim() }.findAll { !it.isEmpty() }
+                if (!propFilters.isEmpty()) {
+                    abiFilters(*propFilters)
+                }
+            } else {
+                // Prefer injected ABI hints and fall back to a host-aware default
+                def requestedAbi = project.findProperty("android.injected.build.abi") ?: System.getenv("ANDROID_ABI")
+                def defaultAbis = []
+                if (requestedAbi) {
+                    defaultAbis = requestedAbi.split(',').collect { it.trim() }.findAll { !it.isEmpty() }
+                }
+                if (defaultAbis.isEmpty()) {
+                    def hostArch = (System.getProperty("os.arch") ?: "").toLowerCase()
+                    if (hostArch.contains("aarch64") || hostArch.contains("arm64")) {
+                        defaultAbis = ['arm64-v8a']
+                    } else {
+                        defaultAbis = ['arm64-v8a', 'x86_64']
+                    }
+                }
+                abiFilters(*defaultAbis)
             }
         }
     }

Tests/UnitTests/Android/app/src/main/cpp/JNI.cpp

@@ -1,5 +1,5 @@
 #include <jni.h>
-#include <Android/log.h>
+#include <android/log.h>
 #include <AndroidExtensions/Globals.h>
 #include <AndroidExtensions/JavaWrappers.h>
 #include <AndroidExtensions/StdoutLogger.h>
@@ -22,7 +22,7 @@ Java_com_jsruntimehost_unittests_Native_javaScriptTests(JNIEnv* env, jclass claz
     android::global::Initialize(javaVM, context);
 
     Babylon::DebugTrace::EnableDebugTrace(true);
-    Babylon::DebugTrace::SetTraceOutput([](const char* trace) { printf("%s\n", trace); fflush(stdout); });
+    Babylon::DebugTrace::SetTraceOutput([](const char* trace) { __android_log_print(ANDROID_LOG_INFO, "JsRuntimeHost", "%s", trace); });
 
     auto testResult = RunTests();
 

Tests/UnitTests/CMakeLists.txt

@@ -1,12 +1,15 @@
-set(SCRIPTS
-    "Scripts/symlink_target.js"
-    "dist/tests.js")
+set(STATIC_SCRIPT_SOURCES
+    "${CMAKE_CURRENT_SOURCE_DIR}/Scripts/symlink_target.js")
+
+set(GENERATED_SCRIPTS
+    "${JSRUNTIMEHOST_OUTPUT_DIR}/tests.js")
 
 set(TYPE_SCRIPTS
     "Scripts/tests.ts")
 
 set(SOURCES
     "Shared/Shared.cpp"
+    "CompatibilityTests.cpp"
     "Shared/Shared.h")
 
 if(APPLE)
@@ -22,7 +25,8 @@ if(APPLE)
             "${CMAKE_CURRENT_LIST_DIR}/iOS/Base.lproj/Main.storyboard")
 
         set_source_files_properties(
-            ${SCRIPTS}
+            ${STATIC_SCRIPT_SOURCES}
+            ${GENERATED_SCRIPTS}
             ${TYPE_SCRIPTS}
             PROPERTIES MACOSX_PACKAGE_LOCATION "Scripts")
     else()
@@ -37,7 +41,7 @@ elseif(UNIX AND NOT ANDROID)
         Linux/App.cpp)
 endif()
 
-add_executable(UnitTests ${SOURCES} ${SCRIPTS} ${TYPE_SCRIPTS})
+add_executable(UnitTests ${SOURCES} ${STATIC_SCRIPT_SOURCES} ${GENERATED_SCRIPTS} ${TYPE_SCRIPTS})
 target_compile_definitions(UnitTests PRIVATE JSRUNTIMEHOST_PLATFORM="${JSRUNTIMEHOST_PLATFORM}")
 
 target_link_libraries(UnitTests
@@ -69,13 +73,22 @@ if(IOS)
         XCODE_ATTRIBUTE_IPHONEOS_DEPLOYMENT_TARGET ${DEPLOYMENT_TARGET}
         XCODE_ATTRIBUTE_PRODUCT_BUNDLE_IDENTIFIER "com.jsruntimehost.unittests")
 else()
-    foreach(SCRIPT ${SCRIPTS})
+    foreach(SCRIPT ${STATIC_SCRIPT_SOURCES})
+        get_filename_component(SCRIPT_NAME "${SCRIPT}" NAME)
+        add_custom_command(
+            OUTPUT "${CMAKE_CFG_INTDIR}/Scripts/${SCRIPT_NAME}"
+            COMMAND "${CMAKE_COMMAND}" -E copy "${SCRIPT}" "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/Scripts/${SCRIPT_NAME}"
+            COMMENT "Copying ${SCRIPT_NAME}"
+            MAIN_DEPENDENCY "${SCRIPT}")
+    endforeach()
+
+    foreach(SCRIPT ${GENERATED_SCRIPTS})
         get_filename_component(SCRIPT_NAME "${SCRIPT}" NAME)
         add_custom_command(
             OUTPUT "${CMAKE_CFG_INTDIR}/Scripts/${SCRIPT_NAME}"
-            COMMAND "${CMAKE_COMMAND}" -E copy "${CMAKE_CURRENT_SOURCE_DIR}/${SCRIPT}" "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/Scripts/${SCRIPT_NAME}"
+            COMMAND "${CMAKE_COMMAND}" -E copy "${SCRIPT}" "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/Scripts/${SCRIPT_NAME}"
             COMMENT "Copying ${SCRIPT_NAME}"
-            MAIN_DEPENDENCY "${CMAKE_CURRENT_SOURCE_DIR}/${SCRIPT}")
+            MAIN_DEPENDENCY "${SCRIPT}")
     endforeach()
 
     add_custom_command(TARGET UnitTests POST_BUILD
@@ -86,5 +99,5 @@ endif()
 
 set_property(TARGET UnitTests PROPERTY FOLDER Tests)
 
-source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${SOURCES} ${SCRIPTS})
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${SOURCES} ${STATIC_SCRIPT_SOURCES})
 source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/Scripts PREFIX scripts FILES ${TYPE_SCRIPTS})