Skip to content

Add testing to the "don’t generate invalid <link rel="canonical"/> with missing href" solution #3501

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

Merged
merged 10 commits into from
Nov 8, 2025
+51 −4
Merged

Add testing to the "don’t generate invalid <link rel="canonical"/> with missing href" solution #3501

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7319a41
Don’t generate invalid <link rel="canonical"/> with missing href
andersk Sep 11, 2025
ac9233b
test(head): Add a test for checking meta og:url tag, modify test util…
erbierc Oct 22, 2025
4b1a391
chore(head test): remove .only from a new test
erbierc Oct 23, 2025
765748e
Merge branch 'stack/invalid-canonical' into add-tests-invalid-canonical
delucis Oct 23, 2025
6db9212
test(head): Add a test for checking meta og:url tag, modify test util…
erbierc Oct 22, 2025
74ff63d
chore(head test): remove .only from a new test
erbierc Oct 23, 2025
e54e2b9
test(head): Add a failing test for checking the canonical tag
erbierc Oct 24, 2025
dcbb7d7
Merge branch 'add-tests-invalid-canonical' of https://github.com/erbi…
erbierc Oct 24, 2025
0a8a1bd
test(head): re-add a failing test for checking the canonical tag
erbierc Oct 24, 2025
2260cd3
test(canonical): Move link canonical test to the basics folder, add n…
erbierc Nov 6, 2025
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
7 changes: 7 additions & 0 deletions .changeset/quick-apes-grab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@astrojs/starlight": patch
---

Fixes invalid `<head>` output when configuration is missing:
- Omits `<meta property="og:description" />` if Starlight’s `description` option is unset
- Omits `<link rel="canonical" />` and `<meta property="og:url" />` if Astro’s `site` option is unset
15 changes: 13 additions & 2 deletions packages/starlight/__tests__/head/head.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,15 @@ test('places the default favicon below any user provided icons', () => {
expect(defaultFaviconIndex).toBeGreaterThan(userFaviconIndex);
});

function getTestHead(heads: HeadConfig = [], route = routes[0]!): HeadConfig {
test('omits meta og:url tag when site is not set', () => {
const head = getTestHead(undefined, undefined, false);

const ogUrlExists = head.some((tag) => tag.tag === 'meta' && tag.attrs?.property === 'og:url');

expect(ogUrlExists).toBe(false);
});

function getTestHead(heads: HeadConfig = [], route = routes[0]!, setSite?: boolean): HeadConfig {
return generateRouteData({
props: {
...route,
Expand All @@ -190,6 +198,9 @@ function getTestHead(heads: HeadConfig = [], route = routes[0]!): HeadConfig {
},
},
},
context: getRouteDataTestContext(),
context:
setSite === undefined
? getRouteDataTestContext()
: getRouteDataTestContext(undefined, setSite),
}).head;
}
8 changes: 6 additions & 2 deletions packages/starlight/__tests__/test-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,15 @@ export async function mockedCollectionConfig(docsUserSchema?: Parameters<typeof
};
}

export function getRouteDataTestContext(pathname?: string): RouteDataContext {
export function getRouteDataTestContext(
pathname?: string,
setSite: boolean = true
): RouteDataContext {
const site = new URL('https://example.com');

return {
generator: 'Astro',
site,
url: pathname ? new URL(pathname, site) : site,
site: setSite ? site : undefined,
};
}
12 changes: 9 additions & 3 deletions packages/starlight/utils/head.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ export function getHead(
attrs: { name: 'viewport', content: 'width=device-width, initial-scale=1' },
},
{ tag: 'title', content: `${data.title} ${config.titleDelimiter} ${siteTitle}` },
{ tag: 'link', attrs: { rel: 'canonical', href: canonicalHref } },
...(canonicalHref !== undefined
? ([{ tag: 'link', attrs: { rel: 'canonical', href: canonicalHref } }] as const)
: []),
{ tag: 'meta', attrs: { name: 'generator', content: context.generator } },
{
tag: 'meta',
Expand All @@ -51,9 +53,13 @@ export function getHead(
// OpenGraph Tags
{ tag: 'meta', attrs: { property: 'og:title', content: data.title } },
{ tag: 'meta', attrs: { property: 'og:type', content: 'article' } },
{ tag: 'meta', attrs: { property: 'og:url', content: canonicalHref } },
...(canonicalHref !== undefined
? ([{ tag: 'meta', attrs: { property: 'og:url', content: canonicalHref } }] as const)
: []),
{ tag: 'meta', attrs: { property: 'og:locale', content: lang } },
{ tag: 'meta', attrs: { property: 'og:description', content: description } },
...(description !== undefined
? ([{ tag: 'meta', attrs: { property: 'og:description', content: description } }] as const)
: []),
{ tag: 'meta', attrs: { property: 'og:site_name', content: siteTitle } },
// Twitter Tags
{
Expand Down