@netlify/build 35.12.0 → 35.13.0

package/lib/core/constants.d.ts

@@ -48,7 +48,7 @@ export interface NetlifyPluginConstants {
     EDGE_FUNCTIONS_SRC?: string;
     /**
      * the directory where database migration source files live.
-     * `undefined` if no `netlify/db/migrations` directory exists and if not specified by the user.
+     * `undefined` if no `netlify/database/migrations` directory exists and if not specified by the user.
      */
     DB_MIGRATIONS_SRC?: string;
     /**
@@ -100,7 +100,7 @@ export declare const getConstants: ({ configPath, buildDir, packagePath, functio
     token: any;
     mode: any;
 }) => Promise<NetlifyPluginConstants>;
-export declare const addMutableConstants: ({ constants, buildDir, netlifyConfig: { build: { publish, edge_functions: edgeFunctions }, functionsDirectory, db, }, }: {
+export declare const addMutableConstants: ({ constants, buildDir, netlifyConfig: { build: { publish, edge_functions: edgeFunctions }, functionsDirectory, database, }, }: {
     constants: any;
     buildDir: any;
     netlifyConfig: {
@@ -109,7 +109,7 @@ export declare const addMutableConstants: ({ constants, buildDir, netlifyConfig:
             edge_functions: any;
         };
         functionsDirectory: any;
-        db: any;
+        database: any;
     };
 }) => Promise<{
     [k: string]: string | boolean | undefined;

package/lib/core/constants.js

@@ -52,7 +52,7 @@ const DB_MIGRATIONS_DIST = '.netlify/internal/db/migrations';
 // Retrieve constants which might change during the build if a plugin modifies
 // `netlifyConfig` or creates some default directories.
 // Unlike readonly constants, this is called again before each build step.
-export const addMutableConstants = async function ({ constants, buildDir, netlifyConfig: { build: { publish, edge_functions: edgeFunctions }, functionsDirectory, db, }, }) {
+export const addMutableConstants = async function ({ constants, buildDir, netlifyConfig: { build: { publish, edge_functions: edgeFunctions }, functionsDirectory, database, }, }) {
     const constantsA = {
         ...constants,
         // Directory that contains the deploy-ready HTML files and assets generated by the build
@@ -62,7 +62,7 @@ export const addMutableConstants = async function ({ constants, buildDir, netlif
         // The directory where Edge Functions source code lives
         EDGE_FUNCTIONS_SRC: edgeFunctions,
         // The directory where database migration source files live
-        DB_MIGRATIONS_SRC: db?.migrations?.path,
+        DB_MIGRATIONS_SRC: database?.migrations?.path,
     };
     const constantsB = await addDefaultConstants(constantsA, buildDir);
     const constantsC = normalizeConstantsPaths(constantsB, buildDir);
@@ -84,7 +84,7 @@ const DEFAULT_PATHS = [
     { constantName: 'FUNCTIONS_SRC', defaultPath: 'netlify-automatic-functions' },
     { constantName: 'FUNCTIONS_SRC', defaultPath: 'netlify/functions' },
     { constantName: 'EDGE_FUNCTIONS_SRC', defaultPath: 'netlify/edge-functions' },
-    { constantName: 'DB_MIGRATIONS_SRC', defaultPath: 'netlify/db/migrations' },
+    { constantName: 'DB_MIGRATIONS_SRC', defaultPath: 'netlify/database/migrations' },
 ];
 const addDefaultConstant = async function ({ constants, constantName, defaultPath, buildDir }) {
     // Configuration paths are relative to the build directory.

package/lib/plugins_core/db_setup/index.js

@@ -1,8 +1,10 @@
 import { join } from 'node:path';
 import { logDbProvisioning, logDbMigrations } from '../../log/messages/core_steps.js';
 import { getPackageJson } from '../../utils/package.js';
-import { readMigrationEntries, getMigrationNames } from './utils.js';
-const NPM_PACKAGE_NAME = '@netlify/db';
+import { readMigrationEntries, getMigrationNames, getMigrationsSrc } from './utils.js';
+const NPM_PACKAGE_NAME = '@netlify/database';
+// TODO: Remove once we stop supporting the legacy `@netlify/db` package name.
+const NPM_PACKAGE_NAME_LEGACY = '@netlify/db';
 const condition = async ({ buildDir, packagePath, featureFlags }) => {
     if (!featureFlags?.netlify_build_db_setup) {
         return false;
@@ -22,10 +24,11 @@ const condition = async ({ buildDir, packagePath, featureFlags }) => {
 const coreStep = async ({ api, branch, buildDir, constants, context, logs }) => {
     const siteId = constants.SITE_ID;
     logDbProvisioning({ logs, branch, context });
-    const entries = await readMigrationEntries(buildDir, constants.DB_MIGRATIONS_SRC);
+    const migrationsSrc = await getMigrationsSrc(buildDir, constants.DB_MIGRATIONS_SRC);
+    const entries = await readMigrationEntries(buildDir, migrationsSrc);
     const migrationNames = getMigrationNames(entries);
-    if (migrationNames.length > 0) {
-        logDbMigrations({ logs, migrations: migrationNames, srcDir: constants.DB_MIGRATIONS_SRC });
+    if (migrationNames.length > 0 && migrationsSrc) {
+        logDbMigrations({ logs, migrations: migrationNames, srcDir: migrationsSrc });
     }
     // @ts-expect-error This is an internal method for now so it isn't typed yet.
     // eslint-disable-next-line @typescript-eslint/no-unsafe-call
@@ -45,13 +48,16 @@ const coreStep = async ({ api, branch, buildDir, constants, context, logs }) =>
 };
 const hasDBPackage = (packageJSON) => {
     const { dependencies = {}, devDependencies = {} } = packageJSON;
-    return NPM_PACKAGE_NAME in dependencies || NPM_PACKAGE_NAME in devDependencies;
+    return (NPM_PACKAGE_NAME in dependencies ||
+        NPM_PACKAGE_NAME in devDependencies ||
+        NPM_PACKAGE_NAME_LEGACY in dependencies ||
+        NPM_PACKAGE_NAME_LEGACY in devDependencies);
 };
 export const dbSetup = {
     event: 'onPreBuild',
     coreStep,
     coreStepId: 'db_provision',
-    coreStepName: 'Netlify DB setup',
-    coreStepDescription: () => 'Netlify DB setup',
+    coreStepName: 'Netlify Database setup',
+    coreStepDescription: () => 'Netlify Database setup',
     condition,
 };

package/lib/plugins_core/db_setup/migrations.js

@@ -1,22 +1,23 @@
 import { copyFile, mkdir } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
 import { pathExists } from 'path-exists';
-import { readMigrationEntries } from './utils.js';
+import { readMigrationEntries, getMigrationsSrc } from './utils.js';
 import { validateMigrations, formatValidationErrors } from './validation.js';
 const condition = async ({ featureFlags, constants, buildDir }) => {
     if (!featureFlags?.netlify_build_db_setup) {
         return false;
     }
-    const srcDir = constants.DB_MIGRATIONS_SRC;
+    const srcDir = await getMigrationsSrc(buildDir, constants.DB_MIGRATIONS_SRC);
     if (!srcDir) {
         return false;
     }
     return pathExists(resolve(buildDir, srcDir));
 };
 const coreStep = async ({ constants, buildDir, systemLog }) => {
-    const srcDir = resolve(buildDir, constants.DB_MIGRATIONS_SRC);
+    const migrationsSrc = await getMigrationsSrc(buildDir, constants.DB_MIGRATIONS_SRC);
+    const srcDir = resolve(buildDir, migrationsSrc);
     const destDir = resolve(buildDir, constants.DB_MIGRATIONS_DIST);
-    const { dirNames, fileNames } = await readMigrationEntries(buildDir, constants.DB_MIGRATIONS_SRC);
+    const { dirNames, fileNames } = await readMigrationEntries(buildDir, migrationsSrc);
     if (dirNames.length === 0 && fileNames.length === 0) {
         systemLog('No migration directories found, skipping copy.');
         return {};
@@ -52,7 +53,7 @@ export const copyDbMigrations = {
     event: 'onBuild',
     coreStep,
     coreStepId: 'db_migrations_copy',
-    coreStepName: 'Netlify DB migrations',
+    coreStepName: 'Netlify Database migrations',
     coreStepDescription: () => 'Copy database migrations to internal directory',
     condition,
     quiet: true,

package/lib/plugins_core/db_setup/utils.d.ts

@@ -1,3 +1,13 @@
+/**
+ * Returns the effective migrations source directory for the current build.
+ *
+ * If the user has set `database.migrations.path` in their config, or the new
+ * default `netlify/database/migrations` directory exists, that value will have
+ * been populated into `constants.DB_MIGRATIONS_SRC` upstream. If not, we fall
+ * back to the legacy `netlify/db/migrations` directory for backwards
+ * compatibility.
+ */
+export declare const getMigrationsSrc: (buildDir: string, configuredSrc: string | undefined) => Promise<string | undefined>;
 export interface MigrationEntries {
     dirNames: string[];
     fileNames: string[];

package/lib/plugins_core/db_setup/utils.js

@@ -1,6 +1,27 @@
 import { readdir, stat } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
 import { pathExists } from 'path-exists';
+// TODO: Remove once we drop support for the legacy `netlify/db/migrations` directory.
+const LEGACY_DB_MIGRATIONS_SRC = 'netlify/db/migrations';
+/**
+ * Returns the effective migrations source directory for the current build.
+ *
+ * If the user has set `database.migrations.path` in their config, or the new
+ * default `netlify/database/migrations` directory exists, that value will have
+ * been populated into `constants.DB_MIGRATIONS_SRC` upstream. If not, we fall
+ * back to the legacy `netlify/db/migrations` directory for backwards
+ * compatibility.
+ */
+// TODO: Remove the legacy fallback once we drop support for `netlify/db/migrations`.
+export const getMigrationsSrc = async (buildDir, configuredSrc) => {
+    if (configuredSrc) {
+        return configuredSrc;
+    }
+    if (await pathExists(resolve(buildDir, LEGACY_DB_MIGRATIONS_SRC))) {
+        return LEGACY_DB_MIGRATIONS_SRC;
+    }
+    return undefined;
+};
 export const readMigrationEntries = async (buildDir, migrationsSrc) => {
     const empty = { dirNames: [], fileNames: [] };
     if (!migrationsSrc) {

package/lib/types/config/netlify_config.d.ts

@@ -25,11 +25,11 @@ interface NetlifyPlugin {
     package: string;
     inputs: PluginInputs;
 }
-interface DbMigrationsConfig {
+interface DatabaseMigrationsConfig {
     path?: string;
 }
-interface DbConfig {
-    migrations?: DbMigrationsConfig;
+interface DatabaseConfig {
+    migrations?: DatabaseMigrationsConfig;
 }
 interface ImagesConfig {
     remote_images: string[];
@@ -60,6 +60,6 @@ export interface NetlifyConfig {
     /**
      * object with options for database configuration
      */
-    db?: DbConfig;
+    database?: DatabaseConfig;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "35.12.0",
+  "version": "35.13.0",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/index.js",
@@ -69,7 +69,7 @@
     "@bugsnag/js": "^8.0.0",
     "@netlify/blobs": "^10.4.4",
     "@netlify/cache-utils": "^6.0.5",
-    "@netlify/config": "^24.4.4",
+    "@netlify/config": "^24.5.0",
     "@netlify/edge-bundler": "14.9.19",
     "@netlify/functions-utils": "^6.2.29",
     "@netlify/git-utils": "^6.0.4",
@@ -153,5 +153,5 @@
   "engines": {
     "node": ">=18.14.0"
   },
-  "gitHead": "85ec413dbce5342df01289953b91169c1f84c34b"
+  "gitHead": "c77982ba1d1886e81f1a517318fcf93123f2a260"
 }