api: reject invalid destination URLs at the API boundary#2
Open
ademboukabes wants to merge 1 commit into
Open
Conversation
Destinations with a non-http/https scheme or a missing host were silently accepted and only failed later in the delivery worker, moving the event to dead-letter with no clear error for the user. validateURL now catches this on POST and PATCH /destinations, and tests cover the main invalid cases.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Currently, destinations with malformed or unsupported URLs (e.g., missing scheme,
ftp://, relative paths) are silently accepted and stored by the API. The error only manifests later in the delivery worker, which moves the event to the dead-letter queue. This results in a poor user experience as the user receives no immediate feedback that their destination URL is invalid.Solution
This PR introduces a
validateURLhelper that validates the destination URL synchronously at the API boundary.httporhttps.POST /destinationsandPATCH /destinations/{id}endpoints.Verification
http,https, relative paths, missing scheme,ftp://, empty hosts).go vetandgo test -race ./...pass successfully.