Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions src/asserts/big-number-assert.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ module.exports = function bigNumberAssert({ validateSignificantDigits = true } =
throw new Error('BigNumber is not installed');
}

BigNumber.DEBUG = !!validateSignificantDigits;

/**
* Class name.
*/
Expand All @@ -38,6 +36,10 @@ module.exports = function bigNumberAssert({ validateSignificantDigits = true } =
*/

this.validate = value => {
const originalDebug = BigNumber.DEBUG;

BigNumber.DEBUG = !!validateSignificantDigits;

try {
const number = new BigNumber(value);

Expand All @@ -50,6 +52,8 @@ module.exports = function bigNumberAssert({ validateSignificantDigits = true } =
}

throw new Violation(this, value);
} finally {
BigNumber.DEBUG = originalDebug;
}

return true;
Expand Down
2 changes: 0 additions & 2 deletions src/asserts/big-number-equal-to-assert.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ module.exports = function bigNumberEqualToAssert(value, { validateSignificantDig
throw new Error('BigNumber is not installed');
}

BigNumber.DEBUG = !!validateSignificantDigits;

/**
* Extend `Assert` with `BigNumberAssert`.
*/
Expand Down
2 changes: 0 additions & 2 deletions src/asserts/big-number-greater-than-assert.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ module.exports = function bigNumberGreaterThanAssert(threshold, { validateSignif
throw new Error('BigNumber is not installed');
}

BigNumber.DEBUG = !!validateSignificantDigits;

/**
* Extend `Assert` with `BigNumberAssert`.
*/
Expand Down
2 changes: 0 additions & 2 deletions src/asserts/big-number-greater-than-or-equal-to-assert.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ module.exports = function bigNumberGreaterThanOrEqualToAssert(threshold, { valid
throw new Error('BigNumber is not installed');
}

BigNumber.DEBUG = !!validateSignificantDigits;

/**
* Extend `Assert` with `BigNumberAssert`.
*/
Expand Down
2 changes: 0 additions & 2 deletions src/asserts/big-number-less-than-assert.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ module.exports = function bigNumberLessThan(threshold, { validateSignificantDigi
throw new Error('BigNumber is not installed');
}

BigNumber.DEBUG = !!validateSignificantDigits;

/**
* Extend `Assert` with `BigNumberAssert`.
*/
Expand Down
2 changes: 0 additions & 2 deletions src/asserts/big-number-less-than-or-equal-to-assert.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ module.exports = function bigNumberLessThanOrEqualToAssert(threshold, { validate
throw new Error('BigNumber is not installed');
}

BigNumber.DEBUG = !!validateSignificantDigits;

/**
* Extend `Assert` with `BigNumberAssert`.
*/
Expand Down
32 changes: 32 additions & 0 deletions test/asserts/big-number-assert.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,36 @@ describe('BigNumberAssert', () => {
}
});
});

it('should restore the original BigNumber.DEBUG value after validation', ({ assert }) => {
const BigNumber = require('bignumber.js');

BigNumber.DEBUG = false;

Assert.bigNumber({ validateSignificantDigits: true }).validate('1.01');

assert.equal(BigNumber.DEBUG, false);

BigNumber.DEBUG = true;

Assert.bigNumber({ validateSignificantDigits: false }).validate('1.01');

assert.equal(BigNumber.DEBUG, true);
});

it('should restore the original BigNumber.DEBUG value even when validation fails', ({ assert }) => {
const BigNumber = require('bignumber.js');

BigNumber.DEBUG = false;

try {
Assert.bigNumber({ validateSignificantDigits: true }).validate('invalid');

assert.fail();
} catch (e) {
assert.ok(e instanceof Violation);
}

assert.equal(BigNumber.DEBUG, false);
});
});
118 changes: 118 additions & 0 deletions test/regression/big-number-debug.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
'use strict';

/**
* Module dependencies.
*/

const { Assert: BaseAssert, Violation } = require('validator.js');
const { describe, it } = require('node:test');
const BigNumber = require('bignumber.js');
const BigNumberEqualToAssert = require('../../src/asserts/big-number-equal-to-assert.js');
const BigNumberGreaterThanAssert = require('../../src/asserts/big-number-greater-than-assert.js');
const BigNumberGreaterThanOrEqualToAssert = require('../../src/asserts/big-number-greater-than-or-equal-to-assert.js');
const BigNumberLessThanAssert = require('../../src/asserts/big-number-less-than-assert.js');
const BigNumberLessThanOrEqualToAssert = require('../../src/asserts/big-number-less-than-or-equal-to-assert.js');

/**
* Extend `Assert` with all BigNumber asserts.
*/

const Assert = BaseAssert.extend({
BigNumberEqualTo: BigNumberEqualToAssert,
BigNumberGreaterThan: BigNumberGreaterThanAssert,
BigNumberGreaterThanOrEqualTo: BigNumberGreaterThanOrEqualToAssert,
BigNumberLessThan: BigNumberLessThanAssert,
BigNumberLessThanOrEqualTo: BigNumberLessThanOrEqualToAssert
});

/**
* Test BigNumber asserts regression - BigNumber.DEBUG preservation.
*/

describe('BigNumber DEBUG Regression', () => {
const asserts = [
{
constructor: options => Assert.bigNumberEqualTo(10, options),
invalidValue: 5,
name: 'BigNumberEqualTo',
validValue: 10
},
{
constructor: options => Assert.bigNumberGreaterThan(10, options),
invalidValue: 5,
name: 'BigNumberGreaterThan',
validValue: 11
},
{
constructor: options => Assert.bigNumberGreaterThanOrEqualTo(10, options),
invalidValue: 5,
name: 'BigNumberGreaterThanOrEqualTo',
validValue: 10
},
{
constructor: options => Assert.bigNumberLessThan(10, options),
invalidValue: 15,
name: 'BigNumberLessThan',
validValue: 9
},
{
constructor: options => Assert.bigNumberLessThanOrEqualTo(10, options),
invalidValue: 15,
name: 'BigNumberLessThanOrEqualTo',
validValue: 10
}
];

const debugValues = [true, false];
const validateSignificantDigitsOptions = [true, false];

asserts.forEach(({ constructor, invalidValue, name, validValue }) => {
describe(name, () => {
debugValues.forEach(initialDebugValue => {
validateSignificantDigitsOptions.forEach(validateSignificantDigits => {
describe(`with DEBUG=${initialDebugValue} and validateSignificantDigits=${validateSignificantDigits}`, () => {
it('should restore original BigNumber.DEBUG value after successful validation', ({ assert }) => {
BigNumber.DEBUG = initialDebugValue;

assert.equal(BigNumber.DEBUG, initialDebugValue);

constructor({ validateSignificantDigits }).validate(validValue);

assert.equal(BigNumber.DEBUG, initialDebugValue);
});

it('should restore original BigNumber.DEBUG value after failed validation', ({ assert }) => {
BigNumber.DEBUG = initialDebugValue;

assert.equal(BigNumber.DEBUG, initialDebugValue);

try {
constructor({ validateSignificantDigits }).validate(invalidValue);
assert.fail();
} catch (e) {
assert.ok(e instanceof Violation);
}

assert.equal(BigNumber.DEBUG, initialDebugValue);
});

it('should restore original BigNumber.DEBUG value after validation with invalid input', ({ assert }) => {
BigNumber.DEBUG = initialDebugValue;

assert.equal(BigNumber.DEBUG, initialDebugValue);

try {
constructor({ validateSignificantDigits }).validate('invalid');
assert.fail();
} catch (e) {
assert.ok(e instanceof Violation);
}

assert.equal(BigNumber.DEBUG, initialDebugValue);
});
});
});
});
});
});
});