Merge pull request #368 from FilenCloudDienste/dev/use-bun

Use Bun

Author: JupiterPi

.github/workflows/build-and-publish.yml

@@ -6,36 +6,50 @@ on:
 
 jobs:
   build-and-publish-binaries:
-    name: Build binaries (${{ matrix.target }})
+    name: Build binaries (${{ matrix.name }})
     strategy:
       matrix:
         include:
-          - os: windows-latest
-            target: win
-          - os: ubuntu-latest
-            target: linux
-          - os: macos-latest
-            target: macos
+          - name: win-x64
+            target: windows-x64 --windows-icon=.github/workflows/filen-icon.ico
+            os: windows-11-arm  # see note below
+          - name: linux-x64
+            target: linux-x64
+            os: ubuntu-latest
+          - name: linux-arm64
+            target: linux-arm64
+            os: ubuntu-24.04-arm
+          - name: macos-x64
+            target: macos-x64
+            os: macos-latest
+          - name: macos-arm64
+            target: macos-arm64
+            os: macos-latest
     runs-on: ${{ matrix.os }}
     permissions:
       contents: write
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Inject version
-        uses: richardrigutins/replace-in-files@v2
+      - name: Install bun
+        if: ${{ matrix.os != 'windows-11-arm' }}
+        uses: oven-sh/setup-bun@v2
+        # Installing Bun on Windows is a bit different:
+        # Bun doesn't support Windows ARM64 (yet?), so we're installing the x64 version, which can be run on Windows arm64 machines via emulation.
+        # However, it seems that the x64 binary built on x64 can't be run on arm64, so we need to build the x64 binary on an arm64 machine.
+        # The oven-sh/setup-bun action doesn't support installing x64 Bun on arm64, so we do it manually using the install script (and then add it to the PATH).
+      - name: Install bun (Windows)
+        if: ${{ matrix.os == 'windows-11-arm' }}
+        run: powershell -c "irm bun.sh/install.ps1|iex"
+      - name: Add bun to path (Windows)
+        if: ${{ matrix.os == 'windows-11-arm' }}
+        uses: actions/github-script@v7
         with:
-          files: "package.json"
-          search-text: "\"version\": \"0.0.0\""
-          replacement-text: "\"version\": \"${{ github.event.release.tag_name }}\""
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: .node-version
-      - run: npm ci
-      - run: npm run package-${{ matrix.target }}
+          script: core.addPath('C:\\Users\\runneradmin\\.bun\\bin');
+      - run: bun install
+      - run: bun run compile --target=bun-${{ matrix.target }} --define "FILEN_CLI_VERSION=${{ github.event.release.tag_name }}" --outfile dist/filen-cli-${{ github.event.release.tag_name }}-${{ matrix.name }}
       - name: Codesign and notarize on macOS
-        if: ${{ matrix.target == 'macos' }}
+        if: ${{ matrix.os == 'macos-latest' }}
         env: 
           APPLE_DEVELOPER_ID_CERT: ${{ secrets.APPLE_DEVELOPER_ID_CERT }}
           APPLE_DEVELOPER_ID_CERT_PASS: ${{ secrets.APPLE_DEVELOPER_ID_CERT_PASS }}
@@ -53,21 +67,27 @@ jobs:
           security unlock-keychain -p actions ~/Library/Keychains/build.keychain
           security set-key-partition-list -S apple-tool:,apple: -s -k actions ~/Library/Keychains/build.keychain
           # codesign
-          codesign --sign "Developer ID Application: Filen Cloud Dienste UG (haftungsbeschraenkt)" --options runtime --force --deep --keychain ~/Library/Keychains/build.keychain --entitlements=../.github/workflows/entitlements.plist filen-cli-macos-x64 filen-cli-macos-arm64
+          codesign --sign "Developer ID Application: Filen Cloud Dienste UG (haftungsbeschraenkt)" --options runtime --force --deep --keychain ~/Library/Keychains/build.keychain --entitlements=../.github/workflows/entitlements.plist filen-cli-${{ github.event.release.tag_name }}-${{ matrix.name }}
           # notarize
