Merge pull request #3372 from atom/deprecation-notice

Show warnings for deprecated APIs

atom/browser/api/lib/app.coffee

@@ -1,3 +1,4 @@
+deprecate = require 'deprecate'
 EventEmitter = require('events').EventEmitter
 
 bindings = process.atomBinding 'app'
@@ -7,19 +8,6 @@ downloadItemBindings = process.atomBinding 'download_item'
 app = bindings.app
 app.__proto__ = EventEmitter.prototype
 
-wrapSession = (session) ->
-  # session is an Event Emitter.
-  session.__proto__ = EventEmitter.prototype
-
-wrapDownloadItem = (downloadItem) ->
-  # downloadItem is an Event Emitter.
-  downloadItem.__proto__ = EventEmitter.prototype
-  # Be compatible with old APIs.
-  downloadItem.url = downloadItem.getUrl()
-  downloadItem.filename = downloadItem.getFilename()
-  downloadItem.mimeType = downloadItem.getMimeType()
-  downloadItem.hasUserGesture = downloadItem.hasUserGesture()
-
 app.setApplicationMenu = (menu) ->
   require('menu').setApplicationMenu menu
 
@@ -47,17 +35,37 @@ app.setAppPath = (path) ->
 app.getAppPath = ->
   appPath
 
-# Be compatible with old API.
+# Helpers.
-app.once 'ready', -> @emit 'finish-launching'
+app.resolveProxy = (url, callback) -> @defaultSession.resolveProxy url, callback
-app.terminate = app.quit
+
-app.getHomeDir = -> @getPath 'home'
+# Deprecated.
-app.getDataPath = -> @getPath 'userData'
+app.getHomeDir = deprecate 'app.getHomeDir', 'app.getPath', ->
-app.setDataPath = (path) -> @setPath 'userData', path
+  @getPath 'home'
-app.resolveProxy = -> @defaultSession.resolveProxy.apply @defaultSession, arguments
+app.getDataPath = deprecate 'app.getDataPath', 'app.getPath', ->
-app.on 'activate', (event, hasVisibleWindows) -> @emit 'activate-with-no-open-windows' if not hasVisibleWindows
+  @getPath 'userData'
+app.setDataPath = deprecate 'app.setDataPath', 'app.setPath', (path) ->
+  @setPath 'userData', path
+deprecate.rename app, 'terminate', 'quit'
+deprecate.event app, 'finish-launching', 'ready', ->
+  setImmediate => # give default app a chance to setup default menu.
+    @emit 'finish-launching'
+deprecate.event app, 'activate-with-no-open-windows', 'activate', (event, hasVisibleWindows) ->
+  @emit 'activate-with-no-open-windows' if not hasVisibleWindows
 
 # Wrappers for native classes.
+wrapSession = (session) ->
+  # session is an EventEmitter.
+  session.__proto__ = EventEmitter.prototype
 sessionBindings._setWrapSession wrapSession
+
+wrapDownloadItem = (downloadItem) ->
+  # downloadItem is an EventEmitter.
+  downloadItem.__proto__ = EventEmitter.prototype
+  # Deprecated.
+  deprecate.property downloadItem, 'url', 'getUrl'
+  deprecate.property downloadItem, 'filename', 'getFilename'
+  deprecate.property downloadItem, 'mimeType', 'getMimeType'
+  deprecate.property downloadItem, 'hasUserGesture', 'hasUserGesture'
 downloadItemBindings._setWrapDownloadItem wrapDownloadItem
 
 # Only one App object pemitted.

atom/browser/api/lib/atom-delegate.coffee

@@ -1,6 +0,0 @@
-module.exports =
-  browserMainParts:
-    preMainMessageLoopRun: ->
-
-setImmediate ->
-  module.exports.browserMainParts.preMainMessageLoopRun()

atom/browser/api/lib/browser-window.coffee

@@ -1,6 +1,7 @@
 EventEmitter = require('events').EventEmitter
 app = require 'app'
 ipc = require 'ipc'
+deprecate = require 'deprecate'
 
 BrowserWindow = process.atomBinding('window').BrowserWindow
 BrowserWindow::__proto__ = EventEmitter.prototype
