@bravemobile/react-native-code-push 12.0.1 → 12.1.0

package/cli/functions/runHermesEmitBinaryCommand.ts

@@ -0,0 +1,186 @@
+/**
+ * code based on appcenter-cli
+ */
+
+import childProcess from "child_process";
+import fs from "fs";
+import path from "path";
+import shell from "shelljs";
+
+/**
+ * Run Hermes compile CLI command
+ *
+ * @param bundleName {string} JS bundle file name
+ * @param outputPath {string} Path to output .hbc file
+ * @param sourcemapOutput {string} Path to output sourcemap file (Warning: if sourcemapOutput points to the outputPath, the sourcemap will be included in the CodePush bundle and increase the deployment size)
+ * @param extraHermesFlags {string[]} Additional options to pass to `hermesc` command
+ * @return {Promise<void>}
+ */
+export async function runHermesEmitBinaryCommand(
+    bundleName: string,
+    outputPath: string,
+    sourcemapOutput: string,
+    extraHermesFlags: string[] = [],
+): Promise<void> {
+    const hermesArgs: string[] = [
+        '-emit-binary',
+        '-out',
+        path.join(outputPath, bundleName + '.hbc'),
+        path.join(outputPath, bundleName),
+        ...extraHermesFlags,
+    ];
+    if (sourcemapOutput) {
+        hermesArgs.push('-output-source-map');
+    }
+
+    console.log('Converting JS bundle to byte code via Hermes, running command:\n');
+
+    return new Promise<void>((resolve, reject) => {
+        try {
+            const hermesCommand = getHermesCommand();
+
+            const disableAllWarningsArg = '-w';
+            shell.exec(`${hermesCommand} ${hermesArgs.join(' ')} ${disableAllWarningsArg}`);
+
+            // Copy HBC bundle to overwrite JS bundle
+            const source = path.join(outputPath, bundleName + '.hbc');
+            const destination = path.join(outputPath, bundleName);
+            shell.cp(source, destination);
+            shell.rm(source);
+            resolve();
+        } catch (e) {
+            reject(e);
+        }
+    }).then(() => {
+        if (!sourcemapOutput) {
+            // skip source map compose if source map is not enabled
+            return;
+        }
+
+        // compose-source-maps.js file path
+        const composeSourceMapsPath = getComposeSourceMapsPath();
+        if (composeSourceMapsPath === null) {
+            throw new Error('react-native compose-source-maps.js scripts is not found');
+        }
+
+        const jsCompilerSourceMapFile = path.join(outputPath, bundleName + '.hbc' + '.map');
+        if (!fs.existsSync(jsCompilerSourceMapFile)) {
+            throw new Error(`sourcemap file ${jsCompilerSourceMapFile} is not found`);
+        }
+
+        return new Promise((resolve, reject) => {
+            const composeSourceMapsArgs = [
+                composeSourceMapsPath,
+                sourcemapOutput,
+                jsCompilerSourceMapFile,
+                '-o',
+                sourcemapOutput,
+            ];
+            const composeSourceMapsProcess = childProcess.spawn('node', composeSourceMapsArgs);
+            console.log(`${composeSourceMapsPath} ${composeSourceMapsArgs.join(' ')}`);
+
+            composeSourceMapsProcess.stdout.on('data', (data) => {
+                console.log(data.toString().trim());
+            });
+
+            composeSourceMapsProcess.stderr.on('data', (data) => {
+                console.error(data.toString().trim());
+            });
+
+            composeSourceMapsProcess.on('close', (exitCode, signal) => {
+                if (exitCode !== 0) {
+                    reject(new Error(`"compose-source-maps" command failed (exitCode=${exitCode}, signal=${signal}).`));
+                }
+
+                // Delete the HBC sourceMap, otherwise it will be included in 'code-push' bundle as well
+                fs.unlink(jsCompilerSourceMapFile, (err) => {
+                    if (err != null) {
+                        console.error(err);
+                        reject(err);
+                    }
+
+                    resolve();
+                });
+            });
+        });
+    });
+}
+
+function getHermesCommand(): string {
+    const fileExists = (file: string): boolean => {
+        try {
+            return fs.statSync(file).isFile();
+        } catch (e) {
+            return false;
+        }
+    };
+    // Hermes is bundled with react-native since 0.69
+    const bundledHermesEngine = path.join(
+        getReactNativePackagePath(),
+        'sdks',
+        'hermesc',
+        getHermesOSBin(),
+        getHermesOSExe(),
+    );
+    if (fileExists(bundledHermesEngine)) {
+        return bundledHermesEngine;
+    }
+    throw new Error('Hermes engine binary not found. Please upgrade to react-native 0.69 or later');
+}
+
+function getHermesOSBin() {
+    switch (process.platform) {
+        case 'win32':
+            return 'win64-bin';
+        case 'darwin':
+            return 'osx-bin';
+        case 'freebsd':
+        case 'linux':
+        case 'sunos':
+        default:
+            return 'linux64-bin';
+    }
+}
+
+function getHermesOSExe(): string {
+    const hermesExecutableName = 'hermesc';
+    switch (process.platform) {
+        case 'win32':
+            return hermesExecutableName + '.exe';
+        default:
+            return hermesExecutableName;
+    }
+}
+
+function getComposeSourceMapsPath(): string | null {
+    // detect if compose-source-maps.js script exists
+    const composeSourceMaps = path.join(getReactNativePackagePath(), 'scripts', 'compose-source-maps.js');
+    if (fs.existsSync(composeSourceMaps)) {
+        return composeSourceMaps;
+    }
+    return null;
+}
+
+function getReactNativePackagePath(): string {
+    const result = childProcess.spawnSync('node', [
+        '--print',
+        "require.resolve('react-native/package.json')",
+    ]);
+    const packagePath = path.dirname(result.stdout.toString());
+    if (result.status === 0 && directoryExistsSync(packagePath)) {
+        return packagePath;
+    }
+
+    return path.join('node_modules', 'react-native');
+}
+
+function directoryExistsSync(dirname: string): boolean {
+    try {
+        return fs.statSync(dirname).isDirectory();
+    } catch (err: unknown) {
+        if ((err as any).code !== 'ENOENT') {
+            throw err;
+        }
+    }
+    return false;
+}

