refactor: Moved the orb validation in a orb API module #968
Conversation
This file contains 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
loderunner
requested changes
Jul 20, 2023
JulesFaucherre
force-pushed
the
task/DEVEX-1028/cli-abstract-api-calls-to-allow-better-testing-and-backward-compatibility-ORB-ABSTRACTION
branch
from
6b037c0 to
e1efa1a
Compare
loderunner
requested changes
Aug 7, 2023
| } | ||
| } | ||
|
|
||
| func detectClientVersion(gql *graphql.Client) (clientVersion, error) { |
There was a problem hiding this comment.
The internals of this function aren't necessarily clear. It might be worth commenting why "handling owner ID" results in being able to differentiate between v1 and v2. What do you think?
loderunner
approved these changes
Aug 8, 2023
JulesFaucherre
force-pushed
the
task/DEVEX-1028/cli-abstract-api-calls-to-allow-better-testing-and-backward-compatibility-ORB-ABSTRACTION
branch
from
bc2b2f3 to
d3625e8
Compare
JulesFaucherre
deleted the
task/DEVEX-1028/cli-abstract-api-calls-to-allow-better-testing-and-backward-compatibility-ORB-ABSTRACTION
branch
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Checklist
Changes
Started implementing an orb API abstraction by moving the orb validation. The interest of this module is that it will handle the different server version and return a client that is matching the Server version used
Rationale
An issue had been opened before to allow users to validate orbs that use private orbs. An
ownerIdhas been added to the GraphQL API to enable this. Because of this change to the API, this created a potential difference between Server customers and standard customers. We handled this potential difference in the API call code directly but decided that we would handle in a better way in the near future. This is the new version of how we handle this backward compatibility.Previous Jira ticket: https://circleci.atlassian.net/browse/DEVEX-856
Considerations
Created the
OrbClientas a lazy-evaluated singleton because it allows it to be imported from anywhere in the codeScreenshots
Not much to show, the behaviour is still the same