consolidate supported snowflake auth method checks

Author: jankuca

src/platform/notebooks/deepnote/integrationTypes.ts

@@ -65,8 +65,13 @@ export interface BigQueryIntegrationConfig extends BaseIntegrationConfig {
 }
 
 // Import and re-export Snowflake auth constants from shared module
-import { SnowflakeAuthMethod, SnowflakeAuthMethods, SUPPORTED_SNOWFLAKE_AUTH_METHODS } from './snowflakeAuthConstants';
-export { SnowflakeAuthMethod, SnowflakeAuthMethods, SUPPORTED_SNOWFLAKE_AUTH_METHODS };
+import {
+    SnowflakeAuthMethod,
+    SnowflakeAuthMethods,
+    SUPPORTED_SNOWFLAKE_AUTH_METHODS,
+    isSupportedSnowflakeAuthMethod
+} from './snowflakeAuthConstants';
+export { SnowflakeAuthMethod, SnowflakeAuthMethods, SUPPORTED_SNOWFLAKE_AUTH_METHODS, isSupportedSnowflakeAuthMethod };
 
 /**
  * Base Snowflake configuration with common fields

src/platform/notebooks/deepnote/snowflakeAuthConstants.ts

@@ -10,7 +10,7 @@ export const SnowflakeAuthMethods = {
     SERVICE_ACCOUNT_KEY_PAIR: 'SERVICE_ACCOUNT_KEY_PAIR'
 } as const;
 
-export type SnowflakeAuthMethod = (typeof SnowflakeAuthMethods)[keyof typeof SnowflakeAuthMethods] | null;
+export type SnowflakeAuthMethod = (typeof SnowflakeAuthMethods)[keyof typeof SnowflakeAuthMethods];
 
 /**
  * Supported auth methods that we can configure in VSCode
@@ -21,3 +21,13 @@ export const SUPPORTED_SNOWFLAKE_AUTH_METHODS = [
     SnowflakeAuthMethods.SERVICE_ACCOUNT_KEY_PAIR
 ] as const;
 
+export type SupportedSnowflakeAuthMethod = (typeof SUPPORTED_SNOWFLAKE_AUTH_METHODS)[number];
+
+/**
+ * Type guard to check if a value is a supported Snowflake auth method
+ * @param value The value to check
+ * @returns true if the value is one of the supported auth methods
+ */
+export function isSupportedSnowflakeAuthMethod(value: unknown): value is SupportedSnowflakeAuthMethod {
+    return (SUPPORTED_SNOWFLAKE_AUTH_METHODS as readonly unknown[]).includes(value);
+}

src/platform/notebooks/deepnote/sqlIntegrationEnvironmentVariablesProvider.ts