package/cli/functions/runReactNativeBundleCommand.ts

@@ -0,0 +1,51 @@
+/**
+ * code based on appcenter-cli
+ */
+
+import path from "path";
+import shell from "shelljs";
+
+/**
+ * Run `react-native bundle` CLI command
+ *
+ * @param bundleName {string} JS bundle file name
+ * @param entryFile {string} App code entry file name (default: index.ts)
+ * @param outputPath {string} Path to output JS bundle file and assets
+ * @param platform {string} Platform (ios | android)
+ * @param sourcemapOutput {string} Path to output sourcemap file (Warning: if sourcemapOutput points to the outputPath, the sourcemap will be included in the CodePush bundle and increase the deployment size)
+ * @param extraBundlerOptions {string[]} Additional options to pass to `react-native bundle` command
+ * @return {void}
+ */
+export function runReactNativeBundleCommand(
+    bundleName: string,
+    outputPath: string,
+    platform: string,
+    sourcemapOutput: string,
+    entryFile: string,
+    extraBundlerOptions: string[] = [],
+): void {
+    function getCliPath(): string {
+        return path.join('node_modules', '.bin', 'react-native');
+    }
+
+    const reactNativeBundleArgs: string[] = [
+        'bundle',
+        '--assets-dest',
+        outputPath,
+        '--bundle-output',
+        path.join(outputPath, bundleName),
+        '--dev',
+        'false',
+        '--entry-file',
+        entryFile,
+        '--platform',
+        platform,
+        '--sourcemap-output',
+        sourcemapOutput,
+        ...extraBundlerOptions,
+    ];
+
+    console.log('Running "react-native bundle" command:\n');
+
+    shell.exec(`${getCliPath()} ${reactNativeBundleArgs.join(' ')}`);
+}

