feat: add db reset command (#7994)

Author: paulo

package-lock.json

@@ -31,7 +31,7 @@ export const createDatabaseCommand = (program: BaseCommand) => {
       'netlify db status',
       'netlify db init',
       'netlify db init --help',
-      ...(process.env.EXPERIMENTAL_NETLIFY_DB_ENABLED === '1' ? ['netlify db migrate'] : []),
+      ...(process.env.EXPERIMENTAL_NETLIFY_DB_ENABLED === '1' ? ['netlify db migrate', 'netlify db reset'] : []),
     ])
 
   dbCommand
@@ -96,5 +96,14 @@ export const createDatabaseCommand = (program: BaseCommand) => {
         const { migrate } = await import('./migrate.js')
         await migrate(options, command)
       })
+
+    dbCommand
+      .command('reset')
+      .description('Reset the local development database, removing all data and tables')
+      .option('--json', 'Output result as JSON')
+      .action(async (options: { json?: boolean }, command: BaseCommand) => {
+        const { reset } = await import('./reset.js')
+        await reset(options, command)
+      })
   }
 }

src/commands/database/database.ts

@@ -0,0 +1,50 @@
+import { NetlifyDev } from '@netlify/dev'
+
+import { log, logJson } from '../../utils/command-helpers.js'
+import BaseCommand from '../base-command.js'
+
+export interface ResetOptions {
+  json?: boolean
+}
+
+export const reset = async (options: ResetOptions, command: BaseCommand) => {
+  const { json } = options
+  const buildDir = command.netlify.site.root ?? command.project.root ?? command.project.baseDirectory
+  if (!buildDir) {
+    throw new Error('Could not determine the project root directory.')
+  }
+
+  const netlifyDev = new NetlifyDev({
+    projectRoot: buildDir,
+    aiGateway: { enabled: false },
+    blobs: { enabled: false },
+    edgeFunctions: { enabled: false },
+    environmentVariables: { enabled: false },
+    functions: { enabled: false },
+    geolocation: { enabled: false },
+    headers: { enabled: false },
+    images: { enabled: false },
+    redirects: { enabled: false },
+    staticFiles: { enabled: false },
+    serverAddress: null,
+  })
+
+  try {
+    await netlifyDev.start()
+
+    const { db } = netlifyDev
+    if (!db) {
+      throw new Error('Local database failed to start. Set EXPERIMENTAL_NETLIFY_DB_ENABLED=1 to enable.')
+    }
+
+    await db.reset()
+
+    if (json) {
+      logJson({ reset: true })
+    } else {
+      log('Local development database has been reset.')
+    }
+  } finally {
+    await netlifyDev.stop()
+  }
+}

src/commands/database/reset.ts

@@ -0,0 +1,99 @@
+import { describe, expect, test, vi, beforeEach } from 'vitest'
+
+const { mockStart, mockStop, mockReset, MockNetlifyDev, logMessages, jsonMessages } = vi.hoisted(() => {
+  const mockStart = vi.fn().mockResolvedValue({})
+  const mockStop = vi.fn().mockResolvedValue(undefined)
+  const mockReset = vi.fn().mockResolvedValue(undefined)
+  const MockNetlifyDev = vi.fn().mockImplementation(() => ({
+    start: mockStart,
+    stop: mockStop,
+    db: { reset: mockReset },
+  }))
+  const logMessages: string[] = []
+  const jsonMessages: unknown[] = []
+  return { mockStart, mockStop, mockReset, MockNetlifyDev, logMessages, jsonMessages }
+})
+
+vi.mock('@netlify/dev', () => ({
+  NetlifyDev: MockNetlifyDev,
+}))
+
+vi.mock('../../../../src/utils/command-helpers.js', async () => ({
+  ...(await vi.importActual('../../../../src/utils/command-helpers.js')),
+  log: (...args: string[]) => {
+    logMessages.push(args.join(' '))
+  },
+  logJson: (message: unknown) => {
+    jsonMessages.push(message)
+  },
+}))
+
+import { reset } from '../../../../src/commands/database/reset.js'
+
+function createMockCommand(overrides: { buildDir?: string; projectRoot?: string } = {}) {
+  const { buildDir = '/project', projectRoot = '/project' } = overrides
+
+  return {
+    project: { root: projectRoot, baseDirectory: undefined },
+    netlify: {
+      site: { root: buildDir },
+      config: {},
+    },
+  } as unknown as Parameters<typeof reset>[1]
+}
+
+describe('reset', () => {
+  beforeEach(() => {
+    logMessages.length = 0
+    jsonMessages.length = 0
+    vi.clearAllMocks()
+  })
+
+  test('starts NetlifyDev, resets the database, and stops', async () => {
+    await reset({}, createMockCommand())
+
+    expect(mockStart).toHaveBeenCalledOnce()
+    expect(mockReset).toHaveBeenCalledOnce()
+    expect(mockStop).toHaveBeenCalledOnce()
+  })
+
+  test('logs success message after reset', async () => {
+    await reset({}, createMockCommand())
+
+    expect(logMessages).toContain('Local development database has been reset.')
+  })
+
+  test('outputs JSON when --json flag is set', async () => {
+    await reset({ json: true }, createMockCommand())
+
+    expect(jsonMessages).toHaveLength(1)
+    expect(jsonMessages[0]).toEqual({ reset: true })
+  })
+
+  test('stops NetlifyDev even when reset throws', async () => {
+    mockReset.mockRejectedValueOnce(new Error('reset failed'))
+
+    await expect(reset({}, createMockCommand())).rejects.toThrow('reset failed')
+
+    expect(mockStop).toHaveBeenCalledOnce()
+  })
+
+  test('throws when db is not available after start', async () => {
+    MockNetlifyDev.mockImplementationOnce(() => ({
+      start: mockStart,
+      stop: mockStop,
+      db: undefined,
+    }))
+
+    await expect(reset({}, createMockCommand())).rejects.toThrow('Local database failed to start')
+  })
+
+  test('throws when project root cannot be determined', async () => {
+    const command = {
+      project: { root: undefined, baseDirectory: undefined },
+      netlify: { site: { root: undefined }, config: {} },
+    } as unknown as Parameters<typeof reset>[1]
+
+    await expect(reset({}, command)).rejects.toThrow('Could not determine the project root directory.')
+  })
+})