Skip to content

fix: don't error remote database status command if database was not enabled yet to provide more meaningful output #8218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pieh wants to merge 9 commits into
base: main
Choose a base branch
from
+30 −4
Open

fix: don't error remote database status command if database was not enabled yet to provide more meaningful output #8218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ae8c1fc
fix: don't error remote database status if database was not enabled y…
pieh Apr 28, 2026
4ea63a0
test: adjust not throwing assertion
pieh Apr 28, 2026
d0e7e94
Merge branch 'main' into fix/database-status-branch-not-yet-created
pieh Apr 28, 2026
d908cbd
Merge branch 'main' into fix/database-status-branch-not-yet-created
pieh Apr 28, 2026
a660745
Merge branch 'main' into fix/database-status-branch-not-yet-created
pieh Apr 29, 2026
4e6fa3e
fix: check if site has database instead of checking computed enabled
pieh Apr 29, 2026
6b0ffd0
skip self-explaining comment
pieh Apr 29, 2026
5541ac3
Merge remote-tracking branch 'origin/main' into fix/database-status-b…
pieh May 5, 2026
bf68be1
fix: don't throw when remote migrations response is null
pieh May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/commands/database/db-status.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,9 +410,13 @@ export const statusDb = async (options: DatabaseStatusOptions, command: BaseComm
throw new Error(`You must be logged in with ${netlifyCommand()} login to target a remote branch.`)
}

connectionString = await fetchBranchConnectionString({ siteId, accessToken, basePath }, branch)
fetchApplied = remoteAppliedMigrations({ siteId, accessToken, basePath, branch })
branchLabel = branch
if (siteHasDatabase) {
Copy link
Copy Markdown
Contributor Author

@pieh pieh May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This explicitly is not using enabled check, because when used with @netlify/database-proxy and NETLIFY_DB_URL (IIRC) it is reported as true even if database is not actually created yet, so fetchBranchConnectionString that is hitting an API would return failure.

The enabled logic might need some more thinking about desired interaction with @netlify/database-proxy, but this seems a bit out of scope for this change.

connectionString = await fetchBranchConnectionString({ siteId, accessToken, basePath }, branch)
fetchApplied = remoteAppliedMigrations({ siteId, accessToken, basePath, branch })
} else {
fetchApplied = () => Promise.resolve([])
}
} else {
isLocal = true
branchLabel = 'local'
Expand Down
6 changes: 4 additions & 2 deletions src/commands/database/util/applied-migrations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ interface RemoteMigration {
}

interface ListMigrationsResponse {
migrations: RemoteMigration[]
migrations: RemoteMigration[] | null
}

export const remoteAppliedMigrations =
Expand All @@ -59,7 +59,9 @@ export const remoteAppliedMigrations =
}

const data = (await response.json()) as ListMigrationsResponse
return data.migrations.filter((m) => m.applied).map((m) => ({ version: m.version, name: m.name, path: m.path }))
return (
data.migrations?.filter((m) => m.applied).map((m) => ({ version: m.version, name: m.name, path: m.path })) ?? []
)
}

interface LocalOptions {
Expand Down
20 changes: 20 additions & 0 deletions tests/unit/commands/database/db-status.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,26 @@ describe('statusDb', () => {
expect(jsonMessages[0]).toMatchObject({ target: 'feature-x' })
})

test('does not fetch branch connection string or remote applied migrations when database is not enabled', async () => {
setupFetchRouter({ siteDatabase: null })

await expect(statusDb({ branch: 'feature-x' }, createMockCommand())).resolves.toBeUndefined()

const fetchedUrls = mockFetch.mock.calls.map((c) => {
const u = c[0] as URL | string
return typeof u === 'string' ? u : u.toString()
})
expect(fetchedUrls.some((u) => u.includes('/database/branch/'))).toBe(false)
expect(fetchedUrls.some((u) => u.includes('/database/migrations'))).toBe(false)
expect(mockConnectToDatabase).not.toHaveBeenCalled()

const output = logMessages.join('\n')
expect(output).toContain('Netlify Database is not enabled for this project')
expect(output).toContain('Applied migrations (0)')
expect(output).toContain('Pending migrations (0)')
expect(output).not.toContain('Connected to database branch')
})

test('throws a helpful error when the branch endpoint 404s', async () => {
setupFetchRouter({ siteDatabase: { connection_string: PROD_CONN } })

Expand Down
Loading