package/cli/index.ts

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+
+import { program } from "commander";
+import shell from "shelljs";
+import { showLogo } from "./utils/showLogo.js";
+
+/**
+ * npx code-push bundle
+ */
+import "./commands/bundleCommand/index.js";
+
+/**
+ * npx code-push create-history
+ */
+import "./commands/createHistoryCommand/index.js";
+
+/**
+ * npx code-push update-history
+ */
+import "./commands/updateHistoryCommand/index.js";
+
+/**
+ * npx code-push release
+ */
+import "./commands/releaseCommand/index.js";
+
+/**
+ * npx code-push show-history
+ */
+import "./commands/showHistoryCommand/index.js";
+
+/**
+ * npx code-push init
+ */
+import "./commands/initCommand/index.js";
+
+shell.set("-e");
+shell.set("+v");
+
+program
+    .name("npx code-push")
+    .description("Command line interface for @bravemobile/react-native-code-push")
+    .version("1.0.0")
+    .action(() => {
+        showLogo();
+    });
+
+program.parse();

package/cli/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@bravemobile/code-push-cli",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "jest"
+  },
+  "dependencies": {
+    "commander": "^12.1.0",
+    "shelljs": "^0.10.0",
+    "xcode": "^3.0.1",
+    "yazl": "^3.3.1"
+  },
+  "peerDependencies": {
+    "ts-node": ">=10"
+  },
+  "peerDependenciesMeta": {
+    "ts-node": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "@types/yazl": "^3.3.0"
+  }
+}

package/cli/utils/{file-utils.js → file-utils.ts}

@@ -2,23 +2,13 @@
  * code based on appcenter-cli
  */
 
-const fs = require('fs');
+import fs from "fs";
 
