Merge pull request #1400 from ethereum/cleanappjs

Clean app.js (10)

src/app.js

@@ -27,8 +27,6 @@ var Config = require('./config')
 var Renderer = require('./app/ui/renderer')
 var Compiler = require('remix-solidity').Compiler
 var executionContext = require('./execution-context')
-var Debugger = require('./app/debugger/debugger')
-var StaticAnalysis = require('./app/staticanalysis/staticAnalysisView')
 var FilePanel = require('./app/panels/file-panel')
 var EditorPanel = require('./app/panels/editor-panel')
 var RighthandPanel = require('./app/panels/righthand-panel')
@@ -43,7 +41,6 @@ var BasicReadOnlyExplorer = require('./app/files/basicReadOnlyExplorer')
 var NotPersistedExplorer = require('./app/files/NotPersistedExplorer')
 var toolTip = require('./app/ui/tooltip')
 var TransactionReceiptResolver = require('./transactionReceiptResolver')
-var SourceHighlighter = require('./app/editor/sourceHighlighter')
 
 var styleGuide = require('./app/ui/styles-guide/theme-chooser')
 var styles = styleGuide.chooser()
@@ -113,6 +110,7 @@ var css = csjs`
 class App {
   constructor (api = {}, events = {}, opts = {}) {
     var self = this
+    this.event = new EventManager()
     self._components = {}
     registry.put({api: self, name: 'app'})
 
@@ -230,7 +228,7 @@ class App {
   }
   runCompiler () {
     const self = this
-    if (self._view.transactionDebugger.isActive) return
+    if (self._components.righthandpanel.debugger().isActive) return
 
     self._components.fileManager.saveCurrentFile()
     self._components.editorpanel.getEditor().clearAnnotations()
@@ -259,7 +257,7 @@ class App {
   startdebugging (txHash) {
     const self = this
     self.event.trigger('debuggingRequested', [])
-    self._view.transactionDebugger.debug(txHash)
+    self._components.righthandpanel.debugger().debug(txHash)
   }
   loadFromGist (params) {
     const self = this
@@ -388,10 +386,9 @@ Please make a backup of your contracts and start using http://remix.ethereum.org
 
   // ----------------- Compiler -----------------
   self._components.compiler = new Compiler((url, cb) => self.importFileCb(url, cb))
-  var compiler = self._components.compiler
+  registry.put({api: self._components.compiler, name: 'compiler'})
-  registry.put({api: compiler, name: 'compiler'})
 
-  var offsetToLineColumnConverter = new OffsetToLineColumnConverter(compiler.event)
+  var offsetToLineColumnConverter = new OffsetToLineColumnConverter(self._components.compiler.event)
   registry.put({api: offsetToLineColumnConverter, name: 'offsettolinecolumnconverter'})
 
   // ----------------- UniversalDApp -----------------
@@ -407,15 +404,14 @@ Please make a backup of your contracts and start using http://remix.ethereum.org
   // ----------------- Tx listener -----------------
   var transactionReceiptResolver = new TransactionReceiptResolver()
 
-  var compiledContracts = function () {
-    if (compiler.lastCompilationResult && compiler.lastCompilationResult.data) {
-      return compiler.lastCompilationResult.data.contracts
-    }
-    return null
-  }
   var txlistener = new Txlistener({
     api: {
-      contracts: compiledContracts,
+      contracts: function () {
+        if (self._components.compiler.lastCompilationResult && self._components.compiler.lastCompilationResult.data) {
+          return self._components.compiler.lastCompilationResult.data.contracts
+        }
+        return null
+      },
       resolveReceipt: function (tx, cb) {
         transactionReceiptResolver.resolve(tx, cb)
       }
@@ -452,7 +448,6 @@ Please make a backup of your contracts and start using http://remix.ethereum.org
 
   self._components.editorpanel.event.register('resize', direction => self._adjustLayout(direction))
   self._view.centerpanel.appendChild(self._components.editorpanel.render())
-  var editor = self._components.editorpanel.getEditor()
 
   // The event listener needs to be registered as early as possible, because the
   // parent will send the message upon the "load" event.
@@ -465,8 +460,6 @@ Please make a backup of your contracts and start using http://remix.ethereum.org
     }
   }, false)
 
-  this.event = new EventManager()
-
   // Replace early callback with instant response
   loadFilesCallback = function (files) {
     self.loadFiles(files)
@@ -478,68 +471,22 @@ Please make a backup of your contracts and start using http://remix.ethereum.org
   }
 
   // ---------------- FilePanel --------------------
-  var filePanel = new FilePanel()
+  self._components.filePanel = new FilePanel()
-  self._view.leftpanel.appendChild(filePanel.render())
+  self._view.leftpanel.appendChild(self._components.filePanel.render())
-  filePanel.event.register('resize', delta => self._adjustLayout('left', delta))
+  self._components.filePanel.event.register('resize', delta => self._adjustLayout('left', delta))
 
   // ----------------- Renderer -----------------
   var renderer = new Renderer()
   registry.put({api: renderer, name: 'renderer'})
 
-  // ----------------- StaticAnalysis -----------------
-  var staticanalysis = new StaticAnalysis()
-  registry.put({api: staticanalysis, name: 'staticanalysis'})
-
   // ---------------- Righthand-panel --------------------
   self._components.righthandpanel = new RighthandPanel()
   self._view.rightpanel.appendChild(self._components.righthandpanel.render())
   self._components.righthandpanel.init()
   self._components.righthandpanel.event.register('resize', delta => self._adjustLayout('right', delta))
 
-  var node = document.getElementById('staticanalysisView')
-  node.insertBefore(staticanalysis.render(), node.childNodes[0])
-
-  // ----------------- Debugger -----------------
-  self._view.transactionDebugger = new Debugger('#debugger', new SourceHighlighter())
-  self._view.transactionDebugger.addProvider('vm', executionContext.vm())
-  self._view.transactionDebugger.addProvider('injected', executionContext.internalWeb3())
-  self._view.transactionDebugger.addProvider('web3', executionContext.internalWeb3())
-  self._view.transactionDebugger.switchProvider(executionContext.getProvider())
-
   var txLogger = new TxLogger() // eslint-disable-line  
 
-  var previousInput = ''
-  var saveTimeout = null
-  function editorOnChange () {
-    var currentFile = self._components.config.get('currentFile')
-    if (!currentFile) {
-      return
-    }
-    var input = editor.get(currentFile)
-    if (!input) {
-      return
-    }
-    // if there's no change, don't do anything
-    if (input === previousInput) {
-      return
-    }
-    previousInput = input
-
-    // fire storage update
-    // NOTE: save at most once per 5 seconds
-    if (saveTimeout) {
-      window.clearTimeout(saveTimeout)
-    }
-    saveTimeout = window.setTimeout(() => {
-      fileManager.saveCurrentFile()
-    }, 5000)
-  }
-
-  // auto save the file when content changed
-  editor.event.register('contentChanged', editorOnChange)
-  // save the file when switching
-  editor.event.register('sessionSwitched', editorOnChange)
-
   executionContext.event.register('contextChanged', this, function (context) {
     self.runCompiler()
   })
@@ -552,8 +499,7 @@ Please make a backup of your contracts and start using http://remix.ethereum.org
   var queryParams = new QueryParams()
 
   // check init query parameters from the URL once the compiler is loaded
-  compiler.event.register('compilerLoaded', this, function (version) {
+  self._components.compiler.event.register('compilerLoaded', this, function (version) {
-    previousInput = ''
     self.runCompiler()
 
     if (queryParams.get().context) {

src/app/contract/publishOnSwarm.js

@@ -3,7 +3,7 @@
 var async = require('async')
 var swarmgw = require('swarmgw')
 
-module.exports = (contract, appAPI, cb, swarmVerifiedPublishCallBack) => {
+module.exports = (contract, fileManager, cb, swarmVerifiedPublishCallBack) => {
   // gather list of files to publish
   var sources = []
 
@@ -32,7 +32,7 @@ module.exports = (contract, appAPI, cb, swarmVerifiedPublishCallBack) => {
       return cb('Metadata inconsistency')
     }
 
-    appAPI.fileProviderOf(fileName).get(fileName, (error, content) => {
+    fileManager.fileProviderOf(fileName).get(fileName, (error, content) => {
       if (error) {
         console.log(error)
       } else {

src/app/debugger/debugger.js

@@ -9,8 +9,7 @@ var globlalRegistry = require('../../global/registry')
 /**
  * Manage remix and source highlighting
  */
-function Debugger (id, sourceHighlighter, localRegistry) {
+function Debugger (container, sourceHighlighter, localRegistry) {
-  this.el = document.querySelector(id)
   this._components = {
     sourceHighlighter: sourceHighlighter
   }
@@ -32,7 +31,7 @@ function Debugger (id, sourceHighlighter, localRegistry) {
       }
     })
   this.sourceMappingDecoder = new remixLib.SourceMappingDecoder()
-  this.el.appendChild(this.debugger.render())
+  container.appendChild(this.debugger.render())
   this.isActive = false
 
   this.breakPointManager = new remixCore.code.BreakpointManager(this.debugger, (sourceLocation) => {

src/app/editor/editor.js

@@ -7,6 +7,8 @@ var ace = require('brace')
 
 require('brace/theme/tomorrow_night_blue')
 
+var globalRegistry = require('../../global/registry')
+
 var Range = ace.acequire('ace/range').Range
 require('brace/ext/language_tools')
 require('brace/ext/searchbox')
@@ -63,13 +65,19 @@ document.head.appendChild(yo`
   </style>
 `)
 
-function Editor (opts = {}) {
+function Editor (opts = {}, localRegistry) {
   var self = this
   var el = yo`<div id="input"></div>`
   var editor = ace.edit(el)
   if (styles.appProperties.aceTheme) {
     editor.setTheme('ace/theme/' + styles.appProperties.aceTheme)
   }
+  self._components = {}
+  self._components.registry = localRegistry || globalRegistry
+  self._deps = {
+    fileManager: self._components.registry.get('filemanager').api,
+    config: self._components.registry.get('config').api
+  }
 
   ace.acequire('ace/ext/language_tools')
   editor.setOptions({
@@ -275,11 +283,15 @@ function Editor (opts = {}) {
 
   this.find = (string) => editor.find(string)
 
+  this.previousInput = ''
+  this.saveTimeout = null
   // Do setup on initialisation here
   editor.on('changeSession', function () {
+    editorOnChange(self)
     event.trigger('sessionSwitched', [])
 
     editor.getSession().on('change', function () {
+      editorOnChange(self)
       event.trigger('contentChanged', [])
     })
   })
@@ -290,4 +302,29 @@ function Editor (opts = {}) {
   editor.resize(true)
 }
 
+function editorOnChange (self) {
+  var currentFile = self._deps.config.get('currentFile')
+  if (!currentFile) {
+    return
+  }
+  var input = self.get(currentFile)
+  if (!input) {
+    return
+  }
+  // if there's no change, don't do anything
+  if (input === self.previousInput) {
+    return
+  }
+  self.previousInput = input
+
+  // fire storage update
+  // NOTE: save at most once per 5 seconds
+  if (self.saveTimeout) {
+    window.clearTimeout(self.saveTimeout)
+  }
+  self.saveTimeout = window.setTimeout(() => {
+    self._deps.fileManager.saveCurrentFile()
+  }, 5000)
+}
+
 module.exports = Editor

src/app/panels/righthand-panel.js

@@ -57,7 +57,13 @@ module.exports = class RighthandPanel {
       pluginAPI,
       self._deps.app,
       self._deps.compiler,
-      self._deps.txlistener)
+      self._deps.txlistener
+   )
+
+    var analysisTab = new AnalysisTab(self._components.registry)
+    analysisTab.event.register('newStaticAnaysisWarningMessage', (msg, settings) => { self._components.compile.addWarning(msg, settings) })
+
+    self._components.debuggerTab = new DebuggerTab(self._components.registry)
 
     self._components = {
       pluginManager: pluginManager,
@@ -65,8 +71,8 @@ module.exports = class RighthandPanel {
       compile: new CompileTab(self._components.registry),
       run: new RunTab(self._components.registry),
       settings: new SettingsTab(self._components.registry),
-      analysis: new AnalysisTab(self._components.registry),
+      analysis: analysisTab,
-      debug: new DebuggerTab(self._components.registry),
+      debug: self._components.debuggerTab,
       support: new SupportTab(self._components.registry),
       test: new TestTab(self._components.registry)
     }
@@ -126,6 +132,10 @@ module.exports = class RighthandPanel {
     return self._view.element
   }
 
+  debugger () {
+    return this._components.debug.debugger()
+  }
+
   focusOn (x) {
     if (this._components.tabbedMenu) this._components.tabbedMenu.selectTabByClassName(x)
   }

src/app/tabs/analysis-tab.js

@@ -1,6 +1,7 @@
 var yo = require('yo-yo')
 var csjs = require('csjs-inject')
 var remixLib = require('remix-lib')
+var StaticAnalysis = require('../staticanalysis/staticAnalysisView')
 
 var globalRegistry = require('../../global/registry')
 var EventManager = remixLib.EventManager
@@ -13,12 +14,25 @@ module.exports = class AnalysisTab {
     self.data = {}
     self._components = {}
     self._components.registry = localRegistry || globalRegistry
+    self._deps = {
+      rightHandPanel: self._components.registry.get('righthandpanel').api
+    }
   }
   render () {
     const self = this
+    var staticanalysis = new StaticAnalysis()
+    staticanalysis.event.register('staticAnaysisWarning', (count) => {
+      if (count > 0) {
+        const msg = `Static Analysis raised ${count} warning(s) that requires your attention. Click here to show the warning(s).`
+        const settings = { type: 'staticAnalysisWarning', click: () => self._deps.rightHandPanel.focusOn('staticanalysisView'), useSpan: true }
+        self.event.trigger('newStaticAnaysisWarningMessage', [msg, settings])
+      }
+    })
+    self._components.registry.put({api: staticanalysis, name: 'staticanalysis'})
     if (self._view.el) return self._view.el
     self._view.el = yo`
