Merge pull request #380 from formidablejs/feature/bun-support

donaldp · web-flow · commit 648284b2fbf0 · 2025-04-21T21:16:25.000+02:00
Feature/bun support
diff --git a/.github/workflows/bun-core-test.yml b/.github/workflows/bun-core-test.yml
@@ -0,0 +1,24 @@
+name: Bun - Core Tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: oven-sh/setup-bun@v2
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v3
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+    - name: Start Redis
+      uses: supercharge/redis-github-action@1.4.0
+    - name: Install dependencies
+      run: bun install
+    - name: Build
+      run: bun run build
+    - name: Run tests
+      run: bun run test
diff --git a/.github/workflows/bun-e2e-test.yml b/.github/workflows/bun-e2e-test.yml
@@ -0,0 +1,22 @@
+name: Bun - E2E Tests
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: oven-sh/setup-bun@v2
+    - name: Install modules
+      run: bun install --frozen-lockfile
+    - name: Build
+      run: bun run build
+    - name: Prepare e2e tests
+      run: RUNTIME=bun bun run pre-test
+    - name: Run e2e tests
+      run: bun run test:e2e
+    - name: Clean up
+      run: ./scripts/5-clean-up.sh
diff --git a/.github/workflows/nodejs-automated.yml b/.github/workflows/nodejs-automated.yml
@@ -1,4 +1,4 @@
-name: Automated Tests
+name: Node.js - Automated Tests
 
 on:
   schedule:
diff --git a/.github/workflows/nodejs-core-test.yml b/.github/workflows/nodejs-core-test.yml
@@ -1,4 +1,4 @@
-name: Core Tests
+name: Node.js - Core Tests
 
 on: [push]
 
diff --git a/.github/workflows/nodejs-e2e-test.yml b/.github/workflows/nodejs-e2e-test.yml
@@ -1,4 +1,4 @@
-name: E2E Tests
+name: Node.js - E2E Tests
 
 on: [push]
 
diff --git a/.github/workflows/package-test.yml b/.github/workflows/package-test.yml
diff --git a/bin/formidablejs/Commands/Build.js b/bin/formidablejs/Commands/Build.js
@@ -1,6 +1,7 @@
 const { Command, Output, boolean } = require("@formidablejs/console");
 const { exec, execSync } = require("child_process");
