fix(gatsby-plugin-sitemap): Sitemap path bug (#31184)

Co-authored-by: gatsbybot <[email protected]>

Author: moonmeister

packages/gatsby-plugin-sitemap/package.json

@@ -2,15 +2,18 @@
   "name": "gatsby-plugin-sitemap",
   "description": "Gatsby plugin that automatically creates a sitemap for your site",
   "version": "4.2.0-next.1",
-  "author": "Nicholas Young <[email protected]>",
+  "contributors": [
+    "Alex Moon <[email protected]>",
+    "Nicholas Young <[email protected]>"
+  ],
   "bugs": {
     "url": "https://github.com/gatsbyjs/gatsby/issues"
   },
   "dependencies": {
     "@babel/runtime": "^7.12.5",
     "common-tags": "^1.8.0",
     "minimatch": "^3.0.4",
-    "sitemap": "^6.3.0"
+    "sitemap": "^7.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.12.1",

packages/gatsby-plugin-sitemap/src/__tests__/gatsby-node.js

@@ -155,4 +155,42 @@ describe(`gatsby-plugin-sitemap Node API`, () => {
       expect(page.url).toEqual(expect.stringContaining(prefix))
     })
   })
+
+  it(`should output modified paths to sitemap`, async () => {
+    const graphql = jest.fn()
+    graphql.mockResolvedValue({
+      data: {
+        site: {
+          siteMetadata: {
+            siteUrl: `http://dummy.url`,
+          },
+        },
+        allSitePage: {
+          nodes: [
+            {
+              path: `/page-1`,
+            },
+            {
+              path: `/page-2`,
+            },
+          ],
+        },
+      },
+    })
+    const prefix = `/test`
+    const subdir = `/subdir`
+    const options = {
+      output: subdir,
+    }
+    await onPostBuild(
+      { graphql, pathPrefix: prefix, reporter },
+      await schema.validateAsync(options)
+    )
+    expect(sitemap.simpleSitemapAndIndex.mock.calls[0][0].publicBasePath).toBe(
+      path.posix.join(prefix, subdir)
+    )
+    expect(sitemap.simpleSitemapAndIndex.mock.calls[0][0].destinationDir).toBe(
+      path.join(`public`, subdir)
+    )
+  })
 })

packages/gatsby-plugin-sitemap/src/gatsby-node.js

@@ -83,11 +83,13 @@ exports.onPostBuild = async (
     }
   }
 
-  const sitemapPath = path.join(`public`, output)
+  const sitemapWritePath = path.join(`public`, output)
+  const sitemapPublicPath = path.posix.join(pathPrefix, output)
 
   return simpleSitemapAndIndex({
     hostname: siteUrl,
-    destinationDir: sitemapPath,
+    publicBasePath: sitemapPublicPath,
+    destinationDir: sitemapWritePath,
     sourceData: serializedPages,
     limit: entryLimit,
     gzip: false,

yarn.lock

@@ -4631,7 +4631,7 @@
     "@types/node" "*"
     form-data "^3.0.0"
 
-"@types/node@*", "@types/node@>= 8", "@types/node@^14.10.2", "@types/node@^14.14.10", "@types/node@^14.14.5", "@types/node@^14.6.4":
+"@types/node@*", "@types/node@>= 8", "@types/node@^14.10.2", "@types/node@^14.14.10", "@types/node@^14.14.5":
   version "14.14.31"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-14.14.31.tgz#72286bd33d137aa0d152d47ec7c1762563d34055"
   integrity sha512-vFHy/ezP5qI0rFgJ7aQnjDXwAMrG0KqqIH7tQG5PPv3BWBayOPIQNBjVc/P6hhdZfMx51REc6tfDNXHUio893g==
@@ -4641,6 +4641,11 @@
   resolved "https://registry.yarnpkg.com/@types/node/-/node-12.20.6.tgz#7b73cce37352936e628c5ba40326193443cfba25"
   integrity sha512-sRVq8d+ApGslmkE9e3i+D3gFGk7aZHAT+G4cIpIEdLJYPsWiSPwcAnJEjddLQQDqV3Ra2jOclX/Sv6YrvGYiWA==
 
+"@types/node@^15.0.1":
+  version "15.0.1"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-15.0.1.tgz#ef34dea0881028d11398be5bf4e856743e3dc35a"
+  integrity sha512-TMkXt0Ck1y0KKsGr9gJtWGjttxlZnnvDtphxUOSd0bfaR6Q1jle+sPvrzNR1urqYTWMinoKvjKfXUGsumaO1PA==
+
 "@types/node@^8.5.7":
   version "8.10.59"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-8.10.59.tgz#9e34261f30183f9777017a13d185dfac6b899e04"
@@ -5965,10 +5970,10 @@ are-we-there-yet@~1.1.2:
     delegates "^1.0.0"
     readable-stream "^2.0.6"
 
-arg@^4.1.3:
-  version "4.1.3"
-  resolved "https://registry.yarnpkg.com/arg/-/arg-4.1.3.tgz#269fc7ad5b8e42cb63c896d5666017261c144089"
-  integrity sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==
+arg@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/arg/-/arg-5.0.0.tgz#a20e2bb5710e82950a516b3f933fee5ed478be90"
+  integrity sha512-4P8Zm2H+BRS+c/xX1LrHw0qKpEhdlZjLCgWy+d78T9vqa2Z2SiD2wMrYuWIAFy5IZUD7nnNXroRttz+0RzlrzQ==
 
 argparse@^1.0.10, argparse@^1.0.6, argparse@^1.0.7:
   version "1.0.10"
@@ -24910,14 +24915,14 @@ sisteransi@^1.0.5:
   resolved "https://registry.yarnpkg.com/sisteransi/-/sisteransi-1.0.5.tgz#134d681297756437cc05ca01370d3a7a571075ed"
   integrity sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==
 
-sitemap@^6.3.0:
-  version "6.3.0"
-  resolved "https://registry.yarnpkg.com/sitemap/-/sitemap-6.3.0.tgz#c9affa49d654b5bd76a56a8e67cee3c17560a8f3"
-  integrity sha512-U0jS5b+V/MQOkmkqwq3ow++sE1A+F4Yo/nDU5wksiGFO7ww7VutOXJWdM2wk54Ztvl4UmlX65l2GVz5jeI4rgw==
+sitemap@^7.0.0:
+  version "7.0.0"
+  resolved "https://registry.yarnpkg.com/sitemap/-/sitemap-7.0.0.tgz#022bef4df8cba42e38e1fe77039f234cab0372b6"
+  integrity sha512-Ud0jrRQO2k7fEtPAM+cQkBKoMvxQyPKNXKDLn8tRVHxRCsdDQ2JZvw+aZ5IRYYQVAV9iGxEar6boTwZzev+x3g==
   dependencies:
-    "@types/node" "^14.6.4"
+    "@types/node" "^15.0.1"
     "@types/sax" "^1.2.1"
-    arg "^4.1.3"
+    arg "^5.0.0"
     sax "^1.2.4"
 
 slash@^1.0.0: