Script for building JavaScriptCore for Android (for React Native but not only)
Clone or download
Permalink
Failed to load latest commit information.
.github added issue template Jun 5, 2018
lib update gradle Sep 26, 2018
measure update measure README Oct 10, 2018
patches update printVersion patch Oct 9, 2018
scripts merge from master Oct 9, 2018
.gitignore no package locks, they do not work May 29, 2018
Dockerfile Add circle ci (#41) Jun 19, 2018
LICENSE Update license. Jun 13, 2017
README.md update README Oct 9, 2018
package.json 225067.0.0 Oct 9, 2018

README.md

npm version Build Status

JSC build scripts for Android

The aim of this project is to provide maintainable build scripts for the JavaScriptCore JavaScript engine and allow the React Native project to incorporate up-to-date releases of JSC into the framework on Android.

This project is based on facebook/android-jsc but instead of rewriting JSC's build scripts into BUCK files, it relies on CMake build scripts maintained in a GTK branch of WebKit maintained by the WebKitGTK team (great work btw!). Thanks to that, with just a small amount of work we should be able to build not only current but also future releases of JSC. An obvious benefit for everyone using React Native is that this will allow us to update JSC for React Native on Android much more often than before (note that facebook/android-jsc uses JSC version from Nov 2014), which is especially helpful since React Native on iOS uses the built-in copy of JSC that is updated with each major iOS release (see this as a reference).

Requirements

  • Homebrew (https://brew.sh/)
  • GNU coreutils brew install coreutils
  • Node brew install node
  • Java 8: brew tap caskroom/versions && brew cask install java8
  • Android SDK: brew cask install android-sdk
    • Run sdkmanager --list and install all platforms, tools, cmake, ndk (android images are not needed)
    • Set $ANDROID_HOME to the correct path (in ~/.bashrc or similar)
    • Set export ANDROID_NDK=$ANDROID_HOME/ndk-bundle
    • Set export PATH=$PATH:$ANDROID_HOME/platform-tools:$ANDROID_HOME/tools/bin
  • Make sure you have Ruby (>2.3), Python (>2.7), Git, SVN, gperf

Build instructions

  1. Clone this repo
  2. npm run clean will clean everything (artifacts, downloaded sources)
  3. Update the config section under package.json to the desired build configuration
  4. Update patches if needed (don't forget to update the printVersion patch in jsc.patch)
  5. npm run download: downloads all needed sources
  6. npm run start: builds jsc (this might take some time...)

The zipfile containing the android-jsc AAR will be available at /dist. The library is packaged as a local Maven repository containing AAR files that include the binaries.

Distribution

JSC library built using this project is distributed over npm: npm/jsc-android. The library is packaged as a local Maven repository containing AAR files that include the binaries. Please refer to the section below in order to learn how your app can consume this format.

On load, JSC prints the version out to logcat, under "JavaScriptCore.Version" tag.

How to use it with my React Native app

Follow steps below in order for your React Native app to use new version of JSC VM on android:

  1. Add jsc-android to the "dependencies" section in your package.json:
dependencies {
+  "jsc-android": "224109.x.x",

then run npm install or yarn (depending which npm client you use) in order for the new dependency to be installed in node_modules

  1. Modify android/build.gradle file to add new local maven repository packaged in the jsc-android package to the search path:
allprojects {
    repositories {
        mavenLocal()
        jcenter()
        maven {
            // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
            url "$rootDir/../node_modules/react-native/android"
        }
+       maven {
+           // Local Maven repo containing AARs with JSC library built for Android
+           url "$rootDir/../node_modules/jsc-android/dist"
+       }
    }
}
  1. Update your app's build.gradle file located in android/app/build.gradle to force app builds to use new version of the JSC library as opposed to the version specified in react-native gradle module as a dependency:
}

+configurations.all {
+    resolutionStrategy {
+        force 'org.webkit:android-jsc:r224109'
+    }
+}

dependencies {
    compile fileTree(dir: "libs", include: ["*.jar"])
  1. Make sure your app's build.gradle uses a minimum sdk version of 21
defaultConfig {
    applicationId "com.myApp"
-    minSdkVersion 16
+    minSdkVersion 21
    targetSdkVersion 22
    versionCode 1
  1. You're done, rebuild your app and enjoy updated version of JSC on android!

International variant

International variant includes ICU i18n library and necessary data allowing to use e.g. Date.toLocaleString and String.localeCompare that give correct results when using with locales other than en-US. Note that this variant is about 6MiB larger per architecture than default.

To use this variant instead replace the third installation step with:

+configurations.all {
+    resolutionStrategy {
+        eachDependency { DependencyResolveDetails details ->
+            if (details.requested.name == 'android-jsc') {
+                details.useTarget group: details.requested.group, name: 'android-jsc-intl', version: 'r224109'
+            }
+        }
+    }
+}

Testing

See Measurements page that contains synthetic perf test results for the most notable versions of JSC we have tried.

Resources

Credits

Check the list of contributors here. This project is supported by:

expo Expo.io

swm Software Mansion

wix Wix