@vercel/build-utils 2.12.3-canary.28 → 2.12.3-canary.31

package/dist/convert-runtime-to-plugin.js

@@ -10,6 +10,36 @@ const glob_1 = __importDefault(require("./fs/glob"));
 const normalize_path_1 = require("./fs/normalize-path");
 const lambda_1 = require("./lambda");
 const _1 = require(".");
+// `.output` was already created by the Build Command, so we have
+// to ensure its contents don't get bundled into the Lambda. Similarily,
+// we don't want to bundle anything from `.vercel` either. Lastly,
+// Builders/Runtimes didn't have `vercel.json` or `now.json`.
+const ignoredPaths = ['.output', '.vercel', 'vercel.json', 'now.json'];
+const shouldIgnorePath = (file, ignoreFilter, ignoreFile) => {
+    const isNative = ignoredPaths.some(item => {
+        return file.startsWith(item);
+    });
+    if (!ignoreFile) {
+        return isNative;
+    }
+    return isNative || ignoreFilter(file);
+};
+const getSourceFiles = async (workPath, ignoreFilter) => {
+    const list = await glob_1.default('**', {
+        cwd: workPath,
+    });
+    // We're not passing this as an `ignore` filter to the `glob` function above,
+    // so that we can re-use exactly the same `getIgnoreFilter` method that the
+    // Build Step uses (literally the same code). Note that this exclusion only applies
+    // when deploying. Locally, another exclusion is needed, which is handled
+    // further below in the `convertRuntimeToPlugin` function.
+    for (const file in list) {
+        if (shouldIgnorePath(file, ignoreFilter, true)) {
+            delete list[file];
+        }
+    }
+    return list;
+};
 /**
  * Convert legacy Runtime to a Plugin.
  * @param buildRuntime - a legacy build() function from a Runtime
@@ -19,29 +49,25 @@ const _1 = require(".");
 function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
     // This `build()` signature should match `plugin.build()` signature in `vercel build`.
     return async function build({ workPath }) {
-        const opts = { cwd: workPath };
-        const files = await glob_1.default('**', opts);
-        // `.output` was already created by the Build Command, so we have
-        // to ensure its contents don't get bundled into the Lambda. Similarily,
-        // we don't want to bundle anything from `.vercel` either. Lastly,
-        // Builders/Runtimes didn't have `vercel.json` or `now.json`.
-        const ignoredPaths = ['.output', '.vercel', 'vercel.json', 'now.json'];
         // We also don't want to provide any files to Runtimes that were ignored
         // through `.vercelignore` or `.nowignore`, because the Build Step does the same.
         const ignoreFilter = await _1.getIgnoreFilter(workPath);
-        // We're not passing this as an `ignore` filter to the `glob` function above,
-        // so that we can re-use exactly the same `getIgnoreFilter` method that the
-        // Build Step uses (literally the same code).
-        for (const file in files) {
-            const isNative = ignoredPaths.some(item => {
-                return file.startsWith(item);
-            });
-            if (isNative || ignoreFilter(file)) {
-                delete files[file];
+        // Retrieve the files that are currently available on the File System,
+        // before the Legacy Runtime has even started to build.
+        const sourceFilesPreBuild = await getSourceFiles(workPath, ignoreFilter);
+        // Instead of doing another `glob` to get all the matching source files,
+        // we'll filter the list of existing files down to only the ones
+        // that are matching the entrypoint pattern, so we're first creating
+        // a clean new list to begin.
+        const entrypoints = Object.assign({}, sourceFilesPreBuild);
+        const entrypointMatch = new RegExp(`^api/.*${ext}$`);
+        // Up next, we'll strip out the files from the list of entrypoints
+        // that aren't actually considered entrypoints.
+        for (const file in entrypoints) {
+            if (!entrypointMatch.test(file)) {
+                delete entrypoints[file];
             }
         }
-        const entrypointPattern = `api/**/*${ext}`;
-        const entrypoints = await glob_1.default(entrypointPattern, opts);
         const pages = {};
         const pluginName = packageName.replace('vercel-plugin-', '');
         const traceDir = path_1.join(workPath, `.output`, `inputs`, 
@@ -53,7 +79,7 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
         await fs_extra_1.default.ensureDir(traceDir);
         for (const entrypoint of Object.keys(entrypoints)) {
             const { output } = await buildRuntime({
-                files,
+                files: sourceFilesPreBuild,
                 entrypoint,
                 workPath,
                 config: {
@@ -63,8 +89,23 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
                     avoidTopLevelInstall: true,
                 },
             });
+            // Legacy Runtimes tend to pollute the `workPath` with compiled results,
+            // because the `workPath` used to be a place that was a place where they could
+            // just put anything, but nowadays it's the working directory of the `vercel build`
+            // command, which is the place where the developer keeps their source files,
+            // so we don't want to pollute this space unnecessarily. That means we have to clean
+            // up files that were created by the build, which is done further below.
+            const sourceFilesAfterBuild = await getSourceFiles(workPath, ignoreFilter);
+            // Further down, we will need the filename of the Lambda handler
+            // for placing it inside `server/pages/api`, but because Legacy Runtimes
+            // don't expose the filename directly, we have to construct it
+            // from the handler name, and then find the matching file further below,
+            // because we don't yet know its extension here.
+            const handler = output.handler;
+            const handlerMethod = handler.split('.').reverse()[0];
+            const handlerFileName = handler.replace(`.${handlerMethod}`, '');
             pages[entrypoint] = {
-                handler: output.handler,
+                handler: handler,
                 runtime: output.runtime,
                 memory: output.memory,
                 maxDuration: output.maxDuration,
@@ -73,12 +114,42 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
             };
             // @ts-ignore This symbol is a private API
             const lambdaFiles = output[lambda_1.FILES_SYMBOL];
+            // When deploying, the `files` that are passed to the Legacy Runtimes already
+            // have certain files that are ignored stripped, but locally, that list of
+            // files isn't used by the Legacy Runtimes, so we need to apply the filters
+            // to the outputs that they are returning instead.
+            for (const file in lambdaFiles) {
+                if (shouldIgnorePath(file, ignoreFilter, false)) {
+                    delete lambdaFiles[file];
+                }
+            }
+            const handlerFilePath = Object.keys(lambdaFiles).find(item => {
+                return path_1.parse(item).name === handlerFileName;
+            });
+            const handlerFileOrigin = lambdaFiles[handlerFilePath || ''].fsPath;
+            if (!handlerFileOrigin) {
+                throw new Error(`Could not find a handler file. Please ensure that the list of \`files\` defined for the returned \`Lambda\` contains a file with the name ${handlerFileName} (+ any extension).`);
+            }
             const entry = path_1.join(workPath, '.output', 'server', 'pages', entrypoint);
             await fs_extra_1.default.ensureDir(path_1.dirname(entry));
