Add toolchain update checking on startup (#34)

* Toolchain updating
  * Check for toolchain update at startup
  * Check for toolchain update after switching toolchain
  * Only prompts to update if update has _'rls-preview'_
  * Skips check if toolchain is dated _(e.g. nightly-2017-12-12)_
  * Enabled/disable in settings _(default enabled)_
* Chang _'switched toolchain'_ prompt to a _success_ style one
* Add toolchain update info to readme features
* Add 'other packages not required' note to readme _Install_ section

Author: alexheretic

README.md

@@ -9,22 +9,21 @@ Rust language support for Atom-IDE, powered by the Rust Language Server (RLS).
  - Go to definition (`ctrl` or `cmd` click)
  - Type information and Documentation on hover (hold `ctrl` or `cmd` for more information)
  - Rls toolchain selection in package settings
+ - Rls toolchain update checking at startup
  - Rls configuration using `rls.toml` file at project root, see [rls#configuration](https://github.com/rust-lang-nursery/rls#configuration)
    ```toml
    # rls.toml
    features = ["serde"]
    ```
 
 ## Install
-
 You can install from the command line with:
-
 ```
 $ apm install ide-rust
 ```
-
 Or you can install from Settings view by searching for `ide-rust`.
 
+No other packages or manual setup is required as these will be handled with user prompts after install.
 
 ## Overriding Rls
 The Rls command can be specified manually, for example to run from local source code:
@@ -47,5 +46,4 @@ If stuff isn't working you can try **enabling logging** to debug:
 This will spit out language server message logging into the atom console. Check if requests/responses are being sent or are incorrect. It will also include any Rls stderr messages (as warnings) which may point to Rls bugs.
 
 ## License
-
 MIT License. See the [license](LICENSE) for more details.

lib/index.js

@@ -1,6 +1,7 @@
 const cp = require("child_process")
 const os = require("os")
 const path = require("path")
+const toml = require('toml')
 const _ = require('underscore-plus')
 const RlsProject = require('./rls-project.js')
 const { CompositeDisposable, Disposable } = require('atom')
@@ -61,6 +62,34 @@ function atomPrompt(message, options, buttons) {
   })
 }
 
+/** @return {Promise<string>} new version of update available (falsy otherwise) */
+function checkForToolchainUpdates() {
+  const toolchain = configToolchain()
+
+  return exec(`rustup run ${toolchain} rustc --version`).then(({ stdout }) => {
+    return new Promise((resolve, reject) => {
+      require("https").get(`https://static.rust-lang.org/dist/channel-rust-${toolchain}.toml`,
+        res => {
+        if (res.statusCode !== 200) {
+          return reject(new Error(`check for toolchain update failed, status: ${res.statusCode}`))
+        }
+
+        res.setEncoding("utf8")
+        let body = ""
+        res.on("data", data => body += data)
+        res.on("end", () => {
+          // use a subsection as toml is slow to parse fully
+          let rustcInfo = body.match(/(\[pkg\.rustc\][^\[]*)/m)
+          if (!rustcInfo) return reject(new Error('could not split channel toml output'))
+          let rustcVersion = toml.parse(rustcInfo[1]).pkg.rustc.version.trim()
+          resolve(!stdout.trim().endsWith(rustcVersion) && body.includes('rls-preview') &&
+            `rustc ${rustcVersion}`)
+        })
+      })
+    })
+  })
+}
+
 // Installs rustup
 function installRustup() {
   return exec("curl https://sh.rustup.rs -sSf | sh -s -- -y")
@@ -253,10 +282,69 @@ class RustLanguageClient extends AutoLanguageClient {
           ' For example ***beta*** or ***nightly-2017-11-01***.',
         type: 'string',
         default: 'nightly'
+      },
+      checkForToolchainUpdates: {
+        description: 'Check on startup for toolchain updates, prompting to install if available',
+        type: 'boolean',
+        default: true
       }
     }
   }
 
+  /**
+   * @param {string} reason Reason for the restart, shown in the prompt
+   * TODO I'd actually like to restart all servers with the new toolchain here
+   * but this doesn't currently seem possible see https://github.com/atom/atom-languageclient/issues/135
+   * Until it is possible a 'Reload' prompt is helpful
+   */
+  _restartLanguageServers(reason) {
+    atom.notifications.addSuccess(reason, {
+      _src: 'ide-rust',
+      dismissable: true,
+      detail: 'Close and reopen editor windows or reload atom to ensure usage of the new toolchain',
+      buttons: [{
+        text: 'Reload',
+        className: 'btn-warning',
+        onDidClick: () => atom.commands.dispatch(window, 'window:reload')
+      }]
+    })
+  }
+
+  // check for toolchain updates if installed & not dated
+  _promptToUpdateToolchain() {
+    const toolchain = configToolchain()
+    const datedRegex = /-\d{4,}-\d{2}-\d{2}$/
+
+    if (atom.config.get('ide-rust.checkForToolchainUpdates') && !datedRegex.test(toolchain)) {
+      checkForToolchainUpdates()
+        .then(newVersion => {
+          if (newVersion) {
+            atom.notifications.addInfo(`Rls \`${toolchain}\` toolchain update available`, {
+              description: newVersion,
+              _src: 'ide-rust',
+              dismissable: true,
+              buttons: [{
+                text: 'Update',
+                onDidClick: () => {
+                  clearIdeRustInfos()
+
+                  let updatePromise = exec(`rustup update ${toolchain}`)
+                    .then(() => checkToolchain())
+                    .then(() => checkRls())
+                    .then(() => this._restartLanguageServers(`Updated Rls toolchain`))
+                    .catch(e => console.error(e))
+                  this.busySignalService && this.busySignalService.reportBusyWhile(
+                    `Updating rust \`${toolchain}\` toolchain`,
+                    () => updatePromise)
+                }
+              }]
+            })
+          }
+        })
+        .catch(e => console.error(e))
+    }
+  }
+
   activate() {
     super.activate()
 
@@ -279,21 +367,12 @@ class RustLanguageClient extends AutoLanguageClient {
       _.debounce(({ newValue }) => {
         checkToolchain(this.busySignalService)
           .then(() => checkRls(this.busySignalService))
-          .then(() => {
-            // TODO I'd actually like to restart all servers with the new toolchain here
-            // but this doesn't currently seem possible see https://github.com/atom/atom-languageclient/issues/135
-            // Until it is possible the 'Reload' button should help
-            atomPrompt(`Switched Rls toolchain to \`${newValue}\``, {
-              detail: 'Close and reopen editor windows or reload ' +
-                'atom to ensure usage of the new toolchain',
-              buttons: [{
-                text: 'Reload',
-                onDidClick: () => atom.commands.dispatch(window, 'window:reload')
-              }]
-            })
-          })
+          .then(() => this._restartLanguageServers(`Switched Rls toolchain to \`${newValue}\``))
+          .then(() => this._promptToUpdateToolchain())
       }, 1000)
     ))
+
+    this._promptToUpdateToolchain()
   }
 
   deactivate() {

package-lock.json

@@ -18,8 +18,8 @@
     "atom": ">=1.21.0"
   },
   "dependencies": {
-    "atom-languageclient": "^0.7.2",
-    "atom-package-deps": "^4.6.0",
+    "atom-languageclient": "^0.7.3",
+    "atom-package-deps": "^4.6.1",
     "toml": "^2.3.3",
     "underscore-plus": "^1.6.6"
   },