feat: support useLibs though env.compileSnapshot and calculate the NDK path internally

Author: DimitarTachev

androidProjectHelpers.js

@@ -47,6 +47,19 @@ const getMksnapshotParams = (projectDir) => {
     }
 };
 
+const getRuntimeNdkRevision = (projectDir) => {
+    try {
+        const androidSettingsJSON = getAndroidSettingsJson(projectDir);
+        if (androidSettingsJSON !== null) {
+            return androidSettingsJSON.ndkRevision;
+        } else {
+            return null;
+        }
+    } catch (e) {
+        return null;
+    }
+};
+
 const getAndroidSettingsJson = projectDir => {
     const androidSettingsJsonPath = resolve(projectDir, PLATFORMS_ANDROID, "settings.json");
     if (existsSync(androidSettingsJsonPath)) {
@@ -62,5 +75,6 @@ module.exports = {
     ANDROID_CONFIGURATIONS_PATH,
     getAndroidRuntimeVersion,
     getAndroidV8Version,
-    getMksnapshotParams
+    getMksnapshotParams,
+    getRuntimeNdkRevision
 };

lib/utils.js

@@ -15,8 +15,15 @@ function isWinOS() {
     return os.type() === "Windows_NT";
 }
 
+function warn(message) {
+    if (message) {
+        console.log(`\x1B[33;1m${message}\x1B[0m`);
+    }
+}
+
 module.exports = {
     shouldSnapshot,
     convertToUnixPath,
-    isWinOS
+    isWinOS,
+    warn
 };

package.json

@@ -58,6 +58,7 @@
     "minimatch": "3.0.4",
     "nativescript-hook": "0.2.4",
     "nativescript-worker-loader": "~0.9.0",
+    "properties-reader": "0.3.1",
     "proxy-lib": "0.4.0",
     "raw-loader": "~0.5.1",
     "request": "2.88.0",

snapshot/android/project-snapshot-generator.js

@@ -16,6 +16,7 @@ const {
     ANDROID_CONFIGURATIONS_PATH,
     getAndroidRuntimeVersion,
     getAndroidV8Version,
+    getRuntimeNdkRevision,
     getMksnapshotParams
 } = require("../../androidProjectHelpers");
 
@@ -155,6 +156,7 @@ const getV8VersionsMap = runtimeVersion =>
         }
     });
 
