Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion providers/shield_provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,13 @@ export default class ShieldProvider {
* Registers ShieldMiddleware to the container with proper configuration
* and dependencies. This method binds the middleware to the IoC container
* and sets up Edge.js integration when available.
*
* The middleware is registered as a singleton because router middleware
* are resolved on every request and the middleware keeps no per-request
* state (everything goes through the HTTP context).
*/
async register() {
this.app.container.bind(ShieldMiddleware, async () => {
this.app.container.singleton(ShieldMiddleware, async () => {
const config = this.app.config.get<ShieldConfig>('shield', {})
const encryptionManager = await this.app.container.make('encryption')
const encryption = encryptionManager.use()
Expand Down
5 changes: 4 additions & 1 deletion tests/helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import { defineConfig as defineSessionConfig } from '@adonisjs/session'
import { sessionApiClient } from '@adonisjs/session/plugins/api_client'
import { type IncomingMessage, type ServerResponse, createServer } from 'node:http'

import type { ShieldConfig } from '../src/types.ts'
import { shieldApiClient } from '../src/plugins/api_client.ts'

export const BASE_URL = new URL('./tmp/', import.meta.url)
Expand All @@ -35,19 +36,21 @@ export const httpServer = {
},
}

export async function setup() {
export async function setup(options: { shield?: ShieldConfig } = {}) {
const ignitor = new IgnitorFactory()
.withCoreProviders()
.withCoreConfig()
.merge({
config: {
views: { cache: { enabled: false } },
session: defineSessionConfig({ enabled: true, store: 'memory', stores: {} }),
...(options.shield ? { shield: options.shield } : {}),
},
rcFileContents: {
providers: [
() => import('@adonisjs/session/session_provider'),
() => import('@adonisjs/core/providers/edge_provider'),
...(options.shield ? [() => import('../providers/shield_provider.ts')] : []),
],
},
})
Expand Down
78 changes: 78 additions & 0 deletions tests/provider.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*
* @adonisjs/shield
*
* (c) AdonisJS
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

import { test } from '@japa/runner'

import { httpServer, setup } from './helpers.ts'
import { defineConfig } from '../src/define_config.ts'
import ShieldMiddleware from '../src/shield_middleware.ts'

const shieldConfig = defineConfig({
csrf: { enabled: true, methods: ['POST', 'PUT', 'PATCH', 'DELETE'] },
xFrame: { enabled: true, action: 'DENY' },
contentTypeSniffing: { enabled: true },
})

test.group('Shield provider', () => {
test('construct the middleware only once', async ({ assert }) => {
const app = await setup({ shield: shieldConfig })

let constructions = 0
app.container.resolving(ShieldMiddleware, () => {
constructions++
})

const first = await app.container.make(ShieldMiddleware)
const second = await app.container.make(ShieldMiddleware)
const fromResolver = await app.container.createResolver().make(ShieldMiddleware)

assert.instanceOf(first, ShieldMiddleware)
assert.strictEqual(first, second)
assert.strictEqual(first, fromResolver)
assert.equal(constructions, 1)
})

test('reuse the middleware instance across HTTP requests', async ({ assert }) => {
const app = await setup({ shield: shieldConfig })

let constructions = 0
app.container.resolving(ShieldMiddleware, () => {
constructions++
})

const router = await app.container.make('router')
router.use([
() => import('@adonisjs/session/session_middleware'),
() => import('../src/shield_middleware.ts'),
])
router.get('/', ({ request }) => ({ token: request.csrfToken }))
router.post('/', () => 'ok')

const server = await app.container.make('server')
await server.boot()

const nodeServer = httpServer.create(server.handle.bind(server))
await new Promise<void>((resolve) => nodeServer.listen(0, resolve))
const { port } = nodeServer.address() as { port: number }
const url = `http://localhost:${port}/`

const getResponse = await fetch(url)
assert.equal(getResponse.status, 200)
assert.equal(getResponse.headers.get('x-frame-options'), 'DENY')
assert.equal(getResponse.headers.get('x-content-type-options'), 'nosniff')
const body = (await getResponse.json()) as { token: string }
assert.isString(body.token)

const postResponse = await fetch(url, { method: 'POST' })
assert.equal(postResponse.status, 403)

await fetch(url)
assert.equal(constructions, 1)
})
})
Loading