Skip to content
This repository was archived by the owner on May 22, 2024. It is now read-only.

Commit 914ae53

Browse files
khendriksekhendrikse
authoredFeb 17, 2023
feat: add generator as an option to config and save it in the manifest and remove isInternal (#1341)
* feat: add generator as an option to config and save it in the manifest * test: add test and remove internalSrcFolder usage
·
v9.32.2v8.7.0
1 parent cde6f11 commit 914ae53

File tree

17 files changed

+86
-78
lines changed

17 files changed

+86
-78
lines changed
 

‎README.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,18 @@ The following properties are accepted:
152152

153153
- `name`
154154

155+
- _Type_: `string`
156+
- _Default value_: undefined
157+
155158
A name to use when displaying the function in the Netlify UI. Populates the `displayName` property in the functions manifest for the specified function.
156159

160+
- `generator`
161+
162+
- _Type_: `string`
163+
- _Default value_: undefined
164+
165+
A field to use if the function has been autogenerated by a plugin or integration. A recommended format is `@netlify/fake-plugin@1.0.0`, where adding the version is highly appreciated.
166+
157167
#### `featureFlags`
158168

159169
See [feature flags](#feature-flags).
@@ -181,13 +191,6 @@ JSON-formatted string with the following properties:
181191

182192
Maximum number of functions to bundle at the same time.
183193

184-
#### `internalSrcFolder`
185-
186-
- _Type_: `string`
187-
- _Default value_: `undefined`
188-
189-
Defines the path to the folder with internal functions. Used to populate a function's `isInternal` property, if its path is within this specified internal functions folder.
190-
191194
### Return value
192195

193196
This returns a `Promise` resolving to an array of objects describing each archive. Every object has the following
@@ -213,13 +216,13 @@ properties.
213216

214217
The size of the generated archive, in bytes.
215218

216-
- `isInternal` `boolean`
219+
- `displayName`: `string`
217220

218-
If the function path has a match with the `internalSrcFolder` property, this boolean will be true.
221+
If there was a user-defined configuration object applied to the function, and it had a `name` defined. This will be returned here.
219222

220-
- `displayName` `string`
223+
- `generator`: `string`
221224

222-
If there was a user-defined configuration object applied to the function, and it had a `name` defined. This will be returned here.
225+
If there was a user-defined configuration object applied to the function, and it had `generator` defined. This will be returned here.
223226

224227
Additionally, the following properties also exist for Node.js functions:
225228

@@ -315,7 +318,7 @@ Each object has the following properties:
315318
Function's name. This is the one used in the Function URL. For example, if a Function is a `myFunc.js` regular file,
316319
the `name` is `myFunc` and the URL is `https://{hostname}/.netlify/functions/myFunc`.
317320

318-
- `displayName` `string`
321+
- `displayName`: `string`
319322

320323
If there was a user-defined configuration object applied to the function, and it had a `name` defined. This will be returned here.
321324

@@ -332,6 +335,10 @@ Each object has the following properties:
332335

333336
Source file extension. For Node.js, this is either `.js`, `.ts` or `.zip`. For Go, this can be anything.
334337

338+
- `generator`: `string`
339+
340+
If there was a user-defined configuration object applied to the function, and it had `generator` defined. This will be returned here.
341+
335342
## listFunctionsFiles(srcFolders)
336343

337344
Like [`listFunctions()`](#listfunctionssrcfolders-options), except it returns not only the Functions main files, but also all

‎src/config.ts

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ interface FunctionConfig {
2525
schedule?: string
2626
zipGo?: boolean
2727
name?: string
28+
generator?: string
2829

2930
// Temporary configuration property, only meant to be used by the deploy
3031
// configuration API. Once we start emitting ESM files for all ESM functions,

‎src/main.ts

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export interface ListedFunction {
2222
extension: string
2323
schedule?: string
2424
displayName?: string
25+
generator?: string
2526
}
2627

2728
type ListedFunctionFile = ListedFunction & {
@@ -136,6 +137,7 @@ const getListedFunction = function ({
136137
runtime: runtime.name,
137138
extension,
138139
schedule: inSourceConfig?.schedule ?? config.schedule,
140+
generator: config.generator,
139141
}
140142
}
141143

‎src/manifest.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ interface ManifestFunction {
1212
schedule?: string
1313
displayName?: string
1414
bundler?: string
15-
isInternal?: boolean
15+
generator?: string
1616
}
1717

1818
export interface Manifest {
@@ -47,7 +47,7 @@ const formatFunctionForManifest = ({
4747
schedule,
4848
displayName,
4949
bundler,
50-
isInternal,
50+
generator,
5151
}: FunctionResult): ManifestFunction => ({
5252
mainFile,
5353
name,
@@ -56,5 +56,5 @@ const formatFunctionForManifest = ({
5656
schedule,
5757
displayName,
5858
bundler,
59-
isInternal,
59+
generator,
6060
})

‎src/runtimes/go/index.ts

+2-11
Original file line numberDiff line numberDiff line change
@@ -109,16 +109,7 @@ const processSource = async ({
109109
}
110110
}
111111

112-
const zipFunction: ZipFunction = async function ({
113-
config,
114-
destFolder,
115-
filename,
116-
mainFile,
117-
srcDir,
118-
srcPath,
119-
stat,
120-
isInternal,
121-
}) {
112+
const zipFunction: ZipFunction = async function ({ config, destFolder, filename, mainFile, srcDir, srcPath, stat }) {
122113
const destPath = join(destFolder, filename)
123114
const isSource = extname(mainFile) === '.go'
124115

@@ -164,7 +155,7 @@ const zipFunction: ZipFunction = async function ({
164155
config,
165156
path: destPath,
166157
displayName: config?.name,
167-
isInternal,
158+
generator: config?.generator,
168159
}
169160
}
170161

‎src/runtimes/node/index.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ const zipFunction: ZipFunction = async function ({
4545
srcDir,
4646
srcPath,
4747
stat,
48-
isInternal,
4948
}) {
5049
const pluginsModulesPath = await getPluginsModulesPath(srcDir)
5150
const bundlerName = await getBundlerName({
@@ -128,7 +127,7 @@ const zipFunction: ZipFunction = async function ({
128127
nodeModulesWithDynamicImports,
129128
path: zipPath,
130129
displayName: config?.name,
131-
isInternal,
130+
generator: config?.generator,
132131
}
133132
}
134133

‎src/runtimes/runtime.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ export interface ZipFunctionResult {
4545
nativeNodeModules?: object
4646
nodeModulesWithDynamicImports?: string[]
4747
path: string
48-
isInternal?: boolean
4948
displayName?: string
49+
generator?: string
5050
}
5151

5252
export type ZipFunction = (
@@ -58,7 +58,7 @@ export type ZipFunction = (
5858
destFolder: string
5959
featureFlags: FeatureFlags
6060
repositoryRoot?: string
61-
isInternal?: boolean
61+
generator?: string
6262
} & FunctionSource,
6363
) => Promise<ZipFunctionResult>
6464

‎src/runtimes/rust/index.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,6 @@ const zipFunction: ZipFunction = async function ({
137137
srcDir,
138138
srcPath,
139139
stat,
140-
isInternal,
141140
}) {
142141
const destPath = join(destFolder, `${filename}.zip`)
143142
const isSource = extname(mainFile) === '.rs'
@@ -162,7 +161,7 @@ const zipFunction: ZipFunction = async function ({
162161
config,
163162
path: destPath,
164163
displayName: config?.name,
165-
isInternal,
164+
generator: config?.generator,
166165
}
167166
}
168167

‎src/zip.ts

-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import { promises as fs } from 'fs'
22
import { resolve } from 'path'
33

4-
import isPathInside from 'is-path-inside'
54
import pMap from 'p-map'
65

76
import { ArchiveFormat } from './archive.js'
@@ -28,14 +27,12 @@ interface ZipFunctionOptions {
2827
zipGo?: boolean
2928
systemLog?: LogFunction
3029
debug?: boolean
31-
internalSrcFolder?: string
3230
}
3331

3432
export type ZipFunctionsOptions = ZipFunctionOptions & {
3533
configFileDirectories?: string[]
3634
manifest?: string
3735
parallelLimit?: number
38-
internalSrcFolder?: string
3936
}
4037

4138
const DEFAULT_PARALLEL_LIMIT = 5
@@ -63,7 +60,6 @@ export const zipFunctions = async function (
6360
repositoryRoot = basePath,
6461
systemLog,
6562
debug,
66-
internalSrcFolder,
6763
}: ZipFunctionsOptions = {},
6864
) {
6965
validateArchiveFormat(archiveFormat)
@@ -72,7 +68,6 @@ export const zipFunctions = async function (
7268
const cache = new RuntimeCache()
7369
const featureFlags = getFlags(inputFeatureFlags)
7470
const srcFolders = resolveFunctionsDirectories(relativeSrcFolders)
75-
const internalFunctionsPath = internalSrcFolder && resolve(internalSrcFolder)
7671

7772
const [paths] = await Promise.all([listFunctionsDirectories(srcFolders), fs.mkdir(destFolder, { recursive: true })])
7873
const functions = await getFunctionsFromPaths(paths, {
@@ -110,7 +105,6 @@ export const zipFunctions = async function (
110105
srcDir: func.srcDir,
111106
srcPath: func.srcPath,
112107
stat: func.stat,
113-
isInternal: Boolean(internalFunctionsPath && isPathInside(func.srcPath, internalFunctionsPath)),
114108
})
115109
const durationNs = endTimer(startIntervalTime)
116110
const logObject = {
@@ -155,7 +149,6 @@ export const zipFunction = async function (
155149
repositoryRoot = basePath,
156150
systemLog,
157151
debug,
158-
internalSrcFolder,
159152
}: ZipFunctionOptions = {},
160153
) {
161154
validateArchiveFormat(archiveFormat)
@@ -165,7 +158,6 @@ export const zipFunction = async function (
165158
const srcPath = resolve(relativeSrcPath)
166159
const cache = new RuntimeCache()
167160
const functions = await getFunctionsFromPaths([srcPath], { cache, config: inputConfig, dedupe: true, featureFlags })
168-
const internalFunctionsPath = internalSrcFolder && resolve(internalSrcFolder)
169161

170162
if (functions.size === 0) {
171163
return
@@ -208,7 +200,6 @@ export const zipFunction = async function (
208200
srcDir,
209201
srcPath,
210202
stat: stats,
211-
isInternal: Boolean(internalFunctionsPath && isPathInside(srcPath, internalFunctionsPath)),
212203
})
213204
const durationNs = endTimer(startIntervalTime)
214205
const logObject = {

‎tests/fixtures/config-files-select-directories/.netlify/functions-internal/internal-function/internal-function.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{
22
"config": {
3-
"includedFiles": ["blog/*.md"]
3+
"includedFiles": ["blog/*.md"],
4+
"name": "Internal Function",
5+
"generator": "@netlify/mock-plugin@1.0.0"
46
},
57
"version": 1
68
}

‎tests/fixtures/json-config/.netlify/functions-internal/simple.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"config": { "name": "A Display Name" },
2+
"config": { "name": "A Display Name", "generator": "@netlify/mock-plugin@1.0.0" },
33
"version": 1
44
}

‎tests/list_function.test.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ describe('listFunction', () => {
2121
})
2222
})
2323

24-
test('listFunction includes json configured functions with a name and returns it as a displayName', async () => {
24+
test('listFunction includes json configured functions with configured properties', async () => {
2525
const dir = join(FIXTURES_DIR, 'json-config/.netlify/functions-internal/')
2626
const mainFile = join(dir, 'simple.js')
2727
const func = await listFunction(mainFile, {
@@ -30,9 +30,11 @@ describe('listFunction', () => {
3030
project_deploy_configuration_api_use_per_function_configuration_files: true,
3131
},
3232
})
33+
3334
expect(func).toEqual({
3435
displayName: 'A Display Name',
3536
extension: '.js',
37+
generator: '@netlify/mock-plugin@1.0.0',
3638
mainFile,
3739
name: 'simple',
3840
runtime: 'js',

‎tests/list_functions.test.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ describe('listFunctions', () => {
8787
})
8888
})
8989

90-
test('listFunctions includes json configured functions with a name and returns it as a displayName', async () => {
90+
test('listFunctions includes json configured functions with configured properties', async () => {
9191
const dir = join(FIXTURES_DIR, 'json-config/.netlify/functions-internal/')
9292
const [func] = await listFunctions([dir], {
9393
configFileDirectories: [dir],
@@ -97,5 +97,6 @@ describe('listFunctions', () => {
9797
})
9898

9999
expect(func.displayName).toBe('A Display Name')
100+
expect(func.generator).toBe('@netlify/mock-plugin@1.0.0')
100101
})
101102
})

‎tests/list_functions_files.test.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ describe('listFunctionsFiles', () => {
252252
warn.mockRestore()
253253
})
254254

255-
test('listFunctionsFiles includes json configured functions with a name and returns it as a displayName', async () => {
255+
test('listFunctionsFiles includes json configured functions with configured properties', async () => {
256256
const dir = join(FIXTURES_DIR, 'json-config/.netlify/functions-internal/')
257257
const [func] = await listFunctionsFiles([dir], {
258258
configFileDirectories: [dir],
@@ -262,5 +262,6 @@ describe('listFunctionsFiles', () => {
262262
})
263263

264264
expect(func.displayName).toBe('A Display Name')
265+
expect(func.generator).toBe('@netlify/mock-plugin@1.0.0')
265266
})
266267
})

‎tests/main.test.ts

+40-14
Original file line numberDiff line numberDiff line change
@@ -67,25 +67,23 @@ describe('zip-it-and-ship-it', () => {
6767
expect(files).toHaveLength(1)
6868
expect(files[0].runtime).toBe('js')
6969
expect(files[0].mainFile).toBe(join(FIXTURES_DIR, fixtureName, 'function.js'))
70-
expect(files[0].isInternal).toBeFalsy()
7170
})
7271

7372
testMany(
74-
'Zips Node.js function files from an internal functions dir with a configured name',
73+
'Zips Node.js function files from an internal functions dir with a configured fields',
7574
[...allBundleConfigs, 'bundler_none'],
7675
async (options) => {
7776
const fixtureName = join('node-internal', '.netlify/internal-functions')
7877
const { files } = await zipFixture(fixtureName, {
7978
length: 2,
8079
opts: {
81-
internalSrcFolder: join(FIXTURES_DIR, fixtureName),
8280
...options,
83-
config: { 'function-1': { name: 'Function One' } },
81+
config: { 'function-1': { name: 'Function One', generator: '@netlify/mock-plugin@1.0.0' } },
8482
},
8583
})
8684
expect(files).toHaveLength(2)
87-
expect(files[0].isInternal).toBe(true)
8885
expect(files[0].displayName).toBe('Function One')
86+
expect(files[0].generator).toBe('@netlify/mock-plugin@1.0.0')
8987
expect(files[1].displayName).toBeUndefined()
9088
},
9189
)
@@ -1787,7 +1785,7 @@ describe('zip-it-and-ship-it', () => {
17871785
expect(mockSource).toBe(unzippedBinaryContents)
17881786
})
17891787

1790-
test('Builds Go functions from an internal functions dir with a configured name', async () => {
1788+
test('Builds Go functions from an internal functions dir with a configured fields', async () => {
17911789
vi.mocked(shellUtils.runCommand).mockImplementation(async (...args) => {
17921790
await writeFile(args[1][2], '')
17931791

@@ -1798,18 +1796,18 @@ describe('zip-it-and-ship-it', () => {
17981796
const { files } = await zipFixture(fixtureName, {
17991797
length: 2,
18001798
opts: {
1801-
internalSrcFolder: join(FIXTURES_DIR, fixtureName),
18021799
config: {
18031800
'go-func-1': {
18041801
name: 'Go Function One',
1802+
generator: '@netlify/mock-plugin@1.0.0',
18051803
},
18061804
},
18071805
},
18081806
})
18091807

18101808
expect(files).toHaveLength(2)
1811-
expect(files[0].isInternal).toBe(true)
18121809
expect(files[0].displayName).toBe('Go Function One')
1810+
expect(files[0].generator).toBe('@netlify/mock-plugin@1.0.0')
18131811
expect(files[1].displayName).toBeUndefined()
18141812
})
18151813

@@ -1832,15 +1830,13 @@ describe('zip-it-and-ship-it', () => {
18321830
name: 'go-func-1',
18331831
path: expect.anything(),
18341832
runtime: 'go',
1835-
isInternal: false,
18361833
},
18371834
{
18381835
config: expect.anything(),
18391836
mainFile: join(FIXTURES_DIR, fixtureName, 'go-func-2', 'go-func-2.go'),
18401837
name: 'go-func-2',
18411838
path: expect.anything(),
18421839
runtime: 'go',
1843-
isInternal: false,
18441840
},
18451841
])
18461842

@@ -1941,7 +1937,6 @@ describe('zip-it-and-ship-it', () => {
19411937
path: expect.anything(),
19421938
runtime: 'rs',
19431939
size: 278,
1944-
isInternal: false,
19451940
},
19461941
{
19471942
config: expect.anything(),
@@ -1950,7 +1945,6 @@ describe('zip-it-and-ship-it', () => {
19501945
path: expect.anything(),
19511946
runtime: 'rs',
19521947
size: 278,
1953-
isInternal: false,
19541948
},
19551949
])
19561950

@@ -1991,10 +1985,10 @@ describe('zip-it-and-ship-it', () => {
19911985
const { files } = await zipFixture(fixtureName, {
19921986
length: 2,
19931987
opts: {
1994-
internalSrcFolder: join(FIXTURES_DIR, fixtureName),
19951988
config: {
19961989
'rust-func-1': {
19971990
name: 'Rust Function Two',
1991+
generator: '@netlify/mock-plugin@1.0.0',
19981992
},
19991993
},
20001994
featureFlags: {
@@ -2004,8 +1998,8 @@ describe('zip-it-and-ship-it', () => {
20041998
})
20051999

20062000
expect(files).toHaveLength(2)
2007-
expect(files[0].isInternal).toBe(true)
20082001
expect(files[0].displayName).toBe('Rust Function Two')
2002+
expect(files[0].generator).toBe('@netlify/mock-plugin@1.0.0')
20092003
expect(files[1].displayName).toBeUndefined()
20102004
})
20112005

@@ -2088,6 +2082,7 @@ describe('zip-it-and-ship-it', () => {
20882082
)
20892083
})
20902084

2085+
// manifest stuff
20912086
test('Creates a manifest file with the list of created functions if the `manifest` property is supplied', async () => {
20922087
const FUNCTIONS_COUNT = 6
20932088
const { path: tmpDir } = await getTmpDir({ prefix: 'zip-it-test' })
@@ -2318,6 +2313,8 @@ describe('zip-it-and-ship-it', () => {
23182313
const func3Entry = files.find(({ name }) => name === 'user-function')
23192314
const func4Entry = files.find(({ name }) => name === 'not-internal')
23202315

2316+
expect(func1Entry?.displayName).toBe('Internal Function')
2317+
expect(func1Entry?.generator).toBe('@netlify/mock-plugin@1.0.0')
23212318
expect(func1Entry?.config.includedFiles).toEqual(['blog/*.md'])
23222319
expect(func2Entry?.config.includedFiles).toEqual(['blog/*.md'])
23232320
expect(func3Entry?.config.includedFiles).toBe(undefined)
@@ -2348,6 +2345,35 @@ describe('zip-it-and-ship-it', () => {
23482345
},
23492346
)
23502347

2348+
testMany(
2349+
'Loads function configuration properties from a JSON file if the function is inside one of `configFileDirectories` and writes to manifest file',
2350+
[...allBundleConfigs],
2351+
async (options) => {
2352+
const { path: tmpManifestDir } = await getTmpDir({ prefix: 'zip-it-test' })
2353+
const manifestPath = join(tmpManifestDir, 'manifest.json')
2354+
const fixtureName = 'config-files-select-directories'
2355+
const pathInternal = join(fixtureName, '.netlify', 'functions-internal')
2356+
const pathNotInternal = join(fixtureName, '.netlify', 'functions-internal-not')
2357+
const pathUser = join(fixtureName, 'netlify', 'functions')
2358+
const opts = merge(options, {
2359+
basePath: join(FIXTURES_DIR, fixtureName),
2360+
manifest: manifestPath,
2361+
configFileDirectories: [join(FIXTURES_DIR, pathInternal)],
2362+
featureFlags: { project_deploy_configuration_api_use_per_function_configuration_files: true },
2363+
})
2364+
await zipFixture([pathInternal, pathNotInternal, pathUser], {
2365+
length: 4,
2366+
opts,
2367+
})
2368+
2369+
const manifest = JSON.parse(await readFile(manifestPath, 'utf-8'))
2370+
const func1Entry = manifest.functions.find(({ name }) => name === 'internal-function')
2371+
2372+
expect(func1Entry?.displayName).toBe('Internal Function')
2373+
expect(func1Entry?.generator).toBe('@netlify/mock-plugin@1.0.0')
2374+
},
2375+
)
2376+
23512377
testMany(
23522378
'Keeps config for functions passed to ZISI, but overwrites with config from JSON config',
23532379
[...allBundleConfigs, 'bundler_none'],

‎tests/zip_function.test.ts

+4-18
Original file line numberDiff line numberDiff line change
@@ -140,32 +140,18 @@ describe('zipFunction', () => {
140140
)
141141

142142
testMany(
143-
'Can populate the isInternal property for functions',
143+
'Can populate the configured properties for functions',
144144
['bundler_default', 'bundler_esbuild', 'bundler_nft'],
145145
async (options) => {
146146
const { path: tmpDir } = await getTmpDir({ prefix: 'zip-it-test' })
147-
const basePath = join(FIXTURES_DIR, 'node-internal', '.netlify/internal-functions')
147+
const basePath = join(FIXTURES_DIR, 'node-configs')
148148
const opts = merge(options, {
149-
internalSrcFolder: basePath,
150-
})
151-
const result = (await zipFunction(`${basePath}/function-1.js`, tmpDir, opts))!
152-
153-
expect(result.isInternal).toBe(true)
154-
},
155-
)
156-
157-
testMany(
158-
'Can populate the displayName property for functions',
159-
['bundler_default', 'bundler_esbuild', 'bundler_nft'],
160-
async (options) => {
161-
const { path: tmpDir } = await getTmpDir({ prefix: 'zip-it-test' })
162-
const basePath = join(FIXTURES_DIR, 'node-display-name')
163-
const opts = merge(options, {
164-
config: { 'function-1': { name: 'Function One' } },
149+
config: { 'function-1': { name: 'Function One', generator: '@netlify/mock-plugin@1.0.0' } },
165150
})
166151
const result = (await zipFunction(`${basePath}/function-1.js`, tmpDir, opts))!
167152

168153
expect(result.displayName).toBe('Function One')
154+
expect(result.generator).toBe('@netlify/mock-plugin@1.0.0')
169155
},
170156
)
171157
})

1 commit comments

Comments
 (1)

github-actions[bot] commented on Feb 17, 2023

@github-actions[bot]
github-actions[bot]
on Feb 17, 2023
Contributor

⏱ Benchmark results

  • largeDepsEsbuild: 2s
  • largeDepsNft: 7.3s
  • largeDepsZisi: 14.7s
This repository has been archived.