-const { getExt } = require('../ext')
+const { getExt } = require('../ext');
+const { getRuntime } = require("../runtime");
 
 class Build extends Command {
   get signature() {
@@ -18,6 +19,8 @@ class Build extends Command {
   }
 
   handle() {
+    const runtime = getRuntime();
+
     if (this.option("watch-console")) {
       return execSync(
         `imba build bootstrap/console${getExt()} -p -s -f -w -o .formidable`,
@@ -29,7 +32,7 @@ class Build extends Command {
     }
 
     const output = exec(
-      `imba build bootstrap/console${getExt()} -p -s -f -o .formidable && imba build bootstrap/build${getExt()} -p -s -f -o .formidable && node craftsman config:cache`,
+      `imba build bootstrap/console${getExt()} -p -s -f -o .formidable && imba build bootstrap/build${getExt()} -p -s -f -o .formidable && ${runtime} craftsman config:cache`,
       {
         stdio: "pipe",
         cwd: process.cwd(),
@@ -69,7 +72,21 @@ class Build extends Command {
       track.push(data);
     });
 
+    let workerThreadErrors = false;
+
     output.stderr.on("data", function (data) {
+      if (
+        data.startsWith('NotImplementedError: worker_threads.Worker')
+      ) {
+        if (workerThreadErrors) {
+          return;
+        }
+
+        workerThreadErrors = true;
+
+        return Output.write("  <bg:yellow> WARN </bg:yellow> Bun does not support node.js worker_threads yet.\n");
+      }
+
       process.stdout.write(data);
     });
 
diff --git a/bin/formidablejs/Commands/Start.js b/bin/formidablejs/Commands/Start.js
@@ -1,5 +1,6 @@
 const { Command } = require("@formidablejs/console");
 const { execSync } = require("child_process");
+const { getRuntime } = require("../runtime");
 
 class Start extends Command {
   get signature() {
@@ -11,7 +12,9 @@ class Start extends Command {
   }
 
   handle() {
-    execSync("node server", {
+    const runtime = getRuntime();
+
+    execSync(`${runtime} server`, {
       stdio: "inherit",
       cwd: process.cwd(),
     });
diff --git a/bin/formidablejs/runtime.js b/bin/formidablejs/runtime.js
@@ -0,0 +1,16 @@
+const getRuntime = () => {
+  const args = process.argv;
+  let runtime = 'node';
+
+  if (args) {
+    const executor = args[0].split('/').pop();
+
+    if (executor != undefined) {
+      runtime = executor;
+    }
+  }
+
+  return runtime;
+}
+
+module.exports = { getRuntime }
diff --git a/scripts/2-install.sh b/scripts/2-install.sh
@@ -1,5 +1,12 @@
 #!/usr/bin/env bash
 
+RUNTIME=${RUNTIME:-node}
+PKG_MGR="npm"
+
+if [ "$RUNTIME" = "bun" ]; then
+    PKG_MGR="bun"
+fi
+
 PACKAGE=${PWD}/output/package.tgz
 E2E=${PWD}/test/e2e
 
@@ -16,10 +23,17 @@ then
 fi
 
 echo
-echo "Install dependencies..."
+echo "Installing dependencies for $RUNTIME...."
 echo
 
-cd $E2E                           && \
-npm i --legacy-peer-deps          && \
-npm i sqlite3 --save              && \
-npm i $PACKAGE --legacy-peer-deps
+cd "$E2E" || exit 1
+
+if [ "$PKG_MGR" = "bun" ]; then
+    rm -rf node_modules yarn.lock package-lock.json bun.lockb && \
+    sed -i '/"@formidablejs\/framework"/d' package.json       && \
+    bun add sqlite3 "$PACKAGE"
+else
+    npm install --legacy-peer-deps            && \
+    npm install sqlite3 --save                && \
+    npm install "$PACKAGE" --legacy-peer-deps
+fi
diff --git a/scripts/4-prepare.sh b/scripts/4-prepare.sh
@@ -1,5 +1,12 @@
 #!/usr/bin/env bash
 
+RUNTIME=${RUNTIME:-node}
+PKG_MGR="npm"
+
+if [ "$RUNTIME" = "bun" ]; then
+    PKG_MGR="bun"
+fi
+
 ENV=${PWD}/test/e2e/.env
 E2E=${PWD}/test/e2e
 
@@ -18,17 +25,17 @@ echo
 echo "Prepare application..."
 echo
 
-cd $E2E                                                                                 && \
-cp .env.example .env                                                                    && \
-perl -i -p -e 's/APP_ENV=local/APP_ENV=testing/g' .env                                  && \
-perl -i -p -e 's/DB_CONNECTION=mysql/DB_CONNECTION=sqlite/g' .env                       && \
-perl -i -p -e 's/"jest --roots test"/"jest --roots=test --forceExit"/g' package.json    && \
-echo "DATABASE_URL=database/db.sqlite" >> .env                                          && \
-touch database/db.sqlite                                                                && \
-node craftsman key:generate                                                             && \
-node craftsman package:publish --package=@formidablejs/framework --tag="auth-emails"    && \
-node craftsman package:publish --package=@formidablejs/mailer --tag="components,config" && \
-node craftsman config:cache                                                             && \
-node craftsman migrate:latest                                                           && \
-npm run build
+cd $E2E                                                                                     && \
+cp .env.example .env                                                                        && \
+perl -i -p -e 's/APP_ENV=local/APP_ENV=testing/g' .env                                      && \
+perl -i -p -e 's/DB_CONNECTION=mysql/DB_CONNECTION=sqlite/g' .env                           && \
+perl -i -p -e 's/"jest --roots test"/"jest --roots=test --forceExit"/g' package.json        && \
+echo "DATABASE_URL=database/db.sqlite" >> .env                                              && \
+touch database/db.sqlite                                                                    && \
+$RUNTIME craftsman key:generate                                                             && \
+$RUNTIME craftsman package:publish --package=@formidablejs/framework --tag="auth-emails"    && \
+$RUNTIME craftsman package:publish --package=@formidablejs/mailer --tag="components,config" && \
+$RUNTIME craftsman config:cache                                                             && \
+$RUNTIME craftsman migrate:latest                                                           && \
+$PKG_MGR run build
 
diff --git a/scripts/e2e/ecosystem.config.js b/scripts/e2e/ecosystem.config.js
@@ -1,8 +1,26 @@
+const runtime = () => {
+  const isInstalled = (cmd) => {
+    try {
+      execSync(`${cmd} -v`, { stdio: 'ignore' });
+      return true;
+    } catch {
+      return false;
+    }
+  };
+
+  if (isInstalled('bun')) return 'bun';
+  if (isInstalled('node')) return 'node';
+
+  throw new Error('Neither Node.js nor Bun is installed. Please install one of them.');
+};
+
+console.log(`Using runtime: ${runtime()}\n`);
+
 module.exports = {
   apps: [
     {
       name: 'app',
-      script: 'node craftsman serve --port=3000 --addr',
+      script: `${runtime} craftsman serve --port=3000 --addr`,
       time: true,
       error_file: "./error.log",
       out_file: "./log.log"

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Automated Tests`
	`1`	`+name: Node.js - Automated Tests`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`schedule:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Core Tests`
	`1`	`+name: Node.js - Core Tests`
`2`	`2`
`3`	`3`	`on: [push]`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: E2E Tests`
	`1`	`+name: Node.js - E2E Tests`
`2`	`2`
`3`	`3`	`on: [push]`
`4`	`4`