Build rewatch in CI and add it to npm package

cknitt · cknitt · commit f56f5c2fd027 · 2024-05-25T16:45:08.000+02:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,6 +20,67 @@ env:
   OCAMLRUNPARAM: b
 
 jobs:
+  build-rewatch:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [
+            macos-13, # x64
+            macos-14, # ARM
+            ubuntu-latest, # x64
+            buildjet-2vcpu-ubuntu-2204-arm, # ARM
+            windows-latest,
+          ]
+        include:
+          - os: macos-13
+            rust-target: x86_64-apple-darwin
+          - os: macos-14
+            rust-target: aarch64-apple-darwin
+          - os: ubuntu-latest
+            rust-target: x86_64-unknown-linux-musl
+          - os: buildjet-2vcpu-ubuntu-2204-arm
+            rust-target: aarch64-unknown-linux-musl
+          - os: windows-latest
+            rust-target: x86_64-pc-windows-gnu
+
+    runs-on: ${{matrix.os}}
+
+    env:
+      RUST_BACKTRACE: "1"
+      SCCACHE_GHA_ENABLED: "true"
+      RUSTC_WRAPPER: "sccache"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install musl gcc
+        if: runner.os == 'Linux'
+        run: sudo apt-get install -y musl-tools
+
+      - name: Set up sccache
+        uses: mozilla-actions/sccache-action@v0.0.4
+        with:
+          version: "v0.8.0"
+
+      - name: Install rust toolchain
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          targets: ${{matrix.rust-target}}
+
+      - name: Build rewatch
+        run: cargo build --manifest-path rewatch/Cargo.toml --target ${{matrix.rust-target}} --release
+
+      - name: Get artifact dir name
+        run: node .github/workflows/get_artifact_dir_name.js
+
+      - name: "Upload artifact: rewatch binary"
+        uses: actions/upload-artifact@v4
+        with:
+          name: rewatch-${{env.artifact_dir_name}}
+          path: rewatch/target/${{matrix.rust-target}}/release/rewatch${{ runner.os == 'Windows' && '.exe' || '' }}
+
   # Build statically linked Linux binaries in an Alpine-based Docker container
   # See https://ocamlpro.com/blog/2021_09_02_generating_static_and_portable_executables_with_ocaml
   # for more info.
@@ -59,6 +120,7 @@ jobs:
   # Therefore, only upload the binaries from the static build
   upload-linux-arm64-binaries:
     needs:
+      - build-rewatch
       - static-binaries-linux
 
     runs-on: buildjet-2vcpu-ubuntu-2204-arm
@@ -73,31 +135,33 @@ jobs:
         with:
           name: static-binaries-linux-${{ runner.arch }}
 
