@netlify/build 35.9.0 → 35.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.ts +1 -0
- package/lib/index.js +1 -0
- package/lib/plugins_core/db_setup/migrations.js +15 -4
- package/lib/plugins_core/db_setup/validation.d.ts +4 -2
- package/lib/plugins_core/db_setup/validation.js +17 -13
- package/lib/plugins_core/db_setup/validation.test.js +92 -42
- package/lib/utils/json.d.ts +1 -0
- package/lib/utils/json.js +1 -0
- package/package.json +6 -6
package/lib/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { buildSite } from './core/main.js';
|
|
2
2
|
export { NetlifyPluginConstants } from './core/constants.js';
|
|
3
|
+
export { getVersion } from './utils/json.js';
|
|
3
4
|
export type { LogOutput as Logs } from './log/logger.js';
|
|
4
5
|
export type { GeneratedFunction } from './steps/return_values.js';
|
|
5
6
|
export type { NetlifyPlugin } from './types/netlify_plugin.js';
|
package/lib/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { copyFile, mkdir, readdir, stat } from 'node:fs/promises';
|
|
2
2
|
import { join, resolve } from 'node:path';
|
|
3
3
|
import { pathExists } from 'path-exists';
|
|
4
|
-
import {
|
|
4
|
+
import { validateMigrations, formatValidationErrors } from './validation.js';
|
|
5
5
|
const condition = async ({ featureFlags, constants, buildDir }) => {
|
|
6
6
|
if (!featureFlags?.netlify_build_db_setup) {
|
|
7
7
|
return false;
|
|
@@ -17,13 +17,17 @@ const coreStep = async ({ constants, buildDir, systemLog }) => {
|
|
|
17
17
|
const destDir = resolve(buildDir, constants.DB_MIGRATIONS_DIST);
|
|
18
18
|
const entries = await readdir(srcDir);
|
|
19
19
|
const dirNames = [];
|
|
20
|
+
const fileNames = [];
|
|
20
21
|
for (const entry of entries) {
|
|
21
22
|
const entryStat = await stat(join(srcDir, entry));
|
|
22
23
|
if (entryStat.isDirectory()) {
|
|
23
24
|
dirNames.push(entry);
|
|
24
25
|
}
|
|
26
|
+
else if (entry.endsWith('.sql')) {
|
|
27
|
+
fileNames.push(entry);
|
|
28
|
+
}
|
|
25
29
|
}
|
|
26
|
-
if (dirNames.length === 0) {
|
|
30
|
+
if (dirNames.length === 0 && fileNames.length === 0) {
|
|
27
31
|
systemLog('No migration directories found, skipping copy.');
|
|
28
32
|
return {};
|
|
29
33
|
}
|
|
@@ -34,7 +38,7 @@ const coreStep = async ({ constants, buildDir, systemLog }) => {
|
|
|
34
38
|
existingSqlFiles.add(dirName);
|
|
35
39
|
}
|
|
36
40
|
}
|
|
37
|
-
const result =
|
|
41
|
+
const result = validateMigrations(dirNames, fileNames, existingSqlFiles);
|
|
38
42
|
if (!result.valid) {
|
|
39
43
|
const message = formatValidationErrors(result.errors);
|
|
40
44
|
throw new Error(message);
|
|
@@ -44,7 +48,14 @@ const coreStep = async ({ constants, buildDir, systemLog }) => {
|
|
|
44
48
|
await mkdir(migrationDestDir, { recursive: true });
|
|
45
49
|
await copyFile(join(srcDir, dirName, 'migration.sql'), join(migrationDestDir, 'migration.sql'));
|
|
46
50
|
}
|
|
47
|
-
|
|
51
|
+
for (const fileName of result.files) {
|
|
52
|
+
const stem = fileName.replace(/\.sql$/, '');
|
|
53
|
+
const migrationDestDir = join(destDir, stem);
|
|
54
|
+
await mkdir(migrationDestDir, { recursive: true });
|
|
55
|
+
await copyFile(join(srcDir, fileName), join(migrationDestDir, 'migration.sql'));
|
|
56
|
+
}
|
|
57
|
+
const totalCount = result.dirs.length + result.files.length;
|
|
58
|
+
systemLog(`Copied ${String(totalCount)} migration(s) to ${destDir}`);
|
|
48
59
|
return {};
|
|
49
60
|
};
|
|
50
61
|
export const copyDbMigrations = {
|
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
export declare const MIGRATION_DIR_PATTERN: RegExp;
|
|
2
|
+
export declare const MIGRATION_FILE_PATTERN: RegExp;
|
|
2
3
|
interface ValidationError {
|
|
3
|
-
type: '
|
|
4
|
+
type: 'missing_sql_file';
|
|
4
5
|
dirName: string;
|
|
5
6
|
}
|
|
6
7
|
interface ValidationResult {
|
|
7
8
|
valid: true;
|
|
8
9
|
dirs: string[];
|
|
10
|
+
files: string[];
|
|
9
11
|
}
|
|
10
12
|
interface ValidationFailure {
|
|
11
13
|
valid: false;
|
|
12
14
|
errors: ValidationError[];
|
|
13
15
|
}
|
|
14
|
-
export declare const
|
|
16
|
+
export declare const validateMigrations: (dirNames: string[], fileNames: string[], existingSqlFiles: Set<string>) => ValidationResult | ValidationFailure;
|
|
15
17
|
export declare const formatValidationErrors: (errors: ValidationError[]) => string;
|
|
16
18
|
export {};
|
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
export const MIGRATION_DIR_PATTERN = /^\d+_[a-z0-
|
|
2
|
-
export const
|
|
1
|
+
export const MIGRATION_DIR_PATTERN = /^\d+_[a-z0-9_-]+$/;
|
|
2
|
+
export const MIGRATION_FILE_PATTERN = /^\d+_[a-z0-9_-]+\.sql$/;
|
|
3
|
+
export const validateMigrations = (dirNames, fileNames, existingSqlFiles) => {
|
|
3
4
|
const errors = [];
|
|
5
|
+
const matchingDirs = [];
|
|
4
6
|
for (const dirName of dirNames) {
|
|
5
7
|
if (!MIGRATION_DIR_PATTERN.test(dirName)) {
|
|
6
|
-
errors.push({ type: 'invalid_dir_name', dirName });
|
|
7
8
|
continue;
|
|
8
9
|
}
|
|
10
|
+
matchingDirs.push(dirName);
|
|
9
11
|
if (!existingSqlFiles.has(dirName)) {
|
|
10
12
|
errors.push({ type: 'missing_sql_file', dirName });
|
|
11
13
|
}
|
|
@@ -13,19 +15,21 @@ export const validateMigrationDirs = (dirNames, existingSqlFiles) => {
|
|
|
13
15
|
if (errors.length > 0) {
|
|
14
16
|
return { valid: false, errors };
|
|
15
17
|
}
|
|
16
|
-
const
|
|
17
|
-
|
|
18
|
+
const matchingFiles = [];
|
|
19
|
+
for (const fileName of fileNames) {
|
|
20
|
+
if (MIGRATION_FILE_PATTERN.test(fileName)) {
|
|
21
|
+
matchingFiles.push(fileName);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
return {
|
|
25
|
+
valid: true,
|
|
26
|
+
dirs: [...matchingDirs].sort(),
|
|
27
|
+
files: [...matchingFiles].sort(),
|
|
28
|
+
};
|
|
18
29
|
};
|
|
19
30
|
export const formatValidationErrors = (errors) => {
|
|
20
31
|
const lines = errors.map((error) => {
|
|
21
|
-
|
|
22
|
-
return ` - "${error.dirName}" does not match the required pattern "<number>_<slug>" (e.g. "1700000000_create-users" or "001_create-users"). Slugs must be lowercase alphanumeric with hyphens.`;
|
|
23
|
-
}
|
|
24
|
-
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
25
|
-
if (error.type === 'missing_sql_file') {
|
|
26
|
-
return ` - "${error.dirName}/migration.sql" is missing.`;
|
|
27
|
-
}
|
|
28
|
-
return ` - "${error.dirName}": unknown validation error.`;
|
|
32
|
+
return ` - "${error.dirName}/migration.sql" is missing.`;
|
|
29
33
|
});
|
|
30
34
|
return `Database migration validation failed:\n${lines.join('\n')}`;
|
|
31
35
|
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { describe, expect, test } from 'vitest';
|
|
2
|
-
import { MIGRATION_DIR_PATTERN,
|
|
2
|
+
import { MIGRATION_DIR_PATTERN, MIGRATION_FILE_PATTERN, validateMigrations, formatValidationErrors, } from './validation.js';
|
|
3
3
|
describe('MIGRATION_DIR_PATTERN', () => {
|
|
4
4
|
const validNames = [
|
|
5
5
|
'1700000000_create-users',
|
|
@@ -12,13 +12,15 @@ describe('MIGRATION_DIR_PATTERN', () => {
|
|
|
12
12
|
'1_init',
|
|
13
13
|
'0001_add-posts',
|
|
14
14
|
'42_z',
|
|
15
|
+
'1700000000_under_score',
|
|
16
|
+
'001_create_users_table',
|
|
17
|
+
'1_a_b_c',
|
|
15
18
|
];
|
|
16
19
|
test.each(validNames)('matches valid name: %s', (name) => {
|
|
17
20
|
expect(MIGRATION_DIR_PATTERN.test(name)).toBe(true);
|
|
18
21
|
});
|
|
19
22
|
const invalidNames = [
|
|
20
23
|
{ name: '1700000000_CAPS', reason: 'uppercase letters' },
|
|
21
|
-
{ name: '1700000000_under_score', reason: 'underscores in slug' },
|
|
22
24
|
{ name: 'no-timestamp', reason: 'no numeric prefix' },
|
|
23
25
|
{ name: '1700000000_', reason: 'empty slug' },
|
|
24
26
|
{ name: '1700000000', reason: 'missing underscore and slug' },
|
|
@@ -30,60 +32,108 @@ describe('MIGRATION_DIR_PATTERN', () => {
|
|
|
30
32
|
expect(MIGRATION_DIR_PATTERN.test(name)).toBe(false);
|
|
31
33
|
});
|
|
32
34
|
});
|
|
33
|
-
describe('
|
|
35
|
+
describe('MIGRATION_FILE_PATTERN', () => {
|
|
36
|
+
const validNames = [
|
|
37
|
+
'1700000000_create-users.sql',
|
|
38
|
+
'001_create_users_table.sql',
|
|
39
|
+
'1_init.sql',
|
|
40
|
+
'42_a-b-c.sql',
|
|
41
|
+
'1700000000_under_score.sql',
|
|
42
|
+
];
|
|
43
|
+
test.each(validNames)('matches valid name: %s', (name) => {
|
|
44
|
+
expect(MIGRATION_FILE_PATTERN.test(name)).toBe(true);
|
|
45
|
+
});
|
|
46
|
+
const invalidNames = [
|
|
47
|
+
{ name: '1700000000_CAPS.sql', reason: 'uppercase letters' },
|
|
48
|
+
{ name: 'no-timestamp.sql', reason: 'no numeric prefix' },
|
|
49
|
+
{ name: '1700000000_.sql', reason: 'empty slug' },
|
|
50
|
+
{ name: '1700000000_create-users.txt', reason: 'wrong extension' },
|
|
51
|
+
{ name: '1700000000_create-users', reason: 'no extension' },
|
|
52
|
+
{ name: '1700000000_hello world.sql', reason: 'spaces in slug' },
|
|
53
|
+
];
|
|
54
|
+
test.each(invalidNames)('rejects invalid name: $name ($reason)', ({ name }) => {
|
|
55
|
+
expect(MIGRATION_FILE_PATTERN.test(name)).toBe(false);
|
|
56
|
+
});
|
|
57
|
+
});
|
|
58
|
+
describe('validateMigrations', () => {
|
|
34
59
|
test('returns valid result with sorted dirs when all dirs are valid', () => {
|
|
35
60
|
const dirNames = ['1700000001_add-posts', '1700000000_create-users'];
|
|
36
61
|
const existingSqlFiles = new Set(['1700000000_create-users', '1700000001_add-posts']);
|
|
37
|
-
const result =
|
|
38
|
-
expect(result
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
62
|
+
const result = validateMigrations(dirNames, [], existingSqlFiles);
|
|
63
|
+
expect(result).toEqual({
|
|
64
|
+
valid: true,
|
|
65
|
+
dirs: ['1700000000_create-users', '1700000001_add-posts'],
|
|
66
|
+
files: [],
|
|
67
|
+
});
|
|
42
68
|
});
|
|
43
|
-
test('
|
|
69
|
+
test('silently skips non-matching directory names', () => {
|
|
44
70
|
const dirNames = ['bad-name', '1700000000_create-users'];
|
|
45
71
|
const existingSqlFiles = new Set(['1700000000_create-users']);
|
|
46
|
-
const result =
|
|
47
|
-
expect(result
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
72
|
+
const result = validateMigrations(dirNames, [], existingSqlFiles);
|
|
73
|
+
expect(result).toEqual({
|
|
74
|
+
valid: true,
|
|
75
|
+
dirs: ['1700000000_create-users'],
|
|
76
|
+
files: [],
|
|
77
|
+
});
|
|
51
78
|
});
|
|
52
79
|
test('returns error for missing migration.sql files', () => {
|
|
53
80
|
const dirNames = ['1700000000_create-users', '1700000001_add-posts'];
|
|
54
81
|
const existingSqlFiles = new Set(['1700000000_create-users']);
|
|
55
|
-
const result =
|
|
56
|
-
expect(result
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
}
|
|
82
|
+
const result = validateMigrations(dirNames, [], existingSqlFiles);
|
|
83
|
+
expect(result).toEqual({
|
|
84
|
+
valid: false,
|
|
85
|
+
errors: [{ type: 'missing_sql_file', dirName: '1700000001_add-posts' }],
|
|
86
|
+
});
|
|
87
|
+
});
|
|
88
|
+
test('returns valid result with sorted files for loose .sql files', () => {
|
|
89
|
+
const fileNames = ['002_add-posts.sql', '001_create-users.sql'];
|
|
90
|
+
const result = validateMigrations([], fileNames, new Set());
|
|
91
|
+
expect(result).toEqual({
|
|
92
|
+
valid: true,
|
|
93
|
+
dirs: [],
|
|
94
|
+
files: ['001_create-users.sql', '002_add-posts.sql'],
|
|
95
|
+
});
|
|
60
96
|
});
|
|
61
|
-
test('
|
|
62
|
-
const
|
|
63
|
-
const
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
97
|
+
test('silently skips non-matching file names', () => {
|
|
98
|
+
const fileNames = ['README.sql', '001_create-users.sql', 'bad-name.sql'];
|
|
99
|
+
const result = validateMigrations([], fileNames, new Set());
|
|
100
|
+
expect(result).toEqual({
|
|
101
|
+
valid: true,
|
|
102
|
+
dirs: [],
|
|
103
|
+
files: ['001_create-users.sql'],
|
|
104
|
+
});
|
|
105
|
+
});
|
|
106
|
+
test('handles mixed dirs and files', () => {
|
|
107
|
+
const dirNames = ['1700000000_create-users'];
|
|
108
|
+
const fileNames = ['1700000001_add-posts.sql'];
|
|
109
|
+
const existingSqlFiles = new Set(['1700000000_create-users']);
|
|
110
|
+
const result = validateMigrations(dirNames, fileNames, existingSqlFiles);
|
|
111
|
+
expect(result).toEqual({
|
|
112
|
+
valid: true,
|
|
113
|
+
dirs: ['1700000000_create-users'],
|
|
114
|
+
files: ['1700000001_add-posts.sql'],
|
|
115
|
+
});
|
|
71
116
|
});
|
|
72
117
|
test('returns valid result for empty input', () => {
|
|
73
|
-
const result =
|
|
74
|
-
expect(result
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
118
|
+
const result = validateMigrations([], [], new Set());
|
|
119
|
+
expect(result).toEqual({
|
|
120
|
+
valid: true,
|
|
121
|
+
dirs: [],
|
|
122
|
+
files: [],
|
|
123
|
+
});
|
|
124
|
+
});
|
|
125
|
+
test('allows underscores in dir names', () => {
|
|
126
|
+
const dirNames = ['001_create_users_table'];
|
|
127
|
+
const existingSqlFiles = new Set(['001_create_users_table']);
|
|
128
|
+
const result = validateMigrations(dirNames, [], existingSqlFiles);
|
|
129
|
+
expect(result).toEqual({
|
|
130
|
+
valid: true,
|
|
131
|
+
dirs: ['001_create_users_table'],
|
|
132
|
+
files: [],
|
|
133
|
+
});
|
|
78
134
|
});
|
|
79
135
|
});
|
|
80
136
|
describe('formatValidationErrors', () => {
|
|
81
|
-
test('formats invalid_dir_name errors', () => {
|
|
82
|
-
const message = formatValidationErrors([{ type: 'invalid_dir_name', dirName: 'bad-name' }]);
|
|
83
|
-
expect(message).toContain('Database migration validation failed');
|
|
84
|
-
expect(message).toContain('"bad-name"');
|
|
85
|
-
expect(message).toContain('<number>_<slug>');
|
|
86
|
-
});
|
|
87
137
|
test('formats missing_sql_file errors', () => {
|
|
88
138
|
const message = formatValidationErrors([{ type: 'missing_sql_file', dirName: '1700000000_create-users' }]);
|
|
89
139
|
expect(message).toContain('Database migration validation failed');
|
|
@@ -91,10 +141,10 @@ describe('formatValidationErrors', () => {
|
|
|
91
141
|
});
|
|
92
142
|
test('formats multiple errors', () => {
|
|
93
143
|
const message = formatValidationErrors([
|
|
94
|
-
{ type: '
|
|
144
|
+
{ type: 'missing_sql_file', dirName: '1700000000_create-users' },
|
|
95
145
|
{ type: 'missing_sql_file', dirName: '1700000001_add-posts' },
|
|
96
146
|
]);
|
|
97
|
-
expect(message).toContain('"
|
|
147
|
+
expect(message).toContain('"1700000000_create-users/migration.sql" is missing');
|
|
98
148
|
expect(message).toContain('"1700000001_add-posts/migration.sql" is missing');
|
|
99
149
|
});
|
|
100
150
|
});
|
package/lib/utils/json.d.ts
CHANGED
package/lib/utils/json.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@netlify/build",
|
|
3
|
-
"version": "35.
|
|
3
|
+
"version": "35.10.1",
|
|
4
4
|
"description": "Netlify build module",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": "./lib/index.js",
|
|
@@ -69,14 +69,14 @@
|
|
|
69
69
|
"@bugsnag/js": "^8.0.0",
|
|
70
70
|
"@netlify/blobs": "^10.4.4",
|
|
71
71
|
"@netlify/cache-utils": "^6.0.5",
|
|
72
|
-
"@netlify/config": "^24.4.
|
|
73
|
-
"@netlify/edge-bundler": "14.9.
|
|
74
|
-
"@netlify/functions-utils": "^6.2.
|
|
72
|
+
"@netlify/config": "^24.4.4",
|
|
73
|
+
"@netlify/edge-bundler": "14.9.18",
|
|
74
|
+
"@netlify/functions-utils": "^6.2.27",
|
|
75
75
|
"@netlify/git-utils": "^6.0.4",
|
|
76
76
|
"@netlify/opentelemetry-utils": "^2.0.2",
|
|
77
77
|
"@netlify/plugins-list": "^6.81.3",
|
|
78
78
|
"@netlify/run-utils": "^6.0.3",
|
|
79
|
-
"@netlify/zip-it-and-ship-it": "14.5.
|
|
79
|
+
"@netlify/zip-it-and-ship-it": "14.5.1",
|
|
80
80
|
"@sindresorhus/slugify": "^2.0.0",
|
|
81
81
|
"ansi-escapes": "^7.0.0",
|
|
82
82
|
"ansis": "^4.1.0",
|
|
@@ -152,5 +152,5 @@
|
|
|
152
152
|
"engines": {
|
|
153
153
|
"node": ">=18.14.0"
|
|
154
154
|
},
|
|
155
|
-
"gitHead": "
|
|
155
|
+
"gitHead": "d215694819e87e39ff42e863ed05124f5fd3da98"
|
|
156
156
|
}
|