Address comments

Author: tinayuangao

functions/data_image.ts

@@ -9,7 +9,7 @@ const bucket = gcs.bucket(firebaseFunctions.config().firebase.storageBucket);
 
 /**
  * Convert data to images. Image data posted to database will be saved as png files
- * and upload to screenshot/$prNumber/dataType/$filename
+ * and uploaded to screenshot/$prNumber/dataType/$filename
  */
 export function convertTestImageDataToFiles(event: any) {
   // Only edit data when it is first created. Exit when the data is deleted.
@@ -22,7 +22,7 @@ export function convertTestImageDataToFiles(event: any) {
   let data = event.data.val();
   let saveFilename = `${event.params.filename}.screenshot.png`;
 
-  if (dataType != 'diff' && dataType != 'test') {
+  if (dataType !== 'diff' && dataType !== 'test') {
     return;
   }
 

functions/github.ts

@@ -22,10 +22,12 @@ export function updateGithubStatus(event: firebaseFunctions.Event<any>) {
   let prNumber = event.params.prNumber;
   return event.data.ref.parent.child('sha').once('value').then((sha: firebaseAdmin.database.DataSnapshot) => {
     return setGithubStatus(sha.val(),
-      result,
-      toolName,
-      `${toolName} ${result ? 'passed' : 'failed'}`,
-      `http://${authDomain}/${prNumber}`,
+      {
+        result: result,
+        name: toolName,
+        description: `${toolName} ${result ? 'passed' : 'failed'}`,
+        url: `http://${authDomain}/${prNumber}`
+      },
       repoSlug,
       token);
   });

functions/index.js

@@ -6,7 +6,6 @@
     "firebase-admin": "^4.1.3",
     "firebase-functions": "^0.5.2",
     "jsonwebtoken": "^7.3.0",
-    "request": "^2.81.0",
-    "typescript": "^2.2.1"
+    "request": "^2.81.0"
   }
 }

functions/package.json

@@ -15,20 +15,20 @@ const bucket = gcs.bucket(firebaseFunctions.config().firebase.storageBucket);
 export function copyTestImagesToGoldens(prNumber: string) {
   return firebaseAdmin.database().ref(`screenshot/reports/${prNumber}/results`).once('value')
     .then((snapshot: firebaseAdmin.database.DataSnapshot) => {
-      let keys: string[] = [];
+      let failedFilenames: string[] = [];
       let counter = 0;
       snapshot.forEach((childSnapshot: firebaseAdmin.database.DataSnapshot) => {
-        if (childSnapshot.val() == false) {
-          keys.push(childSnapshot.key);
+        if (childSnapshot.val() === false) {
+          failedFilenames.push(childSnapshot.key);
         }
-        counter ++;
+        counter++;
         if (counter == snapshot.numChildren()) return true;
       });
-      return keys;
-    }).then((keys: string[]) => {
+      return failedFilenames;
+    }).then((failedFilenames: string[]) => {
       return bucket.getFiles({prefix: `screenshots/${prNumber}/test`}).then(function (data: any) {
         return Promise.all(data[0]
-          .filter((file: any) => keys.includes(path.basename(file.name, '.screenshot.png')))
+          .filter((file: any) => failedFilenames.includes(path.basename(file.name, '.screenshot.png')))
           .map((file: any) => file.copy(`goldens/${path.basename(file.name)}`)));
       });
     })

functions/test_goldens.ts

@@ -18,14 +18,6 @@
     ]
   },
   "files": [
-    "data.ts",
-    "data_image.ts",
-    "github.ts",
-    "image_data.ts",
-    "index.ts",
-    "jwt_util.ts",
-    "test_goldens.ts",
-    "util/github.ts",
-    "util/jwt.ts"
+    "index.ts"
   ]
 }

functions/tsconfig.json

@@ -1,25 +1,30 @@
 const request = require('request');
 
+/** Data that must be specified to set a Github PR status. */
+export type GithubStatusData = {
+  result: boolean;
+  name: string;
+  description: string;
+  url: string;
+};
+
 /** Function that sets a Github commit status */
 export function setGithubStatus(commitSHA: string,
-                                result: boolean,
-                                name: string,
-                                description: string,
-                                url: string,
+                                statusData: GithubStatusData,
                                 repoSlug: string,
                                 token: string) {
-  let state = result ? 'success' : 'failure';
+  let state = statusData.result ? 'success' : 'failure';
 
   let data = JSON.stringify({
     state: state,
-    target_url: url,
-    context: name,
-    description: description
+    target_url: statusData.url,
+    context: statusData.name,
+    description: statusData.description
   });
 
   let headers =  {
     "Authorization": `token ${token}`,
-    "User-Agent": `${name}/1.0`,
+    "User-Agent": `${statusData.name}/1.0`,
     "Content-Type": "application/json"
   };
 

functions/util/github.ts

@@ -46,7 +46,7 @@ task('screenshots', () => {
 
 function updateFileResult(database: firebase.database.Database, prNumber: string,
                           filenameKey: string, result: boolean) {
-  return getPullRequestRef(database, prNumber).child('results').child(filenameKey).set(result)  ;
+  return getPullRequestRef(database, prNumber).child('results').child(filenameKey).set(result);
 }
 
 function updateResult(database: firebase.database.Database, prNumber: string, result: boolean) {