@@ -71,32 +72,32 @@ BrowserWindow.fromDevToolsWebContents = (webContents) ->
 
 # Helpers.
 BrowserWindow::loadUrl = -> @webContents.loadUrl.apply @webContents, arguments
-BrowserWindow::send = -> @webContents.send.apply @webContents, arguments
-
-# Be compatible with old API.
-BrowserWindow::undo = -> @webContents.undo()
-BrowserWindow::redo = -> @webContents.redo()
-BrowserWindow::cut = -> @webContents.cut()
-BrowserWindow::copy = -> @webContents.copy()
-BrowserWindow::paste = -> @webContents.paste()
-BrowserWindow::selectAll = -> @webContents.selectAll()
-BrowserWindow::restart = -> @webContents.reload()
-BrowserWindow::getUrl = -> @webContents.getUrl()
 BrowserWindow::reload = -> @webContents.reload.apply @webContents, arguments
-BrowserWindow::reloadIgnoringCache = -> @webContents.reloadIgnoringCache.apply @webContents, arguments
+BrowserWindow::send = -> @webContents.send.apply @webContents, arguments
-BrowserWindow::getPageTitle = -> @webContents.getTitle()
-BrowserWindow::isLoading = -> @webContents.isLoading()
-BrowserWindow::isWaitingForResponse = -> @webContents.isWaitingForResponse()
-BrowserWindow::stop = -> @webContents.stop()
-BrowserWindow::isCrashed = -> @webContents.isCrashed()
-BrowserWindow::executeJavaScriptInDevTools = (code) -> @devToolsWebContents?.executeJavaScript code
 BrowserWindow::openDevTools = -> @webContents.openDevTools.apply @webContents, arguments
 BrowserWindow::closeDevTools = -> @webContents.closeDevTools()
 BrowserWindow::isDevToolsOpened = -> @webContents.isDevToolsOpened()
 BrowserWindow::toggleDevTools = -> @webContents.toggleDevTools()
 BrowserWindow::inspectElement = -> @webContents.inspectElement.apply @webContents, arguments
 BrowserWindow::inspectServiceWorker = -> @webContents.inspectServiceWorker()
-BrowserWindow::print = -> @webContents.print.apply @webContents, arguments
+
-BrowserWindow::printToPDF = -> @webContents.printToPDF.apply @webContents, arguments
+# Deprecated.
+deprecate.rename BrowserWindow, 'restart', 'reload'
+deprecate.member BrowserWindow, 'undo', 'webContents'
+deprecate.member BrowserWindow, 'redo', 'webContents'
+deprecate.member BrowserWindow, 'cut', 'webContents'
+deprecate.member BrowserWindow, 'copy', 'webContents'
+deprecate.member BrowserWindow, 'paste', 'webContents'
+deprecate.member BrowserWindow, 'selectAll', 'webContents'
+deprecate.member BrowserWindow, 'getUrl', 'webContents'
+deprecate.member BrowserWindow, 'reloadIgnoringCache', 'webContents'
+deprecate.member BrowserWindow, 'getPageTitle', 'webContents'
+deprecate.member BrowserWindow, 'isLoading', 'webContents'
+deprecate.member BrowserWindow, 'isWaitingForResponse', 'webContents'
+deprecate.member BrowserWindow, 'stop', 'webContents'
+deprecate.member BrowserWindow, 'isCrashed', 'webContents'
+deprecate.member BrowserWindow, 'executeJavaScriptInDevTools', 'webContents'
+deprecate.member BrowserWindow, 'print', 'webContents'
+deprecate.member BrowserWindow, 'printToPDF', 'webContents'
 
 module.exports = BrowserWindow

atom/browser/lib/chrome-extension.coffee

@@ -55,7 +55,7 @@ app.once 'ready', ->
   BrowserWindow = require 'browser-window'
 
   # Load persistented extensions.
-  loadedExtensionsPath = path.join app.getDataPath(), 'DevTools Extensions'
+  loadedExtensionsPath = path.join app.getPath('userData'), 'DevTools Extensions'
 
   try
     loadedExtensions = JSON.parse fs.readFileSync(loadedExtensionsPath)

