-
Notifications
You must be signed in to change notification settings - Fork 352
/
registry.mjs
318 lines (249 loc) · 9.92 KB
/
registry.mjs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
// @ts-check
import { mkdir } from 'fs/promises'
import { extname, isAbsolute, join, resolve } from 'path'
import { env } from 'process'
import { listFunctions } from '@netlify/zip-it-and-ship-it'
import extractZip from 'extract-zip'
import { chalk, log, NETLIFYDEVERR, NETLIFYDEVLOG, warn, watchDebounced } from '../../utils/command-helpers.mjs'
import { INTERNAL_FUNCTIONS_FOLDER, SERVE_FUNCTIONS_FOLDER } from '../../utils/functions/functions.mjs'
import { BACKGROUND_FUNCTIONS_WARNING } from '../log.mjs'
import { getPathInProject } from '../settings.mjs'
import NetlifyFunction from './netlify-function.mjs'
import runtimes from './runtimes/index.mjs'
const DEFAULT_URL_EXPRESSION = /^\/.netlify\/(functions|builders)\/([^/]+).*/
const ZIP_EXTENSION = '.zip'
export class FunctionsRegistry {
constructor({ capabilities, config, debug = false, isConnected = false, projectRoot, settings, timeouts }) {
this.capabilities = capabilities
this.config = config
this.debug = debug
this.isConnected = isConnected
this.projectRoot = projectRoot
this.timeouts = timeouts
this.settings = settings
// An object to be shared among all functions in the registry. It can be
// used to cache the results of the build function — e.g. it's used in
// the `memoizedBuild` method in the JavaScript runtime.
this.buildCache = {}
// File watchers for parent directories where functions live — i.e. the
// ones supplied to `scan()`. This is a Map because in the future we
// might have several function directories.
this.directoryWatchers = new Map()
// The functions held by the registry. Maps function names to instances of
// `NetlifyFunction`.
this.functions = new Map()
// File watchers for function files. Maps function names to objects built
// by the `watchDebounced` utility.
this.functionWatchers = new Map()
}
static async prepareDirectoryScan(directory) {
await mkdir(directory, { recursive: true })
// We give runtimes the opportunity to react to a directory scan and run
// additional logic before the directory is read. So if they implement a
// `onDirectoryScan` hook, we run it.
await Promise.all(
Object.values(runtimes).map((runtime) => {
if (typeof runtime.onDirectoryScan !== 'function') {
return null
}
return runtime.onDirectoryScan({ directory })
}),
)
}
async buildFunctionAndWatchFiles(func, firstLoad = false) {
if (!firstLoad) {
log(`${NETLIFYDEVLOG} ${chalk.magenta('Reloading')} function ${chalk.yellow(func.displayName)}...`)
}
const { error: buildError, includedFiles, srcFilesDiff } = await func.build({ cache: this.buildCache })
if (buildError) {
log(
`${NETLIFYDEVERR} ${chalk.red('Failed to load')} function ${chalk.yellow(func.displayName)}: ${
buildError.message
}`,
)
} else {
const verb = firstLoad ? 'Loaded' : 'Reloaded'
log(`${NETLIFYDEVLOG} ${chalk.green(verb)} function ${chalk.yellow(func.displayName)}`)
}
// If the build hasn't resulted in any files being added or removed, there
// is nothing else we need to do.
if (!srcFilesDiff) {
return
}
const watcher = this.functionWatchers.get(func.name)
// If there is already a watcher for this function, we need to unwatch any
// files that have been removed and watch any files that have been added.
if (watcher) {
srcFilesDiff.deleted.forEach((path) => {
watcher.unwatch(path)
})
srcFilesDiff.added.forEach((path) => {
watcher.add(path)
})
return
}
// If there is no watcher for this function but the build produced files,
// we create a new watcher and watch them.
if (srcFilesDiff.added.size !== 0) {
const filesToWatch = [...srcFilesDiff.added, ...includedFiles]
const newWatcher = await watchDebounced(filesToWatch, {
onChange: () => {
this.buildFunctionAndWatchFiles(func, false)
},
})
this.functionWatchers.set(func.name, newWatcher)
}
}
get(name) {
return this.functions.get(name)
}
async getFunctionForURLPath(urlPath, method) {
const defaultURLMatch = urlPath.match(DEFAULT_URL_EXPRESSION)
if (defaultURLMatch) {
const func = this.get(defaultURLMatch[2])
if (!func) {
return
}
const { routes = [] } = await func.getBuildData()
if (routes.length !== 0) {
const paths = routes.map((route) => chalk.underline(route.pattern)).join(', ')
warn(
`Function ${chalk.yellow(func.name)} cannot be invoked on ${chalk.underline(
urlPath,
)}, because the function has the following URL paths defined: ${paths}`,
)
return
}
return { func, route: null }
}
for (const func of this.functions.values()) {
const route = await func.matchURLPath(urlPath, method)
if (route) {
return { func, route }
}
}
}
async registerFunction(name, funcBeforeHook) {
const { runtime } = funcBeforeHook
// The `onRegister` hook allows runtimes to modify the function before it's
// registered, or to prevent it from being registered altogether if the
// hook returns `null`.
const func = typeof runtime.onRegister === 'function' ? runtime.onRegister(funcBeforeHook) : funcBeforeHook
if (func === null) {
return
}
if (func.isBackground && this.isConnected && !this.capabilities.backgroundFunctions) {
warn(BACKGROUND_FUNCTIONS_WARNING)
}
if (!func.hasValidName()) {
warn(
`Function name '${func.name}' is invalid. It should consist only of alphanumeric characters, hyphen & underscores.`,
)
}
// If the function file is a ZIP, we extract it and rewire its main file to
// the new location.
if (extname(func.mainFile) === ZIP_EXTENSION) {
const unzippedDirectory = await this.unzipFunction(func)
if (this.debug) {
log(`${NETLIFYDEVLOG} ${chalk.green('Extracted')} function ${chalk.yellow(name)} from ${func.mainFile}.`)
}
func.mainFile = join(unzippedDirectory, `${func.name}.js`)
}
this.functions.set(name, func)
this.buildFunctionAndWatchFiles(func, true)
}
// This function is here so we can mock it in tests
// eslint-disable-next-line class-methods-use-this
async listFunctions(...args) {
return await listFunctions(...args)
}
async scan(relativeDirs) {
const directories = relativeDirs.filter(Boolean).map((dir) => (isAbsolute(dir) ? dir : join(this.projectRoot, dir)))
// check after filtering to filter out [undefined] for example
if (directories.length === 0) {
return
}
await Promise.all(directories.map((path) => FunctionsRegistry.prepareDirectoryScan(path)))
const functions = await this.listFunctions(directories, {
featureFlags: {
buildRustSource: env.NETLIFY_EXPERIMENTAL_BUILD_RUST_SOURCE === 'true',
},
configFileDirectories: [getPathInProject([INTERNAL_FUNCTIONS_FOLDER])],
config: this.config.functions,
})
// Before registering any functions, we look for any functions that were on
// the previous list but are missing from the new one. We unregister them.
const deletedFunctions = [...this.functions.values()].filter((oldFunc) => {
const isFound = functions.some(
(newFunc) => newFunc.name === oldFunc.name && newFunc.runtime === oldFunc.runtime.name,
)
return !isFound
})
await Promise.all(deletedFunctions.map((func) => this.unregisterFunction(func.name)))
await Promise.all(
// zip-it-and-ship-it returns an array sorted based on which extension should have precedence,
// where the last ones precede the previous ones. This is why
// we reverse the array so we get the right functions precedence in the CLI.
functions.reverse().map(async ({ displayName, mainFile, name, runtime: runtimeName }) => {
const runtime = runtimes[runtimeName]
// If there is no matching runtime, it means this function is not yet
// supported in Netlify Dev.
if (runtime === undefined) {
return
}
// If this function has already been registered, we skip it.
if (this.functions.has(name)) {
return
}
const func = new NetlifyFunction({
config: this.config,
directory: directories.find((directory) => mainFile.startsWith(directory)),
mainFile,
name,
displayName,
projectRoot: this.projectRoot,
runtime,
timeoutBackground: this.timeouts.backgroundFunctions,
timeoutSynchronous: this.timeouts.syncFunctions,
settings: this.settings,
})
await this.registerFunction(name, func)
}),
)
await Promise.all(directories.map((path) => this.setupDirectoryWatcher(path)))
}
// This watcher looks at files being added or removed from a functions
// directory. It doesn't care about files being changed, because those
// will be handled by each functions' watcher.
async setupDirectoryWatcher(directory) {
if (this.directoryWatchers.has(directory)) {
return
}
const watcher = await watchDebounced(directory, {
depth: 1,
onAdd: () => {
this.scan([directory])
},
onUnlink: () => {
this.scan([directory])
},
})
this.directoryWatchers.set(directory, watcher)
}
async unregisterFunction(name) {
this.functions.delete(name)
log(`${NETLIFYDEVLOG} ${chalk.magenta('Removed')} function ${chalk.yellow(name)}.`)
const watcher = this.functionWatchers.get(name)
if (watcher) {
await watcher.close()
}
}
async unzipFunction(func) {
const targetDirectory = resolve(
this.projectRoot,
getPathInProject([SERVE_FUNCTIONS_FOLDER, '.unzipped', func.name]),
)
await extractZip(func.mainFile, { dir: targetDirectory })
return targetDirectory
}
}