Validate API key and endpoint before making requests#1251
Merged
josephjclark merged 2 commits intorelease/nextfrom Feb 17, 2026
Merged
Validate API key and endpoint before making requests#1251josephjclark merged 2 commits intorelease/nextfrom
josephjclark merged 2 commits intorelease/nextfrom
Conversation
Throw a clear error when OPENFN_API_KEY or OPENFN_ENDPOINT is missing instead of letting it fall through to a cryptic TypeError: Invalid URL. See #1249
The endpoint can come from the local project file (not just env/CLI args), so validating in loadAppAuthConfig is too early. Move the check to getLightningUrl where the endpoint is actually consumed.
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
2 participants
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.
Short Description
Throw a clear error when
OPENFN_API_KEYorOPENFN_ENDPOINTis missing instead of letting it fall through to a crypticTypeError: Invalid URL.See #1249
Implementation Details
In
loadAppAuthConfig(projects/util.ts), whenOPENFN_ENDPOINTis not set,config.endpointstaysundefined. This later causesnew URL('/api/provision/...', undefined)ingetLightningUrlto throwTypeError: Invalid URL, which is not helpful to the user.There was already a
// TODO probably need to throwon line 35 anticipating this. This PR fills in that TODO with early validation for bothapiKeyandendpoint, with actionable error messages.QA Notes
.envwith onlyOPENFN_API_KEY(noOPENFN_ENDPOINT)openfn project pull <uuid> -c .envOPENFN_ENDPOINT is required...instead ofTypeError: Invalid URLOPENFN_API_KEYtoo and verify you getOPENFN_API_KEY is required...AI Usage