[gatsby-source-drupal] provide proxyUrl in addition to baseUrl to allow using CDN, API gateway, etc.

[Vacilando]

Plugin gatsby-source-drupal accepts baseUrl and when fetching data from Drupal goes first to baseUrl/apiBase (e.g. www.example.com/jsonapi) to get the list of resources.

The list of resources contains info like this:

...
"image_style--image_style": {
"href": "https://www.example.com/jsonapi/image_style/image_style"
},
"media--image": {
"href": "https://www.example.com/jsonapi/media/image"
},
...

For performance reasons it's often desirable to request these resources via a CDN or an API gateway.

This is currently impossible, because even if we put use the CDN url as baseUrl, the data will be - based on the list in baseUrl/apiBase - fetched from the baseUrl.

So here's a small feature improvement idea:

• provide a new option called eg proxyUrl
• in the code of gatsby-source-drupal fetch the list from baseUrl but when requesting data from the resources replace baseUrl by proxyUrl

To me this seems like a very small / simple improvement. I am happy to contribute to the development / testing with some guidance of the gatsby-source-drupal developers.

[Vacilando]

NB This would also be a solution for issue #36774 where we need the request URL to contain a path.

[Vacilando]

Opened a pull request for this, please review

• feat(gatsby-source-drupal): Provide proxyUrl in addition to baseUrl to allow using CDN, API gateway, etc. #36819

In my particular situation - fetch directly from a Drupal server (32 GB RAM, 8 vCPUs) vs fetch from a CDN (CloudFront) improves the "Fetch all data from Drupal" build phase by a factor of 10!

[Vacilando]

The results are in fact much better; the acceleration thanks to the use of CDN is about 95x (cf https://www.vacilando.org/article/using-cdn-accelerate-drupal-api-sourcing-gatsbyjs).