-            await linkOrCopy(files[entrypoint].fsPath, entry);
+            await linkOrCopy(handlerFileOrigin, entry);
+            const toRemove = [];
+            // You can find more details about this at the point where the
+            // `sourceFilesAfterBuild` is created originally.
+            for (const file in sourceFilesAfterBuild) {
+                if (!sourceFilesPreBuild[file]) {
+                    const path = sourceFilesAfterBuild[file].fsPath;
+                    toRemove.push(fs_extra_1.default.remove(path));
+                }
+            }
+            await Promise.all(toRemove);
             const tracedFiles = [];
             Object.entries(lambdaFiles).forEach(async ([relPath, file]) => {
                 const newPath = path_1.join(traceDir, relPath);
+                // The handler was already moved into position above.
+                if (relPath === handlerFilePath) {
+                    return;
+                }
                 tracedFiles.push({ absolutePath: newPath, relativePath: relPath });
                 if (file.fsPath) {
                     await linkOrCopy(file.fsPath, newPath);
@@ -94,9 +165,9 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
             const nft = path_1.join(workPath, '.output', 'server', 'pages', `${entrypoint}.nft.json`);
             const json = JSON.stringify({
                 version: 1,
-                files: tracedFiles.map(f => ({
-                    input: normalize_path_1.normalizePath(path_1.relative(nft, f.absolutePath)),
-                    output: normalize_path_1.normalizePath(f.relativePath),
+                files: tracedFiles.map(file => ({
+                    input: normalize_path_1.normalizePath(path_1.relative(nft, file.absolutePath)),
+                    output: normalize_path_1.normalizePath(file.relativePath),
                 })),
             });
             await fs_extra_1.default.ensureDir(path_1.dirname(nft));

package/dist/index.js

@@ -32757,6 +32757,36 @@ const glob_1 = __importDefault(__webpack_require__(4240));
 const normalize_path_1 = __webpack_require__(6261);
 const lambda_1 = __webpack_require__(6721);
 const _1 = __webpack_require__(2855);
+// `.output` was already created by the Build Command, so we have
+// to ensure its contents don't get bundled into the Lambda. Similarily,
+// we don't want to bundle anything from `.vercel` either. Lastly,
+// Builders/Runtimes didn't have `vercel.json` or `now.json`.
+const ignoredPaths = ['.output', '.vercel', 'vercel.json', 'now.json'];
+const shouldIgnorePath = (file, ignoreFilter, ignoreFile) => {
+    const isNative = ignoredPaths.some(item => {
+        return file.startsWith(item);
+    });
+    if (!ignoreFile) {
+        return isNative;
+    }
+    return isNative || ignoreFilter(file);
+};
+const getSourceFiles = async (workPath, ignoreFilter) => {
+    const list = await glob_1.default('**', {
+        cwd: workPath,
+    });
+    // We're not passing this as an `ignore` filter to the `glob` function above,
+    // so that we can re-use exactly the same `getIgnoreFilter` method that the
+    // Build Step uses (literally the same code). Note that this exclusion only applies
+    // when deploying. Locally, another exclusion is needed, which is handled
+    // further below in the `convertRuntimeToPlugin` function.
+    for (const file in list) {
+        if (shouldIgnorePath(file, ignoreFilter, true)) {
+            delete list[file];
+        }
+    }
+    return list;
+};
 /**
  * Convert legacy Runtime to a Plugin.
  * @param buildRuntime - a legacy build() function from a Runtime
@@ -32766,29 +32796,25 @@ const _1 = __webpack_require__(2855);
 function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
     // This `build()` signature should match `plugin.build()` signature in `vercel build`.
     return async function build({ workPath }) {
-        const opts = { cwd: workPath };
-        const files = await glob_1.default('**', opts);
-        // `.output` was already created by the Build Command, so we have
-        // to ensure its contents don't get bundled into the Lambda. Similarily,
-        // we don't want to bundle anything from `.vercel` either. Lastly,
-        // Builders/Runtimes didn't have `vercel.json` or `now.json`.
-        const ignoredPaths = ['.output', '.vercel', 'vercel.json', 'now.json'];
         // We also don't want to provide any files to Runtimes that were ignored
         // through `.vercelignore` or `.nowignore`, because the Build Step does the same.
         const ignoreFilter = await _1.getIgnoreFilter(workPath);
-        // We're not passing this as an `ignore` filter to the `glob` function above,
-        // so that we can re-use exactly the same `getIgnoreFilter` method that the
-        // Build Step uses (literally the same code).
-        for (const file in files) {
-            const isNative = ignoredPaths.some(item => {
-                return file.startsWith(item);
-            });
-            if (isNative || ignoreFilter(file)) {
-                delete files[file];
+        // Retrieve the files that are currently available on the File System,
+        // before the Legacy Runtime has even started to build.
+        const sourceFilesPreBuild = await getSourceFiles(workPath, ignoreFilter);
+        // Instead of doing another `glob` to get all the matching source files,
+        // we'll filter the list of existing files down to only the ones
+        // that are matching the entrypoint pattern, so we're first creating
+        // a clean new list to begin.
+        const entrypoints = Object.assign({}, sourceFilesPreBuild);
+        const entrypointMatch = new RegExp(`^api/.*${ext}$`);
+        // Up next, we'll strip out the files from the list of entrypoints
+        // that aren't actually considered entrypoints.
+        for (const file in entrypoints) {
+            if (!entrypointMatch.test(file)) {
+                delete entrypoints[file];
             }
         }
-        const entrypointPattern = `api/**/*${ext}`;
-        const entrypoints = await glob_1.default(entrypointPattern, opts);
         const pages = {};
         const pluginName = packageName.replace('vercel-plugin-', '');
         const traceDir = path_1.join(workPath, `.output`, `inputs`, 
@@ -32800,7 +32826,7 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
         await fs_extra_1.default.ensureDir(traceDir);
         for (const entrypoint of Object.keys(entrypoints)) {
             const { output } = await buildRuntime({
-                files,
+                files: sourceFilesPreBuild,
                 entrypoint,
                 workPath,
                 config: {
@@ -32810,8 +32836,23 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
                     avoidTopLevelInstall: true,
                 },
             });
+            // Legacy Runtimes tend to pollute the `workPath` with compiled results,
+            // because the `workPath` used to be a place that was a place where they could
+            // just put anything, but nowadays it's the working directory of the `vercel build`
+            // command, which is the place where the developer keeps their source files,
+            // so we don't want to pollute this space unnecessarily. That means we have to clean
+            // up files that were created by the build, which is done further below.
+            const sourceFilesAfterBuild = await getSourceFiles(workPath, ignoreFilter);
+            // Further down, we will need the filename of the Lambda handler
+            // for placing it inside `server/pages/api`, but because Legacy Runtimes
+            // don't expose the filename directly, we have to construct it
+            // from the handler name, and then find the matching file further below,
+            // because we don't yet know its extension here.
+            const handler = output.handler;
+            const handlerMethod = handler.split('.').reverse()[0];
+            const handlerFileName = handler.replace(`.${handlerMethod}`, '');
             pages[entrypoint] = {
-                handler: output.handler,
+                handler: handler,
                 runtime: output.runtime,
                 memory: output.memory,
                 maxDuration: output.maxDuration,
@@ -32820,12 +32861,42 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
             };
             // @ts-ignore This symbol is a private API
             const lambdaFiles = output[lambda_1.FILES_SYMBOL];
+            // When deploying, the `files` that are passed to the Legacy Runtimes already
+            // have certain files that are ignored stripped, but locally, that list of
+            // files isn't used by the Legacy Runtimes, so we need to apply the filters
+            // to the outputs that they are returning instead.
+            for (const file in lambdaFiles) {
+                if (shouldIgnorePath(file, ignoreFilter, false)) {
+                    delete lambdaFiles[file];
+                }
+            }
+            const handlerFilePath = Object.keys(lambdaFiles).find(item => {
+                return path_1.parse(item).name === handlerFileName;
+            });
+            const handlerFileOrigin = lambdaFiles[handlerFilePath || ''].fsPath;
+            if (!handlerFileOrigin) {
+                throw new Error(`Could not find a handler file. Please ensure that the list of \`files\` defined for the returned \`Lambda\` contains a file with the name ${handlerFileName} (+ any extension).`);
+            }
             const entry = path_1.join(workPath, '.output', 'server', 'pages', entrypoint);
             await fs_extra_1.default.ensureDir(path_1.dirname(entry));
-            await linkOrCopy(files[entrypoint].fsPath, entry);
+            await linkOrCopy(handlerFileOrigin, entry);
+            const toRemove = [];
+            // You can find more details about this at the point where the
+            // `sourceFilesAfterBuild` is created originally.
+            for (const file in sourceFilesAfterBuild) {
+                if (!sourceFilesPreBuild[file]) {
+                    const path = sourceFilesAfterBuild[file].fsPath;
+                    toRemove.push(fs_extra_1.default.remove(path));
+                }
+            }
+            await Promise.all(toRemove);
             const tracedFiles = [];
             Object.entries(lambdaFiles).forEach(async ([relPath, file]) => {
                 const newPath = path_1.join(traceDir, relPath);
+                // The handler was already moved into position above.
+                if (relPath === handlerFilePath) {
+                    return;
+                }
                 tracedFiles.push({ absolutePath: newPath, relativePath: relPath });
                 if (file.fsPath) {
                     await linkOrCopy(file.fsPath, newPath);
@@ -32841,9 +32912,9 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
             const nft = path_1.join(workPath, '.output', 'server', 'pages', `${entrypoint}.nft.json`);
             const json = JSON.stringify({
                 version: 1,
-                files: tracedFiles.map(f => ({
-                    input: normalize_path_1.normalizePath(path_1.relative(nft, f.absolutePath)),
-                    output: normalize_path_1.normalizePath(f.relativePath),
+                files: tracedFiles.map(file => ({
+                    input: normalize_path_1.normalizePath(path_1.relative(nft, file.absolutePath)),
+                    output: normalize_path_1.normalizePath(file.relativePath),
                 })),
             });
             await fs_extra_1.default.ensureDir(path_1.dirname(nft));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/build-utils",
-  "version": "2.12.3-canary.28",
+  "version": "2.12.3-canary.31",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.js",
@@ -49,5 +49,5 @@
     "typescript": "4.3.4",
     "yazl": "2.4.3"
   },
-  "gitHead": "792ab38760eca4543a7ac02dd05eda280b5328a1"
+  "gitHead": "6f4a1b527ba01973490e1fb2e4c48ccb2841cd86"
 }