@novacraft-engineering/pulsar-code-push 1.5.1 → 1.5.3

package/CodePush.js

@@ -4,6 +4,7 @@ import requestFetchAdapter from "./request-fetch-adapter";
 import { AppState, Platform } from "react-native";
 import log from "./logging";
 import hoistStatics from 'hoist-non-react-statics';
+import { setTargetingInfo } from "./targeting";
 
 let NativeCodePush = require("react-native").NativeModules.CodePush;
 const PackageMixins = require("./package-mixins")(NativeCodePush);
@@ -618,6 +619,7 @@ if (NativeCodePush) {
     notifyAppReady: notifyApplicationReady,
     notifyApplicationReady,
     restartApp,
+    setTargetingInfo,
     setUpTestDependencies,
     sync,
     disallowRestart: NativeCodePush.disallow,

package/android/codepush.gradle

@@ -69,9 +69,9 @@ gradle.projectsEvaluated {
 
         def nodeModulesPath;
         if (project.hasProperty('nodeModulesPath')) {
-            nodeModulesPath = "${project.nodeModulesPath}/@revopush/react-native-code-push"
+            nodeModulesPath = "${project.nodeModulesPath}/@novacraft-engineering/pulsar-code-push"
         } else {
-            nodeModulesPath = findNodeModulePath(projectDir, "@revopush/react-native-code-push")
+            nodeModulesPath = findNodeModulePath(projectDir, "@novacraft-engineering/pulsar-code-push")
         }
 
         def targetName = variant.name.capitalize()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@novacraft-engineering/pulsar-code-push",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "description": "Pulsar OTA client for React Native \u2014 over-the-air JavaScript updates. A CodePush-compatible client (RevoPush lineage) pointed at Pulsar.",
   "main": "CodePush.js",
   "typings": "typings/react-native-code-push.d.ts",
@@ -26,6 +26,7 @@
   "files": [
     "CodePush.js",
     "AlertAdapter.js",
+    "targeting.js",
     "logging.js",
     "package-mixins.js",
     "request-fetch-adapter.js",
@@ -33,6 +34,7 @@
     "CodePush.podspec",
     "android",
     "ios",
+    "scripts",
     "typings",
     "README.md",
     "LICENSE"

package/request-fetch-adapter.js

@@ -1,4 +1,5 @@
 const packageJson = require("./package.json");
+const { getTargetingInfo } = require("./targeting");
 
 module.exports = {
   async request(verb, url, requestBody, callback) {
@@ -7,6 +8,16 @@ module.exports = {
       requestBody = null;
     }
 
+    // Scope the update-check to a specific device model / user id when the host app has set them.
+    // Only the GET update_check request is augmented; report_status is untouched.
+    if (verb === 0 && url.indexOf("update_check") !== -1) {
+      const { userId, deviceModel } = getTargetingInfo();
+      const extra = [];
+      if (deviceModel) extra.push("device_model=" + encodeURIComponent(deviceModel));
+      if (userId) extra.push("user_id=" + encodeURIComponent(userId));
+      if (extra.length) url += (url.indexOf("?") === -1 ? "?" : "&") + extra.join("&");
+    }
+
     const headers = {
       "Accept": "application/json",
       "Content-Type": "application/json",

package/scripts/generateBundledResourcesHash.js

@@ -0,0 +1,165 @@
+/*
+ * This script generates a hash of all the React Native bundled assets and writes it into
+ * into the APK. The hash in "updateCheck" requests to prevent downloading an identical
+ * update to the one already present in the binary.
+ *
+ * It first creates a snapshot of the contents in the resource directory by creating
+ * a map with the modified time of all the files in the directory. It then compares this
+ * snapshot with the one saved earlier in "recordFilesBeforeBundleCommand.js" to figure
+ * out which files were generated by the "react-native bundle" command. It then computes
+ * the hash for each file to generate a manifest, and then computes a hash over the entire
+ * manifest to generate the final hash, which is saved to the APK's assets directory.
+ */
+
+var crypto = require("crypto");
+var fs = require("fs");
+var path = require("path");
+
+var getFilesInFolder = require("./getFilesInFolder");
+
+const CODE_PUSH_FOLDER_PREFIX = "CodePush";
+const CODE_PUSH_HASH_FILE_NAME = "CodePushHash";
+const CODE_PUSH_METADATA_FILE_NAME = "CodePushMetadata";
+const CODE_PUSH_PACKAGE_HASH = "packageHash"
+const CODE_PUSH_BUNDLE_HASH = "bundleHash"
+const CODE_PUSH_ASSET_HASH = "assetHash"
+const MANIFEST = "manifest"
+const CODE_PUSH_HASH_OLD_FILE_NAME = "CodePushHash.json";
+const HASH_ALGORITHM = "sha256";
+
+var resourcesDir = process.argv[2];
+var jsBundleFilePath = process.argv[3];
+var assetsDir = process.argv[4];
+var tempFileName = process.argv[5];
+
+var oldFileToModifiedTimeMap = {};
+var tempFileLocalPath = null;
+if (tempFileName) {
+  tempFileLocalPath = path.join(require("os").tmpdir(), tempFileName);
+  oldFileToModifiedTimeMap = require(tempFileLocalPath);
+}
+var resourceFiles = [];
+
+getFilesInFolder(resourcesDir, resourceFiles);
+
+function getBundleResourceEntries(resourcesDir, assetsDir) {
+  const resourceFiles = [];
+  const assetFiles = [];
+  getFilesInFolder(resourcesDir, resourceFiles);
+  getFilesInFolder(assetsDir, assetFiles);
+  let resourceFilesRelative = resourceFiles.map((it) => path.relative(resourcesDir, it.path));
+  let assetsFilesRelative = assetFiles.map((it) => path.relative(assetsDir, it.path));
+
+  const normalizePath = (it) => path.join(CODE_PUSH_FOLDER_PREFIX, it).replace(/\\/g, "/")
+  return {
+    resources: Object.fromEntries(resourceFilesRelative.map((it) => [normalizePath(it), path.parse(it).name])),
+    assets: Object.fromEntries(assetsFilesRelative.map((it) => [it.replace(/\\/g, "/"), normalizePath(it)]))
+  }
+}
+
+var newFileToModifiedTimeMap = {};
+
+resourceFiles.forEach(function (resourceFile) {
+  newFileToModifiedTimeMap[resourceFile.path.substring(resourcesDir.length)] = resourceFile.mtime;
+});
+
+var bundleGeneratedAssetFiles = [];
+
+for (var newFilePath in newFileToModifiedTimeMap) {
+  if (!oldFileToModifiedTimeMap[newFilePath] || oldFileToModifiedTimeMap[newFilePath] < newFileToModifiedTimeMap[newFilePath].getTime()) {
+    bundleGeneratedAssetFiles.push(newFilePath);
+  }
+}
+
+var manifest = [];
+
+if (bundleGeneratedAssetFiles.length) {
+  bundleGeneratedAssetFiles.forEach(function (assetFile) {
+    // Generate hash for each asset file
+    addFileToManifest(resourcesDir, assetFile, manifest, function () {
+      if (manifest.length === bundleGeneratedAssetFiles.length) {
+        addJsBundleAndMetaToManifest();
+      }
+    });
+  });
+} else {
+  addJsBundleAndMetaToManifest();
+}
+
+function addJsBundleAndMetaToManifest() {
+  addFileToManifest(path.dirname(jsBundleFilePath), path.basename(jsBundleFilePath), manifest, function (jsBundleFileHash) {
+    var jsBundleMetaFilePath = jsBundleFilePath + ".meta";
+    addFileToManifest(path.dirname(jsBundleMetaFilePath), path.basename(jsBundleMetaFilePath), manifest, function () {
+      manifest = manifest.sort();
+      const finalHash = crypto.createHash(HASH_ALGORITHM)
+        .update(JSON.stringify(manifest))
+        .digest("hex");
+
+      const bundleHashDada = path.join(CODE_PUSH_FOLDER_PREFIX, path.basename(jsBundleFilePath)).replace(/\\/g, "/") + ":" + jsBundleFileHash;
+      const bundleHash = crypto.createHash(HASH_ALGORITHM)
+        .update(JSON.stringify([bundleHashDada]))
+        .digest("hex");
+
+      const assetHash = crypto.createHash(HASH_ALGORITHM)
+        .update(JSON.stringify([...manifest].filter(it => it !== bundleHashDada).sort()))
+        .digest("hex");
+
+      const manifestMetadata = {
+        [CODE_PUSH_PACKAGE_HASH]: finalHash,
+        [CODE_PUSH_BUNDLE_HASH]: bundleHash,
+        [CODE_PUSH_ASSET_HASH]: assetHash,
+        ...(getBundleResourceEntries(resourcesDir, assetsDir)),
+        [MANIFEST]: manifest
+      }
+
+      console.log(finalHash);
+
+      fs.writeFileSync(path.join(assetsDir, CODE_PUSH_HASH_FILE_NAME), finalHash);
+      fs.writeFileSync(path.join(assetsDir, CODE_PUSH_METADATA_FILE_NAME), JSON.stringify(manifestMetadata));
+
+      // "CodePushHash.json" file name breaks flow type checking.
+      // To fix the issue we need to delete "CodePushHash.json" file and
+      // use "CodePushHash" file name instead to store the hash value.
+      // Relates to https://github.com/microsoft/react-native-code-push/issues/577
+      var oldSavedResourcesManifestPath = assetsDir + "/" + CODE_PUSH_HASH_OLD_FILE_NAME;
+      if (fs.existsSync(oldSavedResourcesManifestPath)) {
+        fs.unlinkSync(oldSavedResourcesManifestPath);
+      }
+    });
+  });
+}
+
+function addFileToManifest(folder, assetFile, manifest, done) {
+  var fullFilePath = path.join(folder, assetFile);
+  if (!fileExists(fullFilePath)) {
+    done(undefined);
+    return;
+  }
+
+  var readStream = fs.createReadStream(path.join(folder, assetFile));
+  var hashStream = crypto.createHash(HASH_ALGORITHM);
+
+  readStream.pipe(hashStream)
+    .on("error", function (error) {
+      throw error;
+    })
+    .on("finish", function () {
+      hashStream.end();
+      var buffer = hashStream.read();
+      var fileHash = buffer.toString("hex");
+      manifest.push(path.join(CODE_PUSH_FOLDER_PREFIX, assetFile).replace(/\\/g, "/") + ":" + fileHash);
+      done(fileHash);
+    });
+}
+
+function fileExists(file) {
+  try {
+    return fs.statSync(file).isFile();
+  } catch (e) {
+    return false;
+  }
+}
+
+if (tempFileLocalPath) {
+  fs.unlinkSync(tempFileLocalPath);
+}

package/scripts/getFilesInFolder.js

@@ -0,0 +1,19 @@
+var fs = require("fs");
+var path = require("path");
+
+// Utility function that collects the stats of every file in a directory
+// as well as in its subdirectories.
+function getFilesInFolder(folderName, fileList) {
+    var folderFiles = fs.readdirSync(folderName);
+    folderFiles.forEach(function(file) {
+        var fileStats = fs.statSync(path.join(folderName, file));
+        if (fileStats.isDirectory()) {
+            getFilesInFolder(path.join(folderName, file), fileList);
+        } else {
+            fileStats.path = path.join(folderName, file);
+            fileList.push(fileStats);
+        }
+    });
+}
+
+module.exports = getFilesInFolder;

package/scripts/recordFilesBeforeBundleCommand.js

@@ -0,0 +1,41 @@
+/*
+ * This script creates a snapshot of the contents in the resource directory
+ * by creating a map with the modified time of all the files in the directory
+ * and saving it to a temp file. This snapshot is later referenced in 
+ * "generatePackageHash.js" to figure out which files have changed or were
+ * newly generated by the "react-native bundle" command.
+ */
+
+var fs = require("fs");
+var path = require("path");
+
+var getFilesInFolder = require("./getFilesInFolder");
+
+
+var resourcesDir = process.argv[2];
+var tempFileName = process.argv[3];
+
+var tempFileLocalPath = path.join(require("os").tmpdir(), tempFileName);
+var resourceFiles = [];
+
+try {
+    getFilesInFolder(resourcesDir, resourceFiles);
+} catch(error) {
+    var targetPathNotFoundExceptionMessage = "\nResources directory path does not exist.\n";
+    targetPathNotFoundExceptionMessage += "Unable to find '" + resourcesDir;
+    targetPathNotFoundExceptionMessage += "' directory. Please check version of Android Plugin for Gradle.";
+    error.message += targetPathNotFoundExceptionMessage;
+    throw error;
+}
+
+var fileToModifiedTimeMap = {};
+
+resourceFiles.forEach(function(resourceFile) {
+    fileToModifiedTimeMap[resourceFile.path.substring(resourcesDir.length)] = resourceFile.mtime.getTime();
+});
+
+fs.writeFile(tempFileLocalPath, JSON.stringify(fileToModifiedTimeMap), function(err) {
+    if (err) {
+        throw err;
+    }
+}); 

package/targeting.js

@@ -0,0 +1,17 @@
+// Optional targeting identifiers the host app can set (e.g. at login). They are appended to the
+// update-check request so the server can scope a release to specific device models / user ids.
+// Shared singleton: the fetch adapter reads it, CodePush.setTargetingInfo writes it.
+let info = { userId: null, deviceModel: null };
+
+function setTargetingInfo(next) {
+  if (!next) return info;
+  if (next.userId !== undefined) info.userId = next.userId == null ? null : String(next.userId);
+  if (next.deviceModel !== undefined) info.deviceModel = next.deviceModel == null ? null : String(next.deviceModel);
+  return info;
+}
+
+function getTargetingInfo() {
+  return info;
+}
+
+module.exports = { setTargetingInfo, getTargetingInfo };