-
Notifications
You must be signed in to change notification settings - Fork 575
/
credentials.ts
207 lines (172 loc) · 5.75 KB
/
credentials.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { Octokit } from '@octokit/rest';
import * as OctokitTypes from '@octokit/types';
import { ApolloClient, InMemoryCache, NormalizedCacheObject } from 'apollo-boost';
import { setContext } from 'apollo-link-context';
import * as vscode from 'vscode';
import { agent } from '../common/net';
import Logger from '../common/logger';
import * as PersistentState from '../common/persistentState';
import { createHttpLink } from 'apollo-link-http';
import fetch from 'node-fetch';
import { ITelemetry } from '../common/telemetry';
const TRY_AGAIN = 'Try again?';
const CANCEL = 'Cancel';
const SIGNIN_COMMAND = 'Sign in';
const IGNORE_COMMAND = 'Don\'t show again';
const PROMPT_FOR_SIGN_IN_SCOPE = 'prompt for sign in';
const PROMPT_FOR_SIGN_IN_STORAGE_KEY = 'login';
const AUTH_PROVIDER_ID = 'github';
const SCOPES = ['read:user', 'user:email', 'repo'];
export interface GitHub {
octokit: Octokit;
graphql: ApolloClient<NormalizedCacheObject> | null;
currentUser?: OctokitTypes.PullsGetResponseData['user'];
}
export class CredentialStore {
private _githubAPI: GitHub | undefined;
private _sessionId: string | undefined;
constructor(private readonly _telemetry: ITelemetry) { }
public async initialize(): Promise<void> {
const session = await vscode.authentication.getSession(AUTH_PROVIDER_ID, SCOPES, { createIfNone: false });
if (session) {
const token = session.accessToken;
this._sessionId = session.id;
const octokit = await this.createHub(token);
this._githubAPI = octokit;
await this.setCurrentUser(octokit);
} else {
Logger.debug(`No token found.`, 'Authentication');
}
}
public async reset() {
this._githubAPI = undefined;
await this.initialize();
}
public isAuthenticated(): boolean {
return !!this._githubAPI;
}
public getHub(): GitHub | undefined {
return this._githubAPI;
}
public async getHubOrLogin(): Promise<GitHub | undefined> {
return this._githubAPI ?? await this.login();
}
public async showSignInNotification(): Promise<GitHub | undefined> {
if (PersistentState.fetch(PROMPT_FOR_SIGN_IN_SCOPE, PROMPT_FOR_SIGN_IN_STORAGE_KEY) === false) {
return;
}
const result = await vscode.window.showInformationMessage(
`In order to use the Pull Requests functionality, you must sign in to GitHub`,
SIGNIN_COMMAND, IGNORE_COMMAND);
if (result === SIGNIN_COMMAND) {
return await this.login();
} else {
// user cancelled sign in, remember that and don't ask again
PersistentState.store(PROMPT_FOR_SIGN_IN_SCOPE, PROMPT_FOR_SIGN_IN_STORAGE_KEY, false);
/* __GDPR__
"auth.cancel" : {}
*/
this._telemetry.sendTelemetryEvent('auth.cancel');
}
}
public async logout(): Promise<void> {
if (this._sessionId) {
vscode.authentication.logout('github', this._sessionId);
}
}
public async login(): Promise<GitHub | undefined> {
/* __GDPR__
"auth.start" : {}
*/
this._telemetry.sendTelemetryEvent('auth.start');
let retry: boolean = true;
let octokit: GitHub | undefined = undefined;
while (retry) {
try {
const token = await this.getSessionOrLogin();
octokit = await this.createHub(token);
} catch (e) {
Logger.appendLine(`Error signing in to GitHub: ${e}`);
if (e instanceof Error && e.stack) {
Logger.appendLine(e.stack);
}
}
if (octokit) {
retry = false;
} else {
retry = (await vscode.window.showErrorMessage(`Error signing in to GitHub`, TRY_AGAIN, CANCEL)) === TRY_AGAIN;
}
}
if (octokit) {
this._githubAPI = octokit;
await this.setCurrentUser(octokit);
/* __GDPR__
"auth.success" : {}
*/
this._telemetry.sendTelemetryEvent('auth.success');
} else {
/* __GDPR__
"auth.fail" : {}
*/
this._telemetry.sendTelemetryEvent('auth.fail');
}
return octokit;
}
public isCurrentUser(username: string): boolean {
return this._githubAPI?.currentUser?.login === username;
}
public getCurrentUser(): OctokitTypes.PullsGetResponseData['user'] {
const octokit = this._githubAPI?.octokit;
// TODO remove cast
return octokit && (this._githubAPI as any).currentUser;
}
private async setCurrentUser(github: GitHub): Promise<void> {
const user = await github.octokit.users.getAuthenticated({});
github.currentUser = user.data;
}
private async getSessionOrLogin(): Promise<string> {
const session = await vscode.authentication.getSession(AUTH_PROVIDER_ID, SCOPES, { createIfNone: true });
this._sessionId = session.id;
return session.accessToken;
}
private async createHub(token: string): Promise<GitHub> {
const octokit = new Octokit({
request: { agent },
userAgent: 'GitHub VSCode Pull Requests',
// `shadow-cat-preview` is required for Draft PR API access -- https://developer.github.com/v3/previews/#draft-pull-requests
previews: ['shadow-cat-preview'],
auth: `${token || ''}`
});
const graphql = new ApolloClient({
link: link('https://api.github.com', token || ''),
cache: new InMemoryCache,
defaultOptions: {
query: {
fetchPolicy: 'no-cache'
}
}
});
const github: GitHub = {
octokit,
graphql
};
await this.setCurrentUser(github);
return github;
}
}
const link = (url: string, token: string) =>
setContext((_, { headers }) => (({
headers: {
...headers,
authorization: token ? `Bearer ${token}` : '',
Accept: 'application/vnd.github.shadow-cat-preview+json'
}
}))).concat(createHttpLink({
uri: `${url}/graphql`,
// https://github.com/apollographql/apollo-link/issues/513
fetch: fetch as any
}));