+// TODO: remove?
 ProjectSnapshotGenerator.prototype.getV8Version = function (generationOptions) {
     return new Promise((resolve, reject) => {
         const maybeV8Version = generationOptions.v8Version;
@@ -229,6 +231,7 @@ ProjectSnapshotGenerator.prototype.generate = function (generationOptions) {
     let shouldRethrow = false;
 
     const mksnapshotParams = getMksnapshotParams(this.options.projectRoot);
+    const recommendedAndroidNdkRevision = getRuntimeNdkRevision(this.options.projectRoot);
 
     return this.getV8Version(generationOptions).then(v8Version => {
         shouldRethrow = true;
@@ -254,7 +257,8 @@ ProjectSnapshotGenerator.prototype.generate = function (generationOptions) {
             inputFiles: generationOptions.inputFiles || [join(this.options.projectRoot, "__snapshot.js")],
             androidNdkPath,
             mksnapshotParams: mksnapshotParams,
-            snapshotInDocker: generationOptions.snapshotInDocker
+            snapshotInDocker: generationOptions.snapshotInDocker,
+            recommendedAndroidNdkRevision
         };
 
         return generator.generate(options).then(() => {

snapshot/android/snapshot-generator.js

@@ -1,8 +1,8 @@
 const fs = require("fs");
 const { dirname, relative, join, EOL } = require("path");
 const child_process = require("child_process");
-const { convertToUnixPath } = require("../../lib/utils");
-
+const { convertToUnixPath, warn } = require("../../lib/utils");
+const PropertiesReader = require('properties-reader');
 const shelljs = require("shelljs");
 
 const { createDirectory, downloadFile, getHostOS, getHostOSArch, CONSTANTS, has32BitArch, isMacOSCatalinaOrHigher, isSubPath } = require("./utils");
@@ -192,8 +192,9 @@ SnapshotGenerator.prototype.setupDocker = function () {
     child_process.execSync(`docker pull ${SNAPSHOTS_DOCKER_IMAGE}`);
 }
 
-SnapshotGenerator.prototype.buildSnapshotLibs = function (androidNdkBuildPath, targetArchs) {
+SnapshotGenerator.prototype.buildSnapshotLibs = function (androidNdkPath, recommendedAndroidNdkRevision, targetArchs) {
     // Compile *.c files to produce *.so libraries with ndk-build tool
+    const androidNdkBuildPath = this.getAndroidNdkBuildPath(androidNdkPath, recommendedAndroidNdkRevision);
     const ndkBuildPath = join(this.buildPath, "ndk-build");
     const androidArchs = targetArchs.map(arch => this.convertToAndroidArchName(arch));
     console.log("Building native libraries for " + androidArchs.join());
@@ -207,6 +208,54 @@ SnapshotGenerator.prototype.buildSnapshotLibs = function (androidNdkBuildPath, t
     return join(ndkBuildPath, "libs");
 }
 
+SnapshotGenerator.prototype.getAndroidNdkBuildPath = function (androidNdkPath, recommendedAndroidNdkRevision) {
+    const ndkBuildExecutableName = "ndk-build";
+    // fallback for Android Runtime < 6.2.0 with the 6.1.0 value
+    recommendedAndroidNdkRevision = recommendedAndroidNdkRevision || "20.0.5594570";
+    let androidNdkBuildPath = "";
+    if (androidNdkPath) {
+        // specified by the user
+        const localNdkRevision = this.getAndroidNdkRevision(androidNdkPath);
+        androidNdkBuildPath = join(androidNdkPath, ndkBuildExecutableName);
+        if (!fs.existsSync(androidNdkBuildPath)) {
+            throw new Error(`The provided Android NDK path does not contain ${ndkBuildExecutableName} executable.`);
+        } else if (localNdkRevision !== recommendedAndroidNdkRevision) {
+            warn(`The provided Android NDK is v${localNdkRevision} while the recommended one is v${recommendedAndroidNdkRevision}`);
+        }
+    } else {
+        // available globally
+        let hasAndroidNdkInPath = true;
+        androidNdkBuildPath = ndkBuildExecutableName;
+        try {
+            child_process.execSync(`${androidNdkBuildPath} --version`);
+            console.log(`Cannot determine the version of the global Android NDK. The recommended versions is v${recommendedAndroidNdkRevision}`);
+        } catch (_) {
+            hasAndroidNdkInPath = false;
+        }
+
+        if (!hasAndroidNdkInPath) {
+            // installed in ANDROID_HOME
+            const androidHome = process.env.ANDROID_HOME;
+            androidNdkBuildPath = join(androidHome, "ndk", recommendedAndroidNdkRevision, ndkBuildExecutableName);
+            if (!fs.existsSync(androidNdkBuildPath)) {
+                throw new Error(`Android NDK v${recommendedAndroidNdkRevision} is not installed. You can find installation instructions in this article: https://developer.android.com/studio/projects/install-ndk#specific-version`);
+            }
+        }
+    }
+
+    return androidNdkBuildPath;
+}
+
+SnapshotGenerator.prototype.getAndroidNdkRevision = function (androidNdkPath) {
+    const ndkPropertiesFile = join(androidNdkPath, "source.properties");
+    if (fs.existsSync(ndkPropertiesFile)) {
+        const properties = PropertiesReader(ndkPropertiesFile);
+        return properties.get("Pkg.Revision");
+    } else {
+        return null;
+    }
+}
+
 SnapshotGenerator.prototype.buildIncludeGradle = function () {
     shelljs.cp(INCLUDE_GRADLE_PATH, join(this.buildPath, "include.gradle"));
 }
@@ -236,8 +285,7 @@ SnapshotGenerator.prototype.generate = function (options) {
     ).then(() => {
         this.buildIncludeGradle();
         if (options.useLibs) {
-            const androidNdkBuildPath = options.androidNdkPath ? join(options.androidNdkPath, "ndk-build") : "ndk-build";
-            this.buildSnapshotLibs(androidNdkBuildPath, options.targetArchs);
+            this.buildSnapshotLibs(options.androidNdkPath, options.recommendedAndroidNdkRevision, options.targetArchs);
         }
         return this.buildPath;
     });

templates/webpack.angular.js

@@ -52,9 +52,11 @@ module.exports = env => {
         unitTesting, // --env.unitTesting
         verbose, // --env.verbose
         snapshotInDocker, // --env.snapshotInDocker
-        skipSnapshotTools // --env.skipSnapshotTools
+        skipSnapshotTools, // --env.skipSnapshotTools
+        compileSnapshot // --env.compileSnapshot
     } = env;
 
+    const useLibs = compileSnapshot;
     const isAnySourceMapEnabled = !!sourceMap || !!hiddenSourceMap;
     const externals = nsWebpack.getConvertedExternals(env.externals);
     const appFullPath = resolve(projectRoot, appPath);
@@ -315,7 +317,8 @@ module.exports = env => {
             projectRoot,
             webpackConfig: config,
             snapshotInDocker,
-            skipSnapshotTools
+            skipSnapshotTools,
+            useLibs
         }));
     }
 

templates/webpack.javascript.js

@@ -45,9 +45,11 @@ module.exports = env => {
         unitTesting, // --env.unitTesting,
         verbose, // --env.verbose
         snapshotInDocker, // --env.snapshotInDocker
-        skipSnapshotTools // --env.skipSnapshotTools
+        skipSnapshotTools, // --env.skipSnapshotTools
+        compileSnapshot // --env.compileSnapshot
     } = env;
 
+    const useLibs = compileSnapshot;
     const isAnySourceMapEnabled = !!sourceMap || !!hiddenSourceMap;
     const externals = nsWebpack.getConvertedExternals(env.externals);
     const appFullPath = resolve(projectRoot, appPath);
@@ -253,7 +255,8 @@ module.exports = env => {
             projectRoot,
             webpackConfig: config,
             snapshotInDocker,
-            skipSnapshotTools
+            skipSnapshotTools,
+            useLibs
         }));
     }
 

templates/webpack.typescript.js

@@ -47,8 +47,11 @@ module.exports = env => {
         unitTesting, // --env.unitTesting,
         verbose, // --env.verbose
         snapshotInDocker, // --env.snapshotInDocker
-        skipSnapshotTools // --env.skipSnapshotTools
+        skipSnapshotTools, // --env.skipSnapshotTools
+        compileSnapshot // --env.compileSnapshot
     } = env;
+
+    const useLibs = compileSnapshot;
     const isAnySourceMapEnabled = !!sourceMap || !!hiddenSourceMap;
     const externals = nsWebpack.getConvertedExternals(env.externals);
 
@@ -285,7 +288,8 @@ module.exports = env => {
             projectRoot,
             webpackConfig: config,
             snapshotInDocker,
-            skipSnapshotTools
+            skipSnapshotTools,
+            useLibs
         }));
     }
 

templates/webpack.vue.js

@@ -48,9 +48,11 @@ module.exports = env => {
         unitTesting, // --env.unitTesting
         verbose, // --env.verbose
         snapshotInDocker, // --env.snapshotInDocker
-        skipSnapshotTools // --env.skipSnapshotTools
+        skipSnapshotTools, // --env.skipSnapshotTools
+        compileSnapshot // --env.compileSnapshot
     } = env;
 
+    const useLibs = compileSnapshot;
     const isAnySourceMapEnabled = !!sourceMap || !!hiddenSourceMap;
     const externals = nsWebpack.getConvertedExternals(env.externals);
 
@@ -300,7 +302,8 @@ module.exports = env => {
             projectRoot,
             webpackConfig: config,
             snapshotInDocker,
-            skipSnapshotTools
+            skipSnapshotTools,
+            useLibs
         }));
     }