-          zip filen-cli-macos.zip filen-cli-macos-x64 filen-cli-macos-arm64
+          zip filen-cli-macos.zip filen-cli-${{ github.event.release.tag_name }}-${{ matrix.name }}
           xcrun notarytool submit filen-cli-macos.zip --apple-id $APPLE_NOTARIZE_ID --password $APPLE_NOTARIZE_PASS --team-id $APPLE_NOTARIZE_TEAM_ID --output-format json --wait 2>&1 | tee notarization_info.json
           id=$(cat notarization_info.json | jq -r '.id')
           xcrun notarytool log $id --apple-id $APPLE_NOTARIZE_ID --password $APPLE_NOTARIZE_PASS --team-id $APPLE_NOTARIZE_TEAM_ID
           # cleanup certificate
           security delete-keychain build.keychain
           rm -f certificate.p12
-      - name: Rename binaries to include release number
-        run: node -e "['win-x64.exe', 'win-arm64.exe', 'linux-x64', 'linux-arm64', 'macos-x64', 'macos-arm64'].forEach(suffix => { if (fs.existsSync('dist/filen-cli-'+suffix)) { fs.renameSync('dist/filen-cli-'+suffix, 'dist/filen-cli-${{ github.event.release.tag_name }}-'+suffix) } })"
+          rm filen-cli-macos.zip
+      - name: Execute binary
+        if: ${{ matrix.target != 'macos-x64' }}
+        run: dist/filen-cli-${{ github.event.release.tag_name }}-${{ matrix.name }} --help
+      - name: Copy win-x64 binary as win-arm64 binary
+        # so the updater won't be confused
+        if: ${{ matrix.os == 'windows-11-arm' }}
+        run: cp dist/filen-cli-${{ github.event.release.tag_name }}-win-x64.exe dist/filen-cli-${{ github.event.release.tag_name }}-win-arm64.exe
       - name: Attach binaries to release
         uses: softprops/action-gh-release@v2
         with:
-          files: dist/filen-cli-${{ github.event.release.tag_name }}-*
+          files: dist/filen-cli-*
 
   build-and-publish-npm:
     name: Build and publish to npm
@@ -82,29 +102,23 @@ jobs:
           files: "package.json"
           search-text: "\"version\": \"0.0.0\""
           replacement-text: "\"version\": \"${{ github.event.release.tag_name }}\""
+      - name: Install bun
+        uses: oven-sh/setup-bun@v2
+      - run: bun install
+      - run: bun build --target=node --sourcemap --define VERSION="${{ github.event.release.tag_name }}" --define IS_RUNNING_AS_NPM_PACKAGE=true src/index.ts --outdir build --external "@jupiterpi/node-keyring" --external "@parcel/watcher"
       - name: Setup Node
         uses: actions/setup-node@v4
-        with:
-          node-version-file: .node-version
-          registry-url: "https://registry.npmjs.org"
-      - run: npm ci
-      - run: npm publish --access public  # includes build
+      - run: npm publish --access public
         env:
-          FILEN_IS_NPM_PACKAGE: true
           NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
 
   build-and-publish-docker:
     name: Build Docker image
     runs-on: ubuntu-latest
     if: ${{ github.event.release.prerelease == false }}
     steps:
-      - uses: actions/checkout@v3
-      - name: Inject version
-        uses: richardrigutins/replace-in-files@v2
-        with:
-          files: "package.json"
-          search-text: "\"version\": \"0.0.0\""
-          replacement-text: "\"version\": \"${{ github.event.release.tag_name }}\""
+      - name: Checkout
+        uses: actions/checkout@v3
       - name: Log in to Docker Hub
         uses: docker/login-action@v3
         with:
@@ -139,13 +153,11 @@ jobs:
           files: "package.json"
           search-text: "\"version\": \"0.0.0\""
           replacement-text: "\"version\": \"${{ github.event.release.tag_name }}\""