-/**
- *
- * @param path {string}
- * @return {boolean}
- */
-function isDirectory(path) {
+export function isDirectory(path: string): boolean {
     return fs.statSync(path).isDirectory();
 }
 
-/**
- *
- * @param length {number}
- * @return {string}
- */
-function generateRandomFilename(length) {
+export function generateRandomFilename(length: number): string {
     let filename = '';
     const validChar = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
 
@@ -29,14 +19,7 @@ function generateRandomFilename(length) {
     return filename;
 }
 
-/**
- *
- * @param filePath {string}
- * @return {string}
- */
-function normalizePath(filePath) {
+export function normalizePath(filePath: string): string {
     //replace all backslashes coming from cli running on windows machines by slashes
     return filePath.replace(/\\/g, '/');
 }
-
-module.exports = { isDirectory, generateRandomFilename, normalizePath };

package/cli/utils/{fsUtils.js → fsUtils.ts}

@@ -1,17 +1,19 @@
-const fs = require("fs");
-const path = require("path");
+import fs from "fs";
+import path from "path";
+import { createRequire } from "module";
+import type { CliConfigInterface } from "../../typings/react-native-code-push.d.ts";
+
+const nodeRequire = createRequire(import.meta.url);
 
 /**
  * allows to require a config file with .ts extension
- * @param filePath {string}
- * @returns {*} FIXME type
  */
-function requireConfig(filePath) {
+function requireConfig(filePath: string): CliConfigInterface {
   const ext = path.extname(filePath);
 
   if (ext === '.ts') {
     try {
-      require('ts-node/register');
+      nodeRequire('ts-node/register');
     } catch {
       console.error('ts-node not found. Please install ts-node as a devDependency.');
       process.exit(1);
@@ -22,28 +24,19 @@ function requireConfig(filePath) {
     throw new Error(`Unsupported file extension: ${ext}`);
   }
 
-  return require(filePath);
+  return nodeRequire(filePath) as CliConfigInterface;
 }
 
-/**
- * @param startDir {string}
- * @param configFileName {string}
- * @returns {*|null} FIXME type
- */
-function findAndReadConfigFile(startDir, configFileName) {
+export function findAndReadConfigFile(startDir: string, configFileName: string): CliConfigInterface {
   let dir = startDir;
 
   while (dir !== path.parse(dir).root) {
     const configPath = path.join(dir, configFileName);
     if (fs.existsSync(configPath)) {
-      const config = requireConfig(configPath);
-      return config;
+      return requireConfig(configPath);
     }
     dir = path.dirname(dir);
   }
 
-  console.error(`${configFileName} not found.`);
-  return null;
+  throw new Error(`${configFileName} not found.`);
 }
-
-module.exports = { findAndReadConfigFile };

package/cli/utils/hash-utils.ts

@@ -0,0 +1,146 @@
+/**
+ * code based on appcenter-cli
+ */
+
+/**
+ * NOTE!!! This utility file is duplicated for use by the CodePush service (for server-driven hashing/
+ * integrity checks) and Management SDK (for end-to-end code signing), please keep them in sync.
+ */
+
+import crypto from "crypto";
+import fs from "fs";
+import path from "path";
+import { isDirectory } from "./file-utils.js";
+import { walk } from "./promisfied-fs.js";
+
+// Do not throw an exception if either of these modules are missing, as they may not be needed by the
+// consumer of this file.
+const HASH_ALGORITHM = 'sha256';
+class PackageManifest {
+    private _map: Map<string, string>;
+
+    constructor(map?: Map<string, string>) {
+        if (map == null) {
+            map = new Map();
+        }
+        this._map = map;
+    }
+
+    toMap(): Map<string, string> {
+        return this._map;
+    }
+
+    computePackageHash(): string {
+        let entries: string[] = [];
+        this._map.forEach((hash, name) => {
+            entries.push(name + ':' + hash);
+        });
+
+        // Make sure this list is alphabetically ordered so that other clients
+        // can also compute this hash easily given the update contents.
+        entries = entries.sort();
+
+        return crypto.createHash(HASH_ALGORITHM).update(JSON.stringify(entries)).digest('hex');
+    }
+
+    serialize(): string {
+        const obj: Record<string, string> = {};
+
+        this._map.forEach(function (value, key) {
+            obj[key] = value;
+        });
+
+        return JSON.stringify(obj);
+    }
+
+    static normalizePath(filePath: string): string {
+        //replace all backslashes coming from cli running on windows machines by slashes
+        return filePath.replace(/\\/g, '/');
+    }
+
+    static isIgnored(relativeFilePath: string): boolean {
+        const __MACOSX = '__MACOSX/';
+        const DS_STORE = '.DS_Store';
+        const CODEPUSH_METADATA = '.codepushrelease';
+        return (
+            relativeFilePath.startsWith(__MACOSX) ||
+            relativeFilePath === DS_STORE ||
+            relativeFilePath.endsWith('/' + DS_STORE) ||
+            relativeFilePath === CODEPUSH_METADATA ||
+            relativeFilePath.endsWith('/' + CODEPUSH_METADATA)
+        );
+    }
+}
+
+export async function generatePackageHashFromDirectory(directoryPath: string, basePath: string) {
+    try {
+        if (!isDirectory(directoryPath)) {
+            throw new Error('Not a directory. Please either create a directory, or use hashFile().');
+        }
+    } catch (error) {
+        throw new Error('Directory does not exist. Please either create a directory, or use hashFile().');
+    }
+
+    /**
+     * @type {PackageManifest}
+     */
+    const manifest = await generatePackageManifestFromDirectory(directoryPath, basePath);
+    return manifest.computePackageHash();
+}
+
+function generatePackageManifestFromDirectory(directoryPath: string, basePath: string): Promise<PackageManifest> {
+    // eslint-disable-next-line no-async-promise-executor
+    return new Promise(async (resolve, reject) => {
+        const fileHashesMap = new Map<string, string>();
+
+        const files: string[] = await walk(directoryPath);
+
+        if (!files || files.length === 0) {
+            reject('Error: Cannot sign the release because no files were found.');
+            return;
+        }
+
+        // Hash the files sequentially, because streaming them in parallel is not necessarily faster
+        const generateManifestPromise = files.reduce<Promise<unknown>>((soFar, filePath) => {
+            return soFar.then(() => {
+                const relativePath: string = PackageManifest.normalizePath(path.relative(basePath, filePath));
+                if (!PackageManifest.isIgnored(relativePath)) {
+                    return hashFile(filePath).then((hash) => {
+                        fileHashesMap.set(relativePath, hash);
+                    });
+                }
+            });
+        }, Promise.resolve(null));
+
+        generateManifestPromise.then(() => {
+            resolve(new PackageManifest(fileHashesMap));
+        }, reject);
+    });
+}
+
+function hashFile(filePath: string): Promise<string> {
+    const readStream: fs.ReadStream = fs.createReadStream(filePath);
+    return hashStream(readStream);
+}
+
+function hashStream(readStream: fs.ReadStream): Promise<string> {
+    return new Promise((resolve, reject) => {
+        const _hashStream = crypto.createHash(HASH_ALGORITHM)
+
+        readStream
+            .on('error', (error) => {
+                _hashStream.end();
+                reject(error);
+            })
+            .on('end', () => {
+                _hashStream.end();
+
+                const buffer = _hashStream.read();
+                const hash: string = buffer.toString('hex');
+
+                resolve(hash);
+            });
+
+        readStream.pipe(_hashStream);
+    });
+}

package/cli/utils/promisfied-fs.ts

@@ -0,0 +1,19 @@
+/**
+ * code based on appcenter-cli
+ */
+
+import { promises as fs } from "fs";
+import path from "path";
+
+export async function walk(dir: string): Promise<string[]> {
+    const stats = await fs.stat(dir);
+    if (stats.isDirectory()) {
+        let files: string[] = [];
+        for (const file of await fs.readdir(dir)) {
+            files = files.concat(await walk(path.join(dir, file)));
+        }
+        return files;
+    } else {
+        return [dir];
+    }
+}

package/cli/utils/{showLogo.js → showLogo.ts}

@@ -1,4 +1,4 @@
-function showLogo() {
+export function showLogo() {
   const logo = `
     
 +------------------------------------------------------------------+
@@ -19,5 +19,3 @@ Please refer to help command for more information.
     `;
   console.log(logo);
 }
-
-module.exports = { showLogo };

package/cli/utils/zip.ts

@@ -0,0 +1,65 @@
+/**
+ * code based on appcenter-cli
+ */
+
+import fs from "fs";
+import path from "path";
+import yazl from "yazl";
+import { generateRandomFilename, normalizePath, isDirectory } from "./file-utils.js";
+import { walk } from "./promisfied-fs.js";
+
+type ReleaseFile = { sourceLocation: string, targetLocation: string };
+
+export function zip(updateContentsPath: string): Promise<string> {
+
+    // eslint-disable-next-line no-async-promise-executor
+    return new Promise(async (resolve, reject) => {
+        const releaseFiles: ReleaseFile[] = [];
+
+        try {
+            if (!isDirectory(updateContentsPath)) {
+                releaseFiles.push({
+                    sourceLocation: updateContentsPath,
+                    targetLocation: normalizePath(path.basename(updateContentsPath)), // Put the file in the root
+                });
+            }
+        } catch (error: unknown) {
+            if (error instanceof Error) {
+                error.message = error.message + " Make sure you have added the platform you are making a release to.`.";
+            }
+            reject(error);
+        }
+
+        const directoryPath = updateContentsPath;
+        const baseDirectoryPath = path.join(directoryPath, '..'); // For legacy reasons, put the root directory in the zip
+
+        const files: string[] = await walk(updateContentsPath);
+
+        files.forEach((filePath) => {
+            const relativePath = path.relative(baseDirectoryPath, filePath);
+            releaseFiles.push({
+                sourceLocation: filePath,
+                targetLocation: normalizePath(relativePath),
+            });
+        });
+
+        const packagePath = path.join(process.cwd(), generateRandomFilename(15) + '.zip');
+        const zipFile = new yazl.ZipFile();
+        const writeStream = fs.createWriteStream(packagePath);
+
+        zipFile.outputStream
+            .pipe(writeStream)
+            .on('error', (error: unknown) => {
+                reject(error);
+            })
+            .on('close', () => {
+                resolve(packagePath);
+            });
+
+        releaseFiles.forEach((releaseFile) => {
+            zipFile.addFile(releaseFile.sourceLocation, releaseFile.targetLocation);
+        });
+
+        zipFile.end();
+    });
+}

package/expo/plugin/withCodePush.js

@@ -1,10 +1,9 @@
 const { createRunOncePlugin } = require('expo/config-plugins');
-const { withAndroidBuildScriptDependency, withAndroidMainApplicationDependency } = require('./withCodePushAndroid');
+const { withAndroidMainApplicationDependency } = require('./withCodePushAndroid');
 const { withIosBridgingHeader, withIosAppDelegateDependency } = require('./withCodePushIos');
 const pkg = require('../../package.json');
 
 const withCodePush = (config) => {
-  config = withAndroidBuildScriptDependency(config);
   config = withAndroidMainApplicationDependency(config);
   config = withIosBridgingHeader(config);
   config = withIosAppDelegateDependency(config);