Merge remote-tracking branch 'origin/v17'

hapijs · Aug 28, 2024 · 239ec33 · 239ec33
2 parents ed25e95 + 3cb73d6
commit 239ec33
Show file tree

Hide file tree

Showing 9 changed files with 117 additions and 12 deletions.
diff --git a/API.md b/API.md
@@ -3087,6 +3087,7 @@ Requires the string value to be a valid [RFC 3986](http://tools.ietf.org/html/rf
     - `relativeOnly` - Restrict only relative URIs.  Defaults to `false`.
     - `allowQuerySquareBrackets` - Allows unencoded square brackets inside the query string. This is **NOT** RFC 3986 compliant but query strings like `abc[]=123&abc[]=456` are very common these days. Defaults to `false`.
     - `domain` - Validate the domain component using the options specified in [`string.domain()`](#stringdomainoptions).
+    - `encodeUri` - When `convert` is true, if the validation fails, attempts to encode the URI using [`encodeURI`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI) before validating it again. This allows to provide, for example, unicode URIs, and have it encoded for you. Defaults to `false`.
 
 ```js
 // Accept git or git http/https

diff --git a/lib/errors.js b/lib/errors.js
@@ -152,14 +152,14 @@ exports.template = function (value, messages, code, state, prefs) {
 
 exports.label = function (flags, state, prefs, messages) {
 
-    if (flags.label) {
-        return flags.label;
-    }
-
     if (!prefs.errors.label) {
         return '';
     }
 
+    if (flags.label) {
+        return flags.label;
+    }
+
     let path = state.path;
     if (prefs.errors.label === 'key' &&
         state.path.length > 1) {

diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -437,6 +437,12 @@ declare namespace Joi {
          * Validate the domain component using the options specified in `string.domain()`.
          */
         domain?: DomainOptions;
+        /**
+         * Encode URI before validation.
+         * 
+         * @default false
+         */
+        encodeUri?: boolean;
     }
 
     interface DataUriOptions {

diff --git a/lib/types/alternatives.js b/lib/types/alternatives.js
@@ -327,10 +327,13 @@ internals.errors = function (failures, { error, state }) {
         const [type, code] = report.code.split('.');
         if (code !== 'base') {
             complex.push({ type: schema.type, report });
-            continue;
         }
-
-        valids.add(type);
+        else if (report.code === 'object.base') {
+            valids.add(report.local.type);
+        }
+        else {
+            valids.add(type);
+        }
     }
 
     // All errors are base types or valids

diff --git a/lib/types/string.js b/lib/types/string.js
@@ -645,7 +645,7 @@ module.exports = Any.extend({
         uri: {
             method(options = {}) {
 
-                Common.assertOptions(options, ['allowRelative', 'allowQuerySquareBrackets', 'domain', 'relativeOnly', 'scheme']);
+                Common.assertOptions(options, ['allowRelative', 'allowQuerySquareBrackets', 'domain', 'relativeOnly', 'scheme', 'encodeUri']);
 
                 if (options.domain) {
                     Common.assertOptions(options.domain, ['allowFullyQualified', 'allowUnicode', 'maxDomainSegments', 'minDomainSegments', 'tlds']);
@@ -661,7 +661,16 @@ module.exports = Any.extend({
                     return helpers.error('string.uri');
                 }
 
-                const match = regex.exec(value);
+                let match = regex.exec(value);
+
+                if (!match && helpers.prefs.convert && options.encodeUri) {
+                    const encoded = encodeURI(value);
+                    match = regex.exec(encoded);
+                    if (match) {
+                        value = encoded;
+                    }
+                }
+
                 if (match) {
                     const matched = match[1] || match[2];
                     if (domain &&

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "joi",
     "description": "Object schema validation",
-    "version": "17.12.0",
+    "version": "17.13.3",
     "repository": "git://github.com/hapijs/joi",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -15,8 +15,8 @@
         "validation"
     ],
     "dependencies": {
-        "@hapi/hoek": "^11.0.2",
-        "@hapi/tlds": "^1.0.2",
+        "@hapi/hoek": "^11.0.4",
+        "@hapi/tlds": "^1.0.6",
         "@hapi/topo": "^6.0.2",
         "@hapi/address": "^5.1.1",
         "@hapi/pinpoint": "^2.0.1",

diff --git a/test/errors.js b/test/errors.js
@@ -587,6 +587,21 @@ describe('errors', () => {
         expect(schema.validate({ x: { y: { a: [1] } } }, { errors: { label: 'key' } }).error).to.be.an.error('"[0]" must be a string');
     });
 
+    it('removes labels when label is false', () => {
+
+        const schema = Joi.object({
+            x: Joi.object({
+                y: Joi.object({
+                    z: Joi.valid('z').label('z'),
+                    a: Joi.array().items(Joi.string().label('item'))
+                })
+            })
+        }).options({ errors: { label: false } });
+
+        expect(schema.validate({ x: { y: { z: 'o' } } }).error).to.be.an.error('must be [z]');
+        expect(schema.validate({ x: { y: { a: [1] } } }).error).to.be.an.error('must be a string');
+    });
+
     describe('annotate()', () => {
 
         it('annotates error', () => {

diff --git a/test/types/alternatives.js b/test/types/alternatives.js
@@ -1983,6 +1983,18 @@ describe('alternatives', () => {
                 [{ p: 'a' }, false, 'oops']
             ]);
         });
+
+        it('validates alternatives with the correct type', () => {
+
+            const schema = Joi.alternatives([
+                Joi.boolean(),
+                Joi.function()
+            ]);
+
+            Helper.validate(schema, [
+                ['wrong', false, '"value" must be one of [boolean, function]']
+            ]);
+        });
     });
 
     describe('when()', () => {

diff --git a/test/types/string.js b/test/types/string.js
@@ -9043,6 +9043,65 @@ describe('string', () => {
             ]);
         });
 
+        it('validates uri with accented characters with encoding', () => {
+
+            const schema = Joi.string().uri({ encodeUri: true });
+
+            Helper.validate(schema, { convert: true }, [
+                ['https://linkedin.com/in/aïssa/', true, 'https://linkedin.com/in/a%C3%AFssa/'],
+                ['https://linkedin.com/in/a%C3%AFssa/', true, 'https://linkedin.com/in/a%C3%AFssa/'],
+                ['/#.domain.com/', false, {
+                    message: '"value" must be a valid uri',
+                    path: [],
+                    type: 'string.uri',
+                    context: { label: 'value', value: '/#.domain.com/' }
+                }]
+            ]);
+        });
+
+        it('validates relative uri with accented characters with encoding', () => {
+
+            const schema = Joi.string().uri({ encodeUri: true, allowRelative: true });
+
+            Helper.validate(schema, { convert: true }, [
+                ['/in/aïssa/', true, '/in/a%C3%AFssa/'],
+                ['/in/a%C3%AFssa/', true, '/in/a%C3%AFssa/']
+            ]);
+        });
+
+        it('validates uri with encodeUri and scheme', () => {
+
+            const schema = Joi.string().uri({ encodeUri: true, scheme: 'https' });
+
+            Helper.validate(schema, { convert: true }, [
+                ['https://linkedin.com/in/aïssa/', true, 'https://linkedin.com/in/a%C3%AFssa/'],
+                ['http://linkedin.com/in/aïssa/', false, {
+                    message: '"value" must be a valid uri with a scheme matching the https pattern',
+                    path: [],
+                    type: 'string.uriCustomScheme',
+                    context: {
+                        scheme: 'https',
+                        value: 'http://linkedin.com/in/aïssa/',
+                        label: 'value'
+                    }
+                }]
+            ]);
+        });
+
+        it('validates uri with accented characters without encoding', () => {
+
+            const schema = Joi.string().uri({ encodeUri: true });
+
+            Helper.validate(schema, { convert: false }, [
+                ['https://linkedin.com/in/aïssa/', false, {
+                    message: '"value" must be a valid uri',
+                    path: [],
+                    type: 'string.uri',
+                    context: { value: 'https://linkedin.com/in/aïssa/', label: 'value' }
+                }]
+            ]);
+        });
+
         it('errors on unknown options', () => {
 
             expect(() => Joi.string().uri({ foo: 'bar', baz: 'qux' })).to.throw('Options contain unknown keys: foo,baz');