ci: migrate to Sauce Connect 5

[GraemeWatt]

Sauce Connect 5 was recently released with general availability. The announcement email says:

Note that Sauce Connect 4.0 is transitioning into maintenance mode, where it will receive bug fix releases exclusively until its end-of-life in December 2024. Please plan accordingly and reach out if you have any questions or concerns.

I've spent the last couple of days trying to get Sauce Connect 5 working on my laptop (macOS 14.2.1) without success. One breaking change is that a tunnel name is now required. It can be specified with -i "${SAUCE_USERNAME}_tunnel_name" then using the same tunnel name in tests/e2e/conftest.py:

hepdata/tests/e2e/conftest.py

Line 211 in 3589838

'tunnelName': os.environ.get('GITHUB_RUN_ID', ''),

For example, use 'tunnelName': os.environ.get('GITHUB_RUN_ID', local_tunnel_name) where local_tunnel_name = os.environ.get('SAUCE_USERNAME', '') + '_tunnel_name'. After this change, I could start Sauce Connect, but I got an error message trying a live local test:

sauce_connect proxying is denied to host "localhost:5000"
localhost proxying is disabled

I added an option --proxy-localhost allow or --proxy-localhost direct and the live local test partially succeeded in that the HEPData homepage was displayed, but I could not navigate to other pages. The end-to-end tests all failed with timeouts. I have tried various other options without success. This problem should be investigated further and overcome by the end of 2024.

[GraemeWatt]

Latest information from Sauce Labs regarding support for Sauce Connect 4:

As of December 31, 2024, support will be discontinued, meaning there will be no further bug fixes or improvements. Additionally, Sauce Connect 4 will officially reach its end of life on May 5, 2025, after which no tunnels will be available.

I reported the timeout issue with Sauce Connect 5 to Sauce Labs support on 21st August 2024. After several iterations and attempts to find a workaround, it looks like the problem has finally been resolved on the Sauce Labs side. The live local test is now successful and the end-to-end tests can (sometimes!) be run successfully without timing out.

I started a branch sauce-connect-5 with a commit to migrate to Sauce Connect 5 in the GitHub Actions workflow. However, the GitHub action sauce-connect-action does not currently support Sauce Connect 5 or the necessary --proxy-localhost direct option. I opened an issue saucelabs/sauce-connect-action#88 but the repository doesn't seem to be actively maintained. I'm waiting to hear from Sauce Labs support whether there will be an official GitHub action for Sauce Connect 5. Otherwise, we would need to switch to running Sauce Connect 5 via Docker in the GitHub Actions workflow.