feat: allow request.plainCookie options to be set via an object

Author: thetutlage

src/request.ts

@@ -12,6 +12,7 @@ import fresh from 'fresh'
 import typeIs from 'type-is'
 import accepts from 'accepts'
 import { isIP } from 'node:net'
+import is from '@sindresorhus/is'
 import proxyaddr from 'proxy-addr'
 import lodash from '@poppinss/utils/lodash'
 import { safeEqual } from '@poppinss/utils'
@@ -908,9 +909,23 @@ export class Request extends Macroable {
    * Returns value for a given key from unsigned cookies. Optional
    * defaultValue is returned when actual value is undefined.
    */
-  plainCookie(key: string, defaultValue?: string, encoded?: boolean): any {
+  plainCookie(key: string, options?: { defaultValue?: string; encoded?: boolean }): any
+  plainCookie(key: string, defaultValue?: string, encoded?: boolean): any
+  plainCookie(
+    key: string,
+    defaultValueOrOptions?: string | { defaultValue?: string; encoded?: boolean },
+    encoded?: boolean
+  ): any {
     this.#initiateCookieParser()
-    return this.#cookieParser!.decode(key, encoded) || defaultValue
+
+    if (is.object(defaultValueOrOptions)) {
+      return (
+        this.#cookieParser!.decode(key, defaultValueOrOptions?.encoded) ||
+        defaultValueOrOptions.defaultValue
+      )
+    }
+
+    return this.#cookieParser!.decode(key, encoded) || defaultValueOrOptions
   }
 
   /**

tests/request.spec.ts

@@ -1255,7 +1255,7 @@ test.group('Request | Cookies', () => {
     })
   })
 
-  test('get value for a single unsigned cookie', async ({ assert }) => {
+  test('get value for a single plain cookie', async ({ assert }) => {
     const server = createServer((req, res) => {
       const request = new RequestFactory().merge({ req, res, encryption }).create()
       res.writeHead(200, { 'content-type': 'application/json' })
@@ -1269,7 +1269,7 @@ test.group('Request | Cookies', () => {
     })
   })
 
-  test('use default value when actual unsigned value is missing', async ({ assert }) => {
+  test('use default value when actual plain cookie value is missing', async ({ assert }) => {
     const server = createServer((req, res) => {
       const request = new RequestFactory().merge({ req, res, encryption }).create()
       res.writeHead(200, { 'content-type': 'application/json' })
@@ -1303,6 +1303,47 @@ test.group('Request | Cookies', () => {
     })
   })
 
+  test('get value for a single not encoded cookie using options object', async ({ assert }) => {
+    const server = createServer((req, res) => {
+      const request = new RequestFactory()
+        .merge({
+          req,
+          res,
+          encryption,
+        })
+        .create()
+
+      res.writeHead(200, { 'content-type': 'application/json' })
+      res.end(JSON.stringify({ name: request.plainCookie('name', { encoded: false }) }))
+    })
+
+    const cookies = serializer.encode('name', 'virk', { encode: false })!
+    const { body } = await supertest(server).get('/').set('cookie', cookies)
+    assert.deepEqual(body, {
+      name: 'virk',
+    })
+  })
+
+  test('specify plain cookie default value via options object', async ({ assert }) => {
+    const server = createServer((req, res) => {
+      const request = new RequestFactory()
+        .merge({
+          req,
+          res,
+          encryption,
+        })
+        .create()
+
+      res.writeHead(200, { 'content-type': 'application/json' })
+      res.end(JSON.stringify({ name: request.plainCookie('name', { defaultValue: 'virk' }) }))
+    })
+
+    const { body } = await supertest(server).get('/')
+    assert.deepEqual(body, {
+      name: 'virk',
+    })
+  })
+
   test('get value for a single encrypted', async ({ assert }) => {
     const server = createServer((req, res) => {
       const request = new RequestFactory().merge({ req, res, encryption }).create()