utterances/src/github.ts at master · devsdocs/utterances · GitHub

History

427 lines (389 loc) · 11.8 KB

Raw

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

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

import { token } from './oauth';

import { decodeBase64UTF8 } from './encoding';

import { UTTERANCES_API } from './utterances-api';

const GITHUB_API = 'https://api.github.com/';

const GITHUB_ENCODING__HTML_JSON = 'application/vnd.github.VERSION.html+json';

const GITHUB_ENCODING__HTML = 'application/vnd.github.VERSION.html';

const GITHUB_ENCODING__REACTIONS_PREVIEW = 'application/vnd.github.squirrel-girl-preview';

export const PAGE_SIZE = 25;

export const reactionTypes: ReactionID[] = ['+1', '-1', 'laugh', 'hooray', 'confused', 'heart', 'rocket', 'eyes'];

let owner: string;

let repo: string;

const branch = 'master';

export function setRepoContext(context: { owner: string; repo: string; }) {

owner = context.owner;

repo = context.repo;

}

function githubRequest(relativeUrl: string, init?: RequestInit) {

init = init || {};

init.mode = 'cors';

init.cache = 'no-cache'; // force conditional request

const request = new Request(GITHUB_API + relativeUrl, init);

request.headers.set('Accept', GITHUB_ENCODING__REACTIONS_PREVIEW);

if (token.value !== null) {

request.headers.set('Authorization', `token ${token.value}`);

}

return request;

}

