Update Request Cookies Type to Add undefined

plugin.d.ts

@@ -27,7 +27,7 @@ declare module 'fastify' {
     /**
      * Request cookies
      */
-    cookies: { [cookieName: string]: string };
+    cookies: { [cookieName: string]: string | undefined };
 
     /**
      * Unsigns the specified cookie using the secret provided.

test/cookie.test.js

@@ -243,6 +243,61 @@ test('parses incoming cookies', (t) => {
   })
 })
 
+test('defined and undefined cookies', (t) => {
+  t.plan(23)
+  const fastify = Fastify()
+  fastify.register(plugin)
+
+  // check that it parses the cookies in the onRequest hook
+  for (const hook of ['preValidation', 'preHandler']) {
+    fastify.addHook(hook, (req, reply, done) => {
+      t.ok(req.cookies)
+
+      t.ok(req.cookies.bar)
+      t.notOk(req.cookies.baz)
+
+      t.equal(req.cookies.bar, 'bar')
+      t.equal(req.cookies.baz, undefined)
+      done()
+    })
+  }
+
+  fastify.addHook('preParsing', (req, reply, payload, done) => {
+    t.ok(req.cookies)
+
+    t.ok(req.cookies.bar)
+    t.notOk(req.cookies.baz)
+
+    t.equal(req.cookies.bar, 'bar')
+    t.equal(req.cookies.baz, undefined)
+    done()
+  })
+
+  fastify.get('/test2', (req, reply) => {
+    t.ok(req.cookies)
+
+    t.ok(req.cookies.bar)
+    t.notOk(req.cookies.baz)
+
+    t.equal(req.cookies.bar, 'bar')
+    t.equal(req.cookies.baz, undefined)
+
+    reply.send({ hello: 'world' })
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/test2',
+    headers: {
+      cookie: 'bar=bar'
+    }
+  }, (err, res) => {
+    t.error(err)
+    t.equal(res.statusCode, 200)
+    t.same(JSON.parse(res.body), { hello: 'world' })
+  })
+})
+
 test('does not modify supplied cookie options object', (t) => {
   t.plan(3)
   const expireDate = Date.now() + 1000

test/plugin.test-d.ts

@@ -42,13 +42,14 @@ server.after((_err) => {
 
   server.get('/', (request, reply) => {
     const test = request.cookies.test;
+    expectType<string | undefined>(test);
 
     expectType<setCookieWrapper>(reply.cookie);
     expectType<setCookieWrapper>(reply.setCookie);
 
     expectType<FastifyReply>(
       reply
-        .setCookie('test', test, { domain: 'example.com', path: '/' })
+        .setCookie('test', test!, { domain: 'example.com', path: '/' })
         .clearCookie('foo')
         .send({ hello: 'world' })
     );
@@ -63,7 +64,7 @@ serverWithHttp2.after(() => {
   serverWithHttp2.get('/', (request, reply) => {
     const test = request.cookies.test;
     reply
-      .setCookie('test', test, { domain: 'example.com', path: '/' })
+      .setCookie('test', test!, { domain: 'example.com', path: '/' })
       .clearCookie('foo')
       .send({ hello: 'world' });
   });
@@ -75,26 +76,26 @@ testSamesiteOptionsApp.register(cookie);
 testSamesiteOptionsApp.after(() => {
   server.get('/test-samesite-option-true', (request, reply) => {
     const test = request.cookies.test;
-    reply.setCookie('test', test, { sameSite: true }).send({ hello: 'world' });
+    reply.setCookie('test', test!, { sameSite: true }).send({ hello: 'world' });
   });
   server.get('/test-samesite-option-false', (request, reply) => {
     const test = request.cookies.test;
-    reply.setCookie('test', test, { sameSite: false }).send({ hello: 'world' });
+    reply.setCookie('test', test!, { sameSite: false }).send({ hello: 'world' });
   });
   server.get('/test-samesite-option-lax', (request, reply) => {
     const test = request.cookies.test;
-    reply.setCookie('test', test, { sameSite: 'lax' }).send({ hello: 'world' });
+    reply.setCookie('test', test!, { sameSite: 'lax' }).send({ hello: 'world' });
   });
   server.get('/test-samesite-option-strict', (request, reply) => {
     const test = request.cookies.test;
     reply
-      .setCookie('test', test, { sameSite: 'strict' })
+      .setCookie('test', test!, { sameSite: 'strict' })
       .send({ hello: 'world' });
   });
   server.get('/test-samesite-option-none', (request, reply) => {
     const test = request.cookies.test;
     reply
-      .setCookie('test', test, { sameSite: 'none' })
+      .setCookie('test', test!, { sameSite: 'none' })
       .send({ hello: 'world' });
   });
 });
@@ -106,13 +107,13 @@ appWithImplicitHttpSigned.register(cookie, {
 });
 appWithImplicitHttpSigned.after(() => {
   server.get('/', (request, reply) => {
-    appWithImplicitHttpSigned.unsignCookie(request.cookies.test);
+    appWithImplicitHttpSigned.unsignCookie(request.cookies.test!);
     appWithImplicitHttpSigned.unsignCookie('test');
 
-    reply.unsignCookie(request.cookies.test);
+    reply.unsignCookie(request.cookies.test!);
     reply.unsignCookie('test');
 
-    request.unsignCookie(request.cookies.anotherTest);
+    request.unsignCookie(request.cookies.anotherTest!);
     request.unsignCookie('anotherTest');
 
     reply.send({ hello: 'world' });
@@ -126,7 +127,7 @@ appWithRotationSecret.register(cookie, {
 });
 appWithRotationSecret.after(() => {
   server.get('/', (request, reply) => {
-    reply.unsignCookie(request.cookies.test);
+    reply.unsignCookie(request.cookies.test!);
     const { valid, renew, value } = reply.unsignCookie('test');
 
     expectType<boolean>(valid);
@@ -158,7 +159,7 @@ appWithParseOptions.register(cookie, {
 });
 appWithParseOptions.after(() => {
   server.get('/', (request, reply) => {
-    const { valid, renew, value } = reply.unsignCookie(request.cookies.test);
+    const { valid, renew, value } = reply.unsignCookie(request.cookies.test!);
 
     expectType<boolean>(valid);
     expectType<boolean>(renew);
@@ -179,7 +180,7 @@ appWithCustomSigner.register(cookie, {
 })
 appWithCustomSigner.after(() => {
   server.get('/', (request, reply) => {
-    reply.unsignCookie(request.cookies.test)
+    reply.unsignCookie(request.cookies.test!)
     const { valid, renew, value } = reply.unsignCookie('test')
 
     expectType<boolean>(valid)