@reboot-dev/reboot 0.25.7 → 0.27.0

package/binding.gyp

@@ -3,18 +3,8 @@
         {
             "python3":
                 "<!(echo $RBT_PYTHON3_USE)",
-            # Using `node` to get the OS and arch since it is platform independent.
-            "os_and_arch":
-                "<(OS) <!(node -p process.arch)",
-            # See https://gregoryszorc.com/docs/python-build-standalone/main/running.html.
-            # We use `gnu` (rather than `musl`) because we need a libc that we can install
-            # our native python extension on.
-            #
-            # NOTE: Although that page recommends using `x86_64_v3` for Linux, we have
-            # encountered CPUs and/or GCC installs which do not support `x86-64-v3` (or v2)
-            # as the `-march`. Consequently, we use `x86_64` instead.
-            "pbs_base_url":
-                "https://github.com/indygreg/python-build-standalone/releases/download/20240814/cpython-3.10.14+20240814",
+            "REBOOT_BAZEL_TEST_FOR_BINDING":
+                "<!(echo $REBOOT_BAZEL_TEST_FOR_BINDING)",
         },
     "conditions":
         [
@@ -24,62 +14,26 @@
                     "conditions":
                         [
                             [
-                                "os_and_arch=='mac arm64' and python3==''", {
-                                    "variables":
-                                        {
-                                            "python3":
-                                                "<!(curl -s -L <(pbs_base_url)-aarch64-apple-darwin-install_only.tar.gz | tar -xzf - && echo $(pwd)/python/bin/python3)"
-                                        },
-                                }
-                            ],
-                            [
-                                "os_and_arch=='mac x64' and python3==''", {
-                                    "variables":
-                                        {
-                                            "python3":
-                                                "<!(curl -s -L <(pbs_base_url)-x86_64-apple-darwin-install_only.tar.gz | tar -xzf - && echo $(pwd)/python/bin/python3)"
-                                        },
-                                }
-                            ],
-                            [
-                                "os_and_arch=='linux arm64' and python3==''", {
-                                    "variables":
-                                        {
-                                            "python3":
-                                                "<!(curl -s -L <(pbs_base_url)-aarch64-unknown-linux-gnu-install_only.tar.gz | tar -xzf - && echo $(pwd)/python/bin/python3)"
-                                        },
-                                }
-                            ],
-                            [
-                                "os_and_arch=='linux x64' and python3==''", {
-                                    "variables":
-                                        {
-                                            "python3":
-                                                "<!(curl -s -L <(pbs_base_url)-x86_64-unknown-linux-gnu-install_only.tar.gz | tar -xzf - && echo $(pwd)/python/bin/python3)"
-                                        },
-                                }
-                            ],
-                            [
-                                "OS=='mac' and python3==''",
+                                "OS=='mac' and REBOOT_BAZEL_TEST_FOR_BINDING==''",
                                 {
+                                    # NOTE: On macOS, the `rpath` is not respected, and the dependency name of the
+                                    # downloaded Python is based on what it self-reports. We adjust what it will
+                                    # self-report in order to ensure that it is located at runtime.
+                                    #
+                                    # In theory, `gyp` supports Actions and dependencies between Targets. But
+                                    # in practice, `node-gyp` makes (undocumented) adjustments to both Actions and
+                                    # Targets that make it very challenging to use it for either fetching or
+                                    # updating the interpreter. We use private/dummy variables here to trigger
+                                    # side-effects instead.
                                     "variables":
                                         {
-                                            # NOTE: On macOS, the `rpath` is not respected, and the dependency name of the
-                                            # downloaded Python is based on what it self-reports. We adjust what it will
-                                            # self-report in order to ensure that it is located at runtime.
-                                            #
-                                            # In theory, `gyp` supports Actions and dependencies between Targets. But
-                                            # in practice, `node-gyp` makes (undocumented) adjustments to both Actions and
-                                            # Targets that make it very challenging to use it for either fetching or
-                                            # updating the interpreter. We use private/dummy variables here to trigger
-                                            # side-effects instead.
                                             "_absolute_lib_path":
                                                 "<!(echo $(pwd)/python/lib/libpython3.10.dylib)",
                                             "_dummy":
                                                 "<!(install_name_tool -id <(_absolute_lib_path) <(_absolute_lib_path))"
                                         }
                                 }
-                            ],
+                            ]
                         ],
                     "targets":
                         [

package/dummy.cc

@@ -0,0 +1,7 @@
+#include <cstddef>
+#include <iostream>
+#include <string>
+
+int main() {
+  return 0;
+}

package/index.d.ts

@@ -19,6 +19,7 @@ export declare class Reboot {
     stop(): Promise<void>;
     up(application: Application, options?: {
         localEnvoy?: boolean;
+        localEnvoyPort?: number;
     }): Promise<ApplicationRevision>;
     down(): Promise<void>;
     url(): string;

package/index.js

@@ -91,7 +91,7 @@ export class Reboot {
     async up(application, options) {
         // TODO(benh): determine module and file name so that we can
         // namespace if we have more than one implementation of servicers.
-        return await reboot_native.Reboot_up(__classPrivateFieldGet(this, _Reboot_external, "f"), application.__external, options?.localEnvoy);
+        return await reboot_native.Reboot_up(__classPrivateFieldGet(this, _Reboot_external, "f"), application.__external, options?.localEnvoy, options?.localEnvoyPort);
     }
     async down() {
         await reboot_native.Reboot_down(__classPrivateFieldGet(this, _Reboot_external, "f"));

package/install.cjs

@@ -0,0 +1,46 @@
+// Using that file to improve the readability in the package.json.
+const { execSync } = require("child_process");
+const fs = require("fs");
+
+if (process.platform === "win32") {
+  // Do nothing on Windows.
+  process.exit(0);
+}
+
+function removeEnvFile(fileName) {
+  if (fs.existsSync(fileName)) {
+    fs.unlinkSync(fileName);
+  }
+}
+
+try {
+  const downloadedPythonPath = fs
+    .readFileSync(".reboot_python_env", "utf8")
+    .trim();
+  const env = {
+    ...process.env,
+    CC: process.env.CC || fs.readFileSync(".reboot_cc_env", "utf8").trim(),
+    CXX: process.env.CXX || fs.readFileSync(".reboot_cxx_env", "utf8").trim(),
+    RBT_PYTHON3_USE: process.env.RBT_PYTHON3_USE || downloadedPythonPath,
+    REBOOT_BAZEL_TEST_FOR_BINDING: "",
+  };
+
+  // For the Bazel tests we are using a specific Python installed on the
+  // runners. So we need to provide that info to node-gyp to avoid
+  // making extra steps, which may break the installation.
+  if (env.RBT_PYTHON3_USE != downloadedPythonPath) {
+    env.REBOOT_BAZEL_TEST_FOR_BINDING = "1";
+  }
+
+  const cmd = `node-gyp rebuild --python=${env.RBT_PYTHON3_USE}`;
+  console.log(`\n📦 Running: ${cmd}`);
+  execSync(cmd, { stdio: "inherit", env });
+} catch (err) {
+  console.error("❌ install.js failed:", err);
+  process.exit(1);
+} finally {
+  // Clean up the environment files.
+  removeEnvFile(".reboot_cc_env");
+  removeEnvFile(".reboot_cxx_env");
+  removeEnvFile(".reboot_python_env");
+}

package/package.json

@@ -3,7 +3,7 @@
     "@bufbuild/protobuf": "1.3.2",
     "@bufbuild/protoplugin": "1.3.2",
     "@bufbuild/protoc-gen-es": "1.3.2",
-    "@reboot-dev/reboot-api": "0.25.7",
+    "@reboot-dev/reboot-api": "0.27.0",
     "chalk": "^4.1.2",
     "node-addon-api": "^7.0.0",
     "node-gyp": ">=10.2.0",
@@ -16,9 +16,11 @@
   },
   "type": "module",
   "name": "@reboot-dev/reboot",
-  "version": "0.25.7",
+  "version": "0.27.0",
   "description": "npm package for Reboot",
   "scripts": {
+    "preinstall": "node preinstall.cjs",
+    "install": "node install.cjs",
     "postinstall": "rbt || exit 0",
     "test": "echo \"Error: no test specified\" && exit 1",
     "prepack": "tsc"
@@ -64,7 +66,11 @@
     "venv.js",
     "version.d.ts",
     "version.js",
-    "workspaces.js"
+    "workspaces.js",
+    "prepare_environment.sh",
+    "dummy.cc",
+    "preinstall.cjs",
+    "install.cjs"
   ],
   "exports": {
     "./package.json": "./package.json",

package/preinstall.cjs

@@ -0,0 +1,10 @@
+// Using that file to improve the readability in the package.json.
+
+const { execSync } = require("child_process");
+
+if (process.platform === "win32") {
+  // Skip on Windows.
+  process.exit(0);
+}
+
+execSync("./prepare_environment.sh", { stdio: "inherit" });

package/prepare_environment.sh

@@ -0,0 +1,90 @@
+#!/bin/bash
+
+OS=$(node -p "require('os').platform()")
+ARCH=$(node -p "process.arch")
+
+if [[ "$OS" != "darwin" && "$OS" != "linux" ]]; then
+  echo "❌ Unsupported OS: $OS. Only 'darwin' and 'linux' are supported."
+  exit 1
+fi
+
+# See https://gregoryszorc.com/docs/python-build-standalone/main/running.html.
+# We use `gnu` (rather than `musl`) because we need a libc that we can install
+# our native python extension on.
+#
+# NOTE: Although that page recommends using `x86_64_v3` for Linux, we have
+# encountered CPUs and/or GCC installs which do not support `x86-64-v3` (or v2)
+# as the `-march`. Consequently, we use `x86_64` instead.
+BASE_URL="https://github.com/indygreg/python-build-standalone/releases/download/20240814/cpython-3.10.14+20240814"
+
+case "${OS}-${ARCH}" in
+  'darwin-arm64')
+    TAR_URL="${BASE_URL}-aarch64-apple-darwin-install_only.tar.gz"
+    ;;
+  'darwin-x64')
+    TAR_URL="${BASE_URL}-x86_64-apple-darwin-install_only.tar.gz"
+    ;;
+  'linux-arm64')
+    TAR_URL="${BASE_URL}-aarch64-unknown-linux-gnu-install_only.tar.gz"
+    ;;
+  'linux-x64')
+    TAR_URL="${BASE_URL}-x86_64-unknown-linux-gnu-install_only.tar.gz"
+    ;;
+  *)
+    echo "❌ Unsupported OS/ARCH: ${OS}-${ARCH}"
+    exit 1
+    ;;
+esac
+
+# The 'node-gyp' requirements check.
+# https://github.com/nodejs/node-gyp?tab=readme-ov-file#installation
+
+# Make sure 'make' is installed.
+if ! command -v make &> /dev/null; then
+  echo "❌ 'make' is not installed. Please install it to continue."
+  exit 1
+fi
+
+# Make sure proper C/C++ compilers are installed.
+# 'node-gyp' configure generates the Makefile which is used by make later.
+# https://github.com/nodejs/node-gyp/blob/7d883b5cf4c26e76065201f85b0be36d5ebdcc0e/gyp/pylib/gyp/generator/make.py
+#
+# Only perform toolchain autodetect if CC or CXX are not already set.
+if [ -z "${CC:-}" ] || [ -z "${CXX:-}" ]; then
+  if command -v gcc &> /dev/null && command -v g++ &> /dev/null; then
+    export CC=gcc
+    export CXX=g++
+  elif command -v clang &> /dev/null && command -v clang++ &> /dev/null; then
+    export CC=clang
+    export CXX=clang++
+  else
+    if [[ "$OS" == "linux" ]]; then
+      echo "❌ Neither 'clang' nor 'gcc' are installed. Please install a C/C++ compiler to continue."
+    else
+      echo "❌ Neither 'clang' nor 'gcc' are installed. Please install Xcode Command Line Tools to continue."
+    fi
+    exit 1
+  fi
+
+  # Try to compile a simple C++ program which imports some standard libraries
+  # to ensure that the compiler is working correctly.
+  $CXX dummy.cc || {
+    echo "❌ Failed to find the standard C++ library. Make sure you have a working C++ compiler installed."
+    exit 1
+  }
+
+  # To be available in the 'install' phase.
+  # node-gyp will use these environment variables to generate the
+  # correct Makefile.
+  rm -f .reboot_cc_env .reboot_cxx_env
+  echo "$CC" >> .reboot_cc_env
+  echo "$CXX" >> .reboot_cxx_env
+fi
+
+curl -s -L "$TAR_URL" | tar -xzf -
+
+DOWNLOADED_PYTHON=$(echo $(pwd)/python/bin/python3)
+
+# To be available in the 'install' phase.
+rm -f .reboot_python_env
+echo "$DOWNLOADED_PYTHON" >> .reboot_python_env

