Skip to content

fix(gatsby-plugin-sitemap): add meaningful error when siteUrl is missing #13123

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 4 commits into from
Apr 5, 2019
Merged

fix(gatsby-plugin-sitemap): add meaningful error when siteUrl is missing #13123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd7f85b
Throw error when siteUrl property not found
sbardian Apr 4, 2019
d23d69c
Add note in README that siteUrl is required
sbardian Apr 4, 2019
f3b9235
Remove duplicate null check and add link to docs
sbardian Apr 4, 2019
9f79efa
fix review & add test
wardpeet Apr 5, 2019
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
14 changes: 14 additions & 0 deletions packages/gatsby-plugin-sitemap/src/__tests__/internals.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,20 @@ describe(`results using default settings`, () => {

verifyUrlsExistInResults(urls, [`http://dummy.url${pathPrefix}/page-1`])
})

it(`should fail when siteUrl is not set`, async () => {
const graphql = () =>
Promise.resolve(generateQueryResultsMock({ siteUrl: null }))
expect.assertions(1)

try {
await runQuery(graphql, ``, [], pathPrefix)
} catch (err) {
expect(err.message).toEqual(
expect.stringContaining(`SiteMetaData 'siteUrl' property is required`)
)
}
})
}

describe(`no path-prefix`, () => {
Expand Down
12 changes: 8 additions & 4 deletions packages/gatsby-plugin-sitemap/src/internals.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,17 @@ export const runQuery = (handler, query, excludes, pathPrefix) =>
return page
})

if (r.data.site.siteMetadata.siteUrl) {
// remove trailing slash of siteUrl
r.data.site.siteMetadata.siteUrl = withoutTrailingSlash(
r.data.site.siteMetadata.siteUrl
if (!r.data.site.siteMetadata.siteUrl) {
throw new Error(
`SiteMetaData 'siteUrl' property is required. Check out the documentation to see a working example: https://www.gatsbyjs.org/packages/gatsby-plugin-sitemap/#how-to-use`
)
}

// remove trailing slash of siteUrl
r.data.site.siteMetadata.siteUrl = withoutTrailingSlash(
r.data.site.siteMetadata.siteUrl
)

return r.data
})

Expand Down