Execution API detection #145
Merged
Conversation
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
This reverts commit a6cef8b.
…port server version info on error
benPearce1
reviewed
Jan 27, 2023
| const response = await client.get<CapabilitiesResponse>(`${apiLocation}/capabilities`); | ||
| return response.Capabilities.filter((c) => c === capabilityName).length === 1 | ||
| ? null | ||
| : `The Octopus instance does not support ${capabilityName}, you may need to upgrade it to get access to the feature you are trying to use.`; |
There was a problem hiding this comment.
extend this message to include a link/callout to support, and the same for the messages below
benPearce1
reviewed
Jan 27, 2023
| } | ||
|
|
||
| async create(command: CreateReleaseCommandV1): Promise<CreateReleaseResponseV1> { | ||
| const capabilityError = await checkForCapability(this.client, "CreateReleaseCommandV1"); |
There was a problem hiding this comment.
Is there a way we can link between the command that we are creating and the capability string? Perhaps the capability id could go in the Command object itself.
Just a thought
There was a problem hiding this comment.
What I'd love is for TS to support some equivalent to typeof(CreateReleaseCommandV1).Name that we have in C#, but it doesn't have such support.
There was a problem hiding this comment.
yeah, that was the sort of thing I had in mind
benPearce1
approved these changes
Jan 27, 2023
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.
This PR adds calls to the Capabilities API, so the users will get clearer error information if they're using something that relies on the Executions API but their Octopus instance is too old.
The
checkForCapabilitymethod does not throw on purpose, that's the caller's choice. In the current calls, they do happen to all be errors that will throw, but in a number of cases for future use this method can be used to feature sniff with fallback behaviour.