const rateLimit = {

standard: {

limit: Number.MAX_VALUE,

remaining: Number.MAX_VALUE,

reset: 0

search: {

limit: Number.MAX_VALUE,

remaining: Number.MAX_VALUE,

reset: 0

}

};

function processRateLimit(response: Response) {

const limit = response.headers.get('X-RateLimit-Limit')!;

const remaining = response.headers.get('X-RateLimit-Remaining')!;

const reset = response.headers.get('X-RateLimit-Reset')!;

const isSearch = /\/search\//.test(response.url);

const rate = isSearch ? rateLimit.search : rateLimit.standard;

rate.limit = +limit;

rate.remaining = +remaining;

rate.reset = +reset;

if (response.status === 403 && rate.remaining === 0) {

const resetDate = new Date(0);

resetDate.setUTCSeconds(rate.reset);

const mins = Math.round((resetDate.getTime() - new Date().getTime()) / 1000 / 60);

const apiType = isSearch ? 'search API' : 'non-search APIs';

// tslint:disable-next-line:no-console

console.warn(`Rate limit exceeded for ${apiType}. Resets in ${mins} minute${mins === 1 ? '' : 's'}.`);

}

export function readRelNext(response: Response) {

const link = response.headers.get('link');

if (link === null) {

return 0;

}

const match = /\?page=([2-9][0-9]*)>; rel="next"/.exec(link);

if (match === null) {

return 0;

}

return +match[1];

}

function githubFetch(request: Request): Promise<Response> {

return fetch(request).then(response => {

if (response.status === 401) {

token.value = null;

}

if (response.status === 403) {

response.json().then(data => {

if (data.message === 'Resource not accessible by integration') {

window.dispatchEvent(new CustomEvent('not-installed'));

}

});

}

processRateLimit(response);

if (request.method === 'GET'

&& [401, 403].indexOf(response.status) !== -1

&& request.headers.has('Authorization')

) {

request.headers.delete('Authorization');

return githubFetch(request);

}

return response;

});

}

export function loadJsonFile<T>(path: string, html = false) {

const request = githubRequest(`repos/${owner}/${repo}/contents/${path}?ref=${branch}`);

if (html) {

request.headers.set('accept', GITHUB_ENCODING__HTML);

}

return githubFetch(request).then<FileContentsResponse | string>(response => {

if (response.status === 404) {

throw new Error(`Repo "${owner}/${repo}" does not have a file named "${path}" in the "${branch}" branch.`);

}

if (!response.ok) {

throw new Error(`Error fetching ${path}.`);

}

return html ? response.text() : response.json();

}).then<T>(file => {

if (html) {

return file;

}

const { content } = file as FileContentsResponse;

const decoded = decodeBase64UTF8(content);

return JSON.parse(decoded);

});

}

export function loadIssueByTerm(term: string) {

const q = `"${term}" type:issue in:title repo:${owner}/${repo}`;

const request = githubRequest(`search/issues?q=${encodeURIComponent(q)}&sort=created&order=asc`);

return githubFetch(request).then<IssueSearchResponse>(response => {

if (!response.ok) {

throw new Error('Error fetching issue via search.');

}

return response.json();

}).then(results => {

if (results.total_count === 0) {

return null;

}

if (results.total_count > 1) {

// tslint:disable-next-line:no-console

console.warn(`Multiple issues match "${q}".`);

}

term = term.toLowerCase();

for (const result of results.items) {

if (result.title.toLowerCase().indexOf(term) !== -1) {

return result;

}

// tslint:disable-next-line:no-console

console.warn(`Issue search results do not contain an issue with title matching "${term}". Using first result.`);

return results.items[0];

});

}

export function loadIssueByNumber(issueNumber: number) {

const request = githubRequest(`repos/${owner}/${repo}/issues/${issueNumber}`);

return githubFetch(request).then<Issue>(response => {

if (!response.ok) {

throw new Error('Error fetching issue via issue number.');

}

return response.json();

});

}

function commentsRequest(issueNumber: number, page: number) {

const url = `repos/${owner}/${repo}/issues/${issueNumber}/comments?page=${page}&per_page=${PAGE_SIZE}`;

const request = githubRequest(url);

const accept = `${GITHUB_ENCODING__HTML_JSON},${GITHUB_ENCODING__REACTIONS_PREVIEW}`;

request.headers.set('Accept', accept);

return request;

}

export function loadCommentsPage(issueNumber: number, page: number): Promise<IssueComment[]> {

const request = commentsRequest(issueNumber, page);

return githubFetch(request).then(response => {

if (!response.ok) {

throw new Error('Error fetching comments.');

}

return response.json();

});

}

export function loadUser(): Promise<User | null> {

if (token.value === null) {

return Promise.resolve(null);

}

return githubFetch(githubRequest('user'))

.then(response => {

if (response.ok) {

return response.json();

}

return null;

});

}

export function createIssue(issueTerm: string, documentUrl: string, title: string, description: string, label: string) {

const url = `${UTTERANCES_API}/repos/${owner}/${repo}/issues${label ? `?label=${encodeURIComponent(label)}` : ''}`;

const request = new Request(url, {

method: 'POST',

body: JSON.stringify({

title: issueTerm,

body: `# ${title}\n\n${description}\n\n[${documentUrl}](${documentUrl})`

})

});

request.headers.set('Accept', GITHUB_ENCODING__REACTIONS_PREVIEW);

request.headers.set('Authorization', `token ${token.value}`);

return fetch(request).then<Issue>(response => {

if (!response.ok) {

throw new Error('Error creating comments container issue');

}

return response.json();

});

}

export function postComment(issueNumber: number, markdown: string) {

const url = `repos/${owner}/${repo}/issues/${issueNumber}/comments`;

const body = JSON.stringify({ body: markdown });

const request = githubRequest(url, { method: 'POST', body });

const accept = `${GITHUB_ENCODING__HTML_JSON},${GITHUB_ENCODING__REACTIONS_PREVIEW}`;

request.headers.set('Accept', accept);

return githubFetch(request).then<IssueComment>(response => {

if (!response.ok) {

throw new Error('Error posting comment.');

}

return response.json();

});

}

export async function toggleReaction(url: string, content: ReactionID) {

url = url.replace(GITHUB_API, '');

// We don't know if the reaction exists or not. Attempt to create it. If the GitHub

// API responds that the reaction already exists, delete it.

const body = JSON.stringify({ content });

const postRequest = githubRequest(url, { method: 'POST', body });

postRequest.headers.set('Accept', GITHUB_ENCODING__REACTIONS_PREVIEW);

const response = await githubFetch(postRequest);

const reaction: Reaction = response.ok ? await response.json() : null;

if (response.status === 201) { // reaction created.

return { reaction, deleted: false };

}

if (response.status !== 200) {

throw new Error('expected "201 reaction created" or "200 reaction already exists"');

}

// reaction already exists... delete.

const deleteRequest = githubRequest(`reactions/${reaction.id}`, { method: 'DELETE' });

deleteRequest.headers.set('Accept', GITHUB_ENCODING__REACTIONS_PREVIEW);

await githubFetch(deleteRequest);

return { reaction, deleted: true };

}

export function renderMarkdown(text: string) {

const body = JSON.stringify({ text, mode: 'gfm', context: `${owner}/${repo}` });

return githubFetch(githubRequest('markdown', { method: 'POST', body }))

.then(response => response.text());

}

interface IssueSearchResponse {

total_count: number;

incomplete_results: boolean;

items: Issue[];

}

export interface User {

id: number;

avatar_url: string;

gravatar_id: string;

url: string;

html_url: string;

followers_url: string;

following_url: string;

gists_url: string;

starred_url: string;

subscriptions_url: string;

organizations_url: string;

repos_url: string;

events_url: string;

received_events_url: string;

type: string;

}

export type CommentAuthorAssociation =

'COLLABORATOR'

| 'CONTRIBUTOR'

| 'FIRST_TIMER'

| 'FIRST_TIME_CONTRIBUTOR'

| 'MEMBER'

| 'NONE'

| 'OWNER';

export interface Reactions {

url: string;

total_count: number;

'+1': number;

'-1': number;

laugh: number;

hooray: number;

confused: number;

heart: number;

rocket: number;

eyes: number;

}

export interface Reaction {

id: number;

user: User;

content: ReactionID;

created_at: string;

}

export interface Issue {

url: string;

repository_url: string;

labels_url: string;

comments_url: string;

events_url: string;

html_url: string;

id: number;

number: number;

title: string;

user: User;

locked: boolean;

labels: {

url: string;

name: string;

color: string;

}[];

state: string;

assignee: null; // todo,

milestone: null; // todo,

comments: number;

created_at: string;

updated_at: string;

closed_at: null; // todo,

pull_request: {

html_url: null; // todo,

diff_url: null; // todo,

patch_url: null; // todo

};

body: string;

score: number;

reactions: Reactions;

author_association: CommentAuthorAssociation;

}

interface FileContentsResponse {

type: string;

encoding: string;

size: number;

name: string;

path: string;

content: string;

sha: string;

url: string;

git_url: string;

html_url: string;

download_url: string;

}

export interface IssueComment {

id: number;

url: string;

html_url: string;

body_html: string;

user: User;

created_at: string;

updated_at: string;

author_association: CommentAuthorAssociation;

reactions: Reactions;

}

query IssueComments($owner: String!, $repo: String!, $issueQuery: String!) {

search(query: $issueQuery, type: ISSUE, first: 1) {

issueCount

edges {

node {

... on Issue {

title,

comments(first: 100) {

totalCount

edges {

node {

id,

createdAt,

bodyHTML,

author {

avatarUrl,

}

rateLimit {

cost

limit

remaining

resetAt

}

repository(owner: $owner, name: $repo) {

object(expression: "master:utterances.json") {

... on Blob {

text

}

{

"issueQuery": "user:jdanyow repo:utterances-demo debug",

"owner": "jdanyow",

"repo": "utterances-demo"

}

utterances/src/github.ts at master · devsdocs/utterances · GitHub

Expand file tree

Breadcrumbs

github.ts

Latest commit

History

Breadcrumbs

github.ts

File metadata and controls