Skip to content
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

Conditional Validation for parameter algorithm in isHash function #2296

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Conditional Validation for parameter algorithm in isHash function #2296

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
78f4359
Added utility function to check presence of given key in given object.
Sep 30, 2023
c49c8f6
Test cases for utility method: validateKey
Sep 30, 2023
c2186bd
Conditional validation for parameter algorithm in isHash function
Sep 30, 2023
ffdf76d
Test case changes for optional validation of algorithm in isHash func…
Sep 30, 2023
c49fbc1
Documented changes for conditional validation of parameter algorithm …
Sep 30, 2023
c28b702
Changed error object to regex in validateKey test case.
Sep 30, 2023
8efdfe5
Better way to check key in an object.
Oct 2, 2023
2ade081
Added new test for function validateKey
Oct 2, 2023
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Validator | Description
**isFreightContainerID(str)** | alias for `isISO6346`, check if the string is a valid [ISO 6346](https://en.wikipedia.org/wiki/ISO_6346) shipping container identification.
**isFullWidth(str)** | check if the string contains any full-width chars.
**isHalfWidth(str)** | check if the string contains any half-width chars.
**isHash(str, algorithm)** | check if the string is a hash of type algorithm.<br/><br/>Algorithm is one of `['crc32', 'crc32b', 'md4', 'md5', 'ripemd128', 'ripemd160', 'sha1', 'sha256', 'sha384', 'sha512', 'tiger128', 'tiger160', 'tiger192']`.
**isHash(str, algorithm, _validateAlgorithm)** | check if the string is a hash of type algorithm.<br/><br/>Algorithm is one of `['crc32', 'crc32b', 'md4', 'md5', 'ripemd128', 'ripemd160', 'sha1', 'sha256', 'sha384', 'sha512', 'tiger128', 'tiger160', 'tiger192']`<br/><br/>`_validateAlgorithm` is an optional flag to validate algorithm which defaults to `true`.
**isHexadecimal(str)** | check if the string is a hexadecimal number.
**isHexColor(str)** | check if the string is a hexadecimal color.
**isHSL(str)** | check if the string is an HSL (hue, saturation, lightness, optional alpha) color based on [CSS Colors Level 4 specification][CSS Colors Level 4 Specification].<br/><br/>Comma-separated format supported. Space-separated format supported with the exception of a few edge cases (ex: `hsl(200grad+.1%62%/1)`).
Expand Down
12 changes: 11 additions & 1 deletion src/lib/isHash.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import assertString from './util/assertString';
import validateKey from './util/validateKey';

const lengths = {
md5: 32,
Expand All @@ -16,8 +17,17 @@ const lengths = {
crc32b: 8,
};

export default function isHash(str, algorithm) {

export default function isHash(
str,
algorithm,
_validateAlgorithm = true
) {
assertString(str);
if (_validateAlgorithm) {
/* Validate hash algorithm before defining Regular expression for hash check. */
validateKey(lengths, algorithm, `Unknown hash algorithm: ${algorithm}`);
}
const hash = new RegExp(`^[a-fA-F0-9]{${lengths[algorithm]}}$`);
return hash.test(str);
}
6 changes: 6 additions & 0 deletions src/lib/util/validateKey.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export default function validateKey(object, key, errorMessage) {
if (object[key] === undefined) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if (object[key] === undefined) {
if(object[key]) {
return true;
}
throw new Error(errorMessage);

Copy link
Author

@KUSHAGRARAJTIWARI KUSHAGRARAJTIWARI Oct 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@Daniyal-Qureshi
Thanks for your suggestion. But, if(object[key]) will result false if object[key] is any falsy value like 0, "" (empty string), null, etc. This will defeat the purpose of the function validateKey.

I used a better way of checking the key of any object. Please provide your suggestions on that code.

Copy link
Contributor

Choose a reason for hiding this comment

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

@KUSHAGRARAJTIWARI Previously, you were checking the value of the given key,I suggested the better way to check if the value is undefined, I think you need to check whether is key is present in the object or not.

Copy link
Author

@KUSHAGRARAJTIWARI KUSHAGRARAJTIWARI Oct 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, you are correct. I changed the code and am now using the hasOwnProperty() method. This method sends true if the key is present in the object irrespective of the corresponding value. Using Javascript utility functions is good for code.

After your comment, I recollected that there is a function hasOwnProperty() to check if any key is present in the object or not. Thanks for your comment.

throw new Error(errorMessage);
}
return true;
}
36 changes: 36 additions & 0 deletions test/util.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*/
import assert from 'assert';
import typeOf from '../src/lib/util/typeOf';
import validateKey from '../src/lib/util/validateKey';

describe('Util', () => {
it('should validate different typeOf', () => {
Expand All @@ -17,4 +18,39 @@ describe('Util', () => {
assert.strictEqual(typeOf(2021), 'number');
assert.notStrictEqual(typeOf([]), 'object');
});
it('should validate key in object', () => {
assert.strictEqual(validateKey(
{
a: 1,
b: 2,
},
'a',
'Unknown key found'
), true);
assert.strictEqual(validateKey(
{
a: 1,
b: 2,
},
'b',
'Unknown key found'
), true);
assert.strictEqual(validateKey(
{
1: 'a',
b: 2,
},
1,
'Unknown key found'
), true);

assert.throws(() => validateKey(
{
a: 1,
b: 2,
},
'c',
'Unknown key found'
), /Unknown key found/);
});
});
200 changes: 118 additions & 82 deletions test/validators.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4582,60 +4582,139 @@ describe('Validators', () => {
});

it('should validate hash strings', () => {
['md5', 'md4', 'ripemd128', 'tiger128'].forEach((algorithm) => {
[true, false].forEach((_validateAlgorithm) => {
['md5', 'md4', 'ripemd128', 'tiger128'].forEach((algorithm) => {
test({
validator: 'isHash',
args: [algorithm, _validateAlgorithm],
valid: [
'd94f3f016ae679c3008de268209132f2',
'751adbc511ccbe8edf23d486fa4581cd',
'88dae00e614d8f24cfd5a8b3f8002e93',
'0bf1c35032a71a14c2f719e5a14c1e96',
'd94f3F016Ae679C3008de268209132F2',
'88DAE00e614d8f24cfd5a8b3f8002E93',
],
invalid: [
'q94375dj93458w34',
'39485729348',
'%&FHKJFvk',
'KYT0bf1c35032a71a14c2f719e5a1',
],
});
});

['crc32', 'crc32b'].forEach((algorithm) => {
test({
validator: 'isHash',
args: [algorithm, _validateAlgorithm],
valid: [
'd94f3f01',
'751adbc5',
'88dae00e',
'0bf1c350',
'88DAE00e',
'751aDBc5',
],
invalid: [
'KYT0bf1c35032a71a14c2f719e5a14c1',
'q94375dj93458w34',
'q943',
'39485729348',
'%&FHKJFvk',
],
});
});

['sha1', 'tiger160', 'ripemd160'].forEach((algorithm) => {
test({
validator: 'isHash',
args: [algorithm, _validateAlgorithm],
valid: [
'3ca25ae354e192b26879f651a51d92aa8a34d8d3',
'aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d',
'beb8c3f30da46be179b8df5f5ecb5e4b10508230',
'efd5d3b190e893ed317f38da2420d63b7ae0d5ed',
'AAF4c61ddCC5e8a2dabede0f3b482cd9AEA9434D',
'3ca25AE354e192b26879f651A51d92aa8a34d8D3',
],
invalid: [
'KYT0bf1c35032a71a14c2f719e5a14c1',
'KYT0bf1c35032a71a14c2f719e5a14c1dsjkjkjkjkkjk',
'q94375dj93458w34',
'39485729348',
'%&FHKJFvk',
],
});
});

test({
validator: 'isHash',
args: [algorithm],
args: ['sha256', _validateAlgorithm],
valid: [
'd94f3f016ae679c3008de268209132f2',
'751adbc511ccbe8edf23d486fa4581cd',
'88dae00e614d8f24cfd5a8b3f8002e93',
'0bf1c35032a71a14c2f719e5a14c1e96',
'd94f3F016Ae679C3008de268209132F2',
'88DAE00e614d8f24cfd5a8b3f8002E93',
'2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824',
'1d996e033d612d9af2b44b70061ee0e868bfd14c2dd90b129e1edeb7953e7985',
'80f70bfeaed5886e33536bcfa8c05c60afef5a0e48f699a7912d5e399cdcc441',
'579282cfb65ca1f109b78536effaf621b853c9f7079664a3fbe2b519f435898c',
'2CF24dba5FB0a30e26E83b2AC5b9E29E1b161e5C1fa7425E73043362938b9824',
'80F70bFEAed5886e33536bcfa8c05c60aFEF5a0e48f699a7912d5e399cdCC441',
],
invalid: [
'KYT0bf1c35032a71a14c2f719e5a14c1',
'KYT0bf1c35032a71a14c2f719e5a14c1dsjkjkjkjkkjk',
'q94375dj93458w34',
'39485729348',
'%&FHKJFvk',
'KYT0bf1c35032a71a14c2f719e5a1',
],
});
});

['crc32', 'crc32b'].forEach((algorithm) => {
test({
validator: 'isHash',
args: [algorithm],
args: ['sha384', _validateAlgorithm],
valid: [
'd94f3f01',
'751adbc5',
'88dae00e',
'0bf1c350',
'88DAE00e',
'751aDBc5',
'3fed1f814d28dc5d63e313f8a601ecc4836d1662a19365cbdcf6870f6b56388850b58043f7ebf2418abb8f39c3a42e31',
'b330f4e575db6e73500bd3b805db1a84b5a034e5d21f0041d91eec85af1dfcb13e40bb1c4d36a72487e048ac6af74b58',
'bf547c3fc5841a377eb1519c2890344dbab15c40ae4150b4b34443d2212e5b04aa9d58865bf03d8ae27840fef430b891',
'fc09a3d11368386530f985dacddd026ae1e44e0e297c805c3429d50744e6237eb4417c20ffca8807b071823af13a3f65',
'3fed1f814d28dc5d63e313f8A601ecc4836d1662a19365CBDCf6870f6b56388850b58043f7ebf2418abb8f39c3a42e31',
'b330f4E575db6e73500bd3b805db1a84b5a034e5d21f0041d91EEC85af1dfcb13e40bb1c4d36a72487e048ac6af74b58',
],
invalid: [
'KYT0bf1c35032a71a14c2f719e5a14c1',
'KYT0bf1c35032a71a14c2f719e5a14c1dsjkjkjkjkkjk',
'q94375dj93458w34',
'q943',
'39485729348',
'%&FHKJFvk',
],
});
});

['sha1', 'tiger160', 'ripemd160'].forEach((algorithm) => {
test({
validator: 'isHash',
args: [algorithm],
args: ['sha512', _validateAlgorithm],
valid: [
'3ca25ae354e192b26879f651a51d92aa8a34d8d3',
'aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d',
'beb8c3f30da46be179b8df5f5ecb5e4b10508230',
'efd5d3b190e893ed317f38da2420d63b7ae0d5ed',
'AAF4c61ddCC5e8a2dabede0f3b482cd9AEA9434D',
'3ca25AE354e192b26879f651A51d92aa8a34d8D3',
'9b71d224bd62f3785d96d46ad3ea3d73319bfbc2890caadae2dff72519673ca72323c3d99ba5c11d7c7acc6e14b8c5da0c4663475c2e5c3adef46f73bcdec043',
'83c586381bf5ba94c8d9ba8b6b92beb0997d76c257708742a6c26d1b7cbb9269af92d527419d5b8475f2bb6686d2f92a6649b7f174c1d8306eb335e585ab5049',
'45bc5fa8cb45ee408c04b6269e9f1e1c17090c5ce26ffeeda2af097735b29953ce547e40ff3ad0d120e5361cc5f9cee35ea91ecd4077f3f589b4d439168f91b9',
'432ac3d29e4f18c7f604f7c3c96369a6c5c61fc09bf77880548239baffd61636d42ed374f41c261e424d20d98e320e812a6d52865be059745fdb2cb20acff0ab',
'9B71D224bd62f3785D96d46ad3ea3d73319bFBC2890CAAdae2dff72519673CA72323C3d99ba5c11d7c7ACC6e14b8c5DA0c4663475c2E5c3adef46f73bcDEC043',
'432AC3d29E4f18c7F604f7c3c96369A6C5c61fC09Bf77880548239baffd61636d42ed374f41c261e424d20d98e320e812a6d52865be059745fdb2cb20acff0ab',
],
invalid: [
'KYT0bf1c35032a71a14c2f719e5a14c1',
'KYT0bf1c35032a71a14c2f719e5a14c1dsjkjkjkjkkjk',
'q94375dj93458w34',
'39485729348',
'%&FHKJFvk',
],
});
test({
validator: 'isHash',
args: ['tiger192', _validateAlgorithm],
valid: [
'6281a1f098c5e7290927ed09150d43ff3990a0fe1a48267c',
'56268f7bc269cf1bc83d3ce42e07a85632394737918f4760',
'46fc0125a148788a3ac1d649566fc04eb84a746f1a6e4fa7',
'7731ea1621ae99ea3197b94583d034fdbaa4dce31a67404a',
'6281A1f098c5e7290927ed09150d43ff3990a0fe1a48267C',
'46FC0125a148788a3AC1d649566fc04eb84A746f1a6E4fa7',
],
invalid: [
'KYT0bf1c35032a71a14c2f719e5a14c1',
Expand All @@ -4645,58 +4724,17 @@ describe('Validators', () => {
'%&FHKJFvk',
],
});
});

test({
validator: 'isHash',
args: ['sha256'],
valid: [
'2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824',
'1d996e033d612d9af2b44b70061ee0e868bfd14c2dd90b129e1edeb7953e7985',
'80f70bfeaed5886e33536bcfa8c05c60afef5a0e48f699a7912d5e399cdcc441',
'579282cfb65ca1f109b78536effaf621b853c9f7079664a3fbe2b519f435898c',
'2CF24dba5FB0a30e26E83b2AC5b9E29E1b161e5C1fa7425E73043362938b9824',
'80F70bFEAed5886e33536bcfa8c05c60aFEF5a0e48f699a7912d5e399cdCC441',
],
invalid: [
'KYT0bf1c35032a71a14c2f719e5a14c1',
'KYT0bf1c35032a71a14c2f719e5a14c1dsjkjkjkjkkjk',
'q94375dj93458w34',
'39485729348',
'%&FHKJFvk',
],
});
test({
validator: 'isHash',
args: ['sha384'],
valid: [
'3fed1f814d28dc5d63e313f8a601ecc4836d1662a19365cbdcf6870f6b56388850b58043f7ebf2418abb8f39c3a42e31',
'b330f4e575db6e73500bd3b805db1a84b5a034e5d21f0041d91eec85af1dfcb13e40bb1c4d36a72487e048ac6af74b58',
'bf547c3fc5841a377eb1519c2890344dbab15c40ae4150b4b34443d2212e5b04aa9d58865bf03d8ae27840fef430b891',
'fc09a3d11368386530f985dacddd026ae1e44e0e297c805c3429d50744e6237eb4417c20ffca8807b071823af13a3f65',
'3fed1f814d28dc5d63e313f8A601ecc4836d1662a19365CBDCf6870f6b56388850b58043f7ebf2418abb8f39c3a42e31',
'b330f4E575db6e73500bd3b805db1a84b5a034e5d21f0041d91EEC85af1dfcb13e40bb1c4d36a72487e048ac6af74b58',
],
invalid: [
'KYT0bf1c35032a71a14c2f719e5a14c1',
'KYT0bf1c35032a71a14c2f719e5a14c1dsjkjkjkjkkjk',
'q94375dj93458w34',
'39485729348',
'%&FHKJFvk',
],
});
test({
validator: 'isHash',
args: ['sha512'],
valid: [
'9b71d224bd62f3785d96d46ad3ea3d73319bfbc2890caadae2dff72519673ca72323c3d99ba5c11d7c7acc6e14b8c5da0c4663475c2e5c3adef46f73bcdec043',
'83c586381bf5ba94c8d9ba8b6b92beb0997d76c257708742a6c26d1b7cbb9269af92d527419d5b8475f2bb6686d2f92a6649b7f174c1d8306eb335e585ab5049',
'45bc5fa8cb45ee408c04b6269e9f1e1c17090c5ce26ffeeda2af097735b29953ce547e40ff3ad0d120e5361cc5f9cee35ea91ecd4077f3f589b4d439168f91b9',
'432ac3d29e4f18c7f604f7c3c96369a6c5c61fc09bf77880548239baffd61636d42ed374f41c261e424d20d98e320e812a6d52865be059745fdb2cb20acff0ab',
'9B71D224bd62f3785D96d46ad3ea3d73319bFBC2890CAAdae2dff72519673CA72323C3d99ba5c11d7c7ACC6e14b8c5DA0c4663475c2E5c3adef46f73bcDEC043',
'432AC3d29E4f18c7F604f7c3c96369A6C5c61fC09Bf77880548239baffd61636d42ed374f41c261e424d20d98e320e812a6d52865be059745fdb2cb20acff0ab',
],
args: ['ABC', false],
invalid: [
'6281a1f098c5e7290927ed09150d43ff3990a0fe1a48267c',
'56268f7bc269cf1bc83d3ce42e07a85632394737918f4760',
'46fc0125a148788a3ac1d649566fc04eb84a746f1a6e4fa7',
'7731ea1621ae99ea3197b94583d034fdbaa4dce31a67404a',
'6281A1f098c5e7290927ed09150d43ff3990a0fe1a48267C',
'46FC0125a148788a3AC1d649566fc04eb84A746f1a6E4fa7',
'KYT0bf1c35032a71a14c2f719e5a14c1',
'KYT0bf1c35032a71a14c2f719e5a14c1dsjkjkjkjkkjk',
'q94375dj93458w34',
Expand All @@ -4706,16 +4744,14 @@ describe('Validators', () => {
});
test({
validator: 'isHash',
args: ['tiger192'],
valid: [
args: ['ABC'],
error: [
'6281a1f098c5e7290927ed09150d43ff3990a0fe1a48267c',
'56268f7bc269cf1bc83d3ce42e07a85632394737918f4760',
'46fc0125a148788a3ac1d649566fc04eb84a746f1a6e4fa7',
'7731ea1621ae99ea3197b94583d034fdbaa4dce31a67404a',
'6281A1f098c5e7290927ed09150d43ff3990a0fe1a48267C',
'46FC0125a148788a3AC1d649566fc04eb84A746f1a6E4fa7',
],
invalid: [
'KYT0bf1c35032a71a14c2f719e5a14c1',
'KYT0bf1c35032a71a14c2f719e5a14c1dsjkjkjkjkkjk',
'q94375dj93458w34',
Expand Down