Merge pull request #3 from codecoolture/add-headers

Add support to check the 'headers' property from the incoming request

Author: sergioalvz

README.md

@@ -22,6 +22,7 @@
   - [`validate(schemas, handler)`](#validateschemas-handler)
     - [`schemas`](#schemas)
       - [`schemas.body`](#schemasbody)
+      - [`schemas.headers`](#schemasheaders)
       - [`schemas.query`](#schemasquery)
     - [`handler`](#handler)
 
@@ -126,7 +127,7 @@ export default withJoi({
 
 ### `validate(schemas, handler)`
 
-The `validate` function has support to check two request's fields: `query` and `body`. The first argument for this function should always be an object with the desired validation schemas.
+The `validate` function has support to check the following request fields: `body`, `headers` and `query`. The first argument for this function should always be an object with the desired validation schemas.
 
 #### `schemas`
 
@@ -140,6 +141,16 @@ Even if empty, this argument is required.
 
 A valid `joi` schema.
 
+##### `schemas.headers`
+
+**Optional**
+
+> Note: since most of the time you may receive more headers than expected, it is a good practice to make this
+> schema always support [`unknown`](https://joi.dev/api/?v=17.3.0#objectunknownallow) keys. Otherwise, the validation
+> will always fail.
+
+A valid `joi` schema.
+
 ##### `schemas.query`
 
 **Optional**

src/index.ts

@@ -2,7 +2,7 @@ import { Schema } from "joi";
 import { NextApiHandler, NextApiRequest, NextApiResponse } from "next";
 import { NextHandler, RequestHandler } from "next-connect";
 
-export type ValidableRequestFields = Pick<NextApiRequest, "query" | "body">;
+export type ValidableRequestFields = Pick<NextApiRequest, "body" | "headers" | "query">;
 
 export type ValidationSchemas = {
   [K in keyof ValidableRequestFields]?: Schema;
@@ -22,7 +22,7 @@ export default function withJoi(config?: Configuration): ValidationFunction {
 
   return (schemas, handler) => {
     return (req: NextApiRequest, res: NextApiResponse, next?: NextHandler) => {
-      const fields: (keyof ValidableRequestFields)[] = ["body", "query"];
+      const fields: (keyof ValidableRequestFields)[] = ["body", "headers", "query"];
 
       const hasValidationErrors = fields.some((field) => {
         const schema = schemas[field];

tests/index.spec.ts

@@ -114,6 +114,45 @@ function buildSuite({ handlerBuilder, title }: BuildSuiteOptions): void {
       });
     });
 
+    describe("handling headers validation", () => {
+      const schema = Joi.object({
+        "accept-language": Joi.string().valid("en", "es").required(),
+      });
+
+      it("returns a 400 by default if unknown headers are not ignored", async () => {
+        const handler = handlerBuilder(validate, { headers: schema }, postANewUser);
+
+        const response = await server.inject(handler, {
+          headers: { "accept-language": "en" },
+          method: "post",
+        });
+
+        expect(response.status).toBe(400);
+      });
+
+      it("returns a 200 response if the validation passes", async () => {
+        const handler = handlerBuilder(validate, { headers: schema.unknown() }, postANewUser);
+
+        const response = await server.inject(handler, {
+          headers: { "accept-language": "en" },
+          method: "post",
+        });
+
+        expect(response.status).toBe(200);
+      });
+
+      it("returns a 400 response if the validation doesn't pass", async () => {
+        const handler = handlerBuilder(validate, { headers: schema.unknown() }, postANewUser);
+
+        const response = await server.inject(handler, {
+          headers: { "accept-language": "pt" },
+          method: "post",
+        });
+
+        expect(response.status).toBe(400);
+      });
+    });
+
     describe("working with custom error handling", () => {
       const body = Joi.object({ name: Joi.string().required() });