Fix wrong behavior for enum with Joi 16 & 17 joi.override (kenspiri…

…t#36) joi.override is supported since Joi 16 to reset valid options for one schema.
yarkoyarok · Sep 20, 2022 · dde8116 · dde8116
1 parent c954eda
commit dde8116
Show file tree

Hide file tree

Showing 11 changed files with 343 additions and 18 deletions.
diff --git a/fixtures/joi-obj-16.js b/fixtures/joi-obj-16.js
@@ -91,5 +91,29 @@ module.exports = joi.object().keys({
   readOnlyTrue: joi.string().meta({ readOnly: true }),
   readOnlyFalse: joi.string().meta({ readOnly: false }),
   writeOnlyTrue: joi.string().meta({ writeOnly: true }),
-  writeOnlyFalse: joi.string().meta({ writeOnly: false })
+  writeOnlyFalse: joi.string().meta({ writeOnly: false }),
+  extendedEnum: joi
+    .string()
+    .valid('a', 'b', 'c')
+    .example('a')
+    .example( 'b')
+    .example( 'c')
+    .valid('x', 'y', 'z')
+    .example('x')
+    .example('y')
+    .example('z'),
+  enumWithOverride: joi
+    .string()
+    .valid('a', 'b', 'c')
+    .example('a')
+    .example( 'b')
+    .example( 'c')
+    .valid(joi.override, 'x', 'y', 'z')
+    .example('x', {override: true})
+    .example('y')
+    .example('z'),
+  enumWithEmptyOverride: joi
+    .string()
+    .valid('a', 'b', 'c')
+    .valid(joi.override)
 }).id('person').shared(unifiedString)
diff --git a/fixtures/joi-obj-17.js b/fixtures/joi-obj-17.js
@@ -96,5 +96,29 @@ module.exports = joi.object().keys({
   readOnlyTrue: joi.string().meta({ readOnly: true }),
   readOnlyFalse: joi.string().meta({ readOnly: false }),
   writeOnlyTrue: joi.string().meta({ writeOnly: true }),
-  writeOnlyFalse: joi.string().meta({ writeOnly: false })
+  writeOnlyFalse: joi.string().meta({ writeOnly: false }),
+  extendedEnum: joi
+    .string()
+    .valid('a', 'b', 'c')
+    .example('a')
+    .example( 'b')
+    .example( 'c')
+    .valid('x', 'y', 'z')
+    .example('x')
+    .example('y')
+    .example('z'),
+  enumWithOverride: joi
+    .string()
+    .valid('a', 'b', 'c')
+    .example('a')
+    .example( 'b')
+    .example( 'c')
+    .valid(joi.override, 'x', 'y', 'z')
+    .example('x', {override: true})
+    .example('y')
+    .example('z'),
+  enumWithEmptyOverride: joi
+    .string()
+    .valid('a', 'b', 'c')
+    .valid(joi.override)
 }).id('person').shared(unifiedString)
diff --git a/lib/parsers/json.js b/lib/parsers/json.js
@@ -1,6 +1,24 @@
 /* eslint no-use-before-define: 'off' */
 const _ = require('lodash')
 
+/**
+ * Recognize the `joi.override` representation in `describe()` output.
+ *
+ * `joi.override` is a Symbol that can be used in `joi.any().valid(…)`
+ * statements, to reset the list of valid values. In `describe()` output, it
+ * turns up as an object with 1 property:
+ *
+ * ```
+ * { override: true }
+ * ```
+ */
+function isJoiOverride(e) {
+  return typeof e === 'object'
+         && e !== null
+         && Object.keys(e).length === 1
+         && e.override === true
+}
+
 class JoiJsonSchemaParser {
   constructor() {
     this.childrenFieldName = this._getChildrenFieldName()
@@ -124,8 +142,9 @@ class JoiJsonSchemaParser {
 
   _getEnum(fieldDefn) {
     const enumList = fieldDefn[this.enumFieldName]
-    if (fieldDefn.flags && fieldDefn.flags.only && _.size(enumList) > 1) {
-      return _.uniq(enumList)
+    const filteredEnumList = enumList ? _.filter(enumList, e => !isJoiOverride(e)) : enumList
+    if (fieldDefn.flags && fieldDefn.flags.only && _.size(filteredEnumList) > 1) {
+      return _.uniq(filteredEnumList)
     }
   }
 

diff --git a/outputs/json-draft-04/joi-obj-16.json b/outputs/json-draft-04/joi-obj-16.json
@@ -108,7 +108,7 @@
             }
           ]
         },
-        "genderSpecificSwitch":  {
+        "genderSpecificSwitch": {
           "oneOf": [
             {
               "type": "string"
@@ -334,6 +334,41 @@
         },
         "writeOnlyFalse": {
           "type": "string"
+        },
+        "extendedEnum": {
+          "enum": [
+            "a",
+            "b",
+            "c",
+            "x",
+            "y",
+            "z"
+          ],
+          "examples": [
+            "a",
+            "b",
+            "c",
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "string"
+        },
+        "enumWithOverride": {
+          "enum": [
+            "x",
+            "y",
+            "z"
+          ],
+          "examples": [
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "string"
+        },
+        "enumWithEmptyOverride": {
+          "type": "string"
         }
       },
       "required": [

diff --git a/outputs/json-draft-04/joi-obj-17.json b/outputs/json-draft-04/joi-obj-17.json
@@ -351,6 +351,41 @@
         },
         "writeOnlyFalse": {
           "type": "string"
+        },
+        "extendedEnum": {
+          "enum": [
+            "a",
+            "b",
+            "c",
+            "x",
+            "y",
+            "z"
+          ],
+          "examples": [
+            "a",
+            "b",
+            "c",
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "string"
+        },
+        "enumWithOverride": {
+          "enum": [
+            "x",
+            "y",
+            "z"
+          ],
+          "examples": [
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "string"
+        },
+        "enumWithEmptyOverride": {
+          "type": "string"
         }
       },
       "required": [

diff --git a/outputs/json-draft-2019-09/joi-obj-16.json b/outputs/json-draft-2019-09/joi-obj-16.json
@@ -108,7 +108,7 @@
             }
           ]
         },
-        "genderSpecificSwitch":  {
+        "genderSpecificSwitch": {
           "oneOf": [
             {
               "type": "string"
@@ -335,6 +335,41 @@
         },
         "writeOnlyFalse": {
           "type": "string"
+        },
+        "extendedEnum": {
+          "enum": [
+            "a",
+            "b",
+            "c",
+            "x",
+            "y",
+            "z"
+          ],
+          "examples": [
+            "a",
+            "b",
+            "c",
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "string"
+        },
+        "enumWithOverride": {
+          "enum": [
+            "x",
+            "y",
+            "z"
+          ],
+          "examples": [
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "string"
+        },
+        "enumWithEmptyOverride": {
+          "type": "string"
         }
       },
       "required": [

diff --git a/outputs/json-draft-2019-09/joi-obj-17.json b/outputs/json-draft-2019-09/joi-obj-17.json
@@ -352,6 +352,41 @@
         },
         "writeOnlyFalse": {
           "type": "string"
+        },
+        "extendedEnum": {
+          "enum": [
+            "a",
+            "b",
+            "c",
+            "x",
+            "y",
+            "z"
+          ],
+          "examples": [
+            "a",
+            "b",
+            "c",
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "string"
+        },
+        "enumWithOverride": {
+          "enum": [
+            "x",
+            "y",
+            "z"
+          ],
+          "examples": [
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "string"
+        },
+        "enumWithEmptyOverride": {
+          "type": "string"
         }
       },
       "required": [

diff --git a/outputs/json/joi-obj-16.json b/outputs/json/joi-obj-16.json
@@ -108,16 +108,16 @@
             }
           ]
         },
-        "genderSpecificSwitch":  {
+        "genderSpecificSwitch": {
           "oneOf": [
-             {
-               "type": "string"
-             },
-             {
-               "type": "number"
-             }
-           ]
-         },
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            }
+          ]
+        },
         "height": {
           "$ref": "#/$defs/unit"
         },
@@ -334,6 +334,41 @@
         },
         "writeOnlyFalse": {
           "type": "string"
+        },
+        "extendedEnum": {
+          "enum": [
+            "a",
+            "b",
+            "c",
+            "x",
+            "y",
+            "z"
+          ],
+          "examples": [
+            "a",
+            "b",
+            "c",
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "string"
+        },
+        "enumWithOverride": {
+          "enum": [
+            "x",
+            "y",
+            "z"
+          ],
+          "examples": [
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "string"
+        },
+        "enumWithEmptyOverride": {
+          "type": "string"
         }
       },
       "required": [