122685194a
* build: add import/order eslint rule * chore: run lint:js --fix
202 lines
5.2 KiB
TypeScript
202 lines
5.2 KiB
TypeScript
import { expect } from 'chai';
|
|
|
|
import * as deprecate from '../lib/common/deprecate';
|
|
|
|
describe('deprecate', () => {
|
|
let throwing: boolean;
|
|
|
|
beforeEach(() => {
|
|
throwing = process.throwDeprecation;
|
|
deprecate.setHandler(null);
|
|
process.throwDeprecation = true;
|
|
});
|
|
|
|
afterEach(() => {
|
|
process.throwDeprecation = throwing;
|
|
});
|
|
|
|
it('allows a deprecation handler function to be specified', () => {
|
|
const messages: string[] = [];
|
|
|
|
deprecate.setHandler(message => {
|
|
messages.push(message);
|
|
});
|
|
|
|
deprecate.log('this is deprecated');
|
|
expect(messages).to.deep.equal(['this is deprecated']);
|
|
});
|
|
|
|
it('returns a deprecation handler after one is set', () => {
|
|
const messages = [];
|
|
|
|
deprecate.setHandler(message => {
|
|
messages.push(message);
|
|
});
|
|
|
|
deprecate.log('this is deprecated');
|
|
expect(deprecate.getHandler()).to.be.a('function');
|
|
});
|
|
|
|
it('renames a property', () => {
|
|
let msg;
|
|
deprecate.setHandler(m => { msg = m; });
|
|
|
|
const oldProp = 'dingyOldName';
|
|
const newProp = 'shinyNewName';
|
|
|
|
let value = 0;
|
|
const o: Record<string, number> = { [newProp]: value };
|
|
expect(o).to.not.have.property(oldProp);
|
|
expect(o).to.have.property(newProp).that.is.a('number');
|
|
|
|
deprecate.renameProperty(o, oldProp, newProp);
|
|
o[oldProp] = ++value;
|
|
|
|
expect(msg).to.be.a('string');
|
|
expect(msg).to.include(oldProp);
|
|
expect(msg).to.include(newProp);
|
|
|
|
expect(o).to.have.property(newProp).that.is.equal(value);
|
|
expect(o).to.have.property(oldProp).that.is.equal(value);
|
|
});
|
|
|
|
it('doesn\'t deprecate a property not on an object', () => {
|
|
const o: any = {};
|
|
|
|
expect(() => {
|
|
deprecate.removeProperty(o, 'iDoNotExist');
|
|
}).to.throw(/iDoNotExist/);
|
|
});
|
|
|
|
it('deprecates a property of an object', () => {
|
|
let msg;
|
|
deprecate.setHandler(m => { msg = m; });
|
|
|
|
const prop = 'itMustGo';
|
|
const o = { [prop]: 0 };
|
|
|
|
deprecate.removeProperty(o, prop);
|
|
|
|
const temp = o[prop];
|
|
|
|
expect(temp).to.equal(0);
|
|
expect(msg).to.be.a('string');
|
|
expect(msg).to.include(prop);
|
|
});
|
|
|
|
it('deprecates a property of an but retains the existing accessors and setters', () => {
|
|
let msg;
|
|
deprecate.setHandler(m => { msg = m; });
|
|
|
|
const prop = 'itMustGo';
|
|
let i = 1;
|
|
const o = {
|
|
get itMustGo () {
|
|
return i;
|
|
},
|
|
set itMustGo (thing) {
|
|
i = thing + 1;
|
|
}
|
|
};
|
|
|
|
deprecate.removeProperty(o, prop);
|
|
|
|
expect(o[prop]).to.equal(1);
|
|
expect(msg).to.be.a('string');
|
|
expect(msg).to.include(prop);
|
|
o[prop] = 2;
|
|
expect(o[prop]).to.equal(3);
|
|
});
|
|
|
|
it('warns exactly once when a function is deprecated with no replacement', () => {
|
|
let msg;
|
|
deprecate.setHandler(m => { msg = m; });
|
|
|
|
function oldFn () { return 'hello'; }
|
|
const deprecatedFn = deprecate.removeFunction(oldFn, 'oldFn');
|
|
deprecatedFn();
|
|
|
|
expect(msg).to.be.a('string');
|
|
expect(msg).to.include('oldFn');
|
|
});
|
|
|
|
it('warns exactly once when a function is deprecated with a replacement', () => {
|
|
let msg;
|
|
deprecate.setHandler(m => { msg = m; });
|
|
|
|
function oldFn () { return 'hello'; }
|
|
const deprecatedFn = deprecate.renameFunction(oldFn, 'newFn');
|
|
deprecatedFn();
|
|
|
|
expect(msg).to.be.a('string');
|
|
expect(msg).to.include('oldFn');
|
|
expect(msg).to.include('newFn');
|
|
});
|
|
|
|
it('warns only once per item', () => {
|
|
const messages: string[] = [];
|
|
deprecate.setHandler(message => messages.push(message));
|
|
|
|
const key = 'foo';
|
|
const val = 'bar';
|
|
const o = { [key]: val };
|
|
deprecate.removeProperty(o, key);
|
|
|
|
for (let i = 0; i < 3; ++i) {
|
|
expect(o[key]).to.equal(val);
|
|
expect(messages).to.have.length(1);
|
|
}
|
|
});
|
|
|
|
it('warns if deprecated property is already set', () => {
|
|
let msg;
|
|
deprecate.setHandler(m => { msg = m; });
|
|
|
|
const oldProp = 'dingyOldName';
|
|
const newProp = 'shinyNewName';
|
|
|
|
const o: Record<string, number> = { [oldProp]: 0 };
|
|
deprecate.renameProperty(o, oldProp, newProp);
|
|
|
|
expect(msg).to.be.a('string');
|
|
expect(msg).to.include(oldProp);
|
|
expect(msg).to.include(newProp);
|
|
});
|
|
|
|
it('throws an exception if no deprecation handler is specified', () => {
|
|
expect(() => {
|
|
deprecate.log('this is deprecated');
|
|
}).to.throw(/this is deprecated/);
|
|
});
|
|
|
|
describe('moveAPI', () => {
|
|
beforeEach(() => {
|
|
deprecate.setHandler(null);
|
|
});
|
|
|
|
it('should call the original method', () => {
|
|
const warnings = [];
|
|
deprecate.setHandler(warning => warnings.push(warning));
|
|
|
|
let called = false;
|
|
const fn = () => {
|
|
called = true;
|
|
};
|
|
const deprecated = deprecate.moveAPI(fn, 'old', 'new');
|
|
deprecated();
|
|
expect(called).to.equal(true);
|
|
});
|
|
|
|
it('should log the deprecation warning once', () => {
|
|
const warnings: string[] = [];
|
|
deprecate.setHandler(warning => warnings.push(warning));
|
|
|
|
const deprecated = deprecate.moveAPI(() => null, 'old', 'new');
|
|
deprecated();
|
|
expect(warnings).to.have.lengthOf(1);
|
|
deprecated();
|
|
expect(warnings).to.have.lengthOf(1);
|
|
expect(warnings[0]).to.equal('\'old\' is deprecated and will be removed. Please use \'new\' instead.');
|
|
});
|
|
});
|
|
});
|