fastify 5.0.0-alpha.2 → 5.0.0-alpha.4

package/test/schema-feature.test.js

@@ -110,7 +110,14 @@ test('Get compilers is empty when settle on routes', t => {
   fastify.post('/', {
     schema: {
       body: { type: 'object', properties: { hello: { type: 'string' } } },
-      response: { '2xx': { foo: { type: 'array', items: { type: 'string' } } } }
+      response: {
+        '2xx': {
+          type: 'object',
+          properties: {
+            foo: { type: 'array', items: { type: 'string' } }
+          }
+        }
+      }
     },
     validatorCompiler: ({ schema, method, url, httpPart }) => {},
     serializerCompiler: ({ schema, method, url, httpPart }) => {}
@@ -160,8 +167,18 @@ test('Cannot add schema for query and querystring', t => {
   fastify.get('/', {
     handler: () => {},
     schema: {
-      query: { foo: { type: 'string' } },
-      querystring: { foo: { type: 'string' } }
+      query: {
+        type: 'object',
+        properties: {
+          foo: { type: 'string' }
+        }
+      },
+      querystring: {
+        type: 'object',
+        properties: {
+          foo: { type: 'string' }
+        }
+      }
     }
   })
 
@@ -179,7 +196,10 @@ test('Should throw of the schema does not exists in input', t => {
     handler: echoParams,
     schema: {
       params: {
-        name: { $ref: '#notExist' }
+        type: 'object',
+        properties: {
+          name: { $ref: '#notExist' }
+        }
       }
     }
   })
@@ -190,6 +210,27 @@ test('Should throw of the schema does not exists in input', t => {
   })
 })
 
+test('Should throw if schema is missing for content type', t => {
+  t.plan(2)
+
+  const fastify = Fastify()
+  fastify.post('/', {
+    handler: echoBody,
+    schema: {
+      body: {
+        content: {
+          'application/json': {}
+        }
+      }
+    }
+  })
+
+  fastify.ready(err => {
+    t.equal(err.code, 'FST_ERR_SCH_CONTENT_MISSING_SCHEMA')
+    t.equal(err.message, "Schema is missing for the content type 'application/json'")
+  })
+})
+
 test('Should throw of the schema does not exists in output', t => {
   t.plan(2)
   const fastify = Fastify()
@@ -199,7 +240,10 @@ test('Should throw of the schema does not exists in output', t => {
     schema: {
       response: {
         '2xx': {
-          name: { $ref: '#notExist' }
+          type: 'object',
+          properties: {
+            name: { $ref: '#notExist' }
+          }
         }
       }
     }
@@ -235,7 +279,10 @@ test('Should not change the input schemas', t => {
       },
       response: {
         '2xx': {
-          name: { $ref: 'helloSchema#/definitions/hello' }
+          type: 'object',
+          properties: {
+            name: { $ref: 'helloSchema#/definitions/hello' }
+          }
         }
       }
     }
@@ -507,12 +554,37 @@ test('Customize validator compiler in instance and route', t => {
   fastify.post('/:id', {
     handler: echoBody,
     schema: {
-      query: { lang: { type: 'string', enum: ['it', 'en'] } },
-      headers: { x: { type: 'string' } },
-      params: { id: { type: 'number' } },
-      body: { foo: { type: 'array' } },
+      query: {
+        type: 'object',
+        properties: {
+          lang: { type: 'string', enum: ['it', 'en'] }
+        }
+      },
+      headers: {
+        type: 'object',
+        properties: {
+          x: { type: 'string' }
+        }
+      },
+      params: {
+        type: 'object',
+        properties: {
+          id: { type: 'number' }
+        }
+      },
+      body: {
+        type: 'object',
+        properties: {
+          foo: { type: 'array' }
+        }
+      },
       response: {
-        '2xx': { foo: { type: 'array', items: { type: 'string' } } }
+        '2xx': {
+          type: 'object',
+          properties: {
+            foo: { type: 'array', items: { type: 'string' } }
+          }
+        }
       }
     }
   })
@@ -525,10 +597,32 @@ test('Customize validator compiler in instance and route', t => {
       return () => { return true } // ignore the validation
     },
     schema: {
-      query: { lang: { type: 'string', enum: ['it', 'en'] } },
-      headers: { x: { type: 'string' } },
-      params: { id: { type: 'number' } },
-      response: { '2xx': { foo: { type: 'array', items: { type: 'string' } } } }
+      query: {
+        type: 'object',
+        properties: {
+          lang: { type: 'string', enum: ['it', 'en'] }
+        }
+      },
+      headers: {
+        type: 'object',
+        properties: {
+          x: { type: 'string' }
+        }
+      },
+      params: {
+        type: 'object',
+        properties: {
+          id: { type: 'number' }
+        }
+      },
+      response: {
+        '2xx': {
+          type: 'object',
+          properties: {
+            foo: { type: 'array', items: { type: 'string' } }
+          }
+        }
+      }
     }
   })
 
@@ -570,7 +664,12 @@ test('Use the same schema across multiple routes', t => {
 
   fastify.get('/first/:id', {
     schema: {
-      params: { id: { $ref: 'test#/properties/id' } }
+      params: {
+        type: 'object',
+        properties: {
+          id: { $ref: 'test#/properties/id' }
+        }
+      }
     },
     handler: (req, reply) => {
       reply.send(typeof req.params.id)
@@ -579,7 +678,12 @@ test('Use the same schema across multiple routes', t => {
 
   fastify.get('/second/:id', {
     schema: {
-      params: { id: { $ref: 'test#/properties/id' } }
+      params: {
+        type: 'object',
+        properties: {
+          id: { $ref: 'test#/properties/id' }
+        }
+      }
     },
     handler: (req, reply) => {
       reply.send(typeof req.params.id)
@@ -622,7 +726,12 @@ test('Encapsulation should intervene', t => {
     instance.get('/:id', {
       handler: echoParams,
       schema: {
-        params: { id: { $ref: 'encapsulation#/properties/id' } }
+        params: {
+          type: 'object',
+          properties: {
+            id: { $ref: 'encapsulation#/properties/id' }
+          }
+        }
       }
     })
     done()
@@ -761,9 +870,19 @@ test('Use the same schema id in different places', t => {
   fastify.post('/:id', {
     handler: echoBody,
     schema: {
-      body: { id: { $ref: 'test#/properties/id' } },
+      body: {
+        type: 'object',
+        properties: {
+          id: { $ref: 'test#/properties/id' }
+        }
+      },
       response: {
-        200: { id: { $ref: 'test#/properties/id' } }
+        200: {
+          type: 'object',
+          properties: {
+            id: { $ref: 'test#/properties/id' }
+          }
+        }
       }
     }
   })
@@ -1333,7 +1452,10 @@ test('The schema compiler recreate itself if needed', t => {
     fastify.get('/:foobarId', {
       schema: {
         params: {
-          foobarId: { $ref: 'identifier#' }
+          type: 'object',
+          properties: {
+            foobarId: { $ref: 'identifier#' }
+          }
         }
       }
     }, echoBody)
@@ -1525,8 +1647,11 @@ test('setSchemaController: Inherits correctly parent schemas with a customized v
       {
         schema: {
           querystring: {
-            msg: {
-              $ref: 'some#'
+            type: 'object',
+            properties: {
+              msg: {
+                $ref: 'some#'
+              }
             }
           },
           response: {
@@ -1635,8 +1760,11 @@ test('setSchemaController: Inherits buildSerializer from parent if not present w
       {
         schema: {
           querystring: {
-            msg: {
-              $ref: 'some#'
+            type: 'object',
+            properties: {
+              msg: {
+                $ref: 'some#'
+              }
             }
           },
           response: {
@@ -1746,8 +1874,11 @@ test('setSchemaController: Inherits buildValidator from parent if not present wi
         {
           schema: {
             querystring: {
-              msg: {
-                $ref: 'some#'
+              type: 'object',
+              properties: {
+                msg: {
+                  $ref: 'some#'
+                }
               }
             },
             response: {
@@ -1838,13 +1969,19 @@ test('Should throw if not default validator passed', async t => {
       {
         schema: {
           query: {
-            msg: {
-              $ref: 'some#'
+            type: 'object',
+            properties: {
+              msg: {
+                $ref: 'some#'
+              }
             }
           },
           headers: {
-            'x-another': {
-              $ref: 'another#'
+            type: 'object',
+            properties: {
+              'x-another': {
+                $ref: 'another#'
+              }
             }
           }
         }
@@ -1899,13 +2036,19 @@ test('Should coerce the array if the default validator is used', async t => {
       {
         schema: {
           query: {
-            msg: {
-              $ref: 'some#'
+            type: 'object',
+            properties: {
+              msg: {
+                $ref: 'some#'
+              }
             }
           },
           headers: {
-            'x-another': {
-              $ref: 'another#'
+            type: 'object',
+            properties: {
+              'x-another': {
+                $ref: 'another#'
+              }
             }
           }
         }

package/test/schema-serialization.test.js

@@ -61,7 +61,7 @@ test('custom serializer options', t => {
 })
 
 test('Different content types', t => {
-  t.plan(32)
+  t.plan(46)
 
   const fastify = Fastify()
   fastify.addSchema({
@@ -81,9 +81,12 @@ test('Different content types', t => {
           content: {
             'application/json': {
               schema: {
-                name: { type: 'string' },
-                image: { type: 'string' },
-                address: { type: 'string' }
+                type: 'object',
+                properties: {
+                  name: { type: 'string' },
+                  image: { type: 'string' },
+                  address: { type: 'string' }
+                }
               }
             },
             'application/vnd.v1+json': {
@@ -95,17 +98,40 @@ test('Different content types', t => {
           }
         },
         201: {
-          content: { type: 'string' }
+          content: {
+            '*/*': {
+              schema: { type: 'string' }
+            }
+          }
         },
         202: {
-          content: { const: 'Processing exclusive content' }
+          content: {
+            '*/*': {
+              schema: { const: 'Processing exclusive content' }
+            }
+          }
         },
         '3xx': {
           content: {
             'application/vnd.v2+json': {
               schema: {
-                fullName: { type: 'string' },
-                phone: { type: 'string' }
+                type: 'object',
+                properties: {
+                  fullName: { type: 'string' },
+                  phone: { type: 'string' }
+                }
+              }
+            }
+          }
+        },
+        '4xx': {
+          content: {
+            '*/*': {
+              schema: {
+                type: 'object',
+                properties: {
+                  details: { type: 'string' }
+                }
               }
             }
           }
@@ -114,7 +140,19 @@ test('Different content types', t => {
           content: {
             'application/json': {
               schema: {
-                details: { type: 'string' }
+                type: 'object',
+                properties: {
+                  details: { type: 'string' }
+                }
+              }
+            },
+            '*/*': {
+              schema: {
+                type: 'object',
+                properties: {
+                  desc: { type: 'string' },
+                  details: { type: 'string' }
+                }
               }
             }
           }
@@ -160,6 +198,15 @@ test('Different content types', t => {
         reply.code(400)
         reply.send({ details: 'validation error' })
         break
+      case 'application/vnd.v8+json':
+        reply.header('Content-Type', 'application/vnd.v8+json')
+        reply.code(500)
+        reply.send({ desc: 'age is missing', details: 'validation error' })
+        break
+      case 'application/vnd.v9+json':
+        reply.code(500)
+        reply.send({ details: 'validation error' })
+        break
       default:
         // to test if schema not found
         reply.header('Content-Type', 'application/vnd.v3+json')
@@ -179,9 +226,24 @@ test('Different content types', t => {
           content: {
             'application/json': {
               schema: {
-                name: { type: 'string' },
-                image: { type: 'string' },
-                address: { type: 'string' }
+                type: 'object',
+                properties: {
+                  name: { type: 'string' },
+                  image: { type: 'string' },
+                  address: { type: 'string' }
+                }
+              }
+            }
+          }
+        },
+        default: {
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  details: { type: 'string' }
+                }
               }
             }
           }
@@ -189,8 +251,23 @@ test('Different content types', t => {
       }
     }
   }, function (req, reply) {
-    reply.header('Content-Type', 'application/json')
-    reply.send({ age: 18, city: 'AU' })
+    switch (req.headers['code']) {
+      case '200': {
+        reply.header('Content-Type', 'application/json')
+        reply.code(200).send({ age: 18, city: 'AU' })
+        break
+      }
+      case '201': {
+        reply.header('Content-Type', 'application/json')
+        reply.code(201).send({ details: 'validation error' })
+        break
+      }
+      default: {
+        reply.header('Content-Type', 'application/vnd.v1+json')
+        reply.code(201).send({ created: true })
+        break
+      }
+    }
   })
 
   fastify.inject({ method: 'GET', url: '/', headers: { Accept: 'application/json' } }, (err, res) => {
@@ -225,19 +302,19 @@ test('Different content types', t => {
 
   fastify.inject({ method: 'GET', url: '/', headers: { Accept: 'application/vnd.v4+json' } }, (err, res) => {
     t.error(err)
-    t.equal(res.payload, JSON.stringify({ content: 'Games' }))
+    t.equal(res.payload, '"[object Object]"')
     t.equal(res.statusCode, 201)
   })
 
   fastify.inject({ method: 'GET', url: '/', headers: { Accept: 'application/vnd.v5+json' } }, (err, res) => {
     t.error(err)
-    t.equal(res.payload, JSON.stringify({ content: 'Processing exclusive content' }))
+    t.equal(res.payload, '"Processing exclusive content"')
     t.equal(res.statusCode, 202)
   })
 
   fastify.inject({ method: 'GET', url: '/', headers: { Accept: 'application/vnd.v6+json' } }, (err, res) => {
     t.error(err)
-    t.equal(res.payload, JSON.stringify({ desc: 'age is missing', details: 'validation error' }))
+    t.equal(res.payload, JSON.stringify({ details: 'validation error' }))
     t.equal(res.statusCode, 400)
   })
 
@@ -247,11 +324,35 @@ test('Different content types', t => {
     t.equal(res.statusCode, 400)
   })
 
-  fastify.inject({ method: 'GET', url: '/test' }, (err, res) => {
+  fastify.inject({ method: 'GET', url: '/', headers: { Accept: 'application/vnd.v8+json' } }, (err, res) => {
+    t.error(err)
+    t.equal(res.payload, JSON.stringify({ desc: 'age is missing', details: 'validation error' }))
+    t.equal(res.statusCode, 500)
+  })
+
+  fastify.inject({ method: 'GET', url: '/', headers: { Accept: 'application/vnd.v9+json' } }, (err, res) => {
+    t.error(err)
+    t.equal(res.payload, JSON.stringify({ details: 'validation error' }))
+    t.equal(res.statusCode, 500)
+  })
+
+  fastify.inject({ method: 'GET', url: '/test', headers: { Code: '200' } }, (err, res) => {
     t.error(err)
     t.equal(res.payload, JSON.stringify({ age: 18, city: 'AU' }))
     t.equal(res.statusCode, 200)
   })
+
+  fastify.inject({ method: 'GET', url: '/test', headers: { Code: '201' } }, (err, res) => {
+    t.error(err)
+    t.equal(res.payload, JSON.stringify({ details: 'validation error' }))
+    t.equal(res.statusCode, 201)
+  })
+
+  fastify.inject({ method: 'GET', url: '/test', headers: { Accept: 'application/vnd.v1+json' } }, (err, res) => {
+    t.error(err)
+    t.equal(res.payload, JSON.stringify({ created: true }))
+    t.equal(res.statusCode, 201)
+  })
 })
 
 test('Invalid multiple content schema, throw FST_ERR_SCH_CONTENT_MISSING_SCHEMA error', t => {
@@ -265,8 +366,11 @@ test('Invalid multiple content schema, throw FST_ERR_SCH_CONTENT_MISSING_SCHEMA
           content: {
             'application/json': {
               schema: {
-                fullName: { type: 'string' },
-                phone: { type: 'string' }
+                type: 'object',
+                properties: {
+                  fullName: { type: 'string' },
+                  phone: { type: 'string' }
+                }
               },
               example: {
                 fullName: 'John Doe',
@@ -321,7 +425,7 @@ test('Use the same schema id in different places', t => {
     url: '/123'
   }, (err, res) => {
     t.error(err)
-    t.same(res.json(), [{ id: 1 }, { id: 2 }, { }])
+    t.same(res.json(), [{ id: 1 }, { id: 2 }, {}])
   })
 })