breaking(gatsby-plugin-sitemap): vNext rewrite

[moonmeister]

Description

Re-write of gatsby-plugin-sitemap to fix the spaghetti and improve the API. Mostly follows #22757, has some slight deviations where the spec needed more or i realized there was a better way. I'll make more notes as it gets closer to being ready.

TODO:

• more complete Testing before release
• Add activity bars for sitemap
• remove logic for disabled options schema validation now that it's shipped
• allow serialize(or other functions) to be async
• improve page filtering performance

Related Issues

closes #22757

[moonmeister]

#28742 just updated the e2e runner so that's been resolved. This is ready to merge assuming all is green.

outdated

[wardpeet]

Thanks for waiting @moonmeister I'll merge it this week, have to do a couple of tests but code looks awesome!

[moonmeister]

@wardpeet Don't mean to push, take your time for any final release, but if these tests pass could you at-least update the @next version we published previously? Thanks.

[moonmeister]

Changes look good to me ward. Thanks.

[moonmeister]

As shown by all the folks over at #29810 and #22757 this update is in demand, can we get this merged? thanks!

[moonmeister]

@KyleAMathews what can we do to get this merged?

[wardpeet]

Thanks for waiting, I was on vacation. I'll merge it in and publish a @next version for it!

Thanks a bunch @moonmeister

[moonmeister]

Thanks @wardpeet!

[t2ca]

Just want to let you know that when I tried this with just the minimal configuration, i got the following error

"gatsby-plugin-sitemap" threw an error while running the onPostBuild lifecycle:

Body must be a string. Received: undefined.

  38 |             output = _ref2.output, entryLimit = _ref2.entryLimit, query = _ref2.query, excludes =
_ref2.excludes, resolveSiteUrl = _ref2.resolveSiteUrl, resolvePagePath = _ref2.resolvePagePath, resolvePages =
 _ref2.resolvePages, filterPages = _ref2.filterPages, serialize = _ref2.serialize;
  39 |             _context.next = 4;
> 40 |             return graphql(query);
     |                    ^
  41 |
  42 |           case 4:
  43 |             _yield$graphql = _context.sent;

File: node_modules/gatsby-plugin-sitemap/gatsby-node.js:40:20

[pedrolamas]

As far as I can see, the plugin is currently broken...

By default, it will generate the sitemap xml files under the "/sitemap" folder, and it does that correctly, however the sitemap index file points to "/sitemap-0.xml" instead of "/sitemap/sitemap-0.xml" as expected.

The easy fix would be to generate the sitemap on the root as before, however the plugin is not allowing to pass an empty string to the "output" option - is there a reason for not allowing this??

This issue is currently capturing some of the issues found on the 4.0.0 release of the plugin: #31095

[axe312ger]

Can confirm, getting the same error with v4.0.0 and v4.1.0-next.0.

"gatsby-plugin-sitemap" threw an error while running the onPostBuild lifecycle:

Body must be a string. Received: undefined.

  38 |             output = _ref2.output, entryLimit = _ref2.entryLimit, query = _ref2.query, excludes = _ref2.excludes, resolveSiteUrl = _ref2.resolveSiteUrl, resolvePagePath = _ref2.resolvePagePath, resolvePages =
_ref2.resolvePages, filterPages = _ref2.filterPages, serialize = _ref2.serialize;
  39 |             _context.next = 4;
> 40 |             return graphql(query);
     |                    ^
  41 |
  42 |           case 4:
  43 |             _yield$graphql = _context.sent;

[moonmeister]

Hi @axe312ger !

Sorry to hear you're running into an issue. To help us best begin debugging the underlying cause, it is incredibly helpful if you open a new issue. Please include a minimal reproduction and a copy of any relevant code/config or a link to the repository.

Thanks for using Gatsby! 💜