atom/common/api/atom_bindings.cc

@@ -69,9 +69,6 @@ void AtomBindings::BindTo(v8::Isolate* isolate,
   dict.SetMethod("activateUvLoop",
       base::Bind(&AtomBindings::ActivateUVLoop, base::Unretained(this)));
 
-  // Do not warn about deprecated APIs.
-  dict.Set("noDeprecation", true);
-
 #if defined(MAS_BUILD)
   dict.Set("mas", true);
 #endif

atom/common/api/lib/deprecate.coffee

@@ -0,0 +1,62 @@
+# Deprecate a method.
+deprecate = (oldName, newName, fn) ->
+  warned = false
+  ->
+    unless warned or process.noDeprecation
+      warned = true
+      deprecate.warn oldName, newName
+    fn.apply this, arguments
+
+# The method is renamed.
+deprecate.rename = (object, oldName, newName) ->
+  warned = false
+  newMethod = ->
+    unless warned or process.noDeprecation
+      warned = true
+      deprecate.warn oldName, newName
+    this[newName].apply this, arguments
+  if typeof object is 'function'
+    object.prototype[oldName] = newMethod
+  else
+    object[oldName] = newMethod
+
+# Forward the method to member.
+deprecate.member = (object, method, member) ->
+  warned = false
+  object.prototype[method] = ->
+    unless warned or process.noDeprecation
+      warned = true
+      deprecate.warn method, "#{member}.#{method}"
+    this[member][method].apply this[member], arguments
+
+# Deprecate a property.
+deprecate.property = (object, property, method) ->
+  Object.defineProperty object, property,
+    get: ->
+      warned = false
+      unless warned or process.noDeprecation
+        warned = true
+        deprecate.warn "#{property} property", "#{method} method"
+      this[method]()
+
+# Deprecate an event.
+deprecate.event = (emitter, oldName, newName, fn) ->
+  warned = false
+  emitter.on newName, ->
+    if @listenerCount(oldName) > 0  # there is listeners for old API.
+      unless warned or process.noDeprecation
+        warned = true
+        deprecate.warn "'#{oldName}' event", "'#{newName}' event"
+      fn.apply this, arguments
+
+# Print deprecate warning.
+deprecate.warn = (oldName, newName) ->
+  message = "#{oldName} is deprecated. Use #{newName} instead."
+  if process.throwDeprecation
+    throw new Error(message)
+  else if process.traceDeprecation
+    console.trace message
+  else
+    console.warn "(electron) #{message}"
+
+module.exports = deprecate

atom/renderer/api/lib/ipc.coffee

@@ -1,3 +1,5 @@
+deprecate = require 'deprecate'
+
 binding = process.atomBinding 'ipc'
 v8Util  = process.atomBinding 'v8_util'
 
@@ -14,7 +16,7 @@ ipc.sendToHost = (args...) ->
   binding.send 'ipc-message-host', [args...]
 
 # Deprecated.
-ipc.sendChannel = ipc.send
+deprecate.rename ipc, 'sendChannel', 'send'
-ipc.sendChannelSync = ipc.sendSync
+deprecate.rename ipc, 'sendChannelSync', 'sendSync'
 
 module.exports = ipc

filenames.gypi

@@ -9,7 +9,6 @@
     ],
     'coffee_sources': [
       'atom/browser/api/lib/app.coffee',
-      'atom/browser/api/lib/atom-delegate.coffee',
       'atom/browser/api/lib/auto-updater.coffee',
       'atom/browser/api/lib/auto-updater/auto-updater-mac.coffee',
       'atom/browser/api/lib/auto-updater/auto-updater-win.coffee',
@@ -37,6 +36,7 @@
       'atom/common/api/lib/callbacks-registry.coffee',
       'atom/common/api/lib/clipboard.coffee',
       'atom/common/api/lib/crash-reporter.coffee',
+      'atom/common/api/lib/deprecate.coffee',
       'atom/common/api/lib/native-image.coffee',
       'atom/common/api/lib/shell.coffee',
       'atom/common/lib/init.coffee',