Merge pull request #7 from michealroberts/feature/internals/useOrigin…

…AgentCluster

feat: Added useOriginAgentCluster() composable.

src/internals/useOriginAgentCluster.ts

@@ -0,0 +1,33 @@
+/*****************************************************************************************************************/
+
+// @author         Michael Roberts <michael@observerly.com>
+// @package        @observerly/nitro-helmet
+// @license        Copyright © 2021-2023 observerly
+
+/*****************************************************************************************************************/
+
+import { type H3Event, setHeader } from 'h3'
+
+import { type OriginAgentCluster } from './types'
+
+/*****************************************************************************************************************/
+
+export const defaultOriginAgentCluster = '?1'
+
+/*****************************************************************************************************************/
+
+export const useOriginAgentCluster = (
+  event: H3Event,
+  policy: OriginAgentCluster | boolean = defaultOriginAgentCluster
+) => {
+  if (typeof policy === 'boolean' && !policy) {
+    return
+  }
+
+  // If the policy is a boolean, then use the default policy:
+  if (typeof policy === 'boolean') {
+    policy = defaultOriginAgentCluster
+  }
+
+  setHeader(event, 'Origin-Agent-Cluster', policy)
+}

tests/mocks/helmet.ts

@@ -30,6 +30,11 @@ import {
   defaultCrossOriginResourcePolicy
 } from '../../src/internals/useCrossOriginResourcePolicy'
 
+import {
+  useOriginAgentCluster,
+  defaultOriginAgentCluster
+} from '../../src/internals/useOriginAgentCluster'
+
 /*****************************************************************************************************************/
 
 export const helmetHandlers: Handler[] = [
@@ -160,6 +165,42 @@ export const helmetHandlers: Handler[] = [
     handler: eventHandler(async event => {
       useCrossOriginResourcePolicy(event, false)
 
+      return {
+        policy: false
+      }
+    })
+  },
+
+  //
+
+  {
+    method: 'GET',
+    url: '/helmet/origin-agent-cluster',
+    handler: eventHandler(async event => {
+      useOriginAgentCluster(event, '?1')
+
+      return {
+        policy: '?1'
+      }
+    })
+  },
+  {
+    method: 'GET',
+    url: '/helmet/default-origin-agent-cluster',
+    handler: eventHandler(async event => {
+      useOriginAgentCluster(event)
+
+      return {
+        policy: defaultOriginAgentCluster
+      }
+    })
+  },
+  {
+    method: 'GET',
+    url: '/helmet/no-origin-agent-cluster',
+    handler: eventHandler(async event => {
+      useOriginAgentCluster(event, false)
+
       return {
         policy: false
       }

tests/useOriginAgentCluster.spec.ts

@@ -0,0 +1,55 @@
+/*****************************************************************************************************************/
+
+// @author         Michael Roberts <michael@observerly.com>
+// @package        @observerly/nitro-helmet
+// @license        Copyright © 2021-2023 observerly
+
+/*****************************************************************************************************************/
+
+import { beforeEach, describe, expect, it } from 'vitest'
+
+import supertest, { type SuperTest, type Test } from 'supertest'
+
+import { toNodeListener } from 'h3'
+
+import { server } from './utilities/server'
+
+import {
+  defaultOriginAgentCluster,
+  useOriginAgentCluster
+} from '../src/internals/useOriginAgentCluster'
+
+/*****************************************************************************************************************/
+
+describe('useOriginAgentCluster', () => {
+  let request: SuperTest<Test>
+
+  beforeEach(() => {
+    request = supertest(toNodeListener(server))
+  })
+
+  it('should be defined', () => {
+    expect(useOriginAgentCluster).toBeDefined()
+  })
+
+  it('should set Origin-Agent-Cluster on the request', async () => {
+    const res = await request.get('/helmet/origin-agent-cluster', {
+      method: 'GET'
+    })
+    expect(res.header['origin-agent-cluster']).toEqual('?1')
+  })
+
+  it('should set Origin-Agent-Cluster on the request', async () => {
+    const res = await request.get('/helmet/default-origin-agent-cluster', {
+      method: 'GET'
+    })
+    expect(res.header['origin-agent-cluster']).toEqual(defaultOriginAgentCluster)
+  })
+
+  it('should not set Origin-Agent-Cluster on the request', async () => {
+    const res = await request.get('/helmet/no-origin-agent-cluster', {
+      method: 'GET'
+    })
+    expect(res.header['origin-agent-cluster']).toEqual(undefined)
+  })
+})