feat(bun): upgrade to bun, reduce docker image size by 95%, upgrade docs & ci (#371)

* migrate to bun

* added envvars to drizzle

* upgrade bun devcontainer feature to a valid one

* added bun, docker not working

* updated envvars, updated to bunder and esnext modules

* fixed build, reinstated otel

* feat: optimized multi-stage docker images

* add coerce for boolean envvar

* feat: add docker-compose configuration for local LLM services and remove legacy Dockerfile and entrypoint script

* feat: add docker-compose files for local and production environments, and implement GitHub Actions for Docker image build and publish

* refactor: remove unused generateStaticParams function from various API routes and maintain dynamic rendering

* cleanup

* upgraded bun

* updated ci

* fixed build

---------

Co-authored-by: Aditya Tripathi <[email protected]>

Author: waleedlatif1

.devcontainer/.bashrc

@@ -19,16 +19,22 @@ alias check-db="PGPASSWORD=postgres psql -h db -U postgres -c '\l'"
 
 # Sim Studio specific aliases
 alias logs="cd /workspace/apps/sim && tail -f logs/*.log 2>/dev/null || echo 'No log files found'"
-alias sim-start="cd /workspace && npm run dev"
-alias sim-migrate="cd /workspace/apps/sim && npx drizzle-kit push"
-alias sim-generate="cd /workspace/apps/sim && npx drizzle-kit generate"
-alias sim-rebuild="cd /workspace && npm run build && npm run dev"
-alias docs-dev="cd /workspace/apps/docs && npm run dev"
+alias sim-start="cd /workspace && bun run dev"
+alias sim-migrate="cd /workspace/apps/sim && bunx drizzle-kit push"
+alias sim-generate="cd /workspace/apps/sim && bunx drizzle-kit generate"
+alias sim-rebuild="cd /workspace && bun run build && bun run start"
+alias docs-dev="cd /workspace/apps/docs && bun run dev"
 
 # Turbo related commands
-alias turbo-build="cd /workspace && npx turbo run build"
-alias turbo-dev="cd /workspace && npx turbo run dev"
-alias turbo-test="cd /workspace && npx turbo run test"
+alias turbo-build="cd /workspace && bunx turbo run build"
+alias turbo-dev="cd /workspace && bunx turbo run dev"
+alias turbo-test="cd /workspace && bunx turbo run test"
+
+# Bun specific commands
+alias bun-update="cd /workspace && bun update"
+alias bun-add="cd /workspace && bun add"
+alias bun-pm="cd /workspace && bun pm"
+alias bun-canary="bun upgrade --canary"
 
 # Default to workspace directory
 cd /workspace 2>/dev/null || true
@@ -52,6 +58,12 @@ if [ -z "$SIM_WELCOME_SHOWN" ]; then
   echo "  turbo-build  - Build all apps using Turborepo"
   echo "  turbo-dev    - Start development mode for all apps"
   echo "  turbo-test   - Run tests for all packages"
+  echo ""
+  echo "Bun commands:"
+  echo "  bun-update   - Update dependencies"
+  echo "  bun-add      - Add a new dependency"
+  echo "  bun-pm       - Manage dependencies"
+  echo "  bun-canary   - Upgrade to the latest canary version of Bun"
   echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
   echo ""
 fi 

.devcontainer/Dockerfile

@@ -1,29 +1,35 @@
-FROM node:20-bullseye
+# Use the latest Bun canary image for development
+FROM oven/bun:canary
 
 # Avoid warnings by switching to noninteractive
 ENV DEBIAN_FRONTEND=noninteractive
 
 # Install necessary packages for development
 RUN apt-get update \
     && apt-get -y install --no-install-recommends \
-       git curl wget jq sudo postgresql-client \
+       git curl wget jq sudo postgresql-client vim nano \
+       bash-completion ca-certificates lsb-release gnupg \
     && apt-get clean -y \
     && rm -rf /var/lib/apt/lists/*
 
 # Create a non-root user
-ARG USERNAME=node
+ARG USERNAME=bun
 ARG USER_UID=1000
 ARG USER_GID=$USER_UID
 
 # Add sudo support
 RUN echo "$USERNAME ALL=(ALL) NOPASSWD: ALL" > /etc/sudoers.d/$USERNAME \
     && chmod 0440 /etc/sudoers.d/$USERNAME
 
-# Make sure we have the latest npm
-RUN npm install -g npm@latest
+# Install global packages for development
+RUN bun install -g turbo drizzle-kit typescript @types/node
 
-# Install global packages
-RUN npm install -g drizzle-kit turbo
+# Install bun completions
+RUN bun completions > /etc/bash_completion.d/bun
+
+# Set up shell environment
+RUN echo "export PATH=$PATH:/home/$USERNAME/.bun/bin" >> /etc/profile
+RUN echo "source /etc/profile" >> /etc/bash.bashrc
 
 # Switch back to dialog for any ad-hoc use of apt-get
 ENV DEBIAN_FRONTEND=dialog

.devcontainer/README.md

@@ -33,7 +33,7 @@ This directory contains configuration files for Visual Studio Code Dev Container
    - Run database migrations
    - Configure helpful aliases
 
-5. Start the application with `sim-start` (alias for `npm run dev`)
+5. Start the application with `sim-start` (alias for `bun run dev`)
 
 ### Development Commands
 

.devcontainer/devcontainer.json

@@ -38,7 +38,8 @@
         "rvest.vs-code-prettier-eslint",
         "mikestead.dotenv",
         "dsznajder.es7-react-js-snippets",
-        "steoates.autoimport"
+        "steoates.autoimport",
+        "oven.bun-vscode"
       ]
     }
   },
@@ -49,13 +50,12 @@
 
   "postStartCommand": "bash -c 'if [ ! -f ~/.bashrc ] || ! grep -q \"sim-start\" ~/.bashrc; then cp .devcontainer/.bashrc ~/.bashrc; fi'",
 
-  "remoteUser": "node",
+  "remoteUser": "bun",
 
   "features": {
     "ghcr.io/devcontainers/features/git:1": {},
-    "ghcr.io/devcontainers-contrib/features/npm-package:1": {
-      "package": "typescript",
-      "version": "latest"
-    }
+    "ghcr.io/prulloac/devcontainer-features/bun:1": {
+       "version": "latest"
+     }
   }
 }

.devcontainer/docker-compose.yml

@@ -7,13 +7,15 @@ services:
       dockerfile: .devcontainer/Dockerfile
     volumes:
       - ..:/workspace:cached
+      - bun-cache:/home/bun/.bun/cache:delegated
     command: sleep infinity
     environment:
       - NODE_ENV=development
       - DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio
       - POSTGRES_URL=postgresql://postgres:postgres@db:5432/simstudio
       - BETTER_AUTH_URL=http://localhost:3000
       - NEXT_PUBLIC_APP_URL=http://localhost:3000
+      - BUN_INSTALL_CACHE_DIR=/home/bun/.bun/cache
     depends_on:
       db:
         condition: service_healthy
@@ -41,3 +43,4 @@ services:
 
 volumes:
   postgres-data:
+  bun-cache:

.devcontainer/post-create.sh

@@ -15,19 +15,34 @@ cp /workspace/.devcontainer/.bashrc ~/.bashrc
 echo 'if [ -f ~/.bashrc ]; then . ~/.bashrc; fi' >> ~/.profile
 
 # Clean and reinstall dependencies to ensure platform compatibility
-echo "📦 Cleaning and reinstalling npm dependencies..."
+echo "📦 Cleaning and reinstalling dependencies..."
 if [ -d "node_modules" ]; then
   echo "Removing existing node_modules to ensure platform compatibility..."
   rm -rf node_modules
   rm -rf apps/sim/node_modules
   rm -rf apps/docs/node_modules
 fi
 
+# Ensure Bun cache directory exists and has correct permissions
+mkdir -p ~/.bun/cache
+chmod 700 ~/.bun ~/.bun/cache
+
 # Install dependencies with platform-specific binaries
-npm install || {
-  echo "⚠️ npm install had issues but continuing setup..."
+echo "Installing dependencies with Bun..."
+bun install || {
+  echo "⚠️ bun install had issues but continuing setup..."
 }
 
+# Check for native dependencies
+echo "Checking for native dependencies compatibility..."
+NATIVE_DEPS=$(grep '"trustedDependencies"' apps/sim/package.json || echo "")
+if [ ! -z "$NATIVE_DEPS" ]; then
+  echo "⚠️ Native dependencies detected. Ensuring compatibility with Bun..."
+  for pkg in $(echo $NATIVE_DEPS | grep -oP '"[^"]*"' | tr -d '"' | grep -v "trustedDependencies"); do
+    echo "Checking compatibility for $pkg..."
+  done
+fi
+
 # Set up environment variables if .env doesn't exist for the sim app
 if [ ! -f "apps/sim/.env" ]; then
   echo "📄 Creating .env file from template..."
@@ -42,7 +57,7 @@ fi
 echo "🗃️ Running database schema generation and migrations..."
 echo "Generating schema..."
 cd apps/sim
-npx drizzle-kit generate
+bunx drizzle-kit generate
 cd ../..
 
 echo "Waiting for database to be ready..."
@@ -53,7 +68,7 @@ echo "Waiting for database to be ready..."
     if PGPASSWORD=postgres psql -h db -U postgres -c '\q' 2>/dev/null; then
       echo "Database is ready!"
       cd apps/sim
-      DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio npx drizzle-kit push
+      DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio bunx drizzle-kit push
       cd ../..
       break
     fi
@@ -71,13 +86,14 @@ echo "Waiting for database to be ready..."
 cat << EOF >> ~/.bashrc
 
 # Additional Sim Studio Development Aliases
-alias migrate="cd /workspace/apps/sim && DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio npx drizzle-kit push"
-alias generate="cd /workspace/apps/sim && npx drizzle-kit generate"
-alias dev="cd /workspace && npm run dev"
-alias build="cd /workspace && npm run build"
-alias start="cd /workspace && npm run dev"
-alias lint="cd /workspace/apps/sim && npm run lint"
-alias test="cd /workspace && npm run test"
+alias migrate="cd /workspace/apps/sim && DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio bunx drizzle-kit push"
+alias generate="cd /workspace/apps/sim && bunx drizzle-kit generate"
+alias dev="cd /workspace && bun run dev"
+alias build="cd /workspace && bun run build"
+alias start="cd /workspace && bun run dev"
+alias lint="cd /workspace/apps/sim && bun run lint"
+alias test="cd /workspace && bun run test"
+alias bun-update="cd /workspace && bun update"
 EOF
 
 # Source the .bashrc to make aliases available immediately

.dockerignore

@@ -1,12 +1,11 @@
-# Exclude files from Docker build
-.git
-.github
-node_modules
-.next
-.vercel
-.husky
-.env
-.env.*
-npm-debug.log
+LICENSE
+NOTICE
+.prettierrc
+.prettierignore
 README.md
-.devcontainer 
+.gitignore
+.husky
+.github
+.devcontainer
+.env.example
+node_modules

.github/CONTRIBUTING.md

@@ -214,9 +214,9 @@ If you prefer not to use Docker or Dev Containers:
    ```
 2. **Install Dependencies:**
 
-   - Using NPM:
+   - Using Bun:
      ```bash
-     npm install
+     bun install
      ```
 
 3. **Set Up Environment:**
@@ -229,14 +229,14 @@ If you prefer not to use Docker or Dev Containers:
    - You need a PostgreSQL instance running
    - Run migrations:
      ```bash
-     npm run db:push
+     bun run db:push
      ```
 
 5. **Run the Development Server:**
 
-   - With NPM:
+   - With Bun:
      ```bash
-     npm run dev
+     bun run dev
      ```
 
 6. **Make Your Changes and Test Locally.**
@@ -248,7 +248,7 @@ When working on email templates, you can preview them using a local email previe
 1. **Run the Email Preview Server:**
 
    ```bash
-   npm run email:dev
+   bun run email:dev
    ```
 
 2. **Access the Preview:**

.github/PULL_REQUEST_TEMPLATE.md

@@ -26,7 +26,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi
 - [ ] I have performed a self-review of my own code
 - [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] All tests pass locally and in CI (`npm test`)
+- [ ] All tests pass locally and in CI (`bun run test`)
 - [ ] My changes generate no new warnings
 - [ ] Any dependent changes have been merged and published in downstream modules
 - [ ] I have updated version numbers as needed (if needed)

.github/dependabot.yml

@@ -1,7 +1,7 @@
 version: 2
 updates:
-  - package-ecosystem: 'npm'
-    directory: 'apps/sim'
+  - package-ecosystem: 'bun'
+    directory: '/apps/sim'
     schedule:
       interval: 'weekly'
       day: 'monday'
@@ -21,9 +21,9 @@ updates:
         patterns:
           - '*'
 
-  # Documentation site dependencies (/docs)
-  - package-ecosystem: 'npm'
-    directory: 'apps/docs'
+  # Documentation site dependencies (/apps/docs)
+  - package-ecosystem: 'bun'
+    directory: '/apps/docs'
     schedule:
       interval: 'weekly'
       day: 'wednesday'
@@ -42,7 +42,7 @@ updates:
           - '*'
 
   # Root-level dependencies (if any)
-  - package-ecosystem: 'npm'
+  - package-ecosystem: 'bun'
     directory: '/'
     schedule:
       interval: 'weekly'