@bravemobile/react-native-code-push 12.0.2 → 12.1.1

package/cli/{utils → dist/utils}/zip.js

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

package/cli/functions/{getReactTempDir.js → getReactTempDir.ts}

@@ -2,15 +2,11 @@
  * code based on appcenter-cli
  */
 
-const os = require('os');
+import os from "os";
 
 /**
  * Return the path of the temporary directory for react-native bundling
- *
- * @return {string}
  */
-function getReactTempDir() {
+export function getReactTempDir(): string {
     return `${os.tmpdir()}/react-*`;
 }
-
-module.exports = { getReactTempDir };

package/cli/functions/makeCodePushBundle.ts

@@ -0,0 +1,26 @@
+import path from "path";
+import shell from "shelljs";
+import { zip } from "../utils/zip.js";
+import { generatePackageHashFromDirectory } from "../utils/hash-utils.js";
+
+/**
+ * Create a CodePush bundle file and return the information.
+ *
+ * @param contentsPath {string} The directory path containing the contents to be made into a CodePush bundle (usually the 'build/CodePush' directory))
+ * @param bundleDirectory {string} The directory path to save the CodePush bundle file
+ * @return {Promise<{ bundleFileName: string }>}
+ */
+export async function makeCodePushBundle(contentsPath: string, bundleDirectory: string): Promise<{ bundleFileName: string }> {
+    const updateContentsZipPath = await zip(contentsPath);
+
+    const packageHash = await generatePackageHashFromDirectory(contentsPath, path.join(contentsPath, '..'));
+
+    shell.mkdir('-p', `./${bundleDirectory}`);
+    shell.mv(updateContentsZipPath, `./${bundleDirectory}/${packageHash}`);
+
+    return {
+        // To allow the "release" command to get the file and hash value from the result of the "bundle" command,
+        // use the hash value as the name of the file.
+        bundleFileName: packageHash,
+    };
+}

package/cli/functions/prepareToBundleJS.ts

@@ -0,0 +1,10 @@
+import shell from "shelljs";
+
+/**
+ * @param deleteDirs {string[]} Directories to delete
+ * @param makeDir {string} Directory path to create
+ */
+export function prepareToBundleJS({ deleteDirs, makeDir }: { deleteDirs: string[], makeDir: string }) {
+    shell.rm('-rf', deleteDirs);
+    shell.mkdir('-p', makeDir);
+}

package/cli/functions/runExpoBundleCommand.ts

@@ -0,0 +1,45 @@
+import path from "path";
+import shell from "shelljs";
+
+/**
+ * Run `expo 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)
+ * @return {void}
+ */
+export function runExpoBundleCommand(
+    bundleName: string,
+    outputPath: string,
+    platform: string,
+    sourcemapOutput: string,
+    entryFile: string,
+): void {
+    function getCliPath(): string {
+        return path.join('node_modules', '.bin', 'expo');
+    }
+
+    const expoBundleArgs: string[] = [
+        'export:embed',
+        '--assets-dest',
+        outputPath,
+        '--bundle-output',
+        path.join(outputPath, bundleName),
+        '--dev',
+        'false',
+        '--entry-file',
+        entryFile,
+        '--platform',
+        platform,
+        '--sourcemap-output',
+        sourcemapOutput,
+        '--reset-cache',
+    ];
+
+    console.log('Running "expo export:embed" command:\n');
+
+    shell.exec(`${getCliPath()} ${expoBundleArgs.join(' ')}`);
+}

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 };