feat: add srcPath property to output of listFunctions (#6561)

* feat: add `srcPath` property to output of `listFunctions`

* chore: update test

* chore: update snapshot

Author: eduardoboucas

packages/build/tests/plugins/snapshots/tests.js.md

@@ -1929,14 +1929,16 @@ Generated by [AVA](https://avajs.dev).
         "mainFile": "packages/build/tests/plugins/fixtures/functions_list/.netlify/functions-internal/internal_1.js",␊
         "name": "internal_1",␊
         "runtime": "js",␊
-        "srcDir": "packages/build/tests/plugins/fixtures/functions_list/.netlify/functions-internal"␊
+        "srcDir": "packages/build/tests/plugins/fixtures/functions_list/.netlify/functions-internal",␊
+        "srcPath": "packages/build/tests/plugins/fixtures/functions_list/.netlify/functions-internal/internal_1.js"␊
       },␊
       {␊
         "extension": ".js",␊
         "mainFile": "packages/build/tests/plugins/fixtures/functions_list/netlify/functions/user_1.js",␊
         "name": "user_1",␊
         "runtime": "js",␊
-        "srcDir": "packages/build/tests/plugins/fixtures/functions_list/netlify/functions"␊
+        "srcDir": "packages/build/tests/plugins/fixtures/functions_list/netlify/functions",␊
+        "srcPath": "packages/build/tests/plugins/fixtures/functions_list/netlify/functions/user_1.js"␊
       }␊
     ]␊
     ␊

packages/build/tests/plugins/snapshots/tests.js.snap

@@ -107,30 +107,42 @@ test('Should allow "fail" option to customize failures', async () => {
   expect(fail).toHaveBeenCalledWith('No function source directory was specified')
 })
 
