Implement GitHub Enterprise authn provider #115940

kabel · 2021-02-05T22:00:21Z

👋 Note from the maintainers: If you arrived here looking for GitHub Enterprise Server support in the GitHub Pull Requests and Issues extension, please see the wiki. GitHub Enterprise is now tested and officially supported (since 0.51).

Adds an additional provider to the github-authentication extension that leverages the same code with minor modifications. A configuration item has been added for users to provide the URI of their GHE instance.

This allows GitHub API related extensions to easily integrate with
either GitHub.com or their on-premise installations.

This PR fixes microsoft/vscode-pull-request-github#1793
Also fixes #112043

Testing requires access to a GitHub Enterprise instance.

ghost · 2021-02-05T22:00:36Z

All CLA requirements met.

kabel · 2021-02-05T22:05:14Z

Config added for instance URI.

kabel · 2021-02-05T22:05:48Z

Successful local test.

mew1033 · 2021-02-09T02:08:42Z

Awesome!

extensions/github-authentication/src/extension.ts

lupalby · 2021-02-13T00:38:43Z

I was able to test the changes using the configuration here and I can confirm that it works very well with the GHE instance we use at work.
Great work!

jasonwilliams · 2021-02-16T14:20:47Z

I can also confirm that after following the instructions from microsoft/vscode-pull-request-github#1793 (comment) this works with our GitHub Enterprise Server.

RMacfarlane · 2021-02-16T19:39:13Z

Thanks @kabel for picking this up, this is really great! I haven't had time to review this yet, but getting this in is on my to do list

vortechs2000 · 2021-02-18T16:36:07Z

I can also confirm that after following the instructions from microsoft/vscode-pull-request-github#1793 (comment) this works with our GitHub Enterprise Server.

GHE: 2.22
VSCode 1.53.2
macOS 10.15.7

kabel · 2021-02-19T20:09:54Z

extensions/github-authentication/src/githubServer.ts