-      - name: Make static linux binaries executable
-        if: runner.os == 'Linux'
-        run: |
-          chmod +x ninja/ninja
-          chmod +x _build/install/default/bin/*
-
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
           node-version: 18
 
+      - name: Get artifact dir name
+        run: node .github/workflows/get_artifact_dir_name.js
+
+      - name: Download rewatch binary
+        uses: actions/download-artifact@v4
+        with:
+          name: rewatch-${{ env.artifact_dir_name }}
+          path: rewatch
+
       - name: Copy exes to platform bin dirs
         run: node ./scripts/copyExes.js
 
-      - name: Prepare artifact upload
-        run: node .github/workflows/get_artifact_info.js
-
       - name: "Upload artifacts: binaries"
         uses: actions/upload-artifact@v4
         with:
-          name: ${{ env.artifact_name }}
-          path: ${{ env.artifact_path }}
+          name: binaries-${{ env.artifact_dir_name }}
+          path: ${{ env.artifact_dir_name }}
 
   build:
-    needs: static-binaries-linux
+    needs:
+      - build-rewatch
+      - static-binaries-linux
 
     strategy:
       fail-fast: false
@@ -133,10 +197,20 @@ jobs:
         with:
           name: static-binaries-linux-${{ runner.arch }}
 
+      - name: Get artifact dir name
+        run: node .github/workflows/get_artifact_dir_name.js
+
+      - name: Download rewatch binary
+        uses: actions/download-artifact@v4
+        with:
+          name: rewatch-${{ env.artifact_dir_name }}
+          path: rewatch
+
       - name: Make static linux binaries executable
         if: runner.os == 'Linux'
         run: |
           chmod +x ninja/ninja
+          chmod +x rewatch/rewatch
           chmod +x _build/install/default/bin/*
 
       - name: Use OCaml ${{matrix.ocaml_compiler}}
@@ -252,14 +326,11 @@ jobs:
           KEYCDN_PASSWORD: ${{ secrets.KEYCDN_PASSWORD }}
         run: bash playground/upload_bundle.sh
 
-      - name: Prepare artifact upload
-        run: node .github/workflows/get_artifact_info.js
-
       - name: "Upload artifacts: binaries"
         uses: actions/upload-artifact@v4
         with:
-          name: ${{ env.artifact_name }}
-          path: ${{ env.artifact_path }}
+          name: binaries-${{ env.artifact_dir_name }}
+          path: ${{ env.artifact_dir_name }}
 
       - name: "Upload artifacts: lib/ocaml"
         if: runner.os == 'Linux'
diff --git a/.github/workflows/get_artifact_dir_name.js b/.github/workflows/get_artifact_dir_name.js
@@ -0,0 +1,10 @@
+const fs = require("fs");
+const os = require("os");
+
+const artifactDirName = require("../../scripts/bin_path").dirName;
+
+// Pass artifactDirName to subsequent GitHub actions
+fs.appendFileSync(
+  process.env.GITHUB_ENV,
+  `artifact_dir_name=${artifactDirName}${os.EOL}`
+);
diff --git a/.github/workflows/get_artifact_info.js b/.github/workflows/get_artifact_info.js
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,6 +16,7 @@ Happy hacking!
 
 - [NodeJS v18](https://nodejs.org/)
 - C compiler toolchain (usually installed with `xcode` on Mac)
+- Rust toolchain (required to build rewatch; follow the instructions at https://www.rust-lang.org/tools/install)
 - `opam` (OCaml Package Manager)
 - VSCode (+ [OCaml Platform Extension](https://marketplace.visualstudio.com/items?itemName=ocamllabs.ocaml-platform))
 
diff --git a/Makefile b/Makefile
@@ -2,7 +2,7 @@ SHELL = /bin/bash
 
 DUNE_BIN_DIR = ./_build/install/default/bin
 
-build: ninja
+build: ninja rewatch
 	dune build
 	./scripts/copyExes.js
 
@@ -15,6 +15,10 @@ bench:
 dce:
 	reanalyze.exe -dce-cmt _build/default/jscomp
 
+rewatch:
+	cargo build --manifest-path rewatch/Cargo.toml
+	cp rewatch/target/debug/rewatch rewatch
+
 ninja/ninja:
 	./scripts/buildNinjaBinary.js
 
@@ -78,10 +82,11 @@ clean-gentype:
 
 clean:
 	dune clean
-	./scripts/ninja.js clean
+	cargo clean --manifest-path rewatch/Cargo.toml && rm -f rewatch/rewatch
+	./scripts/ninja.js clean && rm -f ninja/ninja
 
 clean-all: clean clean-gentype
 
 .DEFAULT_GOAL := build
 
-.PHONY: build watch ninja bench dce test test-syntax test-syntax-roundtrip test-gentype test-all lib playground playground-cmijs playground-release artifacts format checkformat clean-gentype clean clean-all
+.PHONY: build watch rewatch ninja bench dce test test-syntax test-syntax-roundtrip test-gentype test-all lib playground playground-cmijs playground-release artifacts format checkformat clean-gentype clean clean-all
diff --git a/package.json b/package.json
@@ -12,7 +12,8 @@
   "bin": {
     "bsc": "bsc",
     "bstracing": "lib/bstracing",
-    "rescript": "rescript"
+    "rescript": "rescript",
+    "rewatch": "scripts/rewatch"
   },
   "scripts": {
     "test": "node scripts/ciTest.js -all",
diff --git a/packages/artifacts.txt b/packages/artifacts.txt
@@ -9,10 +9,12 @@ darwin/bsb_helper.exe
 darwin/bsc.exe
 darwin/ninja.exe
 darwin/rescript.exe
+darwin/rewatch.exe
 darwinarm64/bsb_helper.exe
 darwinarm64/bsc.exe
 darwinarm64/ninja.exe
 darwinarm64/rescript.exe
+darwinarm64/rewatch.exe
 docs/docson/build-schema.json
 lib/bstracing
 lib/es6/arg.js
@@ -1056,10 +1058,12 @@ linux/bsb_helper.exe
 linux/bsc.exe
 linux/ninja.exe
 linux/rescript.exe
+linux/rewatch.exe
 linuxarm64/bsb_helper.exe
 linuxarm64/bsc.exe
 linuxarm64/ninja.exe
 linuxarm64/rescript.exe
+linuxarm64/rewatch.exe
 ninja.COPYING
 package.json
 rescript
@@ -1070,7 +1074,9 @@ scripts/rescript_convert.js
 scripts/rescript_dump.js
 scripts/rescript_format.js
 scripts/rescript_postinstall.js
+scripts/rewatch
 win32/bsb_helper.exe
 win32/bsc.exe
 win32/ninja.exe
-win32/rescript.exe
+win32/rescript.exe
+win32/rewatch.exe
diff --git a/rewatch/.gitignore b/rewatch/.gitignore
@@ -1 +1,2 @@
-target
+target/
+rewatch
diff --git a/scripts/.npmignore b/scripts/.npmignore
@@ -2,4 +2,5 @@
 # keep only those actually needed in the npm package.
 *
 !bin_path.js
-!rescript_*.js
+!rescript_*.js
+!rewatch
diff --git a/scripts/copyExes.js b/scripts/copyExes.js
@@ -8,6 +8,7 @@ const { duneBinDir } = require("./dune");
 const { absolutePath: platformBinDir } = require("./bin_path");
 
 const ninjaDir = path.join(__dirname, "..", "ninja");
+const rewatchDir = path.join(__dirname, "..", "rewatch");
 
 if (!fs.existsSync(platformBinDir)) {
   fs.mkdirSync(platformBinDir);
@@ -34,3 +35,4 @@ copyExe(duneBinDir, "rescript");
 copyExe(duneBinDir, "bsc");
 copyExe(duneBinDir, "bsb_helper");
 copyExe(ninjaDir, "ninja");
+copyExe(rewatchDir, "rewatch");
diff --git a/scripts/makeArtifactList.js b/scripts/makeArtifactList.js
@@ -47,7 +47,13 @@ if (isCheckMode) {
 
 function getFilesAddedByCI() {
   const platforms = ["darwin", "darwinarm64", "linux", "linuxarm64", "win32"];
-  const exes = ["bsb_helper.exe", "bsc.exe", "ninja.exe", "rescript.exe"];
+  const exes = [
+    "bsb_helper.exe",
+    "bsc.exe",
+    "ninja.exe",
+    "rescript.exe",
+    "rewatch.exe",
+  ];
 
   const files = ["ninja.COPYING"];
 
diff --git a/scripts/rewatch b/scripts/rewatch
@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+//@ts-check
+"use strict";
+
+const path = require("path");
+const child_process = require("child_process");
+
+const binAbsolutePath = require("./bin_path").absolutePath;
+const rewatchExe = path.join(binAbsolutePath, "rewatch.exe");
+
+const args = process.argv.slice(2);
+
+child_process.spawnSync(rewatchExe, args, { stdio: "inherit" });

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,5 @@`
`2`	`2`	`# keep only those actually needed in the npm package.`
`3`	`3`	`*`
`4`	`4`	`!bin_path.js`
`5`		`-!rescript_*.js`
	`5`	`+!rescript_*.js`
	`6`	`+!rewatch`