@netlify/build 35.6.2 → 35.7.0

package/lib/core/constants.d.ts

@@ -37,11 +37,20 @@ export interface NetlifyPluginConstants {
      * the directory where built Edge Functions are placed before deployment. Its value is always defined, but the target might not have been created yet.
      */
     EDGE_FUNCTIONS_DIST: string;
+    /**
+     * the directory where database migrations are placed before deployment.
+     */
+    DB_MIGRATIONS_DIST?: string;
     /**
      * the directory where Edge Functions source code lives.
      * `undefined` if no `netlify/edge-functions` directory exists.
      */
     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.
+     */
+    DB_MIGRATIONS_SRC?: string;
     /**
      * boolean indicating whether the build was [run locally](https://docs.netlify.com/cli/get-started/#run-builds-locally) or on Netlify
      */
@@ -91,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, }, }: {
+export declare const addMutableConstants: ({ constants, buildDir, netlifyConfig: { build: { publish, edge_functions: edgeFunctions }, functionsDirectory, db, }, }: {
     constants: any;
     buildDir: any;
     netlifyConfig: {
@@ -100,6 +109,7 @@ export declare const addMutableConstants: ({ constants, buildDir, netlifyConfig:
             edge_functions: any;
         };
         functionsDirectory: any;
+        db: any;
     };
 }) => Promise<{
     [k: string]: string | boolean | undefined;

package/lib/core/constants.js

@@ -41,15 +41,18 @@ export const getConstants = async function ({ configPath, buildDir, packagePath,
         // The directory where internal Edge Functions (i.e. generated programmatically
         // via plugins or others) live
         INTERNAL_EDGE_FUNCTIONS_SRC: join(buildDir, packagePath || '', INTERNAL_EDGE_FUNCTIONS_SRC),
+        // The directory where database migrations are placed before deployment
+        DB_MIGRATIONS_DIST: join(buildDir, packagePath || '', DB_MIGRATIONS_DIST),
     };
     return (await addMutableConstants({ constants, buildDir, netlifyConfig }));
 };
 const INTERNAL_EDGE_FUNCTIONS_SRC = '.netlify/edge-functions';
 const INTERNAL_FUNCTIONS_SRC = '.netlify/functions-internal';
+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, }, }) {
+export const addMutableConstants = async function ({ constants, buildDir, netlifyConfig: { build: { publish, edge_functions: edgeFunctions }, functionsDirectory, db, }, }) {
     const constantsA = {
         ...constants,
         // Directory that contains the deploy-ready HTML files and assets generated by the build
@@ -58,6 +61,8 @@ export const addMutableConstants = async function ({ constants, buildDir, netlif
         FUNCTIONS_SRC: functionsDirectory,
         // 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,
     };
     const constantsB = await addDefaultConstants(constantsA, buildDir);
     const constantsC = normalizeConstantsPaths(constantsB, buildDir);
@@ -79,6 +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' },
 ];
 const addDefaultConstant = async function ({ constants, constantName, defaultPath, buildDir }) {
     // Configuration paths are relative to the build directory.
@@ -118,7 +124,9 @@ const CONSTANT_PATHS = new Set([
     'FUNCTIONS_DIST',
     'INTERNAL_EDGE_FUNCTIONS_SRC',
     'INTERNAL_FUNCTIONS_SRC',
+    'DB_MIGRATIONS_DIST',
     'EDGE_FUNCTIONS_DIST',
     'EDGE_FUNCTIONS_SRC',
+    'DB_MIGRATIONS_SRC',
     'CACHE_DIR',
 ]);

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

@@ -0,0 +1,2 @@
+import { CoreStep } from '../types.js';
+export declare const copyDbMigrations: CoreStep;

package/lib/plugins_core/db_setup/migrations.js

@@ -0,0 +1,57 @@
+import { copyFile, mkdir, readdir, stat } from 'node:fs/promises';
+import { join, resolve } from 'node:path';
+import { pathExists } from 'path-exists';
+import { validateMigrationDirs, formatValidationErrors } from './validation.js';
+const condition = async ({ featureFlags, constants, buildDir }) => {
+    if (!featureFlags?.netlify_build_db_setup) {
+        return false;
+    }
+    const srcDir = 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 destDir = resolve(buildDir, constants.DB_MIGRATIONS_DIST);
+    const entries = await readdir(srcDir);
+    const dirNames = [];
+    for (const entry of entries) {
+        const entryStat = await stat(join(srcDir, entry));
+        if (entryStat.isDirectory()) {
+            dirNames.push(entry);
+        }
+    }
+    if (dirNames.length === 0) {
+        systemLog('No migration directories found, skipping copy.');
+        return {};
+    }
+    const existingSqlFiles = new Set();
+    for (const dirName of dirNames) {
+        const sqlPath = join(srcDir, dirName, 'migration.sql');
+        if (await pathExists(sqlPath)) {
+            existingSqlFiles.add(dirName);
+        }
+    }
+    const result = validateMigrationDirs(dirNames, existingSqlFiles);
+    if (!result.valid) {
+        const message = formatValidationErrors(result.errors);
+        throw new Error(message);
+    }
+    for (const dirName of result.dirs) {
+        const migrationDestDir = join(destDir, dirName);
+        await mkdir(migrationDestDir, { recursive: true });
+        await copyFile(join(srcDir, dirName, 'migration.sql'), join(migrationDestDir, 'migration.sql'));
+    }
+    systemLog(`Copied ${String(result.dirs.length)} migration(s) to ${destDir}`);
+    return {};
+};
+export const copyDbMigrations = {
+    event: 'onBuild',
+    coreStep,
+    coreStepId: 'db_migrations_copy',
+    coreStepName: 'Netlify DB migrations',
+    coreStepDescription: () => 'Copy database migrations to internal directory',
+    condition,
+};

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

@@ -0,0 +1,16 @@
+export declare const MIGRATION_DIR_PATTERN: RegExp;
+interface ValidationError {
+    type: 'invalid_dir_name' | 'missing_sql_file';
+    dirName: string;
+}
+interface ValidationResult {
+    valid: true;
+    dirs: string[];
+}
+interface ValidationFailure {
+    valid: false;
+    errors: ValidationError[];
+}
+export declare const validateMigrationDirs: (dirNames: string[], existingSqlFiles: Set<string>) => ValidationResult | ValidationFailure;
+export declare const formatValidationErrors: (errors: ValidationError[]) => string;
+export {};

package/lib/plugins_core/db_setup/validation.js

@@ -0,0 +1,31 @@
+export const MIGRATION_DIR_PATTERN = /^\d{10}_[a-z0-9-]+$/;
+export const validateMigrationDirs = (dirNames, existingSqlFiles) => {
+    const errors = [];
+    for (const dirName of dirNames) {
+        if (!MIGRATION_DIR_PATTERN.test(dirName)) {
+            errors.push({ type: 'invalid_dir_name', dirName });
+            continue;
+        }
+        if (!existingSqlFiles.has(dirName)) {
+            errors.push({ type: 'missing_sql_file', dirName });
+        }
+    }
+    if (errors.length > 0) {
+        return { valid: false, errors };
+    }
+    const sorted = [...dirNames].sort();
+    return { valid: true, dirs: sorted };
+};
+export const formatValidationErrors = (errors) => {
+    const lines = errors.map((error) => {
+        if (error.type === 'invalid_dir_name') {
+            return `  - "${error.dirName}" does not match the required pattern "<Unix-timestamp>_<slug>" (e.g. "1700000000_create-users"). Slugs must be lowercase alphanumeric with hyphens.`;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+        if (error.type === 'missing_sql_file') {
+            return `  - "${error.dirName}/migration.sql" is missing.`;
+        }
+        return `  - "${error.dirName}": unknown validation error.`;
+    });
+    return `Database migration validation failed:\n${lines.join('\n')}`;
+};

package/lib/plugins_core/db_setup/validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/plugins_core/db_setup/validation.test.js

@@ -0,0 +1,98 @@
+import { describe, expect, test } from 'vitest';
+import { MIGRATION_DIR_PATTERN, validateMigrationDirs, formatValidationErrors } from './validation.js';
+describe('MIGRATION_DIR_PATTERN', () => {
+    const validNames = [
+        '1700000000_create-users',
+        '1700000001_add-posts',
+        '0000000000_init',
+        '9999999999_z',
+        '1700000000_a',
+        '1700000000_abc-def-123',
+    ];
+    test.each(validNames)('matches valid name: %s', (name) => {
+        expect(MIGRATION_DIR_PATTERN.test(name)).toBe(true);
+    });
+    const invalidNames = [
+        { name: '170000000_short-ts', reason: '9-digit timestamp' },
+        { name: '17000000000_long-ts', reason: '11-digit timestamp' },
+        { name: '1700000000_CAPS', reason: 'uppercase letters' },
+        { name: '1700000000_under_score', reason: 'underscores in slug' },
+        { name: 'no-timestamp', reason: 'no timestamp prefix' },
+        { name: '1700000000_', reason: 'empty slug' },
+        { name: '1700000000', reason: 'missing underscore and slug' },
+        { name: '_create-users', reason: 'missing timestamp' },
+        { name: '1700000000_hello world', reason: 'spaces in slug' },
+        { name: '1700000000_special!char', reason: 'special characters in slug' },
+    ];
+    test.each(invalidNames)('rejects invalid name: $name ($reason)', ({ name }) => {
+        expect(MIGRATION_DIR_PATTERN.test(name)).toBe(false);
+    });
+});
+describe('validateMigrationDirs', () => {
+    test('returns valid result with sorted dirs when all dirs are valid', () => {
+        const dirNames = ['1700000001_add-posts', '1700000000_create-users'];
+        const existingSqlFiles = new Set(['1700000000_create-users', '1700000001_add-posts']);
+        const result = validateMigrationDirs(dirNames, existingSqlFiles);
+        expect(result.valid).toBe(true);
+        if (result.valid) {
+            expect(result.dirs).toEqual(['1700000000_create-users', '1700000001_add-posts']);
+        }
+    });
+    test('returns error for invalid directory names', () => {
+        const dirNames = ['bad-name', '1700000000_create-users'];
+        const existingSqlFiles = new Set(['1700000000_create-users']);
+        const result = validateMigrationDirs(dirNames, existingSqlFiles);
+        expect(result.valid).toBe(false);
+        if (!result.valid) {
+            expect(result.errors).toEqual([{ type: 'invalid_dir_name', dirName: 'bad-name' }]);
+        }
+    });
+    test('returns error for missing migration.sql files', () => {
+        const dirNames = ['1700000000_create-users', '1700000001_add-posts'];
+        const existingSqlFiles = new Set(['1700000000_create-users']);
+        const result = validateMigrationDirs(dirNames, existingSqlFiles);
+        expect(result.valid).toBe(false);
+        if (!result.valid) {
+            expect(result.errors).toEqual([{ type: 'missing_sql_file', dirName: '1700000001_add-posts' }]);
+        }
+    });
+    test('reports both invalid names and missing files', () => {
+        const dirNames = ['bad-name', '1700000001_add-posts'];
+        const existingSqlFiles = new Set();
+        const result = validateMigrationDirs(dirNames, existingSqlFiles);
+        expect(result.valid).toBe(false);
+        if (!result.valid) {
+            expect(result.errors).toHaveLength(2);
+            expect(result.errors[0]).toEqual({ type: 'invalid_dir_name', dirName: 'bad-name' });
+            expect(result.errors[1]).toEqual({ type: 'missing_sql_file', dirName: '1700000001_add-posts' });
+        }
+    });
+    test('returns valid result for empty input', () => {
+        const result = validateMigrationDirs([], new Set());
+        expect(result.valid).toBe(true);
+        if (result.valid) {
+            expect(result.dirs).toEqual([]);
+        }
+    });
+});
+describe('formatValidationErrors', () => {
+    test('formats invalid_dir_name errors', () => {
+        const message = formatValidationErrors([{ type: 'invalid_dir_name', dirName: 'bad-name' }]);
+        expect(message).toContain('Database migration validation failed');
+        expect(message).toContain('"bad-name"');
+        expect(message).toContain('<Unix-timestamp>_<slug>');
+    });
+    test('formats missing_sql_file errors', () => {
+        const message = formatValidationErrors([{ type: 'missing_sql_file', dirName: '1700000000_create-users' }]);
+        expect(message).toContain('Database migration validation failed');
+        expect(message).toContain('"1700000000_create-users/migration.sql" is missing');
+    });
+    test('formats multiple errors', () => {
+        const message = formatValidationErrors([
+            { type: 'invalid_dir_name', dirName: 'bad-name' },
+            { type: 'missing_sql_file', dirName: '1700000001_add-posts' },
+        ]);
+        expect(message).toContain('"bad-name"');
+        expect(message).toContain('"1700000001_add-posts/migration.sql" is missing');
+    });
+});

package/lib/steps/get.js

@@ -8,6 +8,7 @@ import { bundleEdgeFunctions } from '../plugins_core/edge_functions/index.js';
 import { applyDeployConfig } from '../plugins_core/frameworks_api/index.js';
 import { bundleFunctions } from '../plugins_core/functions/index.js';
 import { dbSetup } from '../plugins_core/db_setup/index.js';
+import { copyDbMigrations } from '../plugins_core/db_setup/migrations.js';
 import { preCleanup } from '../plugins_core/pre_cleanup/index.js';
 import { preDevCleanup } from '../plugins_core/pre_dev_cleanup/index.js';
 import { saveArtifacts } from '../plugins_core/save_artifacts/index.js';
@@ -71,6 +72,7 @@ const addCoreSteps = function (steps) {
         ...steps,
         bundleFunctions,
         bundleEdgeFunctions,
+        copyDbMigrations,
         scanForSecrets,
         uploadBlobs,
         deploySite,

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

@@ -25,6 +25,12 @@ interface NetlifyPlugin {
     package: string;
     inputs: PluginInputs;
 }
+interface DbMigrationsConfig {
+    path?: string;
+}
+interface DbConfig {
+    migrations?: DbMigrationsConfig;
+}
 interface ImagesConfig {
     remote_images: string[];
 }
@@ -51,5 +57,9 @@ export interface NetlifyConfig {
      * object with options for image transforms
      */
     images: ImagesConfig;
+    /**
+     * object with options for database configuration
+     */
+    db?: DbConfig;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "35.6.2",
+  "version": "35.7.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.4",
-    "@netlify/config": "^24.3.1",
+    "@netlify/config": "^24.4.0",
     "@netlify/edge-bundler": "14.9.8",
     "@netlify/functions-utils": "^6.2.21",
     "@netlify/git-utils": "^6.0.3",
@@ -152,5 +152,5 @@
   "engines": {
     "node": ">=18.14.0"
   },
-  "gitHead": "4395795665bc891337d375d51b0a63f6551d7d83"
+  "gitHead": "7afb85bef616ee25b81b3bd5728333dbbd076725"
 }