name: docs-and-testcov

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

on:
  push:
    branches: [main, docs_page]
  # pull_request:
  #   branches: [main]
  workflow_dispatch:
  workflow_run:
    workflows: ["run-benchmarks"]
    types:
      - completed

permissions:
  contents: read
  id-token: write
  pages: write

jobs:
  pick-runner:
    runs-on: ubuntu-latest
    outputs:
      runner: ${{ steps.choose.outputs.use-runner }}
    steps:
      - uses: actions/checkout@v4

      - id: choose
        uses: ./.github/actions/runner-fallback
        with:
          primary-runner: "self-hosted"
          fallback-runner: "ubuntu-latest"
          github-token: ${{ secrets.CUSTOM_GH_TOKEN }}

  docs-and-testcov:
    needs: pick-runner
    runs-on: ${{ fromJson(needs.pick-runner.outputs.runner) }}

    steps:
      - uses: actions/checkout@v4

      - name: Set up Rust
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
          override: true

      - name: Replace logo URL in README.md
        env:
          LOGO_URL: ${{ secrets.LOGO_URL }}
        run: |
          # replace  with EXAMPLE.COM/LOGO

          sed -i 's|.github/rustframe_logo.png|rustframe_logo.png|g' README.md

      - name: Build documentation
        run: cargo doc --no-deps --release

      - name: Prepare documentation for Pages
        run: |

      - name: Install Cargo binstall
        uses: cargo-bins/cargo-binstall@main

      - name: Install cargo-tarpaulin via binstall
        run: cargo binstall cargo-tarpaulin --no-confirm --locked

      - name: Generate coverage report
        run: |
          mkdir -p testcov
          cargo tarpaulin --engine llvm --out Html --out Json

      - name: Check for tarpaulin-report.html
        run: |
          if [ ! -f tarpaulin-report.html ]; then
            echo "tarpaulin-report.html not found!"
            exit 1
          fi

      - name: Export tarpaulin coverage badge JSON
        # extract raw coverage and round to 2 decimal places
        run: |
          coverage=$(jq '.coverage' tarpaulin-report.json)
          formatted=$(printf "%.2f" "$coverage")
          jq --arg message "$formatted" \
            '{schemaVersion:1,
              label:"tarpaulin-report",
              message:$message,
              color:"blue"}' \
            tarpaulin-report.json \
          > tarpaulin-badge.json

      - name: Save last commit date JSON
        run: |
          last_commit_date=$(git log -1 --format=%cd --date=short)
          jq --arg date "$last_commit_date" \
            '{schemaVersion:1,
              label:"last-commit-date",
              message:$date,
              color:"blue"}' \
            <(echo '{}') \
          > last-commit-date.json

      - name: Download last available benchmark report
        run: |
          artifact_url=$(gh api -H "Accept: application/vnd.github+json" \
            /repos/${{ github.repository }}/actions/artifacts \
            | jq -r '.artifacts[] | select(.name | startswith("benchmark-reports")) | .archive_download_url' | head -n 1)

          if [ -z "$artifact_url" ]; then
            echo "No benchmark artifact found!"
            exit 1
          fi

          curl -L -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
            -o benchmark-report.zip "$artifact_url"

          mkdir -p benchmark-report
          unzip benchmark-report.zip -d benchmark-report
          # there will be a tar file in the benchmark-report directory 
          # called artifact.tar. unzip it into the benchmark-report
          tar -xvf benchmark-report/artifact.tar -C benchmark-report
          # remove the artifact.tar file
          rm benchmark-report/artifact.tar
          # add an index.html that points to benchmark-report/report/index.html
          echo "<meta http-equiv=\"refresh\" content=\"0; url=report/index.html\">" > benchmark-report/index.html

      - name: Copy files to output directory
        run: |
          # mkdir docs
          mkdir -p target/doc/docs
          mv target/doc/rustframe/* target/doc/docs/

          mkdir output
          cp tarpaulin-report.html target/doc/docs/
          cp tarpaulin-report.json target/doc/docs/
          cp tarpaulin-badge.json target/doc/docs/
          cp last-commit-date.json target/doc/docs/
          # cp -r .github target/doc/docs
          cp .github/rustframe_logo.png target/doc/docs/
          echo "<meta http-equiv=\"refresh\" content=\"0; url=docs\">" > target/doc/index.html
          touch target/doc/.nojekyll

          # copy the benchmark report to the output directory
          cp -r benchmark-report target/doc/

      # verify that logo exists in the output directory
      - name: Verify logo directory
        run: |
          if [ ! -f target/doc/docs/rustframe_logo.png ]; then
            echo "Logo not found in output directory!"
            exit 1
          fi

      - name: Upload Pages artifact
        # if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
        uses: actions/upload-pages-artifact@v3
        with:
          path: target/doc/

      - name: Deploy to GitHub Pages
        # if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
        uses: actions/deploy-pages@v4