refactor: clean up variable names and jsdoc comments

src/index.ts

@@ -59,7 +59,7 @@ const defaultOptions: CSRFOptions = {
  * @returns {RouterHandler} CSRF Protection Middleware
  * @example
  * const csrfProtection = csrf()
- * app.use(cookieParser())
+ * app.use(cookieParser()) // or a session middleware, if you prefer
  *
  * app.get("/", csrfProtection, (req, res) => {
  *   res.status(200).json({ token: req.csrfToken() });

test/cookie.spec.ts

@@ -3,10 +3,11 @@ import * as assert from 'uvu/assert'
 import type { CSRFOptions } from '../src/index'
 import { initApp } from './helper'
 
-const unsignedOutput = suite('unsigned cookie - output')
+const output = suite('unsigned cookie - output')
 
-unsignedOutput('should output a csrf token', async () => {
+output('should output a csrf token', async () => {
   const { fetch } = initApp({ middleware: 'cookie' })
+
   const response = await fetch('/')
   const body = await response.json()
 
@@ -16,12 +17,13 @@ unsignedOutput('should output a csrf token', async () => {
   assert.type(body.token, 'string')
 })
 
-unsignedOutput('should output a csrf token with given options (different salt & secret length)', async () => {
+output('should output a csrf token with given options (different salt & secret length)', async () => {
   const options: CSRFOptions = {
     saltLength: 10,
     secretLength: 30
   }
   const { fetch } = initApp({ middleware: 'cookie', options })
+
   const response = await fetch('/')
   const body = await response.json()
 
@@ -30,14 +32,15 @@ unsignedOutput('should output a csrf token with given options (different salt &
   assert.is(salt.length, 10)
 })
 
-unsignedOutput('should output a csrf token with given options (different cookie path)', async () => {
+output('should output a csrf token with given options (different cookie path)', async () => {
   const options: CSRFOptions = {
     cookie: {
       path: '/admin',
       key: 'virus'
     }
   }
   const { fetch } = initApp({ middleware: 'cookie', options })
+
   const response = await fetch('/')
   const body = await response.json()
 
@@ -50,14 +53,15 @@ unsignedOutput('should output a csrf token with given options (different cookie
   assert.type(body.token, 'string')
 })
 
-unsignedOutput.run()
+output.run()
 
-const unsignedBody = suite('unsigned cookie - req.body')
+const body = suite('unsigned cookie - req.body')
 
-unsignedBody('should be able to pass through req.body', async () => {
+body('should be able to pass through req.body', async () => {
   const { fetch } = initApp({ middleware: 'cookie', parser: 'json' })
   const request = await fetch('/')
   const requestBody = await request.json()
+
   const response = await fetch('/', {
     method: 'post',
     body: JSON.stringify({ _csrf: requestBody.token, hello: 'there' }),
@@ -72,7 +76,7 @@ unsignedBody('should be able to pass through req.body', async () => {
   assert.is(body.message, 'hello')
 })
 
-unsignedBody('should not be able to pass through req.body', async () => {
+body('should not be able to pass through req.body', async () => {
   const { fetch } = initApp({ middleware: 'cookie', parser: 'json' })
   const request = await fetch('/')
 
@@ -91,10 +95,11 @@ unsignedBody('should not be able to pass through req.body', async () => {
   assert.is(body, 'invalid csrf token')
 })
 
-unsignedBody.run()
+body.run()
+
+const query = suite('unsigned cookie - req.query')
 
-const unsignedQuery = suite('unsigned cookie - req.query')
-unsignedQuery('should be able to pass through query', async () => {
+query('should be able to pass through query', async () => {
   const { fetch } = initApp({ middleware: 'cookie' })
   const request = await fetch('/')
   const requestBody = await request.json()
@@ -112,11 +117,11 @@ unsignedQuery('should be able to pass through query', async () => {
   assert.is(body.message, 'hello')
 })
 
-unsignedQuery.run()
+query.run()
 
-const unsignedHeader = suite('unsigned cookie - req.headers')
+const header = suite('unsigned cookie - req.headers')
 
-unsignedHeader('should be able to pass through headers csrf-token', async () => {
+header('should be able to pass through headers csrf-token', async () => {
   const { fetch } = initApp({ middleware: 'cookie' })
   const request = await fetch('/')
   const requestBody = await request.json()
@@ -128,14 +133,13 @@ unsignedHeader('should be able to pass through headers csrf-token', async () =>
       'csrf-token': requestBody.token
     }
   })
-
   const body = await response.json()
 
   assert.is(response.status, 200)
   assert.is(body.message, 'hello')
 })
 
-unsignedHeader('should be able to pass through headers xsrf-token', async () => {
+header('should be able to pass through headers xsrf-token', async () => {
   const { fetch } = initApp({ middleware: 'cookie' })
   const request = await fetch('/')
   const requestBody = await request.json()
@@ -147,14 +151,13 @@ unsignedHeader('should be able to pass through headers xsrf-token', async () =>
       'xsrf-token': requestBody.token
     }
   })
-
   const body = await response.json()
 
   assert.is(response.status, 200)
   assert.is(body.message, 'hello')
 })
 
-unsignedHeader('should be able to pass through headers x-csrf-token', async () => {
+header('should be able to pass through headers x-csrf-token', async () => {
   const { fetch } = initApp({ middleware: 'cookie' })
   const request = await fetch('/')
   const requestBody = await request.json()
@@ -166,14 +169,13 @@ unsignedHeader('should be able to pass through headers x-csrf-token', async () =
       'x-csrf-token': requestBody.token
     }
   })
-
   const body = await response.json()
 
   assert.is(response.status, 200)
   assert.is(body.message, 'hello')
 })
 
-unsignedHeader('should be able to pass through headers x-xsrf-token', async () => {
+header('should be able to pass through headers x-xsrf-token', async () => {
   const { fetch } = initApp({ middleware: 'cookie' })
   const request = await fetch('/')
   const requestBody = await request.json()
@@ -185,14 +187,13 @@ unsignedHeader('should be able to pass through headers x-xsrf-token', async () =
       'x-xsrf-token': requestBody.token
     }
   })
-
   const body = await response.json()
 
   assert.is(response.status, 200)
   assert.is(body.message, 'hello')
 })
 
-unsignedHeader.run()
+header.run()
 
 const reusable = suite('reusable token')
 
@@ -209,7 +210,6 @@ reusable('a', async () => {
       'x-xsrf-token': requestBody.token
     }
   })
-
   const body1 = await response1.json()
 
   // response #2
@@ -220,7 +220,6 @@ reusable('a', async () => {
       'x-xsrf-token': requestBody.token
     }
   })
-
   const body2 = await response2.json()
 
   assert.is(response1.status, 200)

test/failing.spec.ts

@@ -17,8 +17,10 @@ failing('without a cookie parser', async () => {
   const server = app.listen()
 
   const fetch = makeFetch(server)
+
   const response = await fetch('/')
   const body = await response.text()
+
   assert.is(response.status, 500)
   assert.is(body, 'misconfigured csrf')
 })

test/session.spec.ts

@@ -11,6 +11,7 @@ const output = suite('session - output')
 
 output('should output a csrf token', async () => {
   const { fetch } = initApp({ middleware: 'session', options })
+
   const response = await fetch('/')
   const body = await response.json()
 
@@ -25,6 +26,7 @@ output('should output a csrf token with given options (different salt & secret l
     secretLength: 30
   }
   const { fetch } = initApp({ middleware: 'session', options: { ...options, ...saltySecret } })
+
   const response = await fetch('/')
   const body = await response.json()
 
@@ -39,6 +41,7 @@ const body = suite('session - req.body')
 
 body('should be able to pass through req.body', async () => {
   const { fetch } = initApp({ middleware: 'session', parser: 'json', options })
+
   const request = await fetch('/')
   const requestBody = await request.json()
 
@@ -58,6 +61,7 @@ body('should be able to pass through req.body', async () => {
 
 body('should not be able to pass through req.body', async () => {
   const { fetch } = initApp({ middleware: 'session', parser: 'json', options })
+
   const request = await fetch('/')
 
   const response = await fetch('/', {
@@ -81,6 +85,7 @@ const query = suite('session - req.query')
 
 query('should be able to pass through query', async () => {
   const { fetch } = initApp({ middleware: 'session', options })
+
   const request = await fetch('/')
   const requestBody = await request.json()
 
@@ -103,6 +108,7 @@ const header = suite('session - req.headers')
 
 header('should be able to pass through headers csrf-token', async () => {
   const { fetch } = initApp({ middleware: 'session', options })
+
   const request = await fetch('/')
   const requestBody = await request.json()
 
@@ -113,7 +119,6 @@ header('should be able to pass through headers csrf-token', async () => {
       'csrf-token': requestBody.token
     }
   })
-
   const body = await response.json()
 
   assert.is(response.status, 200)
@@ -122,6 +127,7 @@ header('should be able to pass through headers csrf-token', async () => {
 
 header('should be able to pass through headers xsrf-token', async () => {
   const { fetch } = initApp({ middleware: 'session', options })
+
   const request = await fetch('/')
   const requestBody = await request.json()
 
@@ -132,7 +138,6 @@ header('should be able to pass through headers xsrf-token', async () => {
       'xsrf-token': requestBody.token
     }
   })
-
   const body = await response.json()
 
   assert.is(response.status, 200)
@@ -141,6 +146,7 @@ header('should be able to pass through headers xsrf-token', async () => {
 
 header('should be able to pass through headers x-csrf-token', async () => {
   const { fetch } = initApp({ middleware: 'session', options })
+
   const request = await fetch('/')
   const requestBody = await request.json()
 
@@ -151,7 +157,6 @@ header('should be able to pass through headers x-csrf-token', async () => {
       'x-csrf-token': requestBody.token
     }
   })
-
   const body = await response.json()
 
   assert.is(response.status, 200)
@@ -160,6 +165,7 @@ header('should be able to pass through headers x-csrf-token', async () => {
 
 header('should be able to pass through headers x-xsrf-token', async () => {
   const { fetch } = initApp({ middleware: 'session', options })
+
   const request = await fetch('/')
   const requestBody = await request.json()
 
@@ -170,7 +176,6 @@ header('should be able to pass through headers x-xsrf-token', async () => {
       'x-xsrf-token': requestBody.token
     }
   })
-
   const body = await response.json()
 
   assert.is(response.status, 200)
@@ -183,6 +188,7 @@ const reusable = suite('reusable token')
 
 reusable('a', async () => {
   const { fetch } = initApp({ middleware: 'session', options })
+
   const request = await fetch('/')
   const requestBody = await request.json()
 
@@ -194,7 +200,6 @@ reusable('a', async () => {
       'x-xsrf-token': requestBody.token
     }
   })
-
   const body1 = await response1.json()
 
   // response #2
@@ -205,7 +210,6 @@ reusable('a', async () => {
       'x-xsrf-token': requestBody.token
     }
   })
-
   const body2 = await response2.json()
 
   assert.is(response1.status, 200)