add PII comment to PackageError

chuckries · chuckries · commit aa7000159298 · 2016-11-08T14:08:33.000-08:00
diff --git a/src/packages.ts b/src/packages.ts
@@ -32,6 +32,7 @@ export interface Status {
 }
 
 export class PackageError extends Error {
+    // Do not put PII (personally identifiable information) in the 'message' field as it will be logged to telemetry
     constructor(public message: string, 
                 public pkg: Package = null, 
                 public innerError: any = null) {
@@ -167,7 +168,7 @@ function downloadFile(urlString: string, pkg: Package, logger: Logger, status: S
         let request = https.request(options, response => {
             if (response.statusCode === 301 || response.statusCode === 302) {
                 // Redirect - download from new location
-                resolve(downloadFile(response.headers.location, pkg, logger, status));
+                return resolve(downloadFile(response.headers.location, pkg, logger, status));
             }
 
             if (response.statusCode != 200) {

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ export interface Status {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`export class PackageError extends Error {`
	`35`	`+ // Do not put PII (personally identifiable information) in the 'message' field as it will be logged to telemetry`
`35`	`36`	`constructor(public message: string,`
`36`	`37`	`public pkg: Package = null,`
`37`	`38`	`public innerError: any = null) {`
`@@ -167,7 +168,7 @@ function downloadFile(urlString: string, pkg: Package, logger: Logger, status: S`
`167`	`168`	`let request = https.request(options, response => {`
`168`	`169`	`if (response.statusCode === 301 \|\| response.statusCode === 302) {`
`169`	`170`	`// Redirect - download from new location`
`170`		`- resolve(downloadFile(response.headers.location, pkg, logger, status));`
	`171`	`+ return resolve(downloadFile(response.headers.location, pkg, logger, status));`
`171`	`172`	`}`
`172`	`173`
`173`	`174`	`if (response.statusCode != 200) {`