etcher/lib/gui/app/components/update-notifier.js

/*
 * Copyright 2016 resin.io
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

'use strict'

const electron = require('electron')
const Bluebird = require('bluebird')
const _ = require('lodash')
const settings = require('../models/settings')
const analytics = require('../modules/analytics')
const units = require('../../../shared/units')
const release = require('../../../shared/release')
const packageJSON = require('../../../../package.json')

/**
 * @summary The number of days the update notifier can be put to sleep
 * @constant
 * @private
 * @type {Number}
 */
exports.UPDATE_NOTIFIER_SLEEP_DAYS = packageJSON.updates.sleepDays

/**
 * @summary The current Electron browser window
 * @constant
 * @private
 * @type {Object}
 */
const currentWindow = electron.remote.getCurrentWindow()

/**
 * @summary Determine if it's time to check for updates
 * @function
 * @public
 *
 * @param {Object} options - options
 * @param {Number} [options.lastSleptUpdateNotifier] - last slept update notifier time
 * @param {String} [options.lastSleptUpdateNotifierVersion] - last slept update notifier version
 * @param {String} options.currentVersion - current version
 * @returns {Boolean} should check for updates
 *
 * @example
 * if (updateNotifier.shouldCheckForUpdates({
 *   lastSleptUpdateNotifier: Date.now(),
 *   lastSleptUpdateNotifierVersion: '1.0.0',
 *   currentVersion: '1.0.0'
 * })) {
 *   console.log('We should check for updates!');
 * }
 */
exports.shouldCheckForUpdates = (options) => {
  if (process.env.ELECTRON_RESIN_UPDATE_LOCK) {
    return false
  }

  _.defaults(options, {
    lastSleptUpdateNotifierVersion: options.currentVersion
  })

  if (_.some([
    !options.lastSleptUpdateNotifier,
    !release.isStableRelease(options.currentVersion),
    options.currentVersion !== options.lastSleptUpdateNotifierVersion
  ])) {
    return true
  }

  return Date.now() - options.lastSleptUpdateNotifier > units.daysToMilliseconds(this.UPDATE_NOTIFIER_SLEEP_DAYS)
}

/**
 * @summary Open the update notifier widget
 * @function
 * @public
 *
 * @param {String} version - version
 * @param {Object} [options] - options
 * @param {Boolean} [options.allowSleepUpdateCheck=true] - allow sleeping the update check
 * @returns {Promise}
 *
 * @example
 * updateNotifier.notify('1.0.0-beta.16', {
 *   allowSleepUpdateCheck: true
 * });
 */
exports.notify = (version, options = {}) => {
  const BUTTONS = [
    'Download',
    'Skip'
  ]

  const BUTTON_CONFIRMATION_INDEX = _.indexOf(BUTTONS, _.first(BUTTONS))
  const BUTTON_REJECTION_INDEX = _.indexOf(BUTTONS, _.last(BUTTONS))

  const dialogOptions = {
    type: 'info',
    buttons: BUTTONS,
    defaultId: BUTTON_CONFIRMATION_INDEX,
    cancelId: BUTTON_REJECTION_INDEX,
    title: 'New Update Available!',
    message: `Etcher ${version} is available for download`
  }

  if (_.get(options, [ 'allowSleepUpdateCheck' ], true)) {
    _.merge(dialogOptions, {
      checkboxLabel: `Remind me again in ${this.UPDATE_NOTIFIER_SLEEP_DAYS} days`,
      checkboxChecked: false
    })
  }

  return new Bluebird((resolve) => {
    electron.remote.dialog.showMessageBox(currentWindow, dialogOptions, (response, checkboxChecked) => {
      return resolve({
        agreed: response === BUTTON_CONFIRMATION_INDEX,
        sleepUpdateCheck: checkboxChecked || false
      })
    })
  }).tap((results) => {
    // Only update the last slept update timestamp if the
    // user ticked the "Remind me again in ..." checkbox,
    // but didn't agree.
    if (results.sleepUpdateCheck && !results.agreed) {
      return Bluebird.all([
        settings.set('lastSleptUpdateNotifier', Date.now()),
        settings.set('lastSleptUpdateNotifierVersion', packageJSON.version)
      ])
    }

    return Bluebird.resolve()
  }).then((results) => {
    analytics.logEvent('Close update modal', {
      sleepUpdateCheck: results.sleepUpdateCheck,
      notifyVersion: version,
      currentVersion: packageJSON.version,
      agreed: results.agreed
    })

    if (results.agreed) {
      electron.shell.openExternal('https://etcher.io?ref=etcher_update')
    }
  })
}