feat: add ignoreDuplicateSlashes option (#3929)

fastify · May 26, 2022 · 39830f8 · 39830f8
1 parent be1000e
commit 39830f8
Show file tree

Hide file tree

Showing 14 changed files with 475 additions and 98 deletions.
diff --git a/build/build-validation.js b/build/build-validation.js
@@ -33,6  33,7 @@ const defaultInitOptions = {
   disableRequestLogging: false,
   jsonShorthand: true,
   ignoreTrailingSlash: false,
   ignoreDuplicateSlashes: false,
   maxParamLength: 100,
   onProtoPoisoning: 'error',
   onConstructorPoisoning: 'error',
@@ -76,6  77,7 @@ const schema = {
       then: { setDefaultValue: true }
     },
     ignoreTrailingSlash: { type: 'boolean', default: defaultInitOptions.ignoreTrailingSlash },
     ignoreDuplicateSlashes: { type: 'boolean', default: defaultInitOptions.ignoreDuplicateSlashes },
     disableRequestLogging: {
       type: 'boolean',
       default: false

diff --git a/docs/Reference/Routes.md b/docs/Reference/Routes.md
@@ -114,7  114,7 @@ fastify.route(options)
   * `slash`: Will register only `/prefix/`.
   * `no-slash`: Will register only `/prefix`.
 
-  Note: this option does not override `ignoreTrailingSlashes` in [Server](./Server.md) configuration.
   Note: this option does not override `ignoreTrailingSlash` in [Server](./Server.md) configuration.
 
 * `request` is defined in [Request](./Request.md).
 

diff --git a/docs/Reference/Server.md b/docs/Reference/Server.md
@@ -17,6  17,7 @@ describes the properties available in that options object.
   - [`maxRequestsPerSocket`](#maxrequestspersocket)
   - [`requestTimeout`](#requesttimeout)
   - [`ignoreTrailingSlash`](#ignoretrailingslash)
   - [`ignoreDuplicateSlashes`](#ignoreduplicateslashes)
   - [`maxParamLength`](#maxparamlength)
   - [`bodyLimit`](#bodylimit)
   - [`onProtoPoisoning`](#onprotopoisoning)
@@ -203,6  204,29 @@ fastify.get('/bar', function (req, reply) {
 })
 ```
 
 ### `ignoreDuplicateSlashes`
 <a id="factory-ignore-duplicate-slashes"></a>
 
 Fastify uses [find-my-way](https://github.com/delvedor/find-my-way) to handle
 routing. You can use `ignoreDuplicateSlashes` option to remove duplicate slashes
 from the path. It removes duplicate slashes in the route path and in the request
 URL. This option applies to *all* route registrations for the resulting server instance.
 
 Note that when `ignoreTrailingSlash` and `ignoreDuplicateSlashes` are both set to true, Fastify will remove duplicate slashes, and then trailing slashes, meaning //a//b//c// will be converted to /a/b/c.
 
   Default: `false`
 
 ```js
 const fastify = require('fastify')({
   ignoreDuplicateSlashes: true
 })
 
 // registers "/foo/bar/"
 fastify.get('///foo//bar//', function (req, reply) {
   reply.send('foo')
 })
 ```
 
 ### `maxParamLength`
 <a id="factory-max-param-length"></a>
 

diff --git a/fastify.d.ts b/fastify.d.ts
@@ -106,6  106,7 @@ export type FastifyServerOptions<
   Logger extends FastifyBaseLogger = FastifyLoggerInstance
 > = {
   ignoreTrailingSlash?: boolean,
   ignoreDuplicateSlashes?: boolean,
   connectionTimeout?: number,
   keepAliveTimeout?: number,
   maxRequestsPerSocket?: number,

diff --git a/fastify.js b/fastify.js
@@ -166,6  166,7 @@ function fastify (options) {
       onBadUrl,
       constraints,
       ignoreTrailingSlash: options.ignoreTrailingSlash || defaultInitOptions.ignoreTrailingSlash,
       ignoreDuplicateSlashes: options.ignoreDuplicateSlashes || defaultInitOptions.ignoreDuplicateSlashes,
       maxParamLength: options.maxParamLength || defaultInitOptions.maxParamLength,
       caseSensitive: options.caseSensitive,
       allowUnsafeRegex: options.allowUnsafeRegex || defaultInitOptions.allowUnsafeRegex,