Merge pull request #137 from conveyal/dev

v3.5.0

Author: trevorgerhardt

.travis.yml

@@ -12,6 +12,7 @@ before_install:
 install:
   - yarn
 script:
+  - yarn run lint
   - yarn run cover
   - codecov
 after_success:

README.md

@@ -132,6 +132,15 @@ Options:
 
 ```
 
+#### Slack Notifications
+
+To enable Slack notifications during the deploy process create a [Slack Webhook](https://api.slack.com/incoming-webhooks) and add two entries `SLACK_WEBHOOK` and `SLACK_CHANNEL` to your `env.yml`.
+
+```
+SLACK_CHANNEL: '#devops'
+SLACK_WEBHOOK: https://hooks.slack.com/services/fake-code
+```
+
 ### `lint`
 
 Lint using [Standard](http://standardjs.com/). Everything is passed directly to [`standard-engine`](https://github.com/Flet/standard-engine).

__tests__/lib/__snapshots__/jest.js.snap

@@ -1,3 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
 exports[`test.js generateTestConfig should generate proper config 1`] = `
 Array [
   "-u",

__tests__/lib/__snapshots__/lint-messages.js.snap

@@ -1,3 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
 exports[`import { analysis, project as proj } from '../utils/messages' 1`] = `
 Array [
   undefined,

__tests__/lib/__snapshots__/load-config.js.snap

@@ -1,3 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
 exports[`load-config should work without any config files present 1`] = `
 Object {
   "env": Object {},

__tests__/lib/__snapshots__/util.js.snap

@@ -1,3 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
 exports[`util.js parseEntries should return inputted file paths 1`] = `
 Array [
   Array [

__tests__/lib/push-to-s3.js

@@ -6,12 +6,14 @@ const MOCK_DIR = '__tests__/test-utils/mocks'
 describe('lib > push to s3', () => {
   const configPush = require('../../lib/push-to-s3')
   const loadConfig = require('../../lib/load-config')
+  const createLogger = require('../../lib/logger')
 
   it('should compile JavaScript and CSS and send to s3 via aws-sdk', () => {
     const config = loadConfig(process.cwd(), '~/mastarm/configurations/default', 'test')
     const push = configPush({
       env: 'test',
       config,
+      log: createLogger(),
       minify: false,
       s3bucket: 'test-bucket'
     })

bin/mastarm

@@ -64,24 +64,53 @@ commander
   .option('--cloudfront', 'CloudFront Distribution ID to invalidate.')
   .option('--s3bucket', 'S3 Bucket to push to.')
   .action(function (entries, options) {
+    const commit = require('this-commit')()
+    const username = require('username')
+    const createLogger = require('../lib/logger')
+    const pkg = require('../lib/pkg')
     const pushToS3 = require('../lib/push-to-s3')
+
+    const url = pkg.repository.url.replace('.git', '')
+    const tag = `<${url}/commit/${commit}|${pkg.name}@${commit.slice(0, 6)}>:`
+    const user = username.sync()
     const config = loadConfig(process.cwd(), commander.config, commander.env)
     const get = util.makeGetFn([options, commander, config.settings])
+
+    const env = get('env')
+    const s3bucket = get('s3bucket')
+
     const files = util.parseEntries([...entries, ...(get('entries') || [])])
     util.assertEntriesExist(files)
-    Promise.all(files.map(pushToS3({
-      cloudfront: get('cloudfront'),
+
+    const log = createLogger({channel: config.env.SLACK_CHANNEL || '#devops', webhook: config.env.SLACK_WEBHOOK})
+    const minify = get('minify')
+    const cloudfront = get('cloudfront')
+    const push = pushToS3({
+      cloudfront,
       config,
-      env: get('env'),
-      minify: get('minify'),
-      s3bucket: get('s3bucket')
-    }))).then(() => {
-      console.log('Finished deploying!')
-      process.exit(0)
-    }).catch((err) => {
-      console.error('Error while deploying!')
-      console.error(err.stack)
-      process.exit(1)
+      env,
+      log,
+      minify,
+      s3bucket,
+      tag
+    })
+
+    log(
+`:construction: *${tag} deploy started by <@${user}>*
+:cloud: *cloudfront:* ${cloudfront}
+:hash: *commit:* ${commit}
+:seedling: *env:* ${env}
+:compression: *minify:* ${minify}
+:package: *s3bucket:* ${s3bucket}`
+    ).then(() => {
+      Promise
+        .all(files.map(push))
+        .then(() =>
+          log(`:rocket: ${tag} deploy finished!! :tada: :confetti_ball: :tada:`)
+            .then(() => process.exit(0)))
+        .catch((err) =>
+          log(`:rotating_light: *error deploying ${tag} ${err.message || err}*`)
+            .then(() => process.exit(1)))
     })
   })
 
@@ -90,15 +119,24 @@ commander
   .allowUnknownOption()
   .description('Lint JavaScript [& CSS coming soon!]')
   .action(function () {
+    const eslint = require('eslint')
     const engine = require('standard-engine')
-    const standardOptions = require('standard/options')
     // get lint out of there
     process.argv = process.argv.filter((arg) => arg !== 'lint')
     // Force verbose
     process.argv.push('--verbose')
-    // add babel-eslint parser
-    standardOptions.parser = 'babel-eslint'
-    engine.cli(standardOptions)
+
+    engine.cli({
+      bugs: 'github.com/conveyal/mastarm/issues',
+      cmd: 'mastarm lint',
+      eslint,
+      eslintConfig: {
+        configFile: path.join(__dirname, '../lib/eslintrc.json')
+      },
+      homepage: 'github.com/conveyal/mastarm',
+      tagline: 'never forget to floss...or lint!',
+      version: require('../package.json').version
+    })
   })
 
 commander

lib/browserify.js

@@ -14,6 +14,7 @@ module.exports = function ({
     basedir: process.cwd(),
     cache: {},
     debug: true,
+    fullPaths: env === 'development',
     packageCache: {},
     paths: [
       path.join(__dirname, '/../node_modules'),

lib/eslintrc.json

@@ -0,0 +1,26 @@
+{
+  "extends": [
+    "standard",
+    "standard-jsx",
+    "plugin:flowtype/recommended",
+    "plugin:jsx-a11y/recommended"
+  ],
+  "parser": "babel-eslint",
+  "plugins": [
+    "flowtype",
+    "flowtype-errors",
+    "jsx-a11y"
+  ],
+  "rules": {
+    "flowtype-errors/show-errors": 2,
+    "prefer-const": ["warn", {
+      "destructuring": "all",
+      "ignoreReadBeforeAssign": false
+    }]
+  },
+  "settings": {
+    "flowtype": {
+      "onlyFilesWithFlowAnnotation": true
+    }
+  }
+}

lib/lint-messages.js

@@ -41,7 +41,7 @@ function lintFileContents (messages, js) {
   // what was messages imported as
   let importedAtRootAs = false
   let importedMembersAs
-  let importedMembersLookup = new Map()
+  const importedMembersLookup = new Map()
 
   let rootMatcher, namedMatcher
 

lib/logger.js

@@ -0,0 +1,12 @@
+const slack = require('./notify-slack')
+
+module.exports = function ({channel, webhook} = {}) {
+  if (webhook) console.log(`see slack@${channel} for notifications`)
+  return function (text) {
+    if (webhook) {
+      return slack({channel, text, webhook})
+    } else {
+      return Promise.resolve(console.log(text))
+    }
+  }
+}

lib/notify-slack.js

@@ -0,0 +1,32 @@
+const Slack = require('slack-node')
+const slack = new Slack()
+
+module.exports = function notify ({
+  channel,
+  text,
+  webhook
+}) {
+  return new Promise((resolve, reject) => {
+    try {
+      slack.setWebhook(webhook)
+      slack.webhook({channel, text}, (err, response) => {
+        if (err) {
+          onError(err)
+        } else if (response.statusCode >= 400) {
+          onError(new Error(`${response.statusCode} ${response.response}`))
+        } else {
+          resolve(response)
+        }
+      })
+    } catch (err) {
+      onError(err)
+    }
+
+    function onError (err) {
+      console.log(text)
+      console.error('Error posting to Slack webhook')
+      console.error(err)
+      resolve(err) // Always resolve to avoid logging to cause failure
+    }
+  })
+}

lib/pkg.js

@@ -0,0 +1,8 @@
+const fs = require('fs')
+const path = require('path')
+const pkgPath = path.resolve(process.cwd(), 'package.json')
+if (fs.existsSync(pkgPath)) {
+  module.exports = require(pkgPath)
+} else {
+  module.exports = {}
+}

lib/push-to-s3.js

@@ -10,36 +10,37 @@ module.exports = function ({
   cloudfront,
   config,
   env,
+  log,
   minify,
-  s3bucket
+  s3bucket,
+  tag
 }) {
-  console.log('pushing to s3bucket:', s3bucket, '>cloudfront:', cloudfront, '>env:', env, '>minified:', Boolean(minify))
+  const upload = createUpload({bucket: s3bucket, cloudfront, log, tag})
   return ([entry, outfile]) => (
     path.extname(entry) === '.js'
     ? upload({
       body: browserify({config, entry, env, minify}).bundle(),
-      bucket: s3bucket,
-      cloudfront,
       outfile
     })
     : transformCss({config, entry, env, minify})
         .then((results) =>
-          upload({
-            body: results.css,
-            bucket: s3bucket,
-            cloudfront,
-            outfile
-          })
-        )
+          upload({body: results.css, outfile}))
   )
 }
 
+const createUpload = ({bucket, cloudfront, log, tag}) =>
+  ({body, outfile}) =>
+    upload({body, bucket, cloudfront, log, outfile, tag})
+
 function upload ({
   body,
   bucket,
   cloudfront,
-  outfile
+  log,
+  outfile,
+  tag
 }) {
+  const bucketUrl = `https://s3.amazonaws.com/${bucket}`
   return new Promise((resolve, reject) => {
     const s3object = new AWS.S3({
       params: {
@@ -51,39 +52,40 @@ function upload ({
       }
     })
 
-    console.log('building and pushing %s to s3 bucket %s', outfile, bucket)
-    s3object
-      .upload()
-      .send(function (err) {
-        if (err) return reject(err)
-        console.log('finished pushing %s to s3', outfile)
-
-        if (cloudfront) {
-          const cf = new AWS.CloudFront()
-          console.log('creating invalidation for cf distribution %s at %s', cloudfront, outfile)
-          cf.createInvalidation({
-            DistributionId: cloudfront,
-            InvalidationBatch: {
-              CallerReference: uuid.v4(),
-              Paths: {
-                Quantity: 1,
-                Items: [
-                  '/' + outfile
-                ]
-              }
+    log(`:hammer_and_wrench: ${tag} building ${outfile} and pushing to ${bucket}`).then(() => {
+      s3object
+        .upload()
+        .send(function (err) {
+          if (err) return reject(`s3 upload to ${bucket} rejected with ${err.message}`)
+          log(`:ok_hand: ${tag} finished pushing to <${bucketUrl}/${outfile}|${bucket}/${outfile}>`).then(() => {
+            if (cloudfront) {
+              const cf = new AWS.CloudFront()
+              log(`:earth_asia: ${tag} creating cloudfront invalidation at ${outfile}`).then(() => {
+                cf.createInvalidation({
+                  DistributionId: cloudfront,
+                  InvalidationBatch: {
+                    CallerReference: uuid.v4(),
+                    Paths: {
+                      Quantity: 1,
+                      Items: [
+                        '/' + outfile
+                      ]
+                    }
+                  }
+                }, function (err) {
+                  if (err) return reject(`cf invalidation rejected with ${err.message}`)
+                  done()
+                })
+              })
+            } else {
+              done()
             }
-          }, function (err) {
-            if (err) return reject(err)
-            done()
           })
-        } else {
-          done()
-        }
-      })
+        })
+    })
 
     function done () {
-      console.log('finished deploying %s', outfile)
-      resolve()
+      log(`:checkered_flag: ${tag} finished with ${outfile}`).then(resolve)
     }
   })
 }