Skip to content

util: allow deprecate on classes #7690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vdeturckheim wants to merge 1 commit into from
Closed

util: allow deprecate on classes #7690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
util: allow deprecate on classes 
Classes objects cannot be called without new. util.deprecate executes
'fn.apply'.

Therefore, classes cannot be deprecated with util.deprecate.

This uses 'new.target' to detect (when process is defined) calls to
constructor to allow deprecate on class.
  • Loading branch information
@vdeturckheim
vdeturckheim committed Jul 14, 2016
commit bec56bcc14649b915ec673d7d551fd06998a8c9f
2 changes: 1 addition & 1 deletion doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ environment variable. For example: `NODE_DEBUG=fs,net,tls`.

## util.deprecate(function, string)

The `util.deprecate()` method wraps the given `function` in such a way that
The `util.deprecate()` method wraps the given `function` or class in such a way that
it is marked as deprecated.

```js
Expand Down
9 changes: 9 additions & 0 deletions lib/internal/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,18 @@ exports._deprecate = function(fn, msg) {
var warned = false;
function deprecated() {
warned = exports.printDeprecationMessage(msg, warned, deprecated);
if (new.target) {
return Reflect.construct(fn, arguments, new.target);
}
return fn.apply(this, arguments);
}

// the wrapper will keep the same prototype as fn to maintain prototype chain
Object.setPrototypeOf(deprecated, fn);
if (fn.prototype) {
Object.setPrototypeOf(deprecated.prototype, fn.prototype);
}

return deprecated;
};

Expand Down
12 changes: 12 additions & 0 deletions test/fixtures/deprecated-userland-class.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
const util = require('util');
const assert = require('assert');

class deprecatedClass {
}

const deprecated = util.deprecate(deprecatedClass, 'deprecatedClass is deprecated.');

const instance = new deprecated();

assert(instance instanceof deprecated);
assert(instance instanceof deprecatedClass);
19 changes: 19 additions & 0 deletions test/fixtures/deprecated-userland-subclass.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
const util = require('util');
const assert = require('assert');

class deprecatedClass {
}

const deprecated = util.deprecate(deprecatedClass, 'deprecatedClass is deprecated.');

class subclass extends deprecated {
constructor() {
super();
}
}

const instance = new subclass();

assert(instance instanceof subclass);
assert(instance instanceof deprecated);
assert(instance instanceof deprecatedClass);
24 changes: 21 additions & 3 deletions test/sequential/test-deprecation-flags.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,14 @@ const execFile = require('child_process').execFile;
const depmod = require.resolve(common.fixturesDir + '/deprecated.js');
const node = process.execPath;

const depUserland =
require.resolve(common.fixturesDir + '/deprecated-userland-function.js');
const depUserlandFunction =
require.resolve(common.fixturesDir + '/deprecated-userland-function.js');

const depUserlandClass =
require.resolve(common.fixturesDir + '/deprecated-userland-class.js');

const depUserlandSubClass =
require.resolve(common.fixturesDir + '/deprecated-userland-subclass.js');

const normal = [depmod];
const noDep = ['--no-deprecation', depmod];
Expand Down Expand Up @@ -39,10 +45,22 @@ execFile(node, traceDep, function(er, stdout, stderr) {
console.log('trace ok');
});

execFile(node, [depUserland], function(er, stdout, stderr) {
execFile(node, [depUserlandFunction], function(er, stdout, stderr) {
console.error('normal: testing deprecated userland function');
assert.equal(er, null);
assert.equal(stdout, '');
assert(/deprecatedFunction is deprecated/.test(stderr));
Copy link
Copy Markdown
Member

@jasnell jasnell Jul 29, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW, an easier way to test for the deprecation warning would be to listen for warning events...

process.on('warning', (warning) => {
  if (warning.name === 'DeprecationWarning') {
    // ...
  }
});

But that doesn't need to be fixed here at all.. just pointing it out

console.error('normal: ok');
});

execFile(node, [depUserlandClass], function(er, stdout, stderr) {
assert.strictEqual(er, null);
assert.strictEqual(stdout, '');
assert(/deprecatedClass is deprecated/.test(stderr));
});

execFile(node, [depUserlandSubClass], function(er, stdout, stderr) {
assert.strictEqual(er, null);
assert.strictEqual(stdout, '');
assert(/deprecatedClass is deprecated/.test(stderr));
});