fix: updating branch name fallbacks for GitHub Actions recordings

[tbiethman]

• Closes Unexpected branch values are used for recordings produced by GitHub Actions #27389

Additional details

Note from the above issue:

We have also had some discussion related to normalizing the environment's raw git data and environment variables within the recording service directly, essentially offloading the offending logic here into the cloud. This would give Cypress a better avenue to respond to changes in the various CI environments in the future without requiring a specific app release. A spike has been logged internally to investigate that option and any potential tradeoffs. The proposal described above seems like a quick enough win to get the correct data recorded in the meantime.

Steps to test

Unit tests have been updated to validate the expected environment mappings. It will be difficult to test this end-to-end without some mocking, but given the changes made, I feel like the unit tests provide good coverage.

How has the user experience changed?

If a user:

• Is recording cypress runs as part of a GitHubAction workflow, and
• Is not specifying a branch name with the COMMIT_INFO_BRANCH env, and
• Is not using the cypress/github-action (and thus not setting the GH_BRANCH env)

Then the Cypress recorded cypress runs will be attributed to a branch's short name (tbiethman/fix/gha-branch) rather than a PR's ref name (refs/pulls/merge/27409) or a commit's ref name (refs/heads/tbiethman/fix/gha-branch).

PR Tasks

• Have tests been added/updated?
• [n/a] Has a PR for user-facing changes been opened in cypress-documentation?
• [n/a] Have API changes been updated in the type definitions?

[tbiethman]

While I was in here, I added the GHA variables we use for commit fallbacks (+ GITHUB_REF for completeness) to the ci_params mapping. These additions aren't necessary to correct the current fallback values, but they may be useful in the future for further inspection of the recordings.

[cypress]

6 flaky tests on run #49256 ↗︎

0

5266

137

0

6

Details:

Updating telemetry too
Project: cypress	Commit: 3114c3e0ff
Status: Passed	Duration: 12:35 💡
Started: Jul 27, 2023 7:04 PM	Ended: Jul 27, 2023 7:16 PM

  commands/net_stubbing.cy.ts • 1 flaky test • 5x-driver-firefox

View Output Video

Test		Artifacts
network stubbing > intercepting request > can delay and throttle a StaticResponse		Output

  e2e/origin/commands/navigation.cy.ts • 1 flaky test • 5x-driver-firefox

View Output Video

Test		Artifacts
cy.origin navigation > #consoleProps > .go()		Output

  e2e/origin/basic_login.cy.ts • 1 flaky test • 5x-driver-firefox

View Output Video

Test		Artifacts
Multi-step Auth > final-auth redirects back to localhost - flat		Output

  cypress/cypress.cy.js • 3 flaky tests • 5x-driver-firefox

View Output Video

Test		Artifacts
... > correctly returns currentRetry		Output
... > correctly returns currentRetry		Output
... > correctly returns currentRetry		Output

_{This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.}

[cypress-bot]

Released in 12.17.3.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v12.17.3, please open a new issue.