build: payload github status

* Show payload deta on PRs using the Github Statuses API.

Author: devversion

tools/gulp/tasks/payload.ts

@@ -2,16 +2,18 @@ import {task} from 'gulp';
 import {join} from 'path';
 import {statSync} from 'fs';
 import {DIST_ROOT} from '../constants';
-import {spawnSync} from 'child_process';
-import {isTravisMasterBuild} from '../util/travis-ci';
+import {isTravisBuild, isTravisMasterBuild} from '../util/travis-ci';
 import {openFirebaseDashboardDatabase} from '../util/firebase';
+import {setGithubStatus} from '../util/github';
+
+// These imports lack of types.
+const firebase = require('firebase');
 
 const bundlesDir = join(DIST_ROOT, 'bundles');
 
 /** Task which runs test against the size of material. */
-task('payload', ['material:clean-build'], () => {
-
-  let results = {
+task('payload', ['material:clean-build'], async () => {
+  const results = {
     timestamp: Date.now(),
     // Material bundles
     material_umd: getBundleSize('material.umd.js'),
@@ -28,11 +30,32 @@ task('payload', ['material:clean-build'], () => {
   // Print the results to the console, so we can read it from the CI.
   console.log('Payload Results:', JSON.stringify(results, null, 2));
 
-  // Publish the results to firebase when it runs on Travis and not as a PR.
-  if (isTravisMasterBuild()) {
-    return publishResults(results);
-  }
+  if (isTravisBuild()) {
+    // Open a connection to Firebase. For master builds the database will use an admin account.
+    const database = openFirebaseDashboardDatabase(isTravisMasterBuild());
+    const currentSha = process.env['TRAVIS_COMMIT'];
+    const previousPayload = await getLastPayloadResults(database);
+
+    // Calculate library sizes by combining the CDK and Material FESM 2015 bundles.
+    const previousSize = previousPayload.cdk_fesm_2015 + previousPayload.material_fesm_2015;
+    const currentSize = results.cdk_fesm_2015 + results.material_fesm_2015;
+    const deltaSize = currentSize - previousSize;
 
+    setGithubStatus(process.env['TRAVIS_COMMIT'], {
+      result: true,
+      name: 'Library Payload',
+      url: `https://travis-ci.org/angular/material2/jobs/${process.env['TRAVIS_JOB_ID']}`,
+      description: `${deltaSize > 0 ? `+` : ''} ${deltaSize.toFixed(2)}KB`
+    });
+
+    // Publish the results to firebase when it runs on Travis and not as a PR.
+    if (isTravisMasterBuild()) {
+      await database.ref('payloads').child(currentSha).set(results);
+    }
+
+    // Disconnect database connection because Firebase otherwise prevents Gulp from exiting.
+    database.goOffline();
+  }
 });
 
 /** Returns the size of the given library bundle. */
@@ -45,12 +68,14 @@ function getFilesize(filePath: string) {
   return statSync(filePath).size / 1000;
 }
 
-/** Publishes the given results to the firebase database. */
-function publishResults(results: any) {
-  let latestSha = spawnSync('git', ['rev-parse', 'HEAD']).stdout.toString().trim();
-  let database = openFirebaseDashboardDatabase();
+/** Gets the last payload uploaded from previous Travis builds. */
+async function getLastPayloadResults(database: admin.database.Database) {
+  const snapshot = await database.ref('payloads')
+    .orderByChild('timestamp')
+    .limitToLast(1)
+    .once('value');
 
-  // Write the results to the payloads object with the latest Git SHA as key.
-  return database.ref('payloads').child(latestSha).set(results)
-    .then(() => database.goOffline(), () => database.goOffline());
+  // The value of the DataSnapshot is an object with the SHA as a key. Only return the
+  // value of the object because the SHA is not necessary.
+  return snapshot.val()[Object.keys(snapshot.val())[0]];
 }

tools/gulp/util/firebase.ts

@@ -6,21 +6,29 @@ const cloudStorage = require('@google-cloud/storage');
 const screenshotFirebaseConfig = require('../../screenshot-test/functions/config.json');
 
 /** Opens a connection to the firebase realtime database. */
-export function openFirebaseDashboardDatabase() {
-  // Initialize the Firebase application with firebaseAdmin credentials.
-  // Credentials need to be for a Service Account, which can be created in the Firebase console.
-  firebaseAdmin.initializeApp({
-    credential: firebaseAdmin.credential.cert({
+export function openFirebaseDashboardDatabase(adminLogin = true) {
+  // Firebase client can be either the AdminSDK or the normal client. This is necessary because
+  // for Pull Requests the service account credentials are not available on the CI.
+  const firebaseClient = adminLogin ? firebaseAdmin : firebase;
+  const config: any = {
+    databaseURL: 'https://material2-dashboard.firebaseio.com'
+  };
+
+  if (adminLogin) {
+    // Credentials need to be for a Service Account, which can be created in the Firebase console.
+    config['credential'] = firebaseAdmin.credential.cert({
       project_id: 'material2-dashboard',
       client_email: 'firebase-adminsdk-ch1ob@material2-dashboard.iam.gserviceaccount.com',
       // In Travis CI the private key will be incorrect because the line-breaks are escaped.
       // The line-breaks need to persist in the service account private key.
       private_key: decode(process.env['MATERIAL2_FIREBASE_PRIVATE_KEY'])
-    }),
-    databaseURL: 'https://material2-dashboard.firebaseio.com'
-  });
+    });
+  }
+
+  // Initialize the firebase client.
+  firebaseClient.initializeApp(config);
 
-  return firebaseAdmin.database();
+  return firebaseClient.database();
 }
 
 /**

tools/gulp/util/travis-ci.ts

@@ -2,3 +2,7 @@
 export function isTravisMasterBuild() {
   return process.env['TRAVIS_PULL_REQUEST'] === 'false';
 }
+
+export function isTravisBuild() {
+  return process.env['TRAVIS'] === 'true';
+}