+      - name: Install bun
+        uses: oven-sh/setup-bun@v2
+      - run: bun install
       - name: Setup Node
         uses: actions/setup-node@v4
-        with:
-          node-version-file: .node-version
-      - run: npm ci
-      - name: Build filen-cli
-        run: npm run build
       - name: Build docs
         run: chmod +x build-docs.sh && ./build-docs.sh && mv filen-cli-docs.html filen-cli-${{ github.event.release.tag_name }}-docs.html
       - name: Attach HTML file to release

.github/workflows/eslint.yml

@@ -25,12 +25,10 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: .node-version
-      - run: npm ci
-      - run: npm run lint-ci
+      - name: Install bun
+        uses: oven-sh/setup-bun@v2
+      - run: bun install
+      - run: bun run lint-ci
         continue-on-error: true
       - name: Upload analysis results to GitHub
         uses: github/codeql-action/upload-sarif@v3

icon.ico .github/workflows/filen-icon.icoicon.ico renamed to .github/workflows/filen-icon.ico

@@ -1,23 +1,20 @@
-name: Run Vitest tests
+name: Run tests
 
 on:
   push:
   pull_request:
     types: [opened, synchronize, reopened]
 
 jobs:
-  vitest:
+  test:
     runs-on: ubuntu-latest
     env:
       FILEN_CLI_TESTING_EMAIL: ${{ secrets.V2_TEST_ACC_EMAIL }}
       FILEN_CLI_TESTING_PASSWORD: ${{ secrets.V2_TEST_ACC_PASS }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: .node-version
-      - run: npm ci
-      - name: Run Vitest
-        run: npm run test
+      - name: Install bun
+        uses: oven-sh/setup-bun@v2
+      - run: bun install
+      - run: bun run test

.github/workflows/vitest.yml .github/workflows/test.yml.github/workflows/vitest.yml renamed to .github/workflows/test.yml

@@ -1,8 +1,9 @@
 node_modules/**/*
-build
-dist
 .DS_Store
 tmp
 .idea
 .env
-testing
+testing
+filen-cli.exe
+filen-cli
+build

.gitignore

@@ -0,0 +1,2 @@
+*
+!build/**

.npmignore

@@ -1,13 +1,28 @@
-FROM node:23-alpine AS build
+FROM oven/bun:1 AS base
 WORKDIR /filen-cli
+
+FROM base AS install
+
+RUN mkdir -p /temp/dev
+COPY package.json bun.lock /temp/dev/
+COPY patches/*.patch /temp/dev/patches/
+RUN cd /temp/dev && bun install --frozen-lockfile
+
+RUN mkdir -p /temp/prod
+COPY package.json bun.lock /temp/prod/
+COPY patches/*.patch /temp/prod/patches/
+RUN cd /temp/prod && bun install --frozen-lockfile --production
+
+FROM base AS prerelease
+COPY --from=install /temp/dev/node_modules node_modules
 COPY . .
-ENV FILEN_IS_CONTAINER=true
-RUN npm ci && npm run build
+RUN bun build --target=bun --sourcemap --define IS_RUNNING_AS_CONTAINER=true src/index.ts --outdir build
 
-FROM node:23-alpine
-WORKDIR /filen-cli
-COPY --from=build /filen-cli/dist/bundle.js /filen-cli/filen.js
-ARG TARGETARCH
-RUN if [ "$TARGETARCH" = "amd64" ] ; then npm install @parcel/watcher-linux-x64-musl ; else npm install @parcel/watcher-linux-arm64-musl ; fi
+FROM base AS release
+COPY --from=install /temp/prod/node_modules node_modules
+COPY --from=prerelease /filen-cli/build build
+COPY --from=prerelease /filen-cli/package.json package.json
+
+USER bun
 EXPOSE 80
-ENTRYPOINT ["node", "filen.js"]
+ENTRYPOINT [ "bun", "run", "build/index.js" ]

Dockerfile

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-node build/index.js internal-export-docs-json
+bun start internal-export-docs-json
 
 cp ./filen-cli-docs.json ./filen-cli-docs/src/filen-cli-docs.json