+ const json: { verifiable_password_authentication: boolean, installed_version: string } = await result.json();
+
+ /* __GDPR__
+ "ghe-session" : {


Assume this would be valuable information to see where users are coming from. I don't know the schema for GDPR, so adjust as necessary.

vortechs2000 · 2021-02-25T16:13:50Z

@RMacfarlane what needs to happen to get this and #2468 pulled in?

RMacfarlane · 2021-02-25T16:16:45Z

I just need to review and merge them, I am holding off on doing this since we are in the middle of our stabilization period for the next release where we do not take in new features. We should create our release branch on Friday and I will review after that

vortechs2000 · 2021-02-25T17:06:03Z

Awesome - very excited for this to get it. Feel free to ping me if you need something validated against a GHE 2.22 server and I'll do my best to help.

eschweighofer · 2021-03-16T14:49:23Z

I was able to test the changes using microsoft/vscode-pull-request-github#1793 and confirm it works very well with our GHE instance
Great work!
@RMacfarlane could this be merged?

kubukoz · 2021-03-29T17:45:08Z

Bumping, I would also love if this got merged and soon released 🙏

jasonwilliams · 2021-04-12T11:17:00Z

@RMacfarlane is there space in this iteration to review and merge this?

Adds an additional provider to the github-authentication extension that leverages the same code with minor modifications. A configuration item has been added for users to provide the URI of their GHE instance. This allows GitHub API related extensions to easily integrate with either GitHub.com or their on-premise installations.

Ygilany · 2021-04-30T01:39:41Z

@RMacfarlane any plans to merge this soon?

Uses a new, proposed alternative authentication provider (switch) to handle authentication and API queries. Fixed microsoft#1793, microsoft#2282. Depends on microsoft/vscode#115940

mew1033 · 2021-05-06T22:34:32Z

I'm super excited for this feature. I use GHE every day for work, and will use the pull request extension so much more when I can pair it with GHE. Can't wait to see this merged!

RMacfarlane

Thank you @kabel!

RMacfarlane · 2021-03-04T19:43:07Z

extensions/github-authentication/package.json

 ],
 "contributes": {
 "commands": [
 {
 "command": "github.provide-token",
- "title": "Manually Provide Token"
+ "title": "GitHub: Manually Provide Token"


Instead of changing the title to include "GitHub", there's another property called category that could be used

catskul · 2021-05-10T21:27:05Z

As of the new PR merge what's the right way to configure this?

AlexDias95 · 2021-05-11T15:38:55Z

I have the same question, how can I configure the GitHub enterprise?

kabel · 2021-05-11T16:03:49Z

As of the new PR merge what's the right way to configure this?

I have the same question, how can I configure the GitHub enterprise?

I would imagine there will be some updated wiki, documentation once this feature bakes into the official release process. That said, it's only available through the Insiders version 1.57 from 2021-05-10 or later.

If your question resolves around how this integrates with the GitHub Pull Requests and Issues extension, you will also need to use the nightly build until an official release. Assuming you have the right version of things installed, you can set the configuration as shown in step 4 of my preview releases.

In all cases, the authentication to Enterprise relies on a Personal Access Token (PAT), that must be manually generated and pasted into the appropriate prompt when you interact with a configured enterprise remote repository. Example: https://domain-of-ghe.your-enterprise.tld/settings/tokens

AlexDias95 · 2021-05-11T16:23:36Z

@kabel Thanks for the help! I have installed the nightly build version and I have put in settings.json ("github-enterprise.uri": "https://github.XYZ.com",) but how can I add my token to this configuration?

kabel · 2021-05-11T17:05:22Z

The token is stored in a secure credential manager. It cannot be loaded through configuration; only the UI:

Open a code instance with a workspace/folder that contains a GHE cloned repository. Default remote name origin works out-of-box.
If you have the URI set appropriately (matches clone URI authority), the UI should prompt you that you have an account to authenticate to:
Click the Accounts icon and select the "Sign in..." option:
The UI will prompt for the PAT and display a status bar item:
Assuming PAT works well and complete authn, the UI updates the Accounts menu:
If the GitHub UI view is still stale (didn't trigger the proper events), reload the window:
Success!

catskul · 2021-05-11T18:21:49Z

Thanks so much for the detailed instructions!

I think step 6 was critical. I ended up restarting vscode before I saw your instructions and that seemed to do the trick.

jasonwilliams · 2021-05-11T19:24:07Z

The token is stored in a secure credential manager. It cannot be loaded through configuration; only the UI:

Open a code instance with a workspace/folder that contains a GHE cloned repository. Default remote name origin works out-of-box.

If you have the URI set appropriately (matches clone URI authority), the UI should prompt you that you have an account to authenticate to:

Click the Accounts icon and select the "Sign in..." option:

The UI will prompt for the PAT and display a status bar item:

Assuming PAT works well and complete authn, the UI updates the Accounts menu:

If the GitHub UI view is still stale (didn't trigger the proper events), reload the window:

Success!

@RMacfarlane You could copy this straight into the wiki 😄

AlexDias95 · 2021-05-11T22:35:39Z

It worked @kabel!!! Thanks for all the help! :D

vortechs2000 · 2021-05-13T18:09:21Z

I grabbed the latest Insider build, and set "github-enterprise.uri": "https://git.my.ghe.uri", but I'm not able to log into my GHE instance - I only get the option to log into github.com. Is there some other setting I need to adjust?

catskul · 2021-05-13T18:21:13Z

Make sure you have the nightly of the extension as well vscode-pull-request-github-insiders
Also I had to restart vscode a few times before I got it to work. Also nightly stores it's config in a separate location so if you added it to vscode, and then tried it on nightly, you might be missing the config there.

vortechs2000 · 2021-05-13T18:36:18Z

Make sure you have the nightly of the extension as well vscode-pull-request-github-insiders

That did it - thank you @catskul! I knew I was missing something obvious.

jasonwilliams · 2021-06-04T10:27:05Z

Latest test seems to have errors

Installed VSCode Insiders (Version: 1.57.0-insider (Universal) Commit: 387e2f3)
Installed pull request github nightly (Version: 2021.6.1983)
I set my enterprise URI, filling out "github-enterprise.uri" (I included the schema)
Then needed to restart VSCode
Then i signed in following @kabel's instructions here:
Implement GitHub Enterprise authn provider #115940 (comment)

I can see the list of PRs but clicking on the dropdown shows nothing.

Extension output is as follows:

[Info] Failed to get pull request review comments: Error: GraphQL error: Field 'path' doesn't exist on type 'PullRequestReviewThread'
GraphQL error: Field 'isOutdated' doesn't exist on type 'PullRequestReviewThread'
[Info] Error: GraphQL error: Field 'viewerViewedState' doesn't exist on type 'PullRequestChangedFile'
[Info] Failed to get pull request review comments: Error: GraphQL error: Field 'path' doesn't exist on type 'PullRequestReviewThread'
GraphQL error: Field 'isOutdated' doesn't exist on type 'PullRequestReviewThread'
[Info] Error: GraphQL error: Field 'viewerViewedState' doesn't exist on type 'PullRequestChangedFile'
[Info] Failed to get pull request review comments: Error: GraphQL error: Field 'path' doesn't exist on type 'PullRequestReviewThread'
GraphQL error: Field 'isOutdated' doesn't exist on type 'PullRequestReviewThread'
[Info] Error: GraphQL error: Field 'viewerViewedState' doesn't exist on type 'PullRequestChangedFile'

Github Authentification Output:

[Info  - 09:22:45.590] Getting user info...
[Info  - 09:22:46.204] Got account info!

Enterprise version is: v2.22.4

@kabel do you know why the above errors are happening? Is GHEP now out of sync with the extension again?

bowendeng · 2021-06-04T10:33:27Z

@jasonwilliams I had similar errors on our GHE instance. Based on the change log, these fields were introduced on 2020-09-23. I guess you have to upgrade the GHE to a version after that.

kabel · 2021-06-11T17:43:57Z

Opened a tracking issue at microsoft/vscode-pull-request-github#2772 for the schema related errors. Gotta love GraphQL API version fragmentation. We'll see how hard it will be to keep up with Enterprise support pattern. My enterprise upgraded to GHE 3 and it's seems to be working fine.

alexr00 · 2022-09-27T07:38:12Z

If you arrived here looking for GitHub Enterprise support in the GitHub Pull Requests and Issues extension, please see the wiki. The TL;DR is that GitHub Enterprise is now tested and supported by the project maintainers.

kabel mentioned this pull request Feb 5, 2021

Implement auth service switching for GitHub Enterprise microsoft/vscode-pull-request-github#2468

Merged

isidorn assigned RMacfarlane Feb 8, 2021

kabel commented Feb 9, 2021

View reviewed changes

extensions/github-authentication/src/extension.ts Outdated Show resolved Hide resolved

kabel commented Feb 9, 2021

View reviewed changes

extensions/github-authentication/src/extension.ts Outdated Show resolved Hide resolved

joaomoreno changed the base branch from master to main February 15, 2021 08:51

kabel commented Feb 19, 2021

View reviewed changes

kabel added 2 commits April 26, 2021 13:50

Implement telemetry for GHE version info

13a97ae

Update GDPR comment tag

5b8d40d

RMacfarlane approved these changes May 7, 2021

View reviewed changes

Rachel Macfarlane added 2 commits May 7, 2021 14:07

Tweak command categories

0537979

Merge branch 'main' into pr/kabel/115940

a32b332

RMacfarlane merged commit 4978a18 into microsoft:main May 7, 2021

RMacfarlane added this to the May 2021 milestone May 7, 2021

kabel deleted the feature/github-enterprise-auth branch May 11, 2021 15:50

jasonwilliams mentioned this pull request Jun 4, 2021

Its possible connect to github enterprise microsoft/vscode-pull-request-github#1793

Closed

kabel mentioned this pull request Jun 11, 2021

GitHub Enterprise GraphQL Schema needs to be considered before querying for new-ish fields microsoft/vscode-pull-request-github#2772

Closed

github-actions bot locked and limited conversation to collaborators Jun 21, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement GitHub Enterprise authn provider #115940

Implement GitHub Enterprise authn provider #115940

kabel commented Feb 5, 2021 •

edited by digitarald

Loading

ghost commented Feb 5, 2021 •

edited by ghost

Loading

kabel commented Feb 5, 2021

kabel commented Feb 5, 2021

mew1033 commented Feb 9, 2021

lupalby commented Feb 13, 2021

jasonwilliams commented Feb 16, 2021 •

edited

Loading

RMacfarlane commented Feb 16, 2021

vortechs2000 commented Feb 18, 2021

kabel Feb 19, 2021

vortechs2000 commented Feb 25, 2021

RMacfarlane commented Feb 25, 2021

vortechs2000 commented Feb 25, 2021

eschweighofer commented Mar 16, 2021

kubukoz commented Mar 29, 2021

jasonwilliams commented Apr 12, 2021

Ygilany commented Apr 30, 2021

mew1033 commented May 6, 2021

RMacfarlane left a comment

RMacfarlane Mar 4, 2021

catskul commented May 10, 2021

AlexDias95 commented May 11, 2021

kabel commented May 11, 2021

AlexDias95 commented May 11, 2021

kabel commented May 11, 2021

catskul commented May 11, 2021

jasonwilliams commented May 11, 2021

AlexDias95 commented May 11, 2021

vortechs2000 commented May 13, 2021

catskul commented May 13, 2021

vortechs2000 commented May 13, 2021

jasonwilliams commented Jun 4, 2021 •

edited

Loading

bowendeng commented Jun 4, 2021

kabel commented Jun 11, 2021

alexr00 commented Sep 27, 2022

Implement GitHub Enterprise authn provider #115940

Implement GitHub Enterprise authn provider #115940

Conversation

kabel commented Feb 5, 2021 • edited by digitarald Loading

ghost commented Feb 5, 2021 • edited by ghost Loading

kabel commented Feb 5, 2021

kabel commented Feb 5, 2021

mew1033 commented Feb 9, 2021

lupalby commented Feb 13, 2021

jasonwilliams commented Feb 16, 2021 • edited Loading

RMacfarlane commented Feb 16, 2021

vortechs2000 commented Feb 18, 2021

kabel Feb 19, 2021

Choose a reason for hiding this comment

vortechs2000 commented Feb 25, 2021

RMacfarlane commented Feb 25, 2021

vortechs2000 commented Feb 25, 2021

eschweighofer commented Mar 16, 2021

kubukoz commented Mar 29, 2021

jasonwilliams commented Apr 12, 2021

Ygilany commented Apr 30, 2021

mew1033 commented May 6, 2021

RMacfarlane left a comment

Choose a reason for hiding this comment

RMacfarlane Mar 4, 2021

Choose a reason for hiding this comment

catskul commented May 10, 2021

AlexDias95 commented May 11, 2021

kabel commented May 11, 2021

AlexDias95 commented May 11, 2021

kabel commented May 11, 2021

catskul commented May 11, 2021

jasonwilliams commented May 11, 2021

AlexDias95 commented May 11, 2021

vortechs2000 commented May 13, 2021

catskul commented May 13, 2021

vortechs2000 commented May 13, 2021

jasonwilliams commented Jun 4, 2021 • edited Loading

bowendeng commented Jun 4, 2021

kabel commented Jun 11, 2021

alexr00 commented Sep 27, 2022

kabel commented Feb 5, 2021 •

edited by digitarald

Loading

ghost commented Feb 5, 2021 •

edited by ghost

Loading

jasonwilliams commented Feb 16, 2021 •

edited

Loading

jasonwilliams commented Jun 4, 2021 •

edited

Loading