@vercel/build-utils 2.12.3-canary.39 → 2.12.3-canary.42

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

@@ -70,16 +70,15 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
         }
         const pages = {};
         const pluginName = packageName.replace('vercel-plugin-', '');
-        const traceDir = path_1.join(workPath, `.output`, `inputs`, 
+        const outputPath = path_1.join(workPath, '.output');
+        const traceDir = path_1.join(outputPath, `inputs`, 
         // Legacy Runtimes can only provide API Routes, so that's
         // why we can use this prefix for all of them. Here, we have to
         // make sure to not use a cryptic hash name, because people
         // need to be able to easily inspect the output.
         `api-routes-${pluginName}`);
         await fs_extra_1.default.ensureDir(traceDir);
-        let newPathsRuntime = new Set();
-        const entryDir = path_1.join('.output', 'server', 'pages');
-        const entryRoot = path_1.join(workPath, entryDir);
+        const entryRoot = path_1.join(outputPath, 'server', 'pages');
         for (const entrypoint of Object.keys(entrypoints)) {
             const { output } = await buildRuntime({
                 files: sourceFilesPreBuild,
@@ -93,13 +92,6 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
                     skipDownload: 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);
             // @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
@@ -113,6 +105,7 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
             }
             let handlerFileBase = output.handler;
             let handlerFile = lambdaFiles[handlerFileBase];
+            let handlerHasImport = false;
             const { handler } = output;
             const handlerMethod = handler.split('.').pop();
             const handlerFileName = handler.replace(`.${handlerMethod}`, '');
@@ -124,6 +117,7 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
             if (!handlerFile) {
                 handlerFileBase = handlerFileName + ext;
                 handlerFile = lambdaFiles[handlerFileBase];
+                handlerHasImport = true;
             }
             if (!handlerFile || !handlerFile.fsPath) {
                 throw new Error(`Could not find a handler file. Please ensure that \`files\` for the returned \`Lambda\` contains an \`FileFsRef\` named "${handlerFileBase}" with a valid \`fsPath\`.`);
@@ -132,58 +126,69 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
             const entryBase = path_1.basename(entrypoint).replace(ext, handlerExtName);
             const entryPath = path_1.join(path_1.dirname(entrypoint), entryBase);
             const entry = path_1.join(entryRoot, entryPath);
-            // We never want to link here, only copy, because the launcher
-            // file often has the same name for every entrypoint, which means that
-            // every build for every entrypoint overwrites the launcher of the previous
-            // one, so linking would end with a broken reference.
+            // Create the parent directory of the API Route that will be created
+            // for the current entrypoint inside of `.output/server/pages/api`.
             await fs_extra_1.default.ensureDir(path_1.dirname(entry));
-            await fs_extra_1.default.copy(handlerFile.fsPath, entry);
-            const newFilesEntrypoint = [];
-            const newDirectoriesEntrypoint = [];
-            const preBuildFiles = Object.values(sourceFilesPreBuild).map(file => {
-                return file.fsPath;
-            });
-            // Generate a list of directories and files that weren't present
-            // before the entrypoint was processed by the Legacy Runtime, so
-            // that we can perform a cleanup later. We need to divide into files
-            // and directories because only cleaning up files might leave empty
-            // directories, and listing directories separately also speeds up the
-            // build because we can just delete them, which wipes all of their nested
-            // paths, instead of iterating through all files that should be deleted.
-            for (const file in sourceFilesAfterBuild) {
-                if (!sourceFilesPreBuild[file]) {
-                    const path = sourceFilesAfterBuild[file].fsPath;
-                    const dirPath = path_1.dirname(path);
-                    // If none of the files that were present before the entrypoint
-                    // was processed are contained within the directory we're looking
-                    // at right now, then we know it's a newly added directory
-                    // and it can therefore be removed later on.
-                    const isNewDir = !preBuildFiles.some(filePath => {
-                        return path_1.dirname(filePath).startsWith(dirPath);
-                    });
-                    // Check out the list of tracked directories that were
-                    // newly added and see if one of them contains the path
-                    // we're looking at.
-                    const hasParentDir = newDirectoriesEntrypoint.some(dir => {
-                        return path.startsWith(dir);
+            // For compiled languages, the launcher file will be binary and therefore
+            // won't try to import a user-provided request handler (instead, it will
+            // contain it). But for interpreted languages, the launcher might try to
+            // load a user-provided request handler from the source file instead of bundling
+            // it, so we have to adjust the import statement inside the launcher to point
+            // to the respective source file. Previously, Legacy Runtimes simply expected
+            // the user-provided request-handler to be copied right next to the launcher,
+            // but with the new File System API, files won't be moved around unnecessarily.
+            if (handlerHasImport) {
+                const { fsPath } = handlerFile;
+                const encoding = 'utf-8';
+                // This is the true directory of the user-provided request handler in the
+                // source files, so that's what we will use as an import path in the launcher.
+                const locationPrefix = path_1.relative(entry, outputPath);
+                let handlerContent = await fs_extra_1.default.readFile(fsPath, encoding);
+                const importPaths = [
+                    // This is the full entrypoint path, like `./api/test.py`. In our tests
+                    // Python didn't support importing from a parent directory without using different
+                    // code in the launcher that registers it as a location for modules and then changing
+                    // the importing syntax, but continuing to import it like before seems to work. If
+                    // other languages need this, we should consider excluding Python explicitly.
+                    // `./${entrypoint}`,
+                    // This is the entrypoint path without extension, like `api/test`
+                    entrypoint.slice(0, -ext.length),
+                ];
+                // Generate a list of regular expressions that we can use for
+                // finding matches, but only allow matches if the import path is
+                // wrapped inside single (') or double quotes (").
+                const patterns = importPaths.map(path => {
+                    // eslint-disable-next-line no-useless-escape
+                    return new RegExp(`('|")(${path.replace(/\./g, '\\.')})('|")`, 'g');
+                });
+                let replacedMatch = null;
+                for (const pattern of patterns) {
+                    const newContent = handlerContent.replace(pattern, (_, p1, p2, p3) => {
+                        return `${p1}${path_1.join(locationPrefix, p2)}${p3}`;
                     });
-                    // If we have already tracked a directory that was newly
-                    // added that sits above the file or directory that we're
-                    // looking at, we don't need to add more entries to the list
-                    // because when the parent will get removed in the future,
-                    // all of its children (and therefore the path we're looking at)
-                    // will automatically get removed anyways.
-                    if (hasParentDir) {
-                        continue;
-                    }
-                    if (isNewDir) {
-                        newDirectoriesEntrypoint.push(dirPath);
-                    }
-                    else {
-                        newFilesEntrypoint.push(path);
+                    if (newContent !== handlerContent) {
+                        _1.debug(`Replaced "${pattern}" inside "${entry}" to ensure correct import of user-provided request handler`);
+                        handlerContent = newContent;
+                        replacedMatch = true;
                     }
                 }
+                if (!replacedMatch) {
+                    new Error(`No replacable matches for "${importPaths[0]}" or "${importPaths[1]}" found in "${fsPath}"`);
+                }
+                await fs_extra_1.default.writeFile(entry, handlerContent, encoding);
+            }
+            else {
+                await fs_extra_1.default.copy(handlerFile.fsPath, entry);
             }
+            // Legacy Runtimes based on interpreted languages will create a new launcher file
+            // for every entrypoint, but they will create each one inside `workPath`, which means that
+            // the launcher for one entrypoint will overwrite the launcher provided for the previous
+            // entrypoint. That's why, above, we copy the file contents into the new destination (and
+            // optionally transform them along the way), instead of linking. We then also want to remove
+            // the copy origin right here, so that the `workPath` doesn't contain a useless launcher file
+            // once the build has finished running.
+            await fs_extra_1.default.remove(handlerFile.fsPath);
+            _1.debug(`Removed temporary file "${handlerFile.fsPath}"`);
             const nft = `${entry}.nft.json`;
             const json = JSON.stringify({
                 version: 2,
@@ -201,16 +206,7 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
                 })
                     .filter(Boolean),
             });
-            await fs_extra_1.default.ensureDir(path_1.dirname(nft));
             await fs_extra_1.default.writeFile(nft, json);
-            // Extend the list of directories and files that were created by the
-            // Legacy Runtime with the list of directories and files that were
-            // created for the entrypoint that was just processed above.
-            newPathsRuntime = new Set([
-                ...newPathsRuntime,
-                ...newFilesEntrypoint,
-                ...newDirectoriesEntrypoint,
-            ]);
             // Add an entry that will later on be added to the `functions-manifest.json`
             // file that is placed inside of the `.output` directory.
             pages[normalize_path_1.normalizePath(entryPath)] = {
@@ -226,18 +222,6 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
                 allowQuery: output.allowQuery,
             };
         }
-        // A list of all the files that were created by the Legacy Runtime,
-        // which we'd like to remove from the File System.
-        const toRemove = Array.from(newPathsRuntime).map(path => {
-            _1.debug(`Removing ${path} as part of cleanup`);
-            return fs_extra_1.default.remove(path);
-        });
-        // Once all the entrypoints have been processed, we'd like to
-        // remove all the files from `workPath` that originally weren't present
-        // before the Legacy Runtime began running, because the `workPath`
-        // is nowadays the directory in which the user keeps their source code, since
-        // we're no longer running separate parallel builds for every Legacy Runtime.
-        await Promise.all(toRemove);
         // Add any Serverless Functions that were exposed by the Legacy Runtime
         // to the `functions-manifest.json` file provided in `.output`.
         await updateFunctionsManifest({ workPath, pages });

package/dist/index.js

@@ -32752,16 +32752,15 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
         }
         const pages = {};
         const pluginName = packageName.replace('vercel-plugin-', '');
-        const traceDir = path_1.join(workPath, `.output`, `inputs`, 
+        const outputPath = path_1.join(workPath, '.output');
+        const traceDir = path_1.join(outputPath, `inputs`, 
         // Legacy Runtimes can only provide API Routes, so that's
         // why we can use this prefix for all of them. Here, we have to
         // make sure to not use a cryptic hash name, because people
         // need to be able to easily inspect the output.
         `api-routes-${pluginName}`);
         await fs_extra_1.default.ensureDir(traceDir);
-        let newPathsRuntime = new Set();
-        const entryDir = path_1.join('.output', 'server', 'pages');
-        const entryRoot = path_1.join(workPath, entryDir);
+        const entryRoot = path_1.join(outputPath, 'server', 'pages');
         for (const entrypoint of Object.keys(entrypoints)) {
             const { output } = await buildRuntime({
                 files: sourceFilesPreBuild,
@@ -32775,13 +32774,6 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
                     skipDownload: 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);
             // @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
@@ -32795,6 +32787,7 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
             }
             let handlerFileBase = output.handler;
             let handlerFile = lambdaFiles[handlerFileBase];
+            let handlerHasImport = false;
             const { handler } = output;
             const handlerMethod = handler.split('.').pop();
             const handlerFileName = handler.replace(`.${handlerMethod}`, '');
@@ -32806,6 +32799,7 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
             if (!handlerFile) {
                 handlerFileBase = handlerFileName + ext;
                 handlerFile = lambdaFiles[handlerFileBase];
+                handlerHasImport = true;
             }
             if (!handlerFile || !handlerFile.fsPath) {
                 throw new Error(`Could not find a handler file. Please ensure that \`files\` for the returned \`Lambda\` contains an \`FileFsRef\` named "${handlerFileBase}" with a valid \`fsPath\`.`);
@@ -32814,58 +32808,69 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
             const entryBase = path_1.basename(entrypoint).replace(ext, handlerExtName);
             const entryPath = path_1.join(path_1.dirname(entrypoint), entryBase);
             const entry = path_1.join(entryRoot, entryPath);
-            // We never want to link here, only copy, because the launcher
-            // file often has the same name for every entrypoint, which means that
-            // every build for every entrypoint overwrites the launcher of the previous
-            // one, so linking would end with a broken reference.
+            // Create the parent directory of the API Route that will be created
+            // for the current entrypoint inside of `.output/server/pages/api`.
             await fs_extra_1.default.ensureDir(path_1.dirname(entry));
-            await fs_extra_1.default.copy(handlerFile.fsPath, entry);
-            const newFilesEntrypoint = [];
-            const newDirectoriesEntrypoint = [];
-            const preBuildFiles = Object.values(sourceFilesPreBuild).map(file => {
-                return file.fsPath;
-            });
-            // Generate a list of directories and files that weren't present
-            // before the entrypoint was processed by the Legacy Runtime, so
-            // that we can perform a cleanup later. We need to divide into files
-            // and directories because only cleaning up files might leave empty
-            // directories, and listing directories separately also speeds up the
-            // build because we can just delete them, which wipes all of their nested
-            // paths, instead of iterating through all files that should be deleted.
-            for (const file in sourceFilesAfterBuild) {
-                if (!sourceFilesPreBuild[file]) {
-                    const path = sourceFilesAfterBuild[file].fsPath;
-                    const dirPath = path_1.dirname(path);
-                    // If none of the files that were present before the entrypoint
-                    // was processed are contained within the directory we're looking
-                    // at right now, then we know it's a newly added directory
-                    // and it can therefore be removed later on.
-                    const isNewDir = !preBuildFiles.some(filePath => {
-                        return path_1.dirname(filePath).startsWith(dirPath);
-                    });
-                    // Check out the list of tracked directories that were
-                    // newly added and see if one of them contains the path
-                    // we're looking at.
-                    const hasParentDir = newDirectoriesEntrypoint.some(dir => {
-                        return path.startsWith(dir);
+            // For compiled languages, the launcher file will be binary and therefore
+            // won't try to import a user-provided request handler (instead, it will
+            // contain it). But for interpreted languages, the launcher might try to
+            // load a user-provided request handler from the source file instead of bundling
+            // it, so we have to adjust the import statement inside the launcher to point
+            // to the respective source file. Previously, Legacy Runtimes simply expected
+            // the user-provided request-handler to be copied right next to the launcher,
+            // but with the new File System API, files won't be moved around unnecessarily.
+            if (handlerHasImport) {
+                const { fsPath } = handlerFile;
+                const encoding = 'utf-8';
+                // This is the true directory of the user-provided request handler in the
+                // source files, so that's what we will use as an import path in the launcher.
+                const locationPrefix = path_1.relative(entry, outputPath);
+                let handlerContent = await fs_extra_1.default.readFile(fsPath, encoding);
+                const importPaths = [
+                    // This is the full entrypoint path, like `./api/test.py`. In our tests
+                    // Python didn't support importing from a parent directory without using different
+                    // code in the launcher that registers it as a location for modules and then changing
+                    // the importing syntax, but continuing to import it like before seems to work. If
+                    // other languages need this, we should consider excluding Python explicitly.
+                    // `./${entrypoint}`,
+                    // This is the entrypoint path without extension, like `api/test`
+                    entrypoint.slice(0, -ext.length),
+                ];
+                // Generate a list of regular expressions that we can use for
+                // finding matches, but only allow matches if the import path is
+                // wrapped inside single (') or double quotes (").
+                const patterns = importPaths.map(path => {
+                    // eslint-disable-next-line no-useless-escape
+                    return new RegExp(`('|")(${path.replace(/\./g, '\\.')})('|")`, 'g');
+                });
+                let replacedMatch = null;
+                for (const pattern of patterns) {
+                    const newContent = handlerContent.replace(pattern, (_, p1, p2, p3) => {
+                        return `${p1}${path_1.join(locationPrefix, p2)}${p3}`;
                     });
-                    // If we have already tracked a directory that was newly
-                    // added that sits above the file or directory that we're
-                    // looking at, we don't need to add more entries to the list
-                    // because when the parent will get removed in the future,
-                    // all of its children (and therefore the path we're looking at)
-                    // will automatically get removed anyways.
-                    if (hasParentDir) {
-                        continue;
-                    }
-                    if (isNewDir) {
-                        newDirectoriesEntrypoint.push(dirPath);
-                    }
-                    else {
-                        newFilesEntrypoint.push(path);
+                    if (newContent !== handlerContent) {
+                        _1.debug(`Replaced "${pattern}" inside "${entry}" to ensure correct import of user-provided request handler`);
+                        handlerContent = newContent;
+                        replacedMatch = true;
                     }
                 }
+                if (!replacedMatch) {
+                    new Error(`No replacable matches for "${importPaths[0]}" or "${importPaths[1]}" found in "${fsPath}"`);
+                }
+                await fs_extra_1.default.writeFile(entry, handlerContent, encoding);
+            }
+            else {
+                await fs_extra_1.default.copy(handlerFile.fsPath, entry);
             }
+            // Legacy Runtimes based on interpreted languages will create a new launcher file
+            // for every entrypoint, but they will create each one inside `workPath`, which means that
+            // the launcher for one entrypoint will overwrite the launcher provided for the previous
+            // entrypoint. That's why, above, we copy the file contents into the new destination (and
+            // optionally transform them along the way), instead of linking. We then also want to remove
+            // the copy origin right here, so that the `workPath` doesn't contain a useless launcher file
+            // once the build has finished running.
+            await fs_extra_1.default.remove(handlerFile.fsPath);
+            _1.debug(`Removed temporary file "${handlerFile.fsPath}"`);
             const nft = `${entry}.nft.json`;
             const json = JSON.stringify({
                 version: 2,
@@ -32883,16 +32888,7 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
                 })
                     .filter(Boolean),
             });
-            await fs_extra_1.default.ensureDir(path_1.dirname(nft));
             await fs_extra_1.default.writeFile(nft, json);
-            // Extend the list of directories and files that were created by the
-            // Legacy Runtime with the list of directories and files that were
-            // created for the entrypoint that was just processed above.
-            newPathsRuntime = new Set([
-                ...newPathsRuntime,
-                ...newFilesEntrypoint,
-                ...newDirectoriesEntrypoint,
-            ]);
             // Add an entry that will later on be added to the `functions-manifest.json`
             // file that is placed inside of the `.output` directory.
             pages[normalize_path_1.normalizePath(entryPath)] = {
@@ -32908,18 +32904,6 @@ function convertRuntimeToPlugin(buildRuntime, packageName, ext) {
                 allowQuery: output.allowQuery,
             };
         }
-        // A list of all the files that were created by the Legacy Runtime,
-        // which we'd like to remove from the File System.
-        const toRemove = Array.from(newPathsRuntime).map(path => {
-            _1.debug(`Removing ${path} as part of cleanup`);
-            return fs_extra_1.default.remove(path);
-        });
-        // Once all the entrypoints have been processed, we'd like to
-        // remove all the files from `workPath` that originally weren't present
-        // before the Legacy Runtime began running, because the `workPath`
-        // is nowadays the directory in which the user keeps their source code, since
-        // we're no longer running separate parallel builds for every Legacy Runtime.
-        await Promise.all(toRemove);
         // Add any Serverless Functions that were exposed by the Legacy Runtime
         // to the `functions-manifest.json` file provided in `.output`.
         await updateFunctionsManifest({ workPath, pages });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/build-utils",
-  "version": "2.12.3-canary.39",
+  "version": "2.12.3-canary.42",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.js",
@@ -49,5 +49,5 @@
     "typescript": "4.3.4",
     "yazl": "2.4.3"
   },
-  "gitHead": "2c86ac654ccde97426127fd0a6ffd04253227c50"
+  "gitHead": "d3ef240f6e01fff3d11d0499c9aaf892968748e3"
 }