fix: deploy DB migrations (#8103)

We are generating migration files but we're not including them in the
deployed files. This PR addresses that.

Author: eduardoboucas

src/utils/deploy/deploy-site.ts

@@ -19,6 +19,7 @@ import hashFiles from './hash-files.js'
 import hashFns from './hash-fns.js'
 import {
   deployFileNormalizer,
+  getDbMigrationsDistPathIfExists,
   getDeployConfigPathIfExists,
   getEdgeFunctionsDistPathIfExists,
   isEdgeFunctionFile,
@@ -98,6 +99,7 @@ export const deploySite = async (
 
   const edgeFunctionsDistPath = await getEdgeFunctionsDistPathIfExists(workingDir)
   const deployConfigPath = await getDeployConfigPathIfExists(workingDir)
+  const dbMigrationsDistPath = await getDbMigrationsDistPathIfExists(workingDir)
   const [
     { files: staticFiles, filesShaMap: staticShaMap },
     { fnConfig, fnShaMap, functionSchedules, functions, functionsWithNativeModules },
@@ -106,7 +108,7 @@ export const deploySite = async (
     hashFiles({
       assetType,
       concurrentHash,
-      directories: [dir, edgeFunctionsDistPath, deployConfigPath].filter(Boolean),
+      directories: [dir, edgeFunctionsDistPath, deployConfigPath, dbMigrationsDistPath].filter(Boolean),
       filter,
       hashAlgorithm,
       normalizer: deployFileNormalizer.bind(null, workingDir),

src/utils/deploy/process-files.ts

@@ -6,9 +6,11 @@ import { EDGE_FUNCTIONS_FOLDER, PUBLIC_URL_PATH } from '../../lib/edge-functions
 import { File } from './file.js'
 
 const DEPLOY_CONFIG_PATH = 'deploy-config'
+const DB_MIGRATIONS_PUBLIC_URL_PATH = '.netlify/internal/db/migrations'
 
 const deployConfigPathPath = getPathInProject([DEPLOY_CONFIG_PATH])
 const edgeFunctionsDistPath = getPathInProject([EDGE_FUNCTIONS_FOLDER])
+const dbMigrationsDistPath = getPathInProject(['internal', 'db', 'migrations'])
 
 export const deployFileNormalizer = (workingDir: string, file: File) => {
   let { normalizedPath } = file
@@ -22,6 +24,11 @@ export const deployFileNormalizer = (workingDir: string, file: File) => {
     case join(workingDir, deployConfigPathPath):
       normalizedPath = `.netlify/${DEPLOY_CONFIG_PATH}/${file.normalizedPath}`
 
+      break
+
+    case join(workingDir, dbMigrationsDistPath):
+      normalizedPath = `${DB_MIGRATIONS_PUBLIC_URL_PATH}/${file.normalizedPath}`
+
       break
   }
 
@@ -37,6 +44,9 @@ export const getDeployConfigPathIfExists = async (workingDir: string) =>
 export const getEdgeFunctionsDistPathIfExists = async (workingDir: string) =>
   getDirectoryIfExists(join(workingDir, edgeFunctionsDistPath))
 
+export const getDbMigrationsDistPathIfExists = async (workingDir: string) =>
+  getDirectoryIfExists(join(workingDir, dbMigrationsDistPath))
+
 const getDirectoryIfExists = async (directoryPath: string) => {
   try {
     const stats = await stat(directoryPath)

tests/integration/commands/deploy/deploy.test.ts

@@ -401,6 +401,81 @@ describe.concurrent('deploy command', () => {
     })
   })
 
+  test('should deploy DB migration files when internal migrations directory exists', async (t) => {
+    await withMockDeploy(async (mockApi, deployState) => {
+      await withSiteBuilder(t, async (builder) => {
+        builder
+          .withContentFile({
+            path: 'public/index.html',
+            content: '<h1>Site with DB migrations</h1>',
+          })
+          .withContentFile({
+            path: '.netlify/internal/db/migrations/0000_oval_proudstar/migration.sql',
+            content: 'CREATE TABLE users (id serial PRIMARY KEY);',
+          })
+          .withContentFile({
+            path: '.netlify/internal/db/migrations/0001_second_migration/migration.sql',
+            content: 'ALTER TABLE users ADD COLUMN name text;',
+          })
+          .withNetlifyToml({
+            config: {
+              build: { publish: 'public' },
+            },
+          })
+
+        await builder.build()
+
+        const deploy = await callCli(
+          ['deploy', '--json', '--no-build', '--dir', 'public'],
+          getCLIOptions({ apiUrl: mockApi.apiUrl, builder }),
+        ).then(parseDeploy)
+
+        expect(deploy.site_id).toBe('site_id')
+
+        const body = deployState.getDeployBody()
+        expect(body).not.toBeNull()
+
+        const fileKeys = Object.keys(body!.files!)
+        expect(fileKeys).toContain('index.html')
+        expect(fileKeys).toContain('.netlify/internal/db/migrations/0000_oval_proudstar/migration.sql')
+        expect(fileKeys).toContain('.netlify/internal/db/migrations/0001_second_migration/migration.sql')
+      })
+    })
+  })
+
+  test('should not include DB migrations in deploy when internal migrations directory does not exist', async (t) => {
+    await withMockDeploy(async (mockApi, deployState) => {
+      await withSiteBuilder(t, async (builder) => {
+        builder
+          .withContentFile({
+            path: 'public/index.html',
+            content: '<h1>Site without DB migrations</h1>',
+          })
+          .withNetlifyToml({
+            config: {
+              build: { publish: 'public' },
+            },
+          })
+
+        await builder.build()
+
+        const deploy = await callCli(
+          ['deploy', '--json', '--no-build', '--dir', 'public'],
+          getCLIOptions({ apiUrl: mockApi.apiUrl, builder }),
+        ).then(parseDeploy)
+
+        expect(deploy.site_id).toBe('site_id')
+
+        const body = deployState.getDeployBody()
+        expect(body).not.toBeNull()
+
+        const fileKeys = Object.keys(body!.files!)
+        expect(fileKeys).toContain('index.html')
+        expect(fileKeys.some((key) => key.includes('db/migrations'))).toBe(false)
+      })
+    })
+  })
+
   test('runs build command before deploy by default', async (t) => {
     await withMockDeploy(async (mockApi, deployState) => {
       await withSiteBuilder(t, async (builder) => {