feat(validators): add promise as property resolver

dobromir-hristov · dobromir-hristov · commit aab11d16a804 · 2020-01-03T20:36:52.000+02:00
Works with requiredIf and requiredUnless
diff --git a/packages/validators/src/raw/__tests__/requiredIf.spec.js b/packages/validators/src/raw/__tests__/requiredIf.spec.js
@@ -2,6 +2,8 @@ import requiredIf from '../requiredIf'
 
 const T = () => true
 const F = () => false
+const promiseT = () => Promise.resolve(true)
+const promiseF = () => Promise.resolve(false)
 
 describe('requiredIf validator', () => {
   it('should not validate empty string when functional condition is met', () => {
@@ -19,4 +21,18 @@ describe('requiredIf validator', () => {
   it('should validate empty string when simple boolean condition not met', () => {
     expect(requiredIf('')('')).toBe(true)
   })
+
+  it('should return a promise when passed a promise condition', () => {
+    const response = requiredIf(promiseT)('')
+    expect(response).toHaveProperty('then') // is a promise
+  })
+
+  it('should validate value if condition is a truthy promise', async () => {
+    expect(await requiredIf(promiseT)('')).toBe(false)
+    expect(await requiredIf(promiseT)('someValue')).toBe(true)
+  })
+
+  it('should NOT validate value if condition is a falsy promise', async () => {
+    expect(await requiredIf(promiseF)('')).toBe(true)
+  })
 })
diff --git a/packages/validators/src/raw/requiredIf.js b/packages/validators/src/raw/requiredIf.js
@@ -1,7 +1,21 @@
 import { req } from '../common'
-import { isTruthy } from '../utils/common'
+import { isPromise } from '../utils/common'
 
-// TODO: Double check
+const validate = (prop, val) => prop ? req(val) : true
+/**
+ * Returns required if the passed property is truthy
+ * @param {Boolean | String | function(): (Boolean | Promise<boolean>)} prop
+ * @return {function(*): (Boolean | Promise<Boolean>)}
+ */
 export default (prop) => (value) => {
-  return isTruthy(prop) ? req(value) : true
+  if (typeof prop !== 'function') {
+    return validate(prop, value)
+  }
+  const result = prop()
+  if (isPromise(result)) {
+    return result.then((response) => {
+      return validate(response, value)
+    })
+  }
+  return validate(result, value)
 }
diff --git a/packages/validators/src/raw/requiredUnless.js b/packages/validators/src/raw/requiredUnless.js
@@ -1,6 +1,21 @@
 import { req } from '../common'
-import { isTruthy } from '../utils/common'
+import { isPromise } from '../utils/common'
 
-export default (validateAgainst) => (value) => {
-  return !isTruthy(validateAgainst) ? req(value) : true
+const validate = (prop, val) => !prop ? req(val) : true
+/**
+ * Returns required if the passed property is truthy
+ * @param {Boolean | String | function(): (Boolean | Promise<boolean>)} prop
+ * @return {function(*): (Boolean | Promise<Boolean>)}
+ */
+export default (prop) => (value) => {
+  if (typeof prop !== 'function') {
+    return validate(prop, value)
+  }
+  const result = prop()
+  if (isPromise(result)) {
+    return result.then((response) => {
+      return validate(response, value)
+    })
+  }
+  return validate(result, value)
 }
diff --git a/packages/validators/src/utils/common.js b/packages/validators/src/utils/common.js
@@ -40,3 +40,7 @@ export function isTruthy (prop) {
   prop = unwrap(prop)
   return Boolean(isFunction(prop) ? prop() : prop)
 }
+
+export function isPromise (object) {
+  return isObject(object) && isFunction(object.then)
+}

Original file line number	Diff line number	Diff line change
`@@ -40,3 +40,7 @@ export function isTruthy (prop) {`
`40`	`40`	`prop = unwrap(prop)`
`41`	`41`	`return Boolean(isFunction(prop) ? prop() : prop)`
`42`	`42`	`}`
	`43`	`+`
	`44`	`+export function isPromise (object) {`
	`45`	`+ return isObject(object) && isFunction(object.then)`
	`46`	`+}`