Skip to content

fix: Fix SQL dataframe integration #139

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

Merged
merged 5 commits into from
Oct 30, 2025
Merged

fix: Fix SQL dataframe integration #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c04a3ff
fix: Fix SQL dataframe integration
tkislan Oct 30, 2025
0af50ab
test: Update test expectations
tkislan Oct 30, 2025
ebfbc3f
test: Update comments
tkislan Oct 30, 2025
b10def7
test: Update comments
tkislan Oct 30, 2025
ca4a168
test: Rename empty env vars test variable
tkislan Oct 30, 2025
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
25 changes: 14 additions & 11 deletions src/platform/notebooks/deepnote/sqlIntegrationEnvironmentVariablesProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,19 @@ export class SqlIntegrationEnvironmentVariablesProvider implements ISqlIntegrati
return envVars;
}

// Always add the internal DuckDB integration
const dataframeSqlIntegrationEnvVarName = convertToEnvironmentVariableName(
getSqlEnvVarName(DATAFRAME_SQL_INTEGRATION_ID)
);
const dataframeSqlIntegrationCredentialsJson = JSON.stringify({
url: 'deepnote+duckdb:///:memory:',
params: {},
param_style: 'qmark'
});

envVars[dataframeSqlIntegrationEnvVarName] = dataframeSqlIntegrationCredentialsJson;
logger.debug(`SqlIntegrationEnvironmentVariablesProvider: Added env var for dataframe SQL integration`);

// Scan all cells for SQL integration IDs
const integrationIds = this.scanNotebookForIntegrations(notebook);
if (integrationIds.size === 0) {
Expand All @@ -219,17 +232,7 @@ export class SqlIntegrationEnvironmentVariablesProvider implements ISqlIntegrati
try {
// Handle internal DuckDB integration specially
if (integrationId === DATAFRAME_SQL_INTEGRATION_ID) {
const envVarName = convertToEnvironmentVariableName(getSqlEnvVarName(integrationId));
const credentialsJson = JSON.stringify({
url: 'deepnote+duckdb:///:memory:',
params: {},
param_style: 'qmark'
});

envVars[envVarName] = credentialsJson;
logger.debug(
`SqlIntegrationEnvironmentVariablesProvider: Added env var for dataframe SQL integration`
);
// Internal DuckDB integration is handled above
continue;
}

Expand Down
28 changes: 16 additions & 12 deletions src/platform/notebooks/deepnote/sqlIntegrationEnvironmentVariablesProvider.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ import {
} from './integrationTypes';
import { mockedVSCodeNamespaces, resetVSCodeMocks } from '../../../test/vscode-mock';

const EXPECTED_DATAFRAME_ONLY_ENV_VARS = {
SQL_DEEPNOTE_DATAFRAME_SQL: '{"url":"deepnote+duckdb:///:memory:","params":{},"param_style":"qmark"}'
};

suite('SqlIntegrationEnvironmentVariablesProvider', () => {
let provider: SqlIntegrationEnvironmentVariablesProvider;
let integrationStorage: IntegrationStorage;
Expand Down Expand Up @@ -55,7 +59,7 @@ suite('SqlIntegrationEnvironmentVariablesProvider', () => {
when(mockedVSCodeNamespaces.workspace.notebookDocuments).thenReturn([notebook]);

const envVars = await provider.getEnvironmentVariables(uri);
assert.deepStrictEqual(envVars, {});
assert.deepStrictEqual(envVars, EXPECTED_DATAFRAME_ONLY_ENV_VARS);
});

test('Returns empty object when SQL cells have no integration ID', async () => {
Expand All @@ -67,7 +71,7 @@ suite('SqlIntegrationEnvironmentVariablesProvider', () => {
when(mockedVSCodeNamespaces.workspace.notebookDocuments).thenReturn([notebook]);

const envVars = await provider.getEnvironmentVariables(uri);
assert.deepStrictEqual(envVars, {});
assert.deepStrictEqual(envVars, EXPECTED_DATAFRAME_ONLY_ENV_VARS);
});

test('Returns environment variable for internal DuckDB integration', async () => {
Expand Down Expand Up @@ -186,9 +190,9 @@ suite('SqlIntegrationEnvironmentVariablesProvider', () => {

const envVars = await provider.getEnvironmentVariables(uri);

// Should only have one environment variable
// Should only have one environment variable apart from the internal DuckDB integration
assert.property(envVars, 'SQL_MY_POSTGRES_DB');
assert.strictEqual(Object.keys(envVars).length, 1);
assert.strictEqual(Object.keys(envVars).length, 2);
});

test('Handles multiple SQL cells with different integrations', async () => {
Expand Down Expand Up @@ -230,10 +234,10 @@ suite('SqlIntegrationEnvironmentVariablesProvider', () => {

const envVars = await provider.getEnvironmentVariables(uri);

// Should have two environment variables
// Should have two environment variables apart from the internal DuckDB integration
assert.property(envVars, 'SQL_MY_POSTGRES_DB');
assert.property(envVars, 'SQL_MY_BIGQUERY');
assert.strictEqual(Object.keys(envVars).length, 2);
assert.strictEqual(Object.keys(envVars).length, 3);
});

test('Handles missing integration configuration gracefully', async () => {
Expand All @@ -251,8 +255,8 @@ suite('SqlIntegrationEnvironmentVariablesProvider', () => {

const envVars = await provider.getEnvironmentVariables(uri);

// Should return empty object when integration config is missing
assert.deepStrictEqual(envVars, {});
// Should return only dataframe integration when integration config is missing
assert.deepStrictEqual(envVars, EXPECTED_DATAFRAME_ONLY_ENV_VARS);
});

test('Properly encodes special characters in PostgreSQL credentials', async () => {
Expand Down Expand Up @@ -621,9 +625,9 @@ suite('SqlIntegrationEnvironmentVariablesProvider', () => {
when(mockedVSCodeNamespaces.workspace.notebookDocuments).thenReturn([notebook]);
when(integrationStorage.getIntegrationConfig(integrationId)).thenResolve(config);

// Should return empty object when unsupported auth method is encountered
// Should return only dataframe integration when unsupported auth method is encountered
const envVars = await provider.getEnvironmentVariables(uri);
assert.deepStrictEqual(envVars, {});
assert.deepStrictEqual(envVars, EXPECTED_DATAFRAME_ONLY_ENV_VARS);
});

test('Skips unsupported Snowflake auth method (AZURE_AD)', async () => {
Expand All @@ -647,7 +651,7 @@ suite('SqlIntegrationEnvironmentVariablesProvider', () => {
when(integrationStorage.getIntegrationConfig(integrationId)).thenResolve(config);

const envVars = await provider.getEnvironmentVariables(uri);
assert.deepStrictEqual(envVars, {});
assert.deepStrictEqual(envVars, EXPECTED_DATAFRAME_ONLY_ENV_VARS);
});

test('Skips unsupported Snowflake auth method (KEY_PAIR)', async () => {
Expand All @@ -671,7 +675,7 @@ suite('SqlIntegrationEnvironmentVariablesProvider', () => {
when(integrationStorage.getIntegrationConfig(integrationId)).thenResolve(config);

const envVars = await provider.getEnvironmentVariables(uri);
assert.deepStrictEqual(envVars, {});
assert.deepStrictEqual(envVars, EXPECTED_DATAFRAME_ONLY_ENV_VARS);
});
});
});
Expand Down