Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: 21634 Check for semver constraint matching in application webhook handler #21648

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

eadred
Copy link
Contributor

@eadred eadred commented Jan 23, 2025

The sourceRevisionHasChanged method, rather than doing a simple equality check, now checks if the revision supplied by the webhook matches the target revision's semver constraint, if the latter is a constraint.

Fixes #21634

This change ought to be possible to cherry-pick back as far as 2.12 (support for semver constraints for Git revisions isn't present in 2.11).

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

@eadred eadred requested a review from a team as a code owner January 23, 2025 08:46
Copy link

bunnyshell bot commented Jan 23, 2025

❗ Preview Environment stop on Bunnyshell failed

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔴 /bns:stop to stop again the environment
  • 🔵 /bns:start to start the environment
  • 🚀 /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

return false
}

return constraint.Check(version)
Copy link
Contributor Author

@eadred eadred Jan 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose in theory this logic could trigger an unnecessary sync if the new tag is not the latest tag that would match the constraint.

For example, if the constraint was "1.1.*", there was already a tag "1.1.5" which the application was already synced to, and somebody introduces (or moves) a tag "1.1.4". A sync would be triggered, but the outcome (as decided by resolveSemverRevision in util/git/client.go) would still be that the application would select the "1.1.5" revision.

However, I doubt this is a circumstance that would happen for any sensible SemVer tagging strategy.

Copy link

codecov bot commented Jan 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (master@3593f24). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff            @@
##             master   #21648   +/-   ##
=========================================
  Coverage          ?   53.18%           
=========================================
  Files             ?      339           
  Lines             ?    57211           
  Branches          ?        0           
=========================================
  Hits              ?    30425           
  Misses            ?    24152           
  Partials          ?     2634           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Gitlab webhook tag push events are ignored when source target revision is a Semver constraint
1 participant