package/reboot_native.cc

@@ -1666,6 +1666,11 @@ Napi::Value Reboot_up(const Napi::CallbackInfo& info) {
     local_envoy = info[2].As<Napi::Boolean>();
   }
 
+  int local_envoy_port = 0;
+  if (!info[3].IsUndefined()) {
+    local_envoy_port = info[3].As<Napi::Number>().Int32Value();
+  }
+
   return NodePromiseFromPythonTask(
       info.Env(),
       "Reboot.up(...) in nodejs",
@@ -1674,7 +1679,8 @@ Napi::Value Reboot_up(const Napi::CallbackInfo& info) {
        py_reboot,
        js_external_application, // Ensures `py_application` remains valid.
        py_application,
-       local_envoy]() {
+       local_envoy,
+       local_envoy_port]() {
         return py_reboot->attr("up")(
             py_application,
             // NOTE: while we support subprocess consensuses
@@ -1683,7 +1689,8 @@ Napi::Value Reboot_up(const Napi::CallbackInfo& info) {
             // clone a process like we do with multiprocessing
             // in Python.
             "in_process"_a = true,
-            "local_envoy"_a = local_envoy);
+            "local_envoy"_a = local_envoy,
+            "local_envoy_port"_a = local_envoy_port);
       },
       [](py::object py_revision) {
         py::str py_application_id =

package/version.d.ts

@@ -1 +1 @@
-export declare const REBOOT_VERSION = "0.25.7";
+export declare const REBOOT_VERSION = "0.27.0";

package/version.js

@@ -1 +1 @@
-export const REBOOT_VERSION = "0.25.7";
+export const REBOOT_VERSION = "0.27.0";