-      <div class="${css.analysisTabView} "id="staticanalysisView"></div>`
+      <div class="${css.analysisTabView} "id="staticanalysisView">${staticanalysis.render()}</div>`
+
     return self._view.el
   }
 }

src/app/tabs/compile-tab.js

@@ -25,6 +25,7 @@ module.exports = class CompileTab {
       compileIcon: null,
       compileContainer: null,
       errorContainer: null,
+      errorContainerHead: null,
       contractNames: null,
       contractEl: null
     }
@@ -36,9 +37,9 @@ module.exports = class CompileTab {
       editor: self._components.registry.get('editor').api,
       config: self._components.registry.get('config').api,
       compiler: self._components.registry.get('compiler').api,
-      staticAnalysis: self._components.registry.get('staticanalysis').api,
       renderer: self._components.registry.get('renderer').api,
-      rightHandPanel: self._components.registry.get('righthandpanel').api
+      swarmfileProvider: self._components.registry.get('fileproviders/swarm').api,
+      fileManager: self._components.registry.get('filemanager').api
     }
     self.data = {
       hideWarnings: self._deps.config.get('hideWarnings') || false,
@@ -80,6 +81,7 @@ module.exports = class CompileTab {
     self._deps.compiler.event.register('compilationStarted', function start () {
       if (!self._view.compileIcon) return
       self._view.errorContainer.innerHTML = ''
+      self._view.errorContainerHead.innerHTML = ''
       self._view.compileIcon.classList.remove(`${css.bouncingIcon}`)
       self._view.compileIcon.classList.add(`${css.spinningIcon}`)
       self._view.compileIcon.setAttribute('title', 'compiling...')
@@ -139,13 +141,10 @@ module.exports = class CompileTab {
         })
       }
     })
