@vercel/static-build 1.1.7 → 1.2.1

package/dist/utils/_shared.js

@@ -27,7 +27,7 @@ exports.readPackageJson = readPackageJson;
  * Write package.json
  */
 async function writePackageJson(workPath, packageJson) {
-    await fs_1.promises.writeFile(path_1.default.join(workPath, 'package.json'), JSON.stringify(packageJson, null, 2));
+    await fs_1.promises.writeFile(path_1.default.join(workPath, 'package.json'), `${JSON.stringify(packageJson, null, 2)}\n`);
 }
 exports.writePackageJson = writePackageJson;
 function isObjectEmpty(object) {

package/dist/utils/gatsby.js

@@ -18,155 +18,267 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.injectVercelAnalyticsPlugin = void 0;
+exports.injectPlugins = void 0;
 const fs_1 = require("fs");
 const path = __importStar(require("path"));
+const semver_1 = __importDefault(require("semver"));
+const url_1 = require("url");
 const _shared_1 = require("./_shared");
-const GATSBY_PLUGIN_PACKAGE_NAME = '@vercel/gatsby-plugin-vercel-analytics';
-const DEFAULT_CONFIG = {
-    plugins: [
-        {
-            resolve: GATSBY_PLUGIN_PACKAGE_NAME,
-            options: {},
-        },
-    ],
-};
+const { VERCEL_CLI_VERSION } = process.env;
+const PLUGINS = [
+    '@vercel/gatsby-plugin-vercel-analytics',
+    '@vercel/gatsby-plugin-vercel-builder',
+];
 const GATSBY_CONFIG_FILE = 'gatsby-config';
-async function injectVercelAnalyticsPlugin(dir) {
-    // Gatsby requires a special variable name for environment variables to be
-    // exposed to the client-side JavaScript bundles:
-    process.env.GATSBY_VERCEL_ANALYTICS_ID = process.env.VERCEL_ANALYTICS_ID;
-    const gatsbyConfigPathJs = path.join(dir, `${GATSBY_CONFIG_FILE}.js`);
-    const gatsbyConfigPathMjs = path.join(dir, `${GATSBY_CONFIG_FILE}.mjs`);
-    const gatsbyConfigPathTs = path.join(dir, `${GATSBY_CONFIG_FILE}.ts`);
-    if (await _shared_1.fileExists(gatsbyConfigPathTs)) {
-        console.log(`Injecting Gatsby.js analytics plugin "${GATSBY_PLUGIN_PACKAGE_NAME}" to \`${gatsbyConfigPathTs}\``);
-        await addGatsbyPackage(dir);
-        return updateGatsbyTsConfig(gatsbyConfigPathTs);
+const GATSBY_NODE_FILE = 'gatsby-node';
+async function injectPlugins(detectedVersion, dir) {
+    const plugins = new Set();
+    if (process.env.VERCEL_GATSBY_BUILDER_PLUGIN && detectedVersion) {
+        const version = semver_1.default.coerce(detectedVersion);
+        if (version && semver_1.default.satisfies(version, '>=4.0.0')) {
+            plugins.add('@vercel/gatsby-plugin-vercel-builder');
+        }
     }
-    if (await _shared_1.fileExists(gatsbyConfigPathMjs)) {
-        console.log(`Injecting Gatsby.js analytics plugin "${GATSBY_PLUGIN_PACKAGE_NAME}" to \`${gatsbyConfigPathMjs}\``);
-        await addGatsbyPackage(dir);
-        return updateGatsbyMjsConfig(gatsbyConfigPathMjs);
+    if (process.env.VERCEL_ANALYTICS_ID) {
+        process.env.GATSBY_VERCEL_ANALYTICS_ID = process.env.VERCEL_ANALYTICS_ID;
+        plugins.add('@vercel/gatsby-plugin-vercel-analytics');
     }
-    console.log(`Injecting Gatsby.js analytics plugin "${GATSBY_PLUGIN_PACKAGE_NAME}" to \`${gatsbyConfigPathJs}\``);
-    await addGatsbyPackage(dir);
-    if (await _shared_1.fileExists(gatsbyConfigPathJs)) {
-        await updateGatsbyJsConfig(gatsbyConfigPathJs);
+    if (plugins.size === 0) {
+        return false;
     }
-    else {
-        await fs_1.promises.writeFile(gatsbyConfigPathJs, `module.exports = ${JSON.stringify(DEFAULT_CONFIG)}`);
+    const ops = [addGatsbyPackage(dir, plugins)];
+    if (plugins.has('@vercel/gatsby-plugin-vercel-analytics')) {
+        ops.push(updateGatsbyConfig(dir, ['@vercel/gatsby-plugin-vercel-analytics']));
     }
+    if (plugins.has('@vercel/gatsby-plugin-vercel-builder')) {
+        ops.push(updateGatsbyNode(dir));
+    }
+    await Promise.all(ops);
+    return true;
+}
+exports.injectPlugins = injectPlugins;
+function printInjectingPlugins(plugins, configPath) {
+    const pluginsArray = Array.from(plugins);
+    let pluginsStr = 'plugin';
+    if (pluginsArray.length > 1) {
+        pluginsStr += 's';
+    }
+    console.log(`Injecting Gatsby.js ${pluginsStr} ${pluginsArray
+        .map(p => `"${p}"`)
+        .join(', ')} to \`${configPath}\``);
 }
-exports.injectVercelAnalyticsPlugin = injectVercelAnalyticsPlugin;
-async function addGatsbyPackage(dir) {
+async function addGatsbyPackage(dir, plugins) {
     const pkgJson = (await _shared_1.readPackageJson(dir));
     if (!pkgJson.dependencies) {
         pkgJson.dependencies = {};
     }
-    if (!pkgJson.dependencies[GATSBY_PLUGIN_PACKAGE_NAME]) {
-        console.log(`Adding "${GATSBY_PLUGIN_PACKAGE_NAME}" to \`package.json\` "dependencies"`);
-        pkgJson.dependencies[GATSBY_PLUGIN_PACKAGE_NAME] = 'latest';
-        await _shared_1.writePackageJson(dir, pkgJson);
+    for (const plugin of plugins) {
+        if (!pkgJson.dependencies[plugin]) {
+            console.log(`Adding "${plugin}" to \`package.json\` "dependencies"`);
+            let version = 'latest';
+            // Use the tarball URL for E2E tests
+            if (VERCEL_CLI_VERSION?.startsWith('https://')) {
+                version = new url_1.URL(`./${plugin}.tgz`, VERCEL_CLI_VERSION).href;
+            }
+            pkgJson.dependencies[plugin] = version;
+        }
+    }
+    await _shared_1.writePackageJson(dir, pkgJson);
+}
+async function updateGatsbyConfig(dir, plugins) {
+    const gatsbyConfigPathTs = path.join(dir, `${GATSBY_CONFIG_FILE}.ts`);
+    const gatsbyConfigPathMjs = path.join(dir, `${GATSBY_CONFIG_FILE}.mjs`);
+    const gatsbyConfigPathJs = path.join(dir, `${GATSBY_CONFIG_FILE}.js`);
+    if (await _shared_1.fileExists(gatsbyConfigPathTs)) {
+        printInjectingPlugins(plugins, gatsbyConfigPathTs);
+        await updateGatsbyConfigTs(gatsbyConfigPathTs, plugins);
+    }
+    else if (await _shared_1.fileExists(gatsbyConfigPathMjs)) {
+        printInjectingPlugins(plugins, gatsbyConfigPathMjs);
+        await updateGatsbyConfigMjs(gatsbyConfigPathMjs, plugins);
+    }
+    else {
+        printInjectingPlugins(plugins, gatsbyConfigPathJs);
+        if (await _shared_1.fileExists(gatsbyConfigPathJs)) {
+            await updateGatsbyConfigJs(gatsbyConfigPathJs, plugins);
+        }
+        else {
+            await fs_1.promises.writeFile(gatsbyConfigPathJs, `module.exports = ${JSON.stringify({
+                plugins: Array.from(plugins),
+            })}`);
+        }
     }
 }
-async function updateGatsbyTsConfig(configPath) {
-    await fs_1.promises.rename(configPath, configPath + '.__vercel_builder_backup__.ts');
+async function updateGatsbyConfigTs(configPath, plugins) {
+    const renamedPath = `${configPath}.__vercel_builder_backup__.ts`;
+    if (!(await _shared_1.fileExists(renamedPath))) {
+        await fs_1.promises.rename(configPath, renamedPath);
+    }
     await fs_1.promises.writeFile(configPath, `import userConfig from "./gatsby-config.ts.__vercel_builder_backup__.ts";
 import type { PluginRef } from "gatsby";
 
-// https://github.com/gatsbyjs/gatsby/blob/354003fb2908e02ff12109ca3a02978a5a6e608c/packages/gatsby/src/bootstrap/prefer-default.ts
 const preferDefault = (m: any) => (m && m.default) || m;
 
 const vercelConfig = Object.assign(
   {},
-
-  // https://github.com/gatsbyjs/gatsby/blob/a6ecfb2b01d761e8a3612b8ea132c698659923d9/packages/gatsby/src/services/initialize.ts#L113-L117
   preferDefault(userConfig)
 );
+
 if (!vercelConfig.plugins) {
   vercelConfig.plugins = [];
 }
 
-const hasPlugin = vercelConfig.plugins.find(
-  (p: PluginRef) =>
-    p && (p === "${GATSBY_PLUGIN_PACKAGE_NAME}" || p.resolve === "${GATSBY_PLUGIN_PACKAGE_NAME}")
-);
+for (const plugin of ${JSON.stringify(Array.from(plugins))}) {
+  const hasPlugin = vercelConfig.plugins.find(
+    (p: PluginRef) =>
+      p && (p === plugin || p.resolve === plugin)
+  );
 
-if (!hasPlugin) {
-  vercelConfig.plugins = vercelConfig.plugins.slice();
-  vercelConfig.plugins.push({
-    resolve: "${GATSBY_PLUGIN_PACKAGE_NAME}",
-    options: {},
-  });
+  if (!hasPlugin) {
+    vercelConfig.plugins = vercelConfig.plugins.slice();
+    vercelConfig.plugins.push(plugin);
+  }
 }
 
 export default vercelConfig;
 `);
 }
-async function updateGatsbyMjsConfig(configPath) {
-    await fs_1.promises.rename(configPath, configPath + '.__vercel_builder_backup__.mjs');
+async function updateGatsbyConfigMjs(configPath, plugins) {
+    const renamedPath = `${configPath}.__vercel_builder_backup__.mjs`;
+    if (!(await _shared_1.fileExists(renamedPath))) {
+        await fs_1.promises.rename(configPath, renamedPath);
+    }
     await fs_1.promises.writeFile(configPath, `import userConfig from "./gatsby-config.mjs.__vercel_builder_backup__.mjs";
 
-// https://github.com/gatsbyjs/gatsby/blob/354003fb2908e02ff12109ca3a02978a5a6e608c/packages/gatsby/src/bootstrap/prefer-default.ts
 const preferDefault = (m) => (m && m.default) || m;
 
 const vercelConfig = Object.assign(
   {},
-
-  // https://github.com/gatsbyjs/gatsby/blob/a6ecfb2b01d761e8a3612b8ea132c698659923d9/packages/gatsby/src/services/initialize.ts#L113-L117
   preferDefault(userConfig)
 );
 if (!vercelConfig.plugins) {
   vercelConfig.plugins = [];
 }
 
-const hasPlugin = vercelConfig.plugins.find(
-  (p) =>
-    p && (p === "${GATSBY_PLUGIN_PACKAGE_NAME}" || p.resolve === "${GATSBY_PLUGIN_PACKAGE_NAME}")
-);
+for (const plugin of ${JSON.stringify(Array.from(plugins))}) {
+  const hasPlugin = vercelConfig.plugins.find(
+    (p) => p && (p === plugin || p.resolve === plugin)
+  );
 
-if (!hasPlugin) {
-  vercelConfig.plugins = vercelConfig.plugins.slice();
-  vercelConfig.plugins.push({
-    resolve: "${GATSBY_PLUGIN_PACKAGE_NAME}",
-    options: {},
-  });
+  if (!hasPlugin) {
+    vercelConfig.plugins = vercelConfig.plugins.slice();
+    vercelConfig.plugins.push(plugin);
+  }
 }
 
 export default vercelConfig;
 `);
 }
-async function updateGatsbyJsConfig(configPath) {
-    await fs_1.promises.rename(configPath, configPath + '.__vercel_builder_backup__.js');
+async function updateGatsbyConfigJs(configPath, plugins) {
+    const renamedPath = `${configPath}.__vercel_builder_backup__.js`;
+    if (!(await _shared_1.fileExists(renamedPath))) {
+        await fs_1.promises.rename(configPath, renamedPath);
+    }
     await fs_1.promises.writeFile(configPath, `const userConfig = require("./gatsby-config.js.__vercel_builder_backup__.js");
 
-// https://github.com/gatsbyjs/gatsby/blob/354003fb2908e02ff12109ca3a02978a5a6e608c/packages/gatsby/src/bootstrap/prefer-default.ts
 const preferDefault = m => (m && m.default) || m;
 
 const vercelConfig = Object.assign(
   {},
-
-  // https://github.com/gatsbyjs/gatsby/blob/a6ecfb2b01d761e8a3612b8ea132c698659923d9/packages/gatsby/src/services/initialize.ts#L113-L117
   preferDefault(userConfig)
 );
 if (!vercelConfig.plugins) {
   vercelConfig.plugins = [];
 }
 
-const hasPlugin = vercelConfig.plugins.find(
-  (p) =>
-    p && (p === "${GATSBY_PLUGIN_PACKAGE_NAME}" || p.resolve === "${GATSBY_PLUGIN_PACKAGE_NAME}")
-);
-if (!hasPlugin) {
-  vercelConfig.plugins = vercelConfig.plugins.slice();
-  vercelConfig.plugins.push({
-    resolve: "${GATSBY_PLUGIN_PACKAGE_NAME}",
-    options: {},
-  });
-}
+for (const plugin of ${JSON.stringify(Array.from(plugins))}) {
+  const hasPlugin = vercelConfig.plugins.find(
+    (p) => p && (p === plugin || p.resolve === plugin)
+  );
 
+  if (!hasPlugin) {
+    vercelConfig.plugins = vercelConfig.plugins.slice();
+    vercelConfig.plugins.push(plugin);
+  }
+}
 module.exports = vercelConfig;
 `);
 }
+async function updateGatsbyNode(dir) {
+    const gatsbyNodePathTs = path.join(dir, `${GATSBY_NODE_FILE}.ts`);
+    const gatsbyNodePathMjs = path.join(dir, `${GATSBY_NODE_FILE}.mjs`);
+    const gatsbyNodePathJs = path.join(dir, `${GATSBY_NODE_FILE}.js`);
+    if (await _shared_1.fileExists(gatsbyNodePathTs)) {
+        await updateGatsbyNodeTs(gatsbyNodePathTs);
+    }
+    else if (await _shared_1.fileExists(gatsbyNodePathMjs)) {
+        await updateGatsbyNodeMjs(gatsbyNodePathMjs);
+    }
+    else if (await _shared_1.fileExists(gatsbyNodePathJs)) {
+        await updateGatsbyNodeJs(gatsbyNodePathJs);
+    }
+    else {
+        await fs_1.promises.writeFile(gatsbyNodePathJs, `module.exports = require('@vercel/gatsby-plugin-vercel-builder/gatsby-node.js');`);
+    }
+}
+async function updateGatsbyNodeTs(configPath) {
+    const renamedPath = `${configPath}.__vercel_builder_backup__.ts`;
+    if (!(await _shared_1.fileExists(renamedPath))) {
+        await fs_1.promises.rename(configPath, renamedPath);
+    }
+    await fs_1.promises.writeFile(configPath, `import type { GatsbyNode } from 'gatsby';
+import * as vercelBuilder from '@vercel/gatsby-plugin-vercel-builder/gatsby-node.js';
+import * as gatsbyNode from './gatsby-node.ts.__vercel_builder_backup__.ts';
+
+export * from './gatsby-node.ts.__vercel_builder_backup__.ts';
+
+export const onPostBuild: GatsbyNode['onPostBuild'] = async (args, options) => {
+  if (typeof (gatsbyNode as any).onPostBuild === 'function') {
+    await (gatsbyNode as any).onPostBuild(args, options);
+  }
+  await vercelBuilder.onPostBuild(args, options);
+};
+`);
+}
+async function updateGatsbyNodeMjs(configPath) {
+    const renamedPath = `${configPath}.__vercel_builder_backup__.mjs`;
+    if (!(await _shared_1.fileExists(renamedPath))) {
+        await fs_1.promises.rename(configPath, renamedPath);
+    }
+    await fs_1.promises.writeFile(configPath, `import * as vercelBuilder from '@vercel/gatsby-plugin-vercel-builder/gatsby-node.js';
+import * as gatsbyNode from './gatsby-node.mjs.__vercel_builder_backup__.mjs';
+
+export * from './gatsby-node.mjs.__vercel_builder_backup__.mjs';
+
+export const onPostBuild = async (args, options) => {
+  if (typeof gatsbyNode.onPostBuild === 'function') {
+    await gatsbyNode.onPostBuild(args, options);
+  }
+  await vercelBuilder.onPostBuild(args, options);
+};
+`);
+}
+async function updateGatsbyNodeJs(configPath) {
+    const renamedPath = `${configPath}.__vercel_builder_backup__.js`;
+    if (!(await _shared_1.fileExists(renamedPath))) {
+        await fs_1.promises.rename(configPath, renamedPath);
+    }
+    await fs_1.promises.writeFile(configPath, `const vercelBuilder = require('@vercel/gatsby-plugin-vercel-builder/gatsby-node.js');
+const gatsbyNode = require('./gatsby-node.js.__vercel_builder_backup__.js');
+
+const origOnPostBuild = gatsbyNode.onPostBuild;
+
+gatsbyNode.onPostBuild = async (args, options) => {
+  if (typeof origOnPostBuild === 'function') {
+    await origOnPostBuild(args, options);
+  }
+  await vercelBuilder.onPostBuild(args, options);
+};
+
+module.exports = gatsbyNode;
+`);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/static-build",
-  "version": "1.1.7",
+  "version": "1.2.1",
   "license": "MIT",
   "main": "./dist/index",
   "homepage": "https://vercel.com/docs/build-step",
@@ -15,7 +15,7 @@
   "scripts": {
     "build": "node build",
     "test": "jest --env node --verbose --bail --runInBand",
-    "test-unit": "pnpm test test/build.test.ts test/prepare-cache.test.ts",
+    "test-unit": "pnpm test test/build.test.ts test/gatsby.test.js test/prepare-cache.test.ts",
     "test-integration-once": "pnpm test test/integration-*.test.js"
   },
   "jest": {
@@ -37,8 +37,12 @@
     "@types/node": "14.18.33",
     "@types/node-fetch": "2.5.4",
     "@types/promise-timeout": "1.3.0",
-    "@vercel/build-utils": "5.9.0",
-    "@vercel/frameworks": "1.2.4",
+    "@types/semver": "7.3.13",
+    "@vercel/build-utils": "6.0.0",
+    "@vercel/frameworks": "1.3.0",
+    "@vercel/fs-detectors": "3.7.6",
+    "@vercel/gatsby-plugin-vercel-analytics": "1.0.7",
+    "@vercel/gatsby-plugin-vercel-builder": "1.0.1",
     "@vercel/ncc": "0.24.0",
     "@vercel/routing-utils": "2.1.8",
     "@vercel/static-config": "2.0.11",
@@ -49,9 +53,10 @@
     "ms": "2.1.2",
     "node-fetch": "2.6.7",
     "rc9": "1.2.0",
+    "semver": "7.3.8",
     "tree-kill": "1.2.2",
     "ts-morph": "12.0.0",
     "typescript": "4.3.4"
   },
-  "gitHead": "4ccdcde463560dc44da89edf52523419fc56ab62"
+  "gitHead": "25f6595d3698546ba69c7fe9f601a906167fef3f"
 }