Replace duplicated IsEnterprise and IsTenancy functions in api pkg with auth pkg #173
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
jtmcg
changed the title
There were duplicated, unexported isEnterprise and isTenancy functions in the api package. The exported IsEnterprise and IsTenancy functions exist in the auth package. This removes the duplicated functions from api and replaces them with the exported packages from auth. It doesn't attempt to clean up any more logic than that.
jtmcg
changed the title
andyfeller
approved these changes
Oct 14, 2024
pkg/auth/auth.go
Outdated
Comment on lines
29
to
30
| // TenancyHost is the domain name of a tenancy GitHub instance. | ||
| tenancyHost = "ghe.com" |
There was a problem hiding this comment.
Looking at this I asked myself "Does VS Code really not try to fix the formatting on this one?" only to realize, no it doesn't.
Not the end of the world, but would rather the longer line with consistent formatting than shorter lines that are inconsistent. Not end of the world 🤷
Suggested change
| // TenancyHost is the domain name of a tenancy GitHub instance. | |
| tenancyHost = "ghe.com" | |
| tenancyHost = "ghe.com" // TenancyHost is the domain name of a tenancy GitHub instance. |
There was a problem hiding this comment.
Seems reasonable to me as it also bothered me 😅
williammartin
approved these changes
Oct 14, 2024
There was a problem hiding this comment.
Seems reasonable to me. Maybe there was an original intention here to adhere to
A little copying is better than a little dependency (https://go-proverbs.github.io/)
But even if it was, I think that this has been a source of annoyance a number of times, so let's just do it!
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.
Related to github/cli#577
Changes
In attempting to use
go-ghincli/cliforIsEnterpriseandIsTenancy, I got bamboozled by the duplicate code, here. This removes the duplicated, unexportedisEnterpriseandisTenancyfunctions from theapipackage and replaces them with the exportedIsEnterpriseandIsTenancypackages fromauth.Testing
Note, I've also tested these in cli/cli by running
go mod edit --replace=github.com/cli/go-gh=<localPath>/go-ghand swapped these functions in. Everything there seems to be working as expected, too. I ran all the tests and did somegh authtesting, just to be sure