-    self._deps.staticAnalysis.event.register('staticAnaysisWarning', (count) => {
-      if (count) {
-        const msg = `Static Analysis raised ${count} warning(s) that requires your attention. Click here to show the warning(s).`
-        const settings = { type: 'staticAnalysisWarning', click: () => self._deps.rightHandPanel.focusOn('staticanalysisView'), useSpan: true }
-        self._deps.renderer.error(msg, self._view.errorContainer, settings)
   }
-    })
+  addWarning (msg, settings) {
+    const self = this
+    self._deps.renderer.error(msg, self._view.errorContainerHead, settings)
   }
   render () {
     const self = this
@@ -173,6 +172,7 @@ module.exports = class CompileTab {
         </div>
       </div>`
     self._view.errorContainer = yo`<div class='error'></div>`
+    self._view.errorContainerHead = yo`<div class='error'></div>`
     self._view.contractNames = yo`<select class="${css.contractNames}" disabled></select>`
     self._view.contractEl = yo`
       <div class="${css.container}">
@@ -194,6 +194,7 @@ module.exports = class CompileTab {
       <div class="${css.compileTabView}" id="compileTabView">
         ${self._view.compileContainer}
         ${self._view.contractEl}
+        ${self._view.errorContainerHead}
         ${self._view.errorContainer}
       </div>`
     const help = {
@@ -213,8 +214,8 @@ module.exports = class CompileTab {
     function updateAutoCompile (event) { self._deps.config.set('autoCompile', self._view.autoCompile.checked) }
     function compile (event) { self._deps.app.runCompiler() }
     function hideWarnings (event) {
-      self._opts.config.set('hideWarnings', self._view.hideWarningsBox.checked)
+      self._deps.config.set('hideWarnings', self._view.hideWarningsBox.checked)
-      self._api.runCompiler()
+      compile()
     }
     function getContractProperty (property) {
       const select = self._view.contractNames
@@ -305,7 +306,7 @@ module.exports = class CompileTab {
         if (contract.metadata === undefined || contract.metadata.length === 0) {
           modalDialogCustom.alert('This contract does not implement all functions and thus cannot be published.')
         } else {
-          publishOnSwarm(contract, self._api, function (err) {
+          publishOnSwarm(contract, self._deps.fileManager, function (err) {
             if (err) {
               try {
                 err = JSON.stringify(err)
@@ -316,7 +317,7 @@ module.exports = class CompileTab {
               modalDialogCustom.alert(yo`<span>Metadata published successfully.<br />The Swarm address of the metadata file is available in the contract details.</span>`)
             }
           }, function (item) { // triggered each time there's a new verified publish (means hash correspond)
-            self._api.fileProvider('swarm').addReadOnly(item.hash, item.content)
+            self._deps.swarmfileProvider.addReadOnly(item.hash, item.content)
           })
         }
       }

src/app/tabs/debugger-tab.js

@@ -2,6 +2,11 @@ var yo = require('yo-yo')
 var csjs = require('csjs-inject')
 var remixLib = require('remix-lib')
 
+var Debugger = require('../debugger/debugger')
+var SourceHighlighter = require('../editor/sourceHighlighter')
+
+var executionContext = require('../../execution-context')
+
 var globalRegistry = require('../../global/registry')
 var EventManager = remixLib.EventManager
 var styles = require('../ui/styles-guide/theme-chooser').chooser()
@@ -18,12 +23,22 @@ module.exports = class DebuggerTab {
   render () {
     const self = this
     if (self._view.el) return self._view.el
+
     self._view.el = yo`
-      <div class="${css.debuggerTabView} "id="debugView">
+      <div class="${css.debuggerTabView}" id="debugView">
         <div id="debugger" class="${css.debugger}"></div>
       </div>`
+
+    self._view.transactionDebugger = new Debugger(self._view.el.querySelector('#debugger'), new SourceHighlighter())
+    self._view.transactionDebugger.addProvider('vm', executionContext.vm())
+    self._view.transactionDebugger.addProvider('injected', executionContext.internalWeb3())
+    self._view.transactionDebugger.addProvider('web3', executionContext.internalWeb3())
+    self._view.transactionDebugger.switchProvider(executionContext.getProvider())
     return self._view.el
   }
+  debugger () {
+    return this._view.transactionDebugger
+  }
 }
 const css = csjs`
   .debuggerTabView {