From db042dbe69ecf601bed334d9d8c3d62f6c824b22 Mon Sep 17 00:00:00 2001 From: Griffin Downs Date: Fri, 28 Sep 2018 10:13:58 -0700 Subject: [PATCH 1/8] Remove redundant error telemetry --- Extension/src/LanguageServer/extension.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/Extension/src/LanguageServer/extension.ts b/Extension/src/LanguageServer/extension.ts index d0c3886ee..e0c34d355 100644 --- a/Extension/src/LanguageServer/extension.ts +++ b/Extension/src/LanguageServer/extension.ts @@ -321,7 +321,6 @@ async function checkAndApplyUpdate(updateChannel: string): Promise { }); }, (error: Error) => { // Handle getTargetBuildInfo rejection - logFailure(error); reject(error); }); }); From af9a542ed0af71713f7c5a7de20196a330c50b6b Mon Sep 17 00:00:00 2001 From: Griffin Downs Date: Fri, 28 Sep 2018 11:09:14 -0700 Subject: [PATCH 2/8] Check rate limit before attempting to download release JSON --- Extension/src/githubAPI.ts | 53 +++++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/Extension/src/githubAPI.ts b/Extension/src/githubAPI.ts index 3a4802f84..07985bc8a 100644 --- a/Extension/src/githubAPI.ts +++ b/Extension/src/githubAPI.ts @@ -177,6 +177,54 @@ function getTargetBuild(builds: Build[], updateChannel: string): Build { return needsUpdate(userVersion, targetVersion) ? targetBuild : undefined; } +interface Rate { + remaining: number; +} + +interface RateLimit { + rate: Rate; +} + +function isRate(input: any): input is Rate { + return input && input.remaining && typeof(input.remaining) === 'number'; +} + +function isRateLimit(input: any): input is RateLimit { + return input && input.rate && isRate(input.rate); +} + +async function getRateLimit(): Promise { + try { + const header: OutgoingHttpHeaders = { 'User-Agent': 'vscode-cpptools' }; + let data: string = await util.downloadFileToStr('https://api.github.com/rate_limit', header) + .catch(() => { throw new Error('Failed to download rate limit JSON'); }); + + let rateLimit: any; + try { + rateLimit = JSON.parse(data); + } catch (error) { + throw new Error('Failed to parse rate limit JSON'); + } + + if (isRateLimit(rateLimit)) { + return Promise.resolve(rateLimit); + } else { + throw new Error('Rate limit JSON is not of type RateLimit'); + } + } catch (error) { + return Promise.reject(error); + } +} + +async function rateLimitExceeded(): Promise { + let rateLimit: RateLimit = await getRateLimit(); + if (rateLimit.rate.remaining <= 0) { + return Promise.resolve(true); + } else { + return Promise.resolve(false); + } +} + /** * Download and parse the release list JSON from the GitHub API into a Build[]. * @return Information about the released builds of the C/C++ extension. @@ -191,6 +239,9 @@ async function getReleaseJson(): Promise { } try { + if (await rateLimitExceeded()) { + throw new Error('Failed to stay within GitHub API rate limit'); + } // Download release JSON const releaseUrl: string = 'https://api.github.com/repos/Microsoft/vscode-cpptools/releases'; const header: OutgoingHttpHeaders = { 'User-Agent': 'vscode-cpptools' }; @@ -213,7 +264,7 @@ async function getReleaseJson(): Promise { if (isArrayOfBuilds(releaseJson)) { resolve(releaseJson); } else { - reject(releaseJson); + throw new Error('Release JSON is not of type Build[]'); } } catch (error) { reject(error); From 3dba5bb0864290e52a92b70099569f82318e82c7 Mon Sep 17 00:00:00 2001 From: Griffin Downs Date: Fri, 28 Sep 2018 11:10:55 -0700 Subject: [PATCH 3/8] Mark vars const --- Extension/src/githubAPI.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Extension/src/githubAPI.ts b/Extension/src/githubAPI.ts index 07985bc8a..f48c15d02 100644 --- a/Extension/src/githubAPI.ts +++ b/Extension/src/githubAPI.ts @@ -196,7 +196,7 @@ function isRateLimit(input: any): input is RateLimit { async function getRateLimit(): Promise { try { const header: OutgoingHttpHeaders = { 'User-Agent': 'vscode-cpptools' }; - let data: string = await util.downloadFileToStr('https://api.github.com/rate_limit', header) + const data: string = await util.downloadFileToStr('https://api.github.com/rate_limit', header) .catch(() => { throw new Error('Failed to download rate limit JSON'); }); let rateLimit: any; @@ -217,7 +217,7 @@ async function getRateLimit(): Promise { } async function rateLimitExceeded(): Promise { - let rateLimit: RateLimit = await getRateLimit(); + const rateLimit: RateLimit = await getRateLimit(); if (rateLimit.rate.remaining <= 0) { return Promise.resolve(true); } else { From 73cdbdf1ef9c8dc55fc79aad2c4c9fe55ccf211e Mon Sep 17 00:00:00 2001 From: Griffin Downs Date: Fri, 28 Sep 2018 11:23:11 -0700 Subject: [PATCH 4/8] Add downloadFileToStr fn --- Extension/src/common.ts | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/Extension/src/common.ts b/Extension/src/common.ts index 2c1564a66..6b9593921 100644 --- a/Extension/src/common.ts +++ b/Extension/src/common.ts @@ -616,4 +616,37 @@ export function downloadFileToDestination(urlStr: string, destinationPath: strin request.on('error', (error) => { reject(); }); request.end(); }); +} + +export function downloadFileToStr(urlStr: string, headers?: OutgoingHttpHeaders): Promise { + return new Promise((resolve, reject) => { + let parsedUrl: url.Url = url.parse(urlStr); + let request: ClientRequest = https.request({ + host: parsedUrl.host, + path: parsedUrl.path, + agent: getHttpsProxyAgent(), + rejectUnauthorized: vscode.workspace.getConfiguration().get('http.proxyStrictSSL', true), + headers: headers + }, (response) => { + if (response.statusCode === 301 || response.statusCode === 302) { // If redirected + // Download from new location + let redirectUrl: string; + if (typeof response.headers.location === 'string') { + redirectUrl = response.headers.location; + } else { + redirectUrl = response.headers.location[0]; + } + return resolve(downloadFileToStr(redirectUrl, headers)); + } + if (response.statusCode !== 200) { // If request is not successful + return reject(); + } + let downloadedData: string = ''; + response.on('data', (data) => { downloadedData += data; }); + response.on('error', (error) => { reject(); }); + response.on('end', () => { resolve(downloadedData); }); + }); + request.on('error', (error) => { reject(); }); + request.end(); + }); } \ No newline at end of file From f7b445f1c3b8d12be856a6cbfacf25c7d4715c30 Mon Sep 17 00:00:00 2001 From: Griffin Downs Date: Fri, 28 Sep 2018 15:14:19 -0700 Subject: [PATCH 5/8] Respond to PR feedback --- Extension/src/githubAPI.ts | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/Extension/src/githubAPI.ts b/Extension/src/githubAPI.ts index f48c15d02..4a874ffc6 100644 --- a/Extension/src/githubAPI.ts +++ b/Extension/src/githubAPI.ts @@ -186,15 +186,14 @@ interface RateLimit { } function isRate(input: any): input is Rate { - return input && input.remaining && typeof(input.remaining) === 'number'; + return input && input.remaining && util.isNumber(input.remaining); } function isRateLimit(input: any): input is RateLimit { - return input && input.rate && isRate(input.rate); + return input && isRate(input.rate); } async function getRateLimit(): Promise { - try { const header: OutgoingHttpHeaders = { 'User-Agent': 'vscode-cpptools' }; const data: string = await util.downloadFileToStr('https://api.github.com/rate_limit', header) .catch(() => { throw new Error('Failed to download rate limit JSON'); }); @@ -211,18 +210,11 @@ async function getRateLimit(): Promise { } else { throw new Error('Rate limit JSON is not of type RateLimit'); } - } catch (error) { - return Promise.reject(error); - } } async function rateLimitExceeded(): Promise { const rateLimit: RateLimit = await getRateLimit(); - if (rateLimit.rate.remaining <= 0) { - return Promise.resolve(true); - } else { - return Promise.resolve(false); - } + return rateLimit.rate.remaining <= 0; } /** From 570782d59a0b00bd5893f2785fec4438af0b5967 Mon Sep 17 00:00:00 2001 From: Griffin Downs Date: Mon, 1 Oct 2018 15:05:46 -0700 Subject: [PATCH 6/8] Unindent by one tab --- Extension/src/githubAPI.ts | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/Extension/src/githubAPI.ts b/Extension/src/githubAPI.ts index 4a874ffc6..c884a37ea 100644 --- a/Extension/src/githubAPI.ts +++ b/Extension/src/githubAPI.ts @@ -194,22 +194,22 @@ function isRateLimit(input: any): input is RateLimit { } async function getRateLimit(): Promise { - const header: OutgoingHttpHeaders = { 'User-Agent': 'vscode-cpptools' }; - const data: string = await util.downloadFileToStr('https://api.github.com/rate_limit', header) - .catch(() => { throw new Error('Failed to download rate limit JSON'); }); + const header: OutgoingHttpHeaders = { 'User-Agent': 'vscode-cpptools' }; + const data: string = await util.downloadFileToStr('https://api.github.com/rate_limit', header) + .catch(() => { throw new Error('Failed to download rate limit JSON'); }); - let rateLimit: any; - try { - rateLimit = JSON.parse(data); - } catch (error) { - throw new Error('Failed to parse rate limit JSON'); - } + let rateLimit: any; + try { + rateLimit = JSON.parse(data); + } catch (error) { + throw new Error('Failed to parse rate limit JSON'); + } - if (isRateLimit(rateLimit)) { - return Promise.resolve(rateLimit); - } else { - throw new Error('Rate limit JSON is not of type RateLimit'); - } + if (isRateLimit(rateLimit)) { + return Promise.resolve(rateLimit); + } else { + throw new Error('Rate limit JSON is not of type RateLimit'); + } } async function rateLimitExceeded(): Promise { From 0d79e3830e09d73ee48a36f3285ffcc18f485712 Mon Sep 17 00:00:00 2001 From: Griffin Downs Date: Mon, 1 Oct 2018 15:20:08 -0700 Subject: [PATCH 7/8] No longer download release json to file --- Extension/src/githubAPI.ts | 58 ++++++++++++++------------------------ 1 file changed, 21 insertions(+), 37 deletions(-) diff --git a/Extension/src/githubAPI.ts b/Extension/src/githubAPI.ts index c884a37ea..f9fbbd1fc 100644 --- a/Extension/src/githubAPI.ts +++ b/Extension/src/githubAPI.ts @@ -222,45 +222,29 @@ async function rateLimitExceeded(): Promise { * @return Information about the released builds of the C/C++ extension. */ async function getReleaseJson(): Promise { - return new Promise((resolve, reject) => { - // Create temp file to hold JSON - tmp.file(async (err, releaseJsonPath, fd, cleanupCallback) => { - if (err) { - reject(new Error('Failed to create release json file')); - return; - } + if (await rateLimitExceeded()) { + throw new Error('Failed to stay within GitHub API rate limit'); + } - try { - if (await rateLimitExceeded()) { - throw new Error('Failed to stay within GitHub API rate limit'); - } - // Download release JSON - const releaseUrl: string = 'https://api.github.com/repos/Microsoft/vscode-cpptools/releases'; - const header: OutgoingHttpHeaders = { 'User-Agent': 'vscode-cpptools' }; - await util.downloadFileToDestination(releaseUrl, releaseJsonPath, header) - .catch(() => { throw new Error('Failed to download release JSON'); }); + // Download release JSON + const releaseUrl: string = 'https://api.github.com/repos/Microsoft/vscode-cpptools/releases'; + const header: OutgoingHttpHeaders = { 'User-Agent': 'vscode-cpptools' }; - // Read the release JSON file - const fileContent: string = await util.readFileText(releaseJsonPath) - .catch(() => { throw new Error('Failed to read release JSON file'); } ); + const data: string = await util.downloadFileToStr(releaseUrl, header) + .catch(() => { throw new Error('Failed to download release JSON'); }); - // Parse the file - let releaseJson: any; - try { - releaseJson = JSON.parse(fileContent); - } catch (error) { - throw new Error('Failed to parse release JSON'); - } + // Parse the file + let releaseJson: any; + try { + releaseJson = JSON.parse(data); + } catch (error) { + throw new Error('Failed to parse release JSON'); + } - // Type check - if (isArrayOfBuilds(releaseJson)) { - resolve(releaseJson); - } else { - throw new Error('Release JSON is not of type Build[]'); - } - } catch (error) { - reject(error); - } - }); - }); + // Type check + if (isArrayOfBuilds(releaseJson)) { + return releaseJson; + } else { + throw new Error('Release JSON is not of type Build[]'); + } } From 2dc93c0bdcbacd99373134afef82ddcdd65f173e Mon Sep 17 00:00:00 2001 From: Griffin Downs Date: Mon, 1 Oct 2018 15:48:52 -0700 Subject: [PATCH 8/8] Remove tmp import --- Extension/src/githubAPI.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/Extension/src/githubAPI.ts b/Extension/src/githubAPI.ts index f9fbbd1fc..bd7d80add 100644 --- a/Extension/src/githubAPI.ts +++ b/Extension/src/githubAPI.ts @@ -6,7 +6,6 @@ import { PackageVersion } from './packageVersion'; import * as util from './common'; -import * as tmp from 'tmp'; import { PlatformInformation } from './platform'; import { OutgoingHttpHeaders } from 'http';