@@ -10,7 +10,8 @@ import {
     DATAFRAME_SQL_INTEGRATION_ID,
     IntegrationConfig,
     IntegrationType,
-    SnowflakeAuthMethods
+    SnowflakeAuthMethods,
+    isSupportedSnowflakeAuthMethod
 } from './integrationTypes';
 
 /**
@@ -85,10 +86,16 @@ function convertIntegrationConfigToJson(config: IntegrationConfig): string {
             // Service account key-pair: snowflake://{username}@{account}/{database}?warehouse={warehouse}&role={role}&authenticator=snowflake_jwt&application=YourApp
             const encodedAccount = encodeURIComponent(config.account);
 
+            // Check if this is a supported auth method
+            if (!isSupportedSnowflakeAuthMethod(config.authMethod)) {
+                throw new UnsupportedIntegrationError(
+                    `Snowflake integration with auth method '${config.authMethod}' is not supported in VSCode`
+                );
+            }
+
             let url: string;
             const params: Record<string, unknown> = {};
 
-            // Check if this is a supported auth method
             if (config.authMethod === null || config.authMethod === SnowflakeAuthMethods.PASSWORD) {
                 // Username+password authentication
                 const encodedUsername = encodeURIComponent(config.username);
@@ -109,8 +116,16 @@ function convertIntegrationConfigToJson(config: IntegrationConfig): string {
                 if (queryString) {
                     url += `?${queryString}`;
                 }
-            } else if (config.authMethod === SnowflakeAuthMethods.SERVICE_ACCOUNT_KEY_PAIR) {
-                // Service account key-pair authentication
+            } else {
+                // Service account key-pair authentication (the only other supported method)
+                // TypeScript needs help narrowing the type here
+                if (config.authMethod !== SnowflakeAuthMethods.SERVICE_ACCOUNT_KEY_PAIR) {
+                    // This should never happen due to the type guard above, but TypeScript needs this
+                    throw new UnsupportedIntegrationError(
+                        `Snowflake integration with auth method '${config.authMethod}' is not supported in VSCode`
+                    );
+                }
+
                 const encodedUsername = encodeURIComponent(config.username);
                 const database = config.database ? `/${encodeURIComponent(config.database)}` : '';
                 url = `snowflake://${encodedUsername}@${encodedAccount}${database}`;
@@ -135,11 +150,6 @@ function convertIntegrationConfigToJson(config: IntegrationConfig): string {
                 if (config.privateKeyPassphrase) {
                     params.private_key_passphrase = config.privateKeyPassphrase;
                 }
-            } else {
-                // Unsupported auth method
-                throw new UnsupportedIntegrationError(
-                    `Snowflake integration with auth method '${config.authMethod}' is not supported in VSCode`
-                );
             }
 
             return JSON.stringify({

src/webviews/webview-side/integrations/SnowflakeForm.tsx

@@ -1,6 +1,11 @@
 import * as React from 'react';
 import { format, getLocString } from '../react-common/locReactSide';
-import { SnowflakeIntegrationConfig, SnowflakeAuthMethod, SnowflakeAuthMethods } from './types';
+import {
+    SnowflakeIntegrationConfig,
+    SnowflakeAuthMethod,
+    SnowflakeAuthMethods,
+    isSupportedSnowflakeAuthMethod
+} from './types';
 
 export interface ISnowflakeFormProps {
     integrationId: string;
@@ -10,15 +15,6 @@ export interface ISnowflakeFormProps {
     onCancel: () => void;
 }
 
-// Helper to check if auth method is supported
-function isAuthMethodSupported(authMethod: SnowflakeAuthMethod): boolean {
-    return (
-        authMethod === null ||
-        authMethod === SnowflakeAuthMethods.PASSWORD ||
-        authMethod === SnowflakeAuthMethods.SERVICE_ACCOUNT_KEY_PAIR
-    );
-}
-
 // Helper to get initial values from existing config
 function getInitialValues(existingConfig: SnowflakeIntegrationConfig | null) {
     if (!existingConfig) {
@@ -64,7 +60,7 @@ export const SnowflakeForm: React.FC<ISnowflakeFormProps> = ({
     onSave,
     onCancel
 }) => {
-    const isUnsupported = existingConfig ? !isAuthMethodSupported(existingConfig.authMethod) : false;
+    const isUnsupported = existingConfig ? !isSupportedSnowflakeAuthMethod(existingConfig.authMethod) : false;
     const initialValues = getInitialValues(existingConfig);
 
     const [name, setName] = React.useState(existingConfig?.name || integrationName || '');
@@ -206,7 +202,7 @@ export const SnowflakeForm: React.FC<ISnowflakeFormProps> = ({
                 </label>
                 <select
                     id="authMethod"
-                    value={authMethod ?? ''}
+                    value={authMethod}
                     onChange={(e) => setAuthMethod(e.target.value as SnowflakeAuthMethod)}
                     disabled={isUnsupported}
                 >

src/webviews/webview-side/integrations/types.ts

@@ -1,15 +1,16 @@
 import {
     SnowflakeAuthMethod,
     SnowflakeAuthMethods,
-    SUPPORTED_SNOWFLAKE_AUTH_METHODS
+    SUPPORTED_SNOWFLAKE_AUTH_METHODS,
+    isSupportedSnowflakeAuthMethod
 } from '../../../platform/notebooks/deepnote/snowflakeAuthConstants';
 
 export type IntegrationType = 'postgres' | 'bigquery' | 'snowflake';
 
 export type IntegrationStatus = 'connected' | 'disconnected' | 'error';
 
 // Re-export Snowflake auth constants for convenience
-export { SnowflakeAuthMethod, SnowflakeAuthMethods, SUPPORTED_SNOWFLAKE_AUTH_METHODS };
+export { SnowflakeAuthMethod, SnowflakeAuthMethods, SUPPORTED_SNOWFLAKE_AUTH_METHODS, isSupportedSnowflakeAuthMethod };
 
 export interface BaseIntegrationConfig {
     id: string;