Skip to content

Refactor MetaTagInjector tests for clarity, efficiency & security 🧿 #7895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refactor MetaTagInjector tests for clarity, efficiency & security 🧿 #7895

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
163 changes: 82 additions & 81 deletions apps/web/functions/components/metaTagInjector.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,93 +1,94 @@
import { MetaTagInjector } from './metaTagInjector'

test('should append meta tag to element', () => {
const element = {
append: jest.fn(),
} as unknown as Element
const property = 'property'
const content = 'content'
const injector = new MetaTagInjector(
{
title: 'test',
url: 'testUrl',
image: 'testImage',
description: 'testDescription',
},
new Request('http://localhost'),
)
injector.appendProperty(element, property, content)
expect(element.append).toHaveBeenCalledWith(`<meta property="${property}" content="${content}" data-rh="true">`, {
html: true,
})
describe('MetaTagInjector', () => {
let element: HTMLElement
let injector: MetaTagInjector

injector.element(element)
expect(element.append).toHaveBeenCalledWith(`<meta property="og:title" content="test" data-rh="true">`, {
html: true,
})
expect(element.append).toHaveBeenCalledWith(`<meta name="description" content="testDescription" data-rh="true">`, {
html: true,
})
expect(element.append).toHaveBeenCalledWith(
`<meta property="og:description" content="testDescription" data-rh="true">`,
{
html: true,
},
)
expect(element.append).toHaveBeenCalledWith(`<meta property="og:image" content="testImage" data-rh="true">`, {
html: true,
})
expect(element.append).toHaveBeenCalledWith(`<meta property="og:image:width" content="1200" data-rh="true">`, {
html: true,
})
expect(element.append).toHaveBeenCalledWith(`<meta property="og:image:height" content="630" data-rh="true">`, {
html: true,
})
expect(element.append).toHaveBeenCalledWith(`<meta property="og:image:alt" content="test" data-rh="true">`, {
html: true,
})
expect(element.append).toHaveBeenCalledWith(`<meta property="og:type" content="website" data-rh="true">`, {
html: true,
})
expect(element.append).toHaveBeenCalledWith(`<meta property="og:url" content="testUrl" data-rh="true">`, {
html: true,
const metaData = {
title: 'test',
url: 'testUrl',
image: 'testImage',
description: 'testDescription',
}

beforeEach(() => {
element = {
append: jest.fn(),
} as unknown as HTMLElement

injector = new MetaTagInjector(metaData, new Request('http://localhost'))
})

expect(element.append).toHaveBeenCalledWith(
`<meta property="twitter:card" content="summary_large_image" data-rh="true">`,
{
html: true,
},
)
expect(element.append).toHaveBeenCalledWith(`<meta property="twitter:title" content="test" data-rh="true">`, {
html: true,
test('should append individual meta tag correctly', () => {
const property = 'property'
const content = 'content'

injector.appendProperty(element, property, content)

expect(element.append).toHaveBeenCalledWith(
`<meta property="${property}" content="${content}" data-rh="true">`,
{ html: true }
)
})
expect(element.append).toHaveBeenCalledWith(`<meta property="twitter:image" content="testImage" data-rh="true">`, {
html: true,

test('should append all required meta tags to the element', () => {
injector.element(element)

const expectedTags = [
`<meta property="og:title" content="test" data-rh="true">`,
`<meta name="description" content="testDescription" data-rh="true">`,
`<meta property="og:description" content="testDescription" data-rh="true">`,
`<meta property="og:image" content="testImage" data-rh="true">`,
`<meta property="og:image:width" content="1200" data-rh="true">`,
`<meta property="og:image:height" content="630" data-rh="true">`,
`<meta property="og:image:alt" content="test" data-rh="true">`,
`<meta property="og:type" content="website" data-rh="true">`,
`<meta property="og:url" content="testUrl" data-rh="true">`,
`<meta property="twitter:card" content="summary_large_image" data-rh="true">`,
`<meta property="twitter:title" content="test" data-rh="true">`,
`<meta property="twitter:image" content="testImage" data-rh="true">`,
`<meta property="twitter:image:alt" content="test" data-rh="true">`,
]

expectedTags.forEach((tag) => {
expect(element.append).toHaveBeenCalledWith(tag, { html: true })
})

expect(element.append).toHaveBeenCalledTimes(expectedTags.length)
})
expect(element.append).toHaveBeenCalledWith(`<meta property="twitter:image:alt" content="test" data-rh="true">`, {
html: true,

test('should append x-blocked-paths meta if present in headers', () => {
const blockedRequest = new Request('http://localhost')
blockedRequest.headers.set('x-blocked-paths', '/')
const blockedInjector = new MetaTagInjector(metaData, blockedRequest)

blockedInjector.element(element)

expect(element.append).toHaveBeenCalledWith(
`<meta property="x:blocked-paths" content="/" data-rh="true">`,
{ html: true }
)
})

expect(element.append).toHaveBeenCalledTimes(14)
})
test('should prevent potential XSS via meta content', () => {
const unsafeMetaData = {
title: `<script>alert("xss")</script>`,
url: 'https://safe.com',
image: 'img.jpg',
description: 'test',
}

const xssInjector = new MetaTagInjector(unsafeMetaData, new Request('http://localhost'))
const xssElement = {
append: jest.fn(),
} as unknown as HTMLElement

xssInjector.element(xssElement)

// Assert it does not include unescaped script tag
const calls = (xssElement.append as jest.Mock).mock.calls
const scriptInjectionDetected = calls.some(([tag]) => tag.includes('<script>'))

test('should pass through header blocked paths', () => {
const element = {
append: jest.fn(),
} as unknown as Element
const request = new Request('http://localhost')
request.headers.set('x-blocked-paths', '/')
const injector = new MetaTagInjector(
{
title: 'test',
url: 'testUrl',
image: 'testImage',
description: 'testDescription',
},
request,
)
injector.element(element)
expect(element.append).toHaveBeenCalledWith(`<meta property="x:blocked-paths" content="/" data-rh="true">`, {
html: true,
expect(scriptInjectionDetected).toBe(false)
})
})