feat!: update signature of zipFunctions
#6524
Conversation
eduardoboucas
changed the title
zipFunctionszipFunctions
|
This pull request adds or modifies JavaScript ( |
| @@ -71,11 +113,12 @@ export const zipFunctions = async function ( | |||
| const logger = getLogger(systemLog, debug) | |||
| const cache = new RuntimeCache() | |||
| const featureFlags = getFlags(inputFeatureFlags) | |||
| const srcFolders = resolveFunctionsDirectories(relativeSrcFolders) | |||
| const bag = getFunctionsBag(input) | |||
| const srcFolders = resolveFunctionsDirectories(bag.directories) | |||
There was a problem hiding this comment.
We use directories to go find functions.
| const internalFunctionsPath = internalSrcFolder && resolve(internalSrcFolder) | ||
|
|
||
| const [paths] = await Promise.all([listFunctionsDirectories(srcFolders), fs.mkdir(destFolder, { recursive: true })]) | ||
| const functions = await getFunctionsFromPaths(paths, { | ||
| const functions = await getFunctionsFromPaths([...paths, ...bag.functions], { |
There was a problem hiding this comment.
And we use functions to pass directly to getFunctionsFromPaths, which filters the paths that can actually be functions.
|
This pull request adds or modifies JavaScript ( |
|
This pull request adds or modifies JavaScript ( |
|
This pull request adds or modifies JavaScript ( |
|
This pull request adds or modifies JavaScript ( |
|
This pull request adds or modifies JavaScript ( |
Summary
In #6481 we made it possible for
zipFunctionsto receive both directory and file paths. The idea is that we could accept both directories of functions and individual functions, interchangeably.This works for the most part, but becomes a bit challenging when the individual functions live in their own sub-directory.
For example, given the following tree:
If I pass
my-functionstozipFunctions, zip-it-and-ship-it will understand thatfunc1is a function in a sub-directory and will handle it correctly, which means naming the functionfunc1(notindex) and understanding thatutil.jsis a supporting file and not an entry file for another function.This understanding breaks down if we pass
my-functions/func1/index.jsdirectly, because zip-it-and-ship-it has no way of knowing that the function is actually calledfunc1, notindex.So this PR updates the signature of
zipFunctionsto accept an object (which I've calledFunctionsBag) with two properties that separate the input into:directories: Paths that can contain multiple functions (which in the tree above would bemy-functions)functions: Paths that point to individual functions, whether they live in their own sub-directory or not (which in the tree above would bemy-functions/func-1)zipFunctionscontinues to accept a string or array of strings as before, but I marked this as a breaking change because we no longer accept specific files on those strings. This was the change introduced in #6481, and even though no part of our system is relying on that yet, it's technically a breaking change so I'm doing a major bump.Update
I'm rolling another breaking change into this PR by removing the
internalSrcFolderparameter in favour of making the newFunctionsBagobject acceptuserandgeneratedtop-level properties.We currently have an issue where functions produced with the Frameworks API are not marked as generated (or internal, in zip-it-and-ship-it's terminology). This is because
internalSrcFolderaccepts one single directory, which is currently set by Netlify Build to.netlify/functions-internal.With this change, Netlify Build sends an object that looks something like this:
A picture of a cute animal (not mandatory, but encouraged)
🐖