Skip to content

Add stricter string validation to neo4j.int #985

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

Merged
merged 2 commits into from
Sep 6, 2022
Merged

Add stricter string validation to neo4j.int #985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82d3bb0
Add stricter string validation to `neo4j.int`
bigmontz Sep 5, 2022
3658401
Apply suggestions from code review
bigmontz Sep 6, 2022
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
34 changes: 30 additions & 4 deletions packages/core/src/integer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -833,10 +833,12 @@ class Integer {
* @access private
* @param {string} str The textual representation of the Integer
* @param {number=} radix The radix in which the text is written (2-36), defaults to 10
* @param {Object} [opts={}] Configuration options
* @param {boolean} [opts.strictStringValidation=false] Enable strict validation generated Integer.
* @returns {!Integer} The corresponding Integer value
* @expose
*/
static fromString (str: string, radix?: number): Integer {
static fromString (str: string, radix?: number, { strictStringValidation }: { strictStringValidation?: boolean} = {}): Integer {
if (str.length === 0) {
throw newError('number format error: empty string')
}
Expand Down Expand Up @@ -867,7 +869,13 @@ class Integer {
let result = Integer.ZERO
for (let i = 0; i < str.length; i += 8) {
const size = Math.min(8, str.length - i)
const value = parseInt(str.substring(i, i + size), radix)
const valueString = str.substring(i, i + size)
const value = parseInt(valueString, radix)

if (strictStringValidation === true && !_isValidNumberFromString(valueString, value, radix)) {
throw newError(`number format error: "${valueString}" is NaN in radix ${radix}: ${str}`)
}

if (size < 8) {
const power = Integer.fromNumber(Math.pow(radix, size))
result = result.multiply(power).add(Integer.fromNumber(value))
Expand All @@ -883,18 +891,20 @@ class Integer {
* Converts the specified value to a Integer.
* @access private
* @param {!Integer|number|string|bigint|!{low: number, high: number}} val Value
* @param {Object} [opts={}] Configuration options
* @param {boolean} [opts.strictStringValidation=false] Enable strict validation generated Integer.
* @returns {!Integer}
* @expose
*/
static fromValue (val: Integerable): Integer {
static fromValue (val: Integerable, opts: { strictStringValidation?: boolean} = {}): Integer {
if (val /* is compatible */ instanceof Integer) {
return val
}
if (typeof val === 'number') {
return Integer.fromNumber(val)
}
if (typeof val === 'string') {
return Integer.fromString(val)
return Integer.fromString(val, undefined, opts)
}
if (typeof val === 'bigint') {
return Integer.fromString(val.toString())
Expand Down Expand Up @@ -946,6 +956,20 @@ class Integer {
}
}

/**
*
* @private
* @param theString
* @param theNumber
* @param radix
* @return {boolean} True if valid
*/
function _isValidNumberFromString (theString: string, theNumber: number, radix: number): boolean {
return !Number.isNaN(theString) &&
!Number.isNaN(theNumber) &&
theNumber.toString(radix).toLocaleLowerCase() === theString.toLocaleLowerCase()
}

type Integerable =
| number
| string
Expand Down Expand Up @@ -1011,6 +1035,8 @@ const TWO_PWR_24 = Integer.fromInt(TWO_PWR_24_DBL)
* Cast value to Integer type.
* @access public
* @param {Mixed} value - The value to use.
* @param {Object} [opts={}] Configuration options
* @param {boolean} [opts.strictStringValidation=false] Enable strict validation generated Integer.
* @return {Integer} - An object of type Integer.
*/
const int = Integer.fromValue
Expand Down
43 changes: 43 additions & 0 deletions packages/core/test/integer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,26 @@ describe('Integer', () => {
newError('number format error: interior "-" character: 123-2')
))

test('Integer.fromString("7891a", undefined, { strictStringValidation: true }) toThrow invalid character', () =>
expect(() => Integer.fromString('7891a', undefined, { strictStringValidation: true })).toThrow(
newError('number format error: "7891a" is NaN in radix 10: 7891a')
))

test('Integer.fromString("78a91", undefined, { strictStringValidation: true }) toThrow invalid character', () =>
expect(() => Integer.fromString('78a91', undefined, { strictStringValidation: true })).toThrow(
newError('number format error: "78a91" is NaN in radix 10: 78a91')
))

test('Integer.fromString("a7891", undefined, { strictStringValidation: true }) toThrow invalid character', () =>
expect(() => Integer.fromString('a7891', undefined, { strictStringValidation: true })).toThrow(
newError('number format error: "a7891" is NaN in radix 10: a7891')
))

test('Integer.fromString("7010", 2, { strictStringValidation: true }) toThrow invalid character', () =>
expect(() => Integer.fromString('7010', 2, { strictStringValidation: true })).toThrow(
newError('number format error: "7010" is NaN in radix 2: 7010')
))

forEachFromValueScenarios(({ input, expectedOutput }) =>
test(`Integer.fromValue(${mayIntegerToString(input)}) toEqual ${expectedOutput}`, () =>
expect(Integer.fromValue(input)).toEqual(expectedOutput))
Expand All @@ -266,6 +286,29 @@ describe('Integer', () => {
expect(int(input)).toEqual(expectedOutput))
)

test('int("7891a", { strictStringValidation: true }) toThrow invalid character', () =>
expect(() => int('7891a', { strictStringValidation: true })).toThrow(
newError('number format error: "7891a" is NaN in radix 10: 7891a')
))

test('int("78a91", { strictStringValidation: true }) toThrow invalid character', () =>
expect(() => int('78a91', { strictStringValidation: true })).toThrow(
newError('number format error: "78a91" is NaN in radix 10: 78a91')
))

test('int("a7891", { strictStringValidation: true }) toThrow invalid character', () =>
expect(() => int('a7891', { strictStringValidation: true })).toThrow(
newError('number format error: "a7891" is NaN in radix 10: a7891')
))

test('int("7891123456789876a", { strictStringValidation: true }) toThrow invalid character', () =>
expect(() => int('7891123456789876a', { strictStringValidation: true })).toThrow(
newError('number format error: "a" is NaN in radix 10: 7891123456789876a')
))

test('int("7891123456789876a") not toThrow invalid character', () =>
expect(() => int('7891123456789876a')).not.toThrow())

forEachStaticToNumberScenarios(({ input, expectedOutput }) =>
test(`Integer.toNumber(${mayIntegerToString(input)}) toEqual ${expectedOutput}`, () =>
expect(Integer.toNumber(input)).toEqual(expectedOutput))
Expand Down