Clarify usage with Enterprise instances

[cederfjard]

Could the README be amended to include instructions for using this extension with GitHub Enterprise instances? I've seen in other places (#368 (comment)) that this is intended to work.

I've tried generating a personal access token, and supplied it along with the URL for our instance and my username:

"github.hosts": [
	{
		"host": "HOST",
		"username": "USERNAME",
		"token": "TOKEN",
	}
]

But after reloading username and token are stripped, and I'm prompted to use the regular signin process, which doesn't work:

"github.hosts": [
	{
		"host": "HOST",
	}
]

And the thing is that I can't figure out whether this is an user error or a bug (I've installed version 0.1.1).

[paul-sachs]

Having similar issue, though our github instance also has SSO enabled, which also seems to throw the extension through a loop.

[shana]

The normal signin won't work because the update to enable it in enterprise instances is going to be shipped this week so it won't be on your instance until your admin updates it (once it's available) - unfortunately we couldn't align those schedules nicely.

Manually setting the token should work though. What scopes are you selecting for the personal auth token?

[TeamTeaTime]

I'm having the same problem. Also have SSO enabled on our instance. On my personal auth token I have read:user, user:email, repo and write:discussion checked, as per your comment #384 (comment)

I've tried it with more permissions as well. When I save the User Settings file I get a popup saying "Fetching pull requests failed: Not authenticated" and my settings are reset to only contain the "host" section.

[shana]

Weeeeird. What does the log show in the Output tab, GitHub Pull Requests dropdown option?

[shana]

Also, what are you using as the url for the host? Is it just https://your-domain?

[TeamTeaTime]

Yes I am just using https://my-domain for the host url.

Output of GitHub Pull requests below:

> git config --local --get branch.master.github-pr-owner-number
> git symbolic-ref --short HEAD
> git rev-parse master
> git rev-parse --symbolic-full-name master@{u}
> git rev-list --left-right master...refs/remotes/origin/master
> git for-each-ref --format %(refname) %(objectname) --sort -committerdate
> git remote --verbose
> git config --local --get remote.origin.github-pr-remote
GitHubRepository> Fetching all pull requests failed: Error: Not authenticated.
> git branch
> git config --local --get remote.origin.github-pr-remote
> git config --local --get remote.origin.github-pr-remote
> git config --local --get remote.origin.github-pr-remote
GitHubRepository> Fetching all pull requests failed: Error: Not authenticated.
> git config --local --get branch.MM-1954.github-pr-owner-number
> git config --local --get branch.MM-2023.github-pr-owner-number
> git config --local --get branch.MM-962.github-pr-owner-number
> git config --local --get branch.dev.github-pr-owner-number
> git config --local --get branch.master.github-pr-owner-number
> git config --local --get branch.qa.github-pr-owner-number
> git config --local --get branch.staging.github-pr-owner-number
GitHubRepository> Fetching all pull requests failed: Error: Not authenticated.
GitHubRepository> Fetching all pull requests failed: Error: Not authenticated.
> git branch
> git config --local --get remote.origin.github-pr-remote
> git config --local --get remote.origin.github-pr-remote
> git config --local --get remote.origin.github-pr-remote
GitHubRepository> Fetching all pull requests failed: Error: Not authenticated.
> git config --local --get branch.MM-1954.github-pr-owner-number
> git config --local --get branch.MM-2023.github-pr-owner-number
> git config --local --get branch.MM-962.github-pr-owner-number
> git config --local --get branch.dev.github-pr-owner-number
> git config --local --get branch.master.github-pr-owner-number
> git config --local --get branch.qa.github-pr-owner-number
> git config --local --get branch.staging.github-pr-owner-number
GitHubRepository> Fetching all pull requests failed: Error: Not authenticated.
GitHubRepository> Fetching all pull requests failed: Error: Not authenticated.

[cederfjard]

I’m away from the computer so I can’t check the output, but my experience was the same as TeamTeaTime’s. And just to be sure I granted all available permissions.

The URL for the host I’ve put is https://github.ourdomain.com

[shana]

Thanks for the info, I'll try to repro internally and get a fix going for y'all. Sorry for the trouble!

[lumaxis]

@shana I believe this might be happening because our GitHub Enterprise instance does not have rate limiting enabled which makes GET /api/v3/rate_limit return a 404 error with this error:

{
    "message": "Rate limiting is not enabled.",
    "documentation_url": "https://developer.github.com/enterprise/2.13/v3/rate_limit/#get-your-current-rate-limit-status"
}

That API is used to validate the provided credentials on start-up and the validation fails because of the 404:
https://github.com/Microsoft/vscode-pull-request-github/blob/cd5f1dd04e90655409765ee973ac4db611392431/src/authentication/githubServer.ts#L210

If the credentials for the request however were actually bad, GHE would respond with a 401 error and

{
    "message": "Bad credentials",
    "documentation_url": "https://developer.github.com/enterprise/2.13/v3"
}

I just opened #397 with a suggested fix that locally made the extension work for me ✨

[lumaxis]

@TeamTeaTime @cederfjard Could you try to run this curl request and see if you also get a 404 response?

curl -X GET -H 'Authorization: token $TOKEN' https://$DOMAIN/api/v3/rate_limit

[shana]

@lumaxis Aaaaah, darn it, you might be right, good catch. I was suspecting that the credential validation was failing, and that makes total sense. 😢