feat(gatsby): Support Functions in plugins #31466
Conversation
Also fix a couple small bugs most noticibly I didn't rename `apiRoute` to `functionRoute` before.
gatsbot
bot
added
the
status: triage needed
KyleAMathews
added
topic: functions
and removed
status: triage needed
| @@ -238,6 +238,26 @@ export function runTests(env, host) { | |||
| }) | |||
| }) | |||
|
|
|||
| describe(`plugins can declare functions and they can be shadowed`, () => { | |||
There was a problem hiding this comment.
tests for plugin functions + shadowing
| } | ||
|
|
||
| // Create glob type w/ glob, plugin name, root path | ||
| const createGlobArray = (siteDirectoryPath, plugins): Array<IGlobPattern> => { |
There was a problem hiding this comment.
generate globs for the default src/api directory & one for each plugin (that's not a default plugin)
| } | ||
| // Glob and return object with relative/absolute paths + which plugin | ||
| // they belong to. | ||
| const allFunctions = await Promise.all( |
There was a problem hiding this comment.
setup the route + metadata for each function file
| @@ -240,7 +317,11 @@ export async function onPreBootstrap({ | |||
|
|
|||
| // Log success in dev | |||
| if (!isProductionEnv) { | |||
| reporter.success(`Re-building functions`) | |||
| if (isFirstBuild) { | |||
There was a problem hiding this comment.
remove unneeded message from bootstrap
|
|
||
| // Combine functions by the route name so that functions in the default | ||
| // functions directory can override the plugin's implementations. | ||
| const knownFunctions = _.unionBy( |
There was a problem hiding this comment.
we implement shadowing using lodash's unionBy and combine by the functionRoute. The site's function implementations are first so they override any matching functions that come later.
| @@ -363,20 +452,26 @@ export async function onCreateDevServer({ | |||
|
|
|||
| await Promise.resolve(fnToExecute(req, res)) | |||
| } catch (e) { | |||
| // Override the default error with something more specific. | |||
| if (e.message.includes(`fnToExecute is not a function`)) { | |||
There was a problem hiding this comment.
set a better error if the function file doesn't export a function
|
FYI: I don't believe we support this (nested functions) from a hosting side of things, unless I am wrong @dmccraw |
|
We don't support dynamic functions on the Cloud side of things but this pr sets up the manifest file so we can support it. |
|
functions in subdirectories work e.g. |
|
As a theme creator this is exciting. I can package up a plug-and-play e-commerce theme now that abstracts the function for someone in a powerful way...nice work!! |
|
Thanks! Yeah, I'm very excited by the possibilities. Make themes and plugins 75% more powerful plus creates a lot of new use cases. |
LekoArts
added
the
topic: DX
Enable plugins/themes to ship Functions.
Their Functions must be created within their namespace:
src/api/{pluginName}/.Shadowing work with functions similar to how it does in general. You can shadow a plugin/theme Function by copying the file from its src tree into the site's src tree e.g.
node_modules/gatsby-plugin-cool/src/api/gatsby-plugin-cool/function.js=>src/api/gatsby-plugin-cool/function.js.Also fix a few small bugs most noticeably I didn't rename
apiRoutetofunctionRoutebefore.