feat: populate generator field if function is in the internal folder (#1357)

* feat: populate generator field if function is in the internal folder

* Update README.md

Co-authored-by: Daniel Tschinder <231804+danez@users.noreply.github.com>

---------

Co-authored-by: Daniel Tschinder <231804+danez@users.noreply.github.com>

Author: khendrikse

README.md

@@ -191,6 +191,13 @@ JSON-formatted string with the following properties:
 
 Maximum number of functions to bundle at the same time.
 
+#### `internalSrcFolder`
+
+- _Type_: `string`
+- _Default value_: `undefined`
+
+Defines the path to the folder with internal functions. Used to populate a function's `generator` property if `generator` is not configured in the function's config itself, if its path is within this specified internal functions folder.
+
 ### Return value
 
 This returns a `Promise` resolving to an array of objects describing each archive. Every object has the following
@@ -222,7 +229,7 @@ properties.
 
 - `generator`: `string`
 
-  If there was a user-defined configuration object applied to the function, and it had `generator` defined. This will be returned here.
+  If there was a user-defined configuration object applied to the function, and it had `generator` defined. This will be returned here. If there was nothing defined, but an `internalSrcFolder` was passed and the function was defined in there, it will return a string to specify it was an internal function.
 
 Additionally, the following properties also exist for Node.js functions:
 

src/runtimes/go/index.ts

@@ -6,6 +6,7 @@ import { copyFile } from 'cp-file'
 import { SourceFile } from '../../function.js'
 import type { RuntimeCache } from '../../utils/cache.js'
 import { cachedLstat, cachedReaddir } from '../../utils/fs.js'
+import getInternalValue from '../../utils/get_internal_value.js'
 import { nonNullable } from '../../utils/non_nullable.js'
 import { zipBinary } from '../../zip_binary.js'
 import { detectBinaryRuntime } from '../detect_runtime.js'
@@ -109,7 +110,16 @@ const processSource = async ({
   }
 }
 
-const zipFunction: ZipFunction = async function ({ config, destFolder, filename, mainFile, srcDir, srcPath, stat }) {
+const zipFunction: ZipFunction = async function ({
+  config,
+  destFolder,
+  filename,
+  mainFile,
+  srcDir,
+  srcPath,
+  stat,
+  isInternal,
+}) {
   const destPath = join(destFolder, filename)
   const isSource = extname(mainFile) === '.go'
 
@@ -155,7 +165,7 @@ const zipFunction: ZipFunction = async function ({ config, destFolder, filename,
     config,
     path: destPath,
     displayName: config?.name,
-    generator: config?.generator,
+    generator: config?.generator || getInternalValue(isInternal),
   }
 }
 

src/runtimes/node/index.ts

@@ -2,6 +2,7 @@ import { join } from 'path'
 
 import { copyFile } from 'cp-file'
 
+import getInternalValue from '../../utils/get_internal_value.js'
 import { GetSrcFilesFunction, Runtime, RuntimeType, ZipFunction } from '../runtime.js'
 
 import { getBundler, getBundlerName } from './bundlers/index.js'
@@ -45,6 +46,7 @@ const zipFunction: ZipFunction = async function ({
   srcDir,
   srcPath,
   stat,
+  isInternal,
 }) {
   const pluginsModulesPath = await getPluginsModulesPath(srcDir)
   const bundlerName = await getBundlerName({
@@ -127,7 +129,7 @@ const zipFunction: ZipFunction = async function ({
     nodeModulesWithDynamicImports,
     path: zipPath,
     displayName: config?.name,
-    generator: config?.generator,
+    generator: config?.generator || getInternalValue(isInternal),
   }
 }
 

src/runtimes/runtime.ts

@@ -59,6 +59,7 @@ export type ZipFunction = (
     featureFlags: FeatureFlags
     repositoryRoot?: string
     generator?: string
+    isInternal: boolean
   } & FunctionSource,
 ) => Promise<ZipFunctionResult>
 

src/runtimes/rust/index.ts

@@ -5,6 +5,7 @@ import { FeatureFlags } from '../../feature_flags.js'
 import { SourceFile } from '../../function.js'
 import type { RuntimeCache } from '../../utils/cache.js'
 import { cachedLstat, cachedReaddir } from '../../utils/fs.js'
+import getInternalValue from '../../utils/get_internal_value.js'
 import { nonNullable } from '../../utils/non_nullable.js'
 import { zipBinary } from '../../zip_binary.js'
 import { detectBinaryRuntime } from '../detect_runtime.js'
@@ -137,6 +138,7 @@ const zipFunction: ZipFunction = async function ({
   srcDir,
   srcPath,
   stat,
+  isInternal,
 }) {
   const destPath = join(destFolder, `${filename}.zip`)
   const isSource = extname(mainFile) === '.rs'
@@ -161,7 +163,7 @@ const zipFunction: ZipFunction = async function ({
     config,
     path: destPath,
     displayName: config?.name,
-    generator: config?.generator,
+    generator: config?.generator || getInternalValue(isInternal),
   }
 }
 

src/utils/get_internal_value.ts

@@ -0,0 +1,3 @@
+const getInternalValue = (isInternal: boolean) => (isInternal ? 'internalFunc' : undefined)
+
+export default getInternalValue

src/zip.ts

@@ -1,6 +1,7 @@
 import { promises as fs } from 'fs'
 import { resolve } from 'path'
 
+import isPathInside from 'is-path-inside'
 import pMap from 'p-map'
 
 import { ArchiveFormat } from './archive.js'
@@ -27,12 +28,14 @@ interface ZipFunctionOptions {
   zipGo?: boolean
   systemLog?: LogFunction
   debug?: boolean
+  internalSrcFolder?: string
 }
 
 export type ZipFunctionsOptions = ZipFunctionOptions & {
   configFileDirectories?: string[]
   manifest?: string
   parallelLimit?: number
+  internalSrcFolder?: string
 }
 
 const DEFAULT_PARALLEL_LIMIT = 5
@@ -60,6 +63,7 @@ export const zipFunctions = async function (
     repositoryRoot = basePath,
     systemLog,
     debug,
+    internalSrcFolder,
   }: ZipFunctionsOptions = {},
 ) {
   validateArchiveFormat(archiveFormat)
@@ -68,6 +72,7 @@ export const zipFunctions = async function (
   const cache = new RuntimeCache()
   const featureFlags = getFlags(inputFeatureFlags)
   const srcFolders = resolveFunctionsDirectories(relativeSrcFolders)
+  const internalFunctionsPath = internalSrcFolder && resolve(internalSrcFolder)
 
   const [paths] = await Promise.all([listFunctionsDirectories(srcFolders), fs.mkdir(destFolder, { recursive: true })])
   const functions = await getFunctionsFromPaths(paths, {
@@ -105,6 +110,7 @@ export const zipFunctions = async function (
         srcDir: func.srcDir,
         srcPath: func.srcPath,
         stat: func.stat,
+        isInternal: Boolean(internalFunctionsPath && isPathInside(func.srcPath, internalFunctionsPath)),
       })
       const durationNs = endTimer(startIntervalTime)
       const logObject = {
@@ -149,6 +155,7 @@ export const zipFunction = async function (
     repositoryRoot = basePath,
     systemLog,
     debug,
+    internalSrcFolder,
   }: ZipFunctionOptions = {},
 ) {
   validateArchiveFormat(archiveFormat)
@@ -158,6 +165,7 @@ export const zipFunction = async function (
   const srcPath = resolve(relativeSrcPath)
   const cache = new RuntimeCache()
   const functions = await getFunctionsFromPaths([srcPath], { cache, config: inputConfig, dedupe: true, featureFlags })
+  const internalFunctionsPath = internalSrcFolder && resolve(internalSrcFolder)
 
   if (functions.size === 0) {
     return
@@ -200,6 +208,7 @@ export const zipFunction = async function (
     srcDir,
     srcPath,
     stat: stats,
+    isInternal: Boolean(internalFunctionsPath && isPathInside(srcPath, internalFunctionsPath)),
   })
   const durationNs = endTimer(startIntervalTime)
   const logObject = {

tests/main.test.ts

@@ -78,13 +78,15 @@ describe('zip-it-and-ship-it', () => {
         length: 2,
         opts: {
           ...options,
+          internalSrcFolder: join(FIXTURES_DIR, fixtureName),
           config: { 'function-1': { name: 'Function One', generator: '@netlify/mock-plugin@1.0.0' } },
         },
       })
       expect(files).toHaveLength(2)
       expect(files[0].displayName).toBe('Function One')
       expect(files[0].generator).toBe('@netlify/mock-plugin@1.0.0')
       expect(files[1].displayName).toBeUndefined()
+      expect(files[1].generator).toBe('internalFunc')
     },
   )
 
@@ -1785,7 +1787,7 @@ describe('zip-it-and-ship-it', () => {
     expect(mockSource).toBe(unzippedBinaryContents)
   })
 
-  test('Builds Go functions from an internal functions dir with a configured fields', async () => {
+  test('Builds Go functions from an internal functions dir with configured fields', async () => {
     vi.mocked(shellUtils.runCommand).mockImplementation(async (...args) => {
       await writeFile(args[1][2], '')
 
@@ -1796,6 +1798,7 @@ describe('zip-it-and-ship-it', () => {
     const { files } = await zipFixture(fixtureName, {
       length: 2,
       opts: {
+        internalSrcFolder: join(FIXTURES_DIR, fixtureName),
         config: {
           'go-func-1': {
             name: 'Go Function One',
@@ -1809,6 +1812,7 @@ describe('zip-it-and-ship-it', () => {
     expect(files[0].displayName).toBe('Go Function One')
     expect(files[0].generator).toBe('@netlify/mock-plugin@1.0.0')
     expect(files[1].displayName).toBeUndefined()
+    expect(files[1].generator).toBe('internalFunc')
   })
 
   test('Builds Go functions from source', async () => {
@@ -1985,6 +1989,7 @@ describe('zip-it-and-ship-it', () => {
     const { files } = await zipFixture(fixtureName, {
       length: 2,
       opts: {
+        internalSrcFolder: join(FIXTURES_DIR, fixtureName),
         config: {
           'rust-func-1': {
             name: 'Rust Function Two',
@@ -2001,6 +2006,7 @@ describe('zip-it-and-ship-it', () => {
     expect(files[0].displayName).toBe('Rust Function Two')
     expect(files[0].generator).toBe('@netlify/mock-plugin@1.0.0')
     expect(files[1].displayName).toBeUndefined()
+    expect(files[1].generator).toBe('internalFunc')
   })
 
   test('Adds `type: "functionsBundling"` to errors resulting from compiling Rust binaries', async () => {
@@ -2082,7 +2088,6 @@ describe('zip-it-and-ship-it', () => {
     )
   })
 
-  // manifest stuff
   test('Creates a manifest file with the list of created functions if the `manifest` property is supplied', async () => {
     const FUNCTIONS_COUNT = 6
     const { path: tmpDir } = await getTmpDir({ prefix: 'zip-it-test' })
@@ -2316,6 +2321,7 @@ describe('zip-it-and-ship-it', () => {
       expect(func1Entry?.generator).toBe('@netlify/mock-plugin@1.0.0')
       expect(func1Entry?.config.includedFiles).toEqual(['blog/*.md'])
       expect(func2Entry?.config.includedFiles).toEqual(['blog/*.md'])
+      expect(func2Entry?.generator).toBeUndefined()
       expect(func3Entry?.config.includedFiles).toBe(undefined)
       expect(func4Entry?.config.includedFiles).toBe(undefined)