From 678053be6b11368cfcecd77219ec36e853de38fd Mon Sep 17 00:00:00 2001
From: Jonathan Fischer PEPE <jfisch27@jhu.edu>
Date: Sun, 17 Nov 2024 17:44:26 -0500
Subject: [PATCH] added logging and sleep/verify step for xvfb framebuffer

---
 .github/workflows/Documentation.yml | 56 ++++++++++++++++++++---------
 1 file changed, 40 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
index 31984e5f23..513eb2a842 100644
--- a/.github/workflows/Documentation.yml
+++ b/.github/workflows/Documentation.yml
@@ -22,11 +22,34 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      # Install binary dependencies needed for GLMakie to run in a headless environment
-      # xvfb: Creates a virtual frame buffer to simulate a display
-      # libgl1, mesa-utils, freeglut3-dev, xorg-dev, libxrandr-dev, libxinerama-dev, libxcursor-dev, libxi-dev, libxext-dev: Required libraries for OpenGL rendering
+      # Install all required X11 and OpenGL libraries
+      # These are needed for GLMakie to work in a headless environment
       - name: Install binary dependencies
-        run: sudo apt-get update && sudo apt-get install -y xvfb libgl1 mesa-utils freeglut3-dev xorg-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y xvfb libgl1 mesa-utils freeglut3-dev xorg-dev \
+            libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
+
+      # Start Xvfb explicitly instead of using xvfb-run
+      # This gives us more control and visibility into the virtual display setup
+      - name: Setup and verify virtual framebuffer
+        run: |
+          # Start Xvfb on display :99
+          /usr/bin/Xvfb :99 -screen 0 1024x768x24 &
+          echo "Waiting for Xvfb to start..."
+          sleep 3
+          
+          # Test if Xvfb is accepting connections
+          echo "Testing Xvfb connection..."
+          if xdpyinfo -display :99 >/dev/null 2>&1; then
+            echo "✓ Xvfb is running and accepting connections"
+            echo "DISPLAY=:99" >> $GITHUB_ENV
+          else
+            echo "✗ Failed to connect to Xvfb"
+            echo "Xvfb status:"
+            ps aux | grep Xvfb
+            exit 1
+          fi
 
       - name: Install Julia
         uses: julia-actions/setup-julia@latest
@@ -38,22 +61,23 @@ jobs:
         with:
           cache-name: docs-cache
 
-      # Install Julia package dependencies for the documentation project
+      # Install dependencies with the virtual display already running
       - name: Install dependencies
-        run: >
-          DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs/ -e 'ENV["JULIA_PKG_SERVER"] = ""; using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+        run: |
+          julia --project=docs/ -e '
+            ENV["JULIA_PKG_SERVER"] = "";
+            using Pkg;
+            Pkg.develop(PackageSpec(path=pwd()));
+            Pkg.instantiate()'
 
-      # Build and deploy the documentation using xvfb to simulate a display for GLMakie
-      # xvfb-run: Runs Julia with a virtual display to support OpenGL rendering
-      # --server-args: Configures the virtual display resolution and color depth
+      # Build documentation with the stable virtual display
       - name: Build and deploy
         env:
-          GKSwstype: "100" # Specifies the workstation type for GR framework rendering, https://discourse.julialang.org/t/generation-of-documentation-fails-qt-qpa-xcb-could-not-connect-to-display/60988/7
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Required for permissions to deploy documentation
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
-        run: >
-          DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' 
-          julia --project=docs --color=yes --code-coverage=user docs/make.jl
+          # GKSwstype=100 tells GR to use a different backend that works better in headless environments
+          GKSwstype: "100"
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia --project=docs --color=yes --code-coverage=user docs/make.jl
 
       - name: Upload site as artifact
         uses: actions/upload-artifact@v4