Merge pull request #317 from atom/improve-diagnostics-for-http-request-errors

Improve diagnostics for package initialization errors

Author: jasonrudolph

index.js

@@ -11,5 +11,6 @@ module.exports = new TeletypePackage({
     cluster: atom.config.get('teletype.pusherCluster'),
     disableStats: true
   },
-  baseURL: atom.config.get('teletype.baseURL')
+  baseURL: atom.config.get('teletype.baseURL'),
+  getAtomVersion: atom.getVersion.bind(atom)
 })

lib/package-initialization-error-component.js

@@ -1,4 +1,5 @@
 const etch = require('etch')
+const {URL} = require('url')
 const $ = etch.dom
 
 module.exports =
@@ -16,7 +17,6 @@ class PackageInitializationErrorComponent {
   render () {
     return $.div({className: 'PackageInitializationErrorComponent'},
       $.h3(null, 'Teletype initialization failed'),
-      $.p(null, 'Error: ' + this.props.initializationError.message),
       $.p(null, 'Make sure your internet connection is working and restart the package.'),
       $.div(null,
         $.button(
@@ -31,15 +31,38 @@ class PackageInitializationErrorComponent {
       ),
       $.p(null,
         'If the problem persists, visit ',
-        $.a({href: 'https://github.com/atom/teletype/issues/new', className: 'text-info'}, 'atom/teletype'),
+        $.a({href: this.getIssueURL(), className: 'text-info'}, 'atom/teletype'),
         ' and open an issue.'
       )
     )
   }
 
+  getIssueURL () {
+    const {initializationError} = this.props
+
+    const url = new URL('https://github.com/atom/teletype/issues/new')
+    url.searchParams.append('title', 'Package Initialization Error')
+    url.searchParams.append('body',
+      '### Diagnostics\n\n' +
+      '```\n' +
+      initializationError.diagnosticMessage + '\n\n' +
+      '```\n' +
+      '### Versions\n\n' +
+      `**Teletype version**: v${getTeletypeVersion()}\n` +
+      `**Atom version**: ${this.props.getAtomVersion()}\n` +
+      `**Platform**: ${process.platform}\n`
+    )
+
+    return url.href
+  }
+
   async restartTeletype () {
     const {packageManager} = this.props
     await packageManager.deactivatePackage('teletype')
     await packageManager.activatePackage('teletype')
   }
 }
+
+function getTeletypeVersion () {
+  return require('../package.json').version
+}

lib/popover-component.js

@@ -23,7 +23,7 @@ class PopoverComponent {
     const {
       isClientOutdated, initializationError,
       authenticationProvider, portalBindingManager,
-      commandRegistry, clipboard, workspace, notificationManager, packageManager
+      commandRegistry, clipboard, workspace, notificationManager, packageManager, getAtomVersion
     } = this.props
 
     let activeComponent
@@ -36,6 +36,7 @@ class PopoverComponent {
       activeComponent = $(PackageInitializationErrorComponent, {
         ref: 'packageInitializationErrorComponent',
         packageManager,
+        getAtomVersion,
         initializationError
       })
     } else if (this.props.authenticationProvider.isSignedIn()) {

lib/teletype-package.js

@@ -9,9 +9,9 @@ module.exports =
 class TeletypePackage {
   constructor (options) {
     const {
-      baseURL, clipboard, commandRegistry, credentialCache, notificationManager,
-      packageManager, pubSubGateway, pusherKey, pusherOptions,
-      tetherDisconnectWindow, tooltipManager, workspace
+      baseURL, clipboard, commandRegistry, credentialCache, getAtomVersion,
+      notificationManager, packageManager, pubSubGateway, pusherKey,
+      pusherOptions, tetherDisconnectWindow, tooltipManager, workspace
     } = options
 
     this.workspace = workspace
@@ -24,6 +24,7 @@ class TeletypePackage {
     this.pusherKey = pusherKey
     this.pusherOptions = pusherOptions
     this.baseURL = baseURL
+    this.getAtomVersion = getAtomVersion
     this.tetherDisconnectWindow = tetherDisconnectWindow
     this.credentialCache = credentialCache || new CredentialCache()
     this.client = new TeletypeClient({
@@ -132,7 +133,8 @@ class TeletypePackage {
       clipboard: this.clipboard,
       workspace: this.workspace,
       notificationManager: this.notificationManager,
-      packageManager: this.packageManager
+      packageManager: this.packageManager,
+      getAtomVersion: this.getAtomVersion
     })
 
     this.portalStatusBarIndicator.attach()

package.json

@@ -25,7 +25,7 @@
     "temp": "^0.8.3"
   },
   "dependencies": {
-    "@atom/teletype-client": "^0.32.0",
+    "@atom/teletype-client": "^0.33.0",
     "etch": "^0.12.6"
   },
   "consumedServices": {

test/teletype-package.test.js

@@ -1101,6 +1101,7 @@ suite('TeletypePackage', function () {
       commandRegistry: env.commands,
       tooltipManager: env.tooltips,
       clipboard: new FakeClipboard(),
+      getAtomVersion: function () { return 'x.y.z' },
       tetherDisconnectWindow: 300,
       credentialCache
     })