Merge pull request #11117 from electron/add_deprecations_spec

Add to deprecations spec

lib/common/api/deprecate.js

@@ -1,7 +1,6 @@
 // Deprecate a method.
 const deprecate = function (oldName, newName, fn) {
-  var warned
-  warned = false
+  let warned = false
   return function () {
     if (!(warned || process.noDeprecation)) {
       warned = true
@@ -11,80 +10,31 @@ const deprecate = function (oldName, newName, fn) {
   }
 }
 
-// The method is renamed.
-deprecate.rename = function (object, oldName, newName) {
-  var newMethod, warned
-  warned = false
-  newMethod = function () {
+// The method is aliases and the old method is retained for backwards compat
+deprecate.alias = function (object, deprecatedName, existingName) {
+  let warned = false
+  const newMethod = function () {
     if (!(warned || process.noDeprecation)) {
       warned = true
-      deprecate.warn(oldName, newName)
+      deprecate.warn(deprecatedName, existingName)
     }
-    return this[newName].apply(this, arguments)
+    return this[existingName].apply(this, arguments)
   }
   if (typeof object === 'function') {
-    object.prototype[oldName] = newMethod
+    object.prototype[deprecatedName] = newMethod
   } else {
-    object[oldName] = newMethod
+    object[deprecatedName] = newMethod
   }
 }
 
-// Forward the method to member.
-deprecate.member = function (object, method, member) {
-  var warned
-  warned = false
-  object.prototype[method] = function () {
-    if (!(warned || process.noDeprecation)) {
-      warned = true
-      deprecate.warn(method, member + '.' + method)
-    }
-    return this[member][method].apply(this[member], arguments)
-  }
+deprecate.warn = (oldName, newName) => {
+  return deprecate.log(`'${oldName}' is deprecated. Use '${newName}' instead.`)
 }
 
-// Deprecate a property.
-deprecate.property = function (object, property, method) {
-  return Object.defineProperty(object, property, {
-    get: function () {
-      var warned
-      warned = false
-      if (!(warned || process.noDeprecation)) {
-        warned = true
-        deprecate.warn(property + ' property', method + ' method')
-      }
-      return this[method]()
-    }
-  })
-}
-
-// Deprecate an event.
-deprecate.event = function (emitter, oldName, newName, fn) {
-  var warned = false
-  return emitter.on(newName, function (...args) {
-    // there is listeners for old API.
-    if (this.listenerCount(oldName) > 0) {
-      if (!(warned || process.noDeprecation)) {
-        warned = true
-        deprecate.warn("'" + oldName + "' event", "'" + newName + "' event")
-      }
-      if (fn != null) {
-        fn.apply(this, arguments)
-      } else {
-        this.emit.apply(this, [oldName].concat(args))
-      }
-    }
-  })
-}
-
-// Print deprecation warning.
-deprecate.warn = function (oldName, newName) {
-  return deprecate.log(oldName + ' is deprecated. Use ' + newName + ' instead.')
-}
-
-var deprecationHandler = null
+let deprecationHandler = null
 
 // Print deprecation message.
-deprecate.log = function (message) {
+deprecate.log = (message) => {
   if (typeof deprecationHandler === 'function') {
     deprecationHandler(message)
   } else if (process.throwDeprecation) {
@@ -92,16 +42,61 @@ deprecate.log = function (message) {
   } else if (process.traceDeprecation) {
     return console.trace(message)
   } else {
-    return console.warn('(electron) ' + message)
+    return console.warn(`(electron) ${message}`)
   }
 }
 
-deprecate.setHandler = function (handler) {
+deprecate.setHandler = (handler) => {
   deprecationHandler = handler
 }
 
-deprecate.getHandler = function () {
-  return deprecationHandler
-}
+deprecate.getHandler = () => deprecationHandler
+
+// None of the below methods are used, and so will be commented
+// out until such time that they are needed to be used and tested.
+
+// // Forward the method to member.
+// deprecate.member = (object, method, member) => {
+//   let warned = false
+//   object.prototype[method] = function () {
+//     if (!(warned || process.noDeprecation)) {
+//       warned = true
+//       deprecate.warn(method, `${member}.${method}`)
+//     }
+//     return this[member][method].apply(this[member], arguments)
+//   }
+// }
+//
+// // Deprecate a property.
+// deprecate.property = (object, property, method) => {
+//   return Object.defineProperty(object, property, {
+//     get: function () {
+//       let warned = false
+//       if (!(warned || process.noDeprecation)) {
+//         warned = true
+//         deprecate.warn(`${property} property`, `${method} method`)
+//       }
+//       return this[method]()
+//     }
+//   })
+// }
+//
+// // Deprecate an event.
+// deprecate.event = (emitter, oldName, newName, fn) => {
+//   let warned = false
+//   return emitter.on(newName, function (...args) {
+//     if (this.listenerCount(oldName) > 0) {
+//       if (!(warned || process.noDeprecation)) {
+//         warned = true
+//         deprecate.warn(`'${oldName}' event`, `'${newName}' event`)
+//       }
+//       if (fn != null) {
+//         fn.apply(this, arguments)
+//       } else {
+//         this.emit.apply(this, [oldName].concat(args))
+//       }
+//     }
+//   })
+// }
 
 module.exports = deprecate

spec/api-deprecations-spec.js

@@ -1,5 +1,5 @@
 const assert = require('assert')
-const {deprecations, deprecate} = require('electron')
+const {deprecations, deprecate, nativeImage} = require('electron')
 
 describe('deprecations', () => {
   beforeEach(() => {
@@ -18,6 +18,37 @@ describe('deprecations', () => {
     assert.deepEqual(messages, ['this is deprecated'])
   })
 
+  it('returns a deprecation handler after one is set', () => {
+    const messages = []
+
+    deprecations.setHandler((message) => {
+      messages.push(message)
+    })
+
+    deprecate.log('this is deprecated')
+    assert(typeof deprecations.getHandler() === 'function')
+  })
+
+  it('returns a deprecation warning', () => {
+    const messages = []
+
+    deprecations.setHandler((message) => {
+      messages.push(message)
+    })
+
+    deprecate.warn('old', 'new')
+    assert.deepEqual(messages, [`'old' is deprecated. Use 'new' instead.`])
+  })
+
+  it('renames a method', () => {
+    assert.equal(typeof nativeImage.createFromDataUrl, 'undefined')
+    assert.equal(typeof nativeImage.createFromDataURL, 'function')
+
+    deprecate.alias(nativeImage, 'createFromDataUrl', 'createFromDataURL')
+
+    assert.equal(typeof nativeImage.createFromDataUrl, 'function')
+  })
+
   it('throws an exception if no deprecation handler is specified', () => {
     assert.throws(() => {
       deprecate.log('this is deprecated')