From 2d820137ad8d9f5a608d72875e3c7c4877065215 Mon Sep 17 00:00:00 2001
From: Adrien Cacciaguerra <adrien.caccia@gmail.com>
Date: Wed, 1 May 2024 14:47:47 -0400
Subject: [PATCH] feat: add CodSpeed to the project

---
 .github/workflows/benchmark.yml |  31 +++
 .github/workflows/ci.yml        | 118 ---------
 .github/workflows/release.yml   | 429 --------------------------------
 Cargo.lock                      |  34 ++-
 lapce-app/Cargo.toml            |   2 +-
 5 files changed, 65 insertions(+), 549 deletions(-)
 create mode 100644 .github/workflows/benchmark.yml
 delete mode 100644 .github/workflows/ci.yml
 delete mode 100644 .github/workflows/release.yml

diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
new file mode 100644
index 0000000000..622c45f2be
--- /dev/null
+++ b/.github/workflows/benchmark.yml
@@ -0,0 +1,31 @@
+name: codspeed-benchmarks
+
+on:
+  # Run on pushes to the master branch
+  push:
+    branches:
+      - "master"
+  # Run on pull requests
+  pull_request:
+  # `workflow_dispatch` allows CodSpeed to trigger backtest
+  # performance analysis in order to generate initial data.
+  workflow_dispatch:
+
+jobs:
+  benchmarks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup rust toolchain, cache and cargo-codspeed binary
+        uses: moonrepo/setup-rust@v1
+        with:
+          cache-target: release
+          bins: cargo-codspeed
+
+      - name: Build the benchmark target(s)
+        run: cargo codspeed build -p lapce-app
+
+      - name: Run the benchmarks
+        uses: CodSpeedHQ/action@v2
+        with:
+          run: cargo codspeed run -p lapce-app
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
deleted file mode 100644
index f567c7ecd5..0000000000
--- a/.github/workflows/ci.yml
+++ /dev/null
@@ -1,118 +0,0 @@
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    types: [opened, synchronize, reopened, ready_for_review]
-
-name: CI
-
-concurrency:
-  group: ${{ github.ref }}-${{ github.workflow }}
-  cancel-in-progress: true
-
-env:
-  CARGO_TERM_COLOR: always
-  CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
-
-jobs:
-  build:
-    name: Rust on ${{ matrix.os }} (${{ join(matrix.features, ',') }})
-    if: github.event.pull_request.draft == false
-    needs: [fmt, clippy]
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ ubuntu-latest, macos-latest ]
-        include:
-          - os: windows-latest
-            features: []
-          - os: windows-latest
-            features: 
-              - lapce-app/portable
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install dependencies on Ubuntu
-        if: startsWith(matrix.os, 'ubuntu')
-        run: sudo make ubuntu-deps
-
-      - name: Update toolchain & add llvm-tools
-        run: |
-          rustup update --no-self-update
-          rustup component add llvm-tools-preview
-
-      - name: Cache Rust dependencies
-        uses: Swatinem/rust-cache@v2
-
-      - name: Fetch dependencies
-        run: cargo fetch --locked
-
-      - name: Build
-        if: ${{ join(matrix.features, ',') == '' }}
-        run: cargo build --frozen
-
-      - name: Build
-        if: ${{ join(matrix.features, ',') != '' }}
-        run: cargo build --frozen --features ${{ join(matrix.features, ',') }}
-
-      - name: Free space
-        if: startsWith(matrix.os, 'windows')
-        run: cargo clean
-
-      - name: Install cargo-llvm-cov
-        uses: taiki-e/install-action@cargo-llvm-cov
-
-      - name: Run tests and coverage
-        if: ${{ toJSON(matrix.features) == '[]' }}
-        run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
-
-      - name: Run doc tests
-        run: cargo test --doc --workspace
-
-      - uses: codecov/codecov-action@v4
-        with:
-          files: lcov.info
-
-  fmt:
-    name: Rustfmt
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Update toolchain & add rustfmt
-        run: |
-          rustup update
-          rustup component add rustfmt
-
-      - name: Run rustfmt
-        run: cargo fmt --all --check
-
-  clippy:
-    name: Clippy on ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Update toolchain & add clippy
-        run: |
-          rustup update --no-self-update
-          rustup component add clippy
-
-      - name: Install dependencies on Ubuntu
-        if: startsWith(matrix.os, 'ubuntu')
-        run: sudo make ubuntu-deps
-
-      - name: Cache Rust dependencies
-        uses: Swatinem/rust-cache@v2
-        
-      - name: Fetch dependencies
-        run: cargo fetch --locked
-
-      - name: Run clippy
-        run: cargo clippy
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
deleted file mode 100644
index c088226f03..0000000000
--- a/.github/workflows/release.yml
+++ /dev/null
@@ -1,429 +0,0 @@
-name: Release
-
-on:
-  schedule:
-    - cron: 0 0 * * *
-  workflow_dispatch:
-    inputs:
-      tag_name:
-        description: "Tag name for release"
-        required: false
-        default: nightly
-  push:
-    tags: ["v[0-9]+.[0-9]+.[0-9]+*"]
-  pull_request:
-    paths:
-      # trigger release workflow only if this file changed
-      - .github/workflows/release.yml
-
-concurrency:
-  group: ${{ github.ref }}-${{ github.workflow }}
-  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
-
-env:
-  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  CARGO_TERM_COLOR: always
-
-jobs:
-  tagname:
-    runs-on: ubuntu-latest
-    outputs:
-      tag_name: ${{ steps.tag.outputs.tag }}
-    steps:
-      - id: vars
-        shell: bash
-        run: echo "sha_short=${GITHUB_SHA::7}" | tee -a $GITHUB_OUTPUT
-
-      - if: github.event_name == 'workflow_dispatch'
-        run: echo "TAG_NAME=${{ github.event.inputs.tag_name }}" | tee -a $GITHUB_ENV
-
-      - if: github.event_name == 'schedule' || github.event_name == 'pull_request'
-        run: echo 'TAG_NAME=nightly-${{ steps.vars.outputs.sha_short }}' | tee -a $GITHUB_ENV
-
-      - if: github.event_name == 'push'
-        run: |
-          TAG_NAME=${{ github.ref }}
-          echo "TAG_NAME=${TAG_NAME#refs/tags/}" | tee -a $GITHUB_ENV
-
-      - id: tag
-        run: echo "tag=$TAG_NAME" | tee -a $GITHUB_OUTPUT
-
-  windows:
-    runs-on: windows-latest
-    needs: tagname
-    env:
-      RELEASE_TAG_NAME: ${{ needs.tagname.outputs.tag_name }}
-
-    defaults:
-      run:
-        shell: bash
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Update rust
-        run: rustup update --no-self-update
-
-      - name: Fetch dependencies
-        run: cargo fetch --locked
-
-      - name: Build
-        run: cargo build --frozen --profile release-lto
-
-      - name: Crate msi installer
-        run: |
-          candle.exe -arch "x64" -ext WixUIExtension -ext WixUtilExtension \
-            -out "./lapce.wixobj" "extra/windows/wix/lapce.wxs"
-
-          light.exe -ext WixUIExtension -ext WixUtilExtension \
-            -out "./Lapce-windows.msi" -sice:ICE61 -sice:ICE91 \
-            "./lapce.wixobj"
-
-      - name: Create portable
-        shell: pwsh
-        run: |
-          cargo build --profile release-lto --features lapce-app/portable
-          Compress-Archive ./target/release-lto/lapce.exe ./Lapce-windows-portable.zip
-
-      - name: Create lapce-proxy archive
-        shell: pwsh
-        run: |
-          $file = [System.IO.File]::Open((Join-Path $PWD '.\target\release-lto\lapce-proxy.exe'), [System.IO.FileMode]::Open)
-          $archive = [System.IO.File]::Create((Join-Path $PWD '.\lapce-proxy-windows-x86_64.gz'))
-          $compressor = [System.IO.Compression.GZipStream]::new($archive, [System.IO.Compression.CompressionMode]::Compress)
-          $file.CopyTo($compressor)
-          Start-Sleep -Seconds 10
-          $compressor.close()
-
-      - uses: actions/upload-artifact@v4
-        with:
-          name: lapce-windows
-          path: |
-            ./lapce-proxy-windows-*.gz
-            ./Lapce-windows-portable.zip
-            ./Lapce-windows.msi
-          retention-days: 1
-
-  linux:
-    runs-on: ubuntu-latest
-    needs: tagname
-    env:
-      RELEASE_TAG_NAME: ${{ needs.tagname.outputs.tag_name }}
-    steps:
-      - uses: actions/checkout@v4
-      - name: Build deb packages
-        run: |
-          docker buildx create --driver=docker-container --use
-          docker buildx bake --pull ubuntu-focal-binary
-
-      - name: Gzip
-        run: |
-          mkdir Lapce
-          cp ./target/linux_amd64/lapce Lapce/
-          tar -zcvf ./lapce-linux-amd64.tar.gz Lapce
-
-          rm -rf Lapce
-
-          mkdir Lapce
-          cp ./target/linux_arm64/lapce Lapce/
-          tar -zcvf ./lapce-linux-arm64.tar.gz Lapce
-
-      - name: Fetch dependencies
-        run: cargo fetch --locked
-
-      - name: Vendor dependencies
-        run: |
-          cargo vendor --frozen > ./vendor-config.toml
-          mv ./vendor-config.toml ./vendor/
-          tar -zcf vendor.tar.gz ./vendor/
-
-      - uses: actions/upload-artifact@v4
-        with:
-          name: lapce-linux
-          path: |
-            ./lapce-linux-*.tar.gz
-            ./vendor.tar.gz
-          retention-days: 1
-
-  deb:
-    runs-on: ubuntu-latest
-    needs: tagname
-    env:
-      RELEASE_TAG_NAME: ${{ needs.tagname.outputs.tag_name }}
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - os-name: debian
-            os-version: bookworm
-          - os-name: debian
-            os-version: bullseye
-          - os-name: ubuntu
-            os-version: focal
-          - os-name: ubuntu
-            os-version: jammy
-          - os-name: ubuntu
-            os-version: lunar
-          - os-name: ubuntu
-            os-version: mantic
-          # - os-name: ubuntu
-          #   os-version: noble
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Build deb packages
-        run: |
-          docker buildx create --driver=docker-container --use
-          docker buildx bake --pull ${{ matrix.os-name }}-${{ matrix.os-version }}-package
-
-      - uses: actions/upload-artifact@v4
-        with:
-          name: lapce-${{ matrix.os-name }}-${{ matrix.os-version }}
-          path: |
-            ./target/linux_*/*
-          retention-days: 1
-
-  rpm:
-    runs-on: ubuntu-latest
-    needs: tagname
-    env:
-      RELEASE_TAG_NAME: ${{ needs.tagname.outputs.tag_name }}
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - os-name: fedora
-            os-version: 39
-          - os-name: fedora
-            os-version: 40
-          # - os-name: fedora
-          #   os-version: 41
-          # - os-name: fedora
-          #   os-version: rawhide
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Build rpm packages
-        run: |
-          docker buildx create --driver=docker-container --use
-          docker buildx bake --pull ${{ matrix.os-name }}-${{ matrix.os-version }}-package
-
-      - uses: actions/upload-artifact@v4
-        with:
-          name: lapce-${{ matrix.os-name }}-${{ matrix.os-version }}
-          path: |
-            ./target/*
-          retention-days: 1
-
-  linux-musl:
-    name: Build lapce-proxy for ${{ matrix.platform }}
-    runs-on: ubuntu-latest
-    needs: tagname
-    env:
-      RELEASE_TAG_NAME: ${{ needs.tagname.outputs.tag_name }}
-      CROSS_SYSROOT: /mnt/alpine-${{ matrix.platform }}
-      PACKAGES: >
-        zlib-static freetype-static fontconfig-static
-        libgit2-static libssh2-static openssl-libs-static
-        libssl3 gtk+3.0-dev http-parser-dev rustup
-        build-base openssl-dev git lld clang
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - triple: x86_64-unknown-linux-musl
-            platform: x86_64
-          - triple: aarch64-unknown-linux-musl
-            platform: aarch64
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Alpine Linux for ${{ matrix.platform }} (target arch)
-        id: alpine-target
-        uses: jirutka/setup-alpine@v1
-        with:
-          arch: ${{ matrix.platform }}
-          branch: v3.18
-          packages: ${{ env.PACKAGES }}
-          shell-name: alpine-target.sh
-
-      - name: Set up Alpine Linux for x86_64 (build arch)
-        uses: jirutka/setup-alpine@v1
-        with:
-          arch: x86_64
-          branch: v3.18
-          packages: ${{ env.PACKAGES }}
-          volumes: ${{ steps.alpine-target.outputs.root-path }}:${{ env.CROSS_SYSROOT }}
-          shell-name: alpine.sh
-
-      - name: Install Rust stable toolchain via rustup
-        run: rustup-init --target ${{ matrix.triple }} --default-toolchain stable --profile minimal -y
-        shell: alpine.sh {0}
-
-      - name: Build ${{ matrix.triple }}
-        shell: alpine.sh {0}
-        env:
-          LIBZ_SYS_STATIC: 1
-          LIBSSH2_STATIC: 1
-          LIBGIT2_STATIC: 1
-          OPENSSL_STATIC: 1
-          OPENSSL_DIR: ${{ env.CROSS_SYSROOT }}/usr # static/dynamic lib workaround <3
-          OPENSSL_NO_VENDOR: 1 # don't even try to build without it on musl
-          PKG_CONFIG_ALL_STATIC: 1
-          PKG_CONFIG_LIBDIR: ${{ env.CROSS_SYSROOT }}/usr/lib/pkgconfig
-          RUSTFLAGS: -C target-feature=+crt-static -C linker=/usr/bin/ld.lld # link runtime static, use universal linker
-          CARGO_BUILD_TARGET: ${{ matrix.triple }}
-          CARGO_PROFILE_RELEASE_LTO: "true"
-          CARGO_PROFILE_RELEASE_STRIP: symbols # remove unneeded debug stuff
-          CARGO_PROFILE_RELEASE_OPT_LEVEL: "s" # optimise for size
-          CARGO_PROFILE_RELEASE_CODEGEN_UNITS: "1" # optimise each crate
-          SYSROOT: /dummy # workaround for https://github.com/rust-lang/pkg-config-rs/issues/102
-          CC: clang
-        run: |
-          # Workaround for https://github.com/rust-lang/pkg-config-rs/issues/102
-          echo -e '#!/bin/sh\nPKG_CONFIG_SYSROOT_DIR=${{ env.CROSS_SYSROOT }} exec pkgconf "$@"' \
-              | install -m755 /dev/stdin pkg-config
-          export PKG_CONFIG="$(pwd)/pkg-config"
-          cargo fetch --locked
-          cargo build \
-            --frozen \
-            --verbose \
-            --release \
-            --bin lapce-proxy \
-            --manifest-path lapce-proxy/Cargo.toml
-
-      - name: Gzip
-        run: |
-          gzip -c ./target/${{ matrix.triple }}/release/lapce-proxy > ./lapce-proxy-linux-${{ matrix.platform }}.gz
-
-      - uses: actions/upload-artifact@v4
-        with:
-          name: lapce-proxy-linux-${{ matrix.platform }}
-          path: |
-            ./lapce-proxy-linux-*.gz
-          retention-days: 1
-
-  macos:
-    runs-on: macos-11
-    needs: tagname
-    env:
-      RELEASE_TAG_NAME: ${{ needs.tagname.outputs.tag_name }}
-
-      NOTARIZE_USERNAME: ${{ secrets.NOTARIZE_USERNAME }}
-      NOTARIZE_PASSWORD: ${{ secrets.NOTARIZE_PASSWORD }}
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install ARM target
-        run: rustup update && rustup target add aarch64-apple-darwin
-
-      - name: Import Certificate
-        uses: lapce/import-codesign-certs@72dec84923586f8bef2bed09fdb4f9475c8f623d # use updated action, can be dropped once/if upstream is fixed
-        with:
-          p12-file-base64: ${{ secrets.MACOS_CERTIFICATE }}
-          p12-password: ${{ secrets.MACOS_CERTIFICATE_PWD }}
-
-      - name: Fetch dependencies
-        run: cargo fetch --locked
-
-      - name: Make DMG
-        run: make dmg-universal
-
-      - name: Rename
-        run: |
-          cp ./target/release-lto/macos/Lapce.dmg ./target/release-lto/macos/Lapce-macos.dmg
-
-      - name: Gzip lapce-proxy
-        run: |
-          gzip -c ./target/x86_64-apple-darwin/release-lto/lapce-proxy > ./target/release-lto/macos/lapce-proxy-darwin-x86_64.gz
-          gzip -c ./target/aarch64-apple-darwin/release-lto/lapce-proxy > ./target/release-lto/macos/lapce-proxy-darwin-aarch64.gz
-
-      - name: Notarize Release Build
-        uses: lando/notarize-action@v2
-        with:
-          product-path: "./target/release-lto/macos/Lapce-macos.dmg"
-          appstore-connect-username: ${{ secrets.NOTARIZE_USERNAME }}
-          appstore-connect-password: ${{ secrets.NOTARIZE_PASSWORD }}
-          appstore-connect-team-id: CYSGAZFR8D
-          primary-bundle-id: "io.lapce"
-          
-
-      - name: "Staple Release Build"
-        uses: lapce/xcode-staple@062485d6eeafe841c18a412f012e80f49e23c517
-        with:
-          product-path: "./target/release-lto/macos/Lapce-macos.dmg"
-
-      - uses: actions/upload-artifact@v4
-        with:
-          name: lapce-macos
-          path: |
-            ./target/release-lto/macos/lapce-proxy-darwin-*.gz
-            ./target/release-lto/macos/Lapce-macos.dmg
-          retention-days: 1
-
-  publish:
-    needs:
-      - linux
-      - linux-musl
-      - deb
-      - rpm
-      - windows
-      - macos
-    runs-on: ubuntu-latest
-    env:
-      GH_REPO: ${{ github.repository }}
-      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-    permissions:
-      contents: write
-    steps:
-      # Must perform checkout first, since it deletes the target directory
-      # before running, and would therefore delete the downloaded artifacts
-      - uses: actions/checkout@v4
-
-      - uses: actions/download-artifact@v4
-
-      - if: github.event_name == 'workflow_dispatch'
-        run: echo "TAG_NAME=${{ github.event.inputs.tag_name }}" | tee -a $GITHUB_ENV
-
-      - if: github.event_name == 'schedule'
-        run: echo 'TAG_NAME=nightly' | tee -a $GITHUB_ENV
-
-      - if: github.event_name == 'push'
-        run: |
-          TAG_NAME=${{ github.ref }}
-          echo "TAG_NAME=${TAG_NAME#refs/tags/}" | tee -a $GITHUB_ENV
-
-      - if: env.TAG_NAME == 'nightly'
-        run: |
-          {
-            echo 'SUBJECT=Lapce development build'
-            echo 'PRERELEASE=--prerelease'
-          } | tee -a $GITHUB_ENV
-
-      - if: env.TAG_NAME == 'nightly' && github.event_name != 'pull_request'
-        name: Re-Tag nightly
-        run: |
-          gh release delete nightly --yes || true
-          git push origin :nightly || true
-
-      - if: env.TAG_NAME != 'nightly'
-        run: |
-          {
-            echo 'SUBJECT=Lapce release build'
-            echo 'PRERELEASE='
-          } | tee -a $GITHUB_ENV
-
-      - name: Publish release
-        if: github.event_name != 'pull_request'
-        env:
-          DEBUG: api
-        run: |
-          gh release create $TAG_NAME $PRERELEASE --title "$TAG_NAME" --target $GITHUB_SHA \
-            lapce-macos/* \
-            lapce-linux/* \
-            lapce-debian*/*/* \
-            lapce-ubuntu*/*/* \
-            lapce-fedora*/* \
-            lapce-proxy-linux-*/* \
-            lapce-windows/*
diff --git a/Cargo.lock b/Cargo.lock
index 9a2e17508b..54076725f7 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -866,12 +866,44 @@ dependencies = [
  "unicode-width",
 ]
 
+[[package]]
+name = "codspeed"
+version = "2.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3a104ac948e0188b921eb3fcbdd55dcf62e542df4c7ab7e660623f6288302089"
+dependencies = [
+ "colored",
+ "libc",
+ "serde_json",
+]
+
+[[package]]
+name = "codspeed-criterion-compat"
+version = "2.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "722c36bdc62d9436d027256ce2627af81ac7a596dfc7d13d849d0d212448d7fe"
+dependencies = [
+ "codspeed",
+ "colored",
+ "criterion",
+]
+
 [[package]]
 name = "color_quant"
 version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3d7b894f5411737b7867f4827955924d7c254fc9f4d91a6aad6b097804b1018b"
 
+[[package]]
+name = "colored"
+version = "2.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cbf2150cce219b664a8a70df7a1f933836724b503f8a413af9365b4dcc4d90b8"
+dependencies = [
+ "lazy_static",
+ "windows-sys 0.48.0",
+]
+
 [[package]]
 name = "com"
 version = "0.6.0"
@@ -2963,8 +2995,8 @@ dependencies = [
  "bytemuck",
  "chrono",
  "clap",
+ "codspeed-criterion-compat",
  "config",
- "criterion",
  "crossbeam-channel",
  "directories",
  "dmg",
diff --git a/lapce-app/Cargo.toml b/lapce-app/Cargo.toml
index 86287b2d14..85a638bdcc 100644
--- a/lapce-app/Cargo.toml
+++ b/lapce-app/Cargo.toml
@@ -97,7 +97,7 @@ all-languages = [
 ]
 
 [dev-dependencies]
-criterion = "0.5"
+criterion = { version = "2.6.0", package = "codspeed-criterion-compat" }
 
 [[bench]]
 name    = "visual_line"