-const normalizeFiles = function (fixtureDir, { name, mainFile, runtime, extension, srcDir, srcFile, schedule }) {
+const normalizeFiles = function (
+  fixtureDir,
+  { name, mainFile, runtime, extension, srcDir, srcFile, srcPath, schedule },
+) {
   const mainFileA = normalize(`${fixtureDir}/${mainFile}`)
   const srcFileA = srcFile === undefined ? {} : { srcFile: normalize(`${fixtureDir}/${srcFile}`) }
   const srcDirA = srcDir ? { srcDir: resolve(fixtureDir, srcDir) } : {}
-  return { name, mainFile: mainFileA, runtime, extension, schedule, ...srcFileA, ...srcDirA }
+  const srcPathA = srcPath ? { srcPath: resolve(fixtureDir, srcPath) } : {}
+  return { name, mainFile: mainFileA, runtime, extension, schedule, ...srcFileA, ...srcDirA, ...srcPathA }
 }
 
 test('Can list function main files with list()', async () => {
   const fixtureDir = `${FIXTURES_DIR}/list`
   const functions = await list(fixtureDir)
   expect(sortOn(functions, ['mainFile', 'extension'])).toEqual(
     [
-      { name: 'four', mainFile: 'four.js/four.js.js', runtime: 'js', extension: '.js', srcDir: 'four.js' },
+      {
+        name: 'four',
+        mainFile: 'four.js/four.js.js',
+        runtime: 'js',
+        extension: '.js',
+        srcDir: 'four.js',
+        srcPath: 'four.js',
+      },
       {
         name: 'one',
         mainFile: 'one/index.js',
         runtime: 'js',
         extension: '.js',
         srcDir: 'one',
+        srcPath: 'one',
       },
-      { name: 'test', mainFile: 'test', runtime: 'go', extension: '', srcDir: '.' },
-      { name: 'test', mainFile: 'test.js', runtime: 'js', extension: '.js', srcDir: '.' },
-      { name: 'test', mainFile: 'test.zip', runtime: 'js', extension: '.zip', srcDir: '.' },
-      { name: 'two', mainFile: 'two/two.js', runtime: 'js', extension: '.js', srcDir: 'two' },
+      { name: 'test', mainFile: 'test', runtime: 'go', extension: '', srcDir: '.', srcPath: 'test' },
+      { name: 'test', mainFile: 'test.js', runtime: 'js', extension: '.js', srcDir: '.', srcPath: 'test.js' },
+      { name: 'test', mainFile: 'test.zip', runtime: 'js', extension: '.zip', srcDir: '.', srcPath: 'test.zip' },
+      { name: 'two', mainFile: 'two/two.js', runtime: 'js', extension: '.js', srcDir: 'two', srcPath: 'two' },
     ].map(normalizeFiles.bind(null, fixtureDir)),
   )
 })
@@ -147,13 +159,15 @@ test('Can list all function files with listAll()', async () => {
         extension: '.js',
         srcFile: 'four.js/four.js.js',
         srcDir: 'four.js',
+        srcPath: 'four.js',
       },
       {
         name: 'four',
         mainFile: 'four.js/four.js.js',
         runtime: 'js',
         extension: '.json',
         srcFile: '../../../package.json',
+        srcPath: 'four.js',
         srcDir: 'four.js',
       },
       {
@@ -162,6 +176,7 @@ test('Can list all function files with listAll()', async () => {
         runtime: 'js',
         extension: '.js',
         srcFile: 'one/index.js',
+        srcPath: 'one',
         srcDir: 'one',
       },
       {
@@ -170,6 +185,7 @@ test('Can list all function files with listAll()', async () => {
         runtime: 'js',
         extension: '.json',
         srcFile: '../../../package.json',
+        srcPath: 'one',
         srcDir: 'one',
       },
       {
@@ -178,6 +194,7 @@ test('Can list all function files with listAll()', async () => {
         runtime: 'go',
         extension: '',
         srcFile: 'test',
+        srcPath: 'test',
         srcDir: '.',
       },
       {
@@ -186,6 +203,7 @@ test('Can list all function files with listAll()', async () => {
         runtime: 'js',
         extension: '.js',
         srcFile: 'test.js',
+        srcPath: 'test.js',
         srcDir: '.',
       },
       {
@@ -194,6 +212,7 @@ test('Can list all function files with listAll()', async () => {
         runtime: 'js',
         extension: '.json',
         srcFile: '../../../package.json',
+        srcPath: 'test.js',
         srcDir: '.',
       },
       {
@@ -202,16 +221,34 @@ test('Can list all function files with listAll()', async () => {
         runtime: 'js',
         extension: '.zip',
         srcFile: 'test.zip',
+        srcPath: 'test.zip',
         srcDir: '.',
       },
-      { name: 'two', mainFile: 'two/two.js', runtime: 'js', extension: '.js', srcFile: 'two/two.js', srcDir: 'two' },
-      { name: 'two', mainFile: 'two/two.js', runtime: 'js', extension: '.js', srcFile: 'two/three.js', srcDir: 'two' },
+      {
+        name: 'two',
+        mainFile: 'two/two.js',
+        runtime: 'js',
+        extension: '.js',
+        srcFile: 'two/two.js',
+        srcPath: 'two',
+        srcDir: 'two',
+      },
+      {
+        name: 'two',
+        mainFile: 'two/two.js',
+        runtime: 'js',
+        extension: '.js',
+        srcFile: 'two/three.js',
+        srcPath: 'two',
+        srcDir: 'two',
+      },
       {
         name: 'two',
         mainFile: 'two/two.js',
         runtime: 'js',
         extension: '.json',
         srcFile: '../../../package.json',
+        srcPath: 'two',
         srcDir: 'two',
       },
     ].map(normalizeFiles.bind(null, fixtureDir)),

packages/functions-utils/tests/main.test.ts

@@ -39,6 +39,7 @@ export interface ListedFunction {
   excludedRoutes?: Route[]
   routes?: ExtendedRoute[]
   srcDir?: string
+  srcPath: string
 }
 
 type ListedFunctionFile = ListedFunction & {
@@ -154,6 +155,7 @@ const getListedFunction = function ({
   name,
   runtime,
   srcDir,
+  srcPath,
 }: AugmentedFunctionSource): ListedFunction {
   return {
     displayName: config.name,
@@ -169,6 +171,7 @@ const getListedFunction = function ({
     schedule: staticAnalysisResult?.config?.schedule ?? config.schedule,
     inputModuleFormat: staticAnalysisResult?.inputModuleFormat,
     srcDir,
+    srcPath,
   }
 }
 

packages/zip-it-and-ship-it/src/main.ts

@@ -15,6 +15,7 @@ exports[`listFunction > V2 API > listFunction includes metadata properties when
   "schedule": undefined,
   "srcDir": "v2-api-esm-ts-aliases",
   "srcFile": undefined,
+  "srcPath": "v2-api-esm-ts-aliases/function.ts",
   "timeout": undefined,
 }
 `;