@lightdash/warehouses 0.1992.1 → 0.1992.2

package/dist/warehouseClients/SnowflakeWarehouseClient.d.ts

@@ -70,5 +70,6 @@ export declare class SnowflakeWarehouseClient extends WarehouseBaseClient<Create
         table: any;
     }[]>;
     getFields(tableName: string, schema?: string, database?: string, tags?: Record<string, string>): Promise<WarehouseCatalog>;
+    private formatCustomErrorMessage;
     parseError(error: SnowflakeError, query?: string): WarehouseQueryError;
 }

package/dist/warehouseClients/SnowflakeWarehouseClient.js

@@ -613,11 +613,44 @@ class SnowflakeWarehouseClient extends WarehouseBaseClient_1.default {
         const { rows } = await this.runQuery(query, tags, undefined, values);
         return this.parseWarehouseCatalog(rows, exports.mapFieldType);
     }
+    /*
+     * This function is used to format the error message for the user.
+     * It is used to replace the {snowflakeTable} and {snowflakeSchema} with the actual table and schema names.
+     * Sample custom template: You don't have access to the {snowflakeTable} table. Please go to '{snowflakeSchema}' and request access
+     */
+    formatCustomErrorMessage(originalMessage, customTemplate) {
+        let formattedMessage = customTemplate;
+        // Extract table information from the original error message
+        // Pattern matches: Object 'DATABASE.SCHEMA.TABLE' does not exist or not authorized
+        const tableMatch = originalMessage.match(/Object '([^']+)' does not exist or not authorized/i);
+        if (tableMatch) {
+            const fullTableName = tableMatch[1];
+            const parts = fullTableName.split('.');
+            if (parts.length >= 3) {
+                const snowflakeTable = parts[parts.length - 1]; // Last part is table name
+                const snowflakeSchema = parts[parts.length - 2]; // Second to last is schema
+                // Replace variables in the custom message
+                formattedMessage = formattedMessage
+                    .replace(/\{snowflakeTable\}/g, snowflakeTable)
+                    .replace(/\{snowflakeSchema\}/g, snowflakeSchema);
+            }
+        }
+        return formattedMessage;
+    }
     parseError(error, query = '') {
         // if the error has no code or data, return a generic error
         if (!error?.code && !error.data) {
             return new common_1.WarehouseQueryError(error?.message || 'Unknown error');
         }
+        const originalMessage = error?.message || 'Unknown error';
+        // Check for unauthorized access errors and use custom message if configured
+        if (originalMessage.includes('does not exist or not authorized')) {
+            const customErrorMessage = process.env.SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE;
+            if (customErrorMessage) {
+                const formattedMessage = this.formatCustomErrorMessage(originalMessage, customErrorMessage);
+                return new common_1.WarehouseQueryError(formattedMessage);
+            }
+        }
         // pull error type from data object
         const errorType = error.data?.type || error.code;
         switch (errorType) {
@@ -652,7 +685,7 @@ class SnowflakeWarehouseClient extends WarehouseBaseClient_1.default {
                 break;
         }
         // otherwise return a generic error
-        return new common_1.WarehouseQueryError(error?.message || 'Unknown error');
+        return new common_1.WarehouseQueryError(originalMessage);
     }
 }
 exports.SnowflakeWarehouseClient = SnowflakeWarehouseClient;

package/dist/warehouseClients/SnowflakeWarehouseClient.test.js

@@ -65,3 +65,82 @@ describe('SnowflakeTypeParsing', () => {
         expect((0, SnowflakeWarehouseClient_1.mapFieldType)('VARCHAR(12)')).toEqual(common_1.DimensionType.STRING);
     });
 });
+describe('SnowflakeErrorParsing', () => {
+    let warehouse;
+    const originalEnv = process.env.SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE;
+    beforeEach(() => {
+        warehouse = new SnowflakeWarehouseClient_1.SnowflakeWarehouseClient(SnowflakeWarehouseClient_mock_1.credentials);
+    });
+    afterEach(() => {
+        // Restore original environment variable
+        if (originalEnv) {
+            process.env.SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE = originalEnv;
+        }
+        else {
+            delete process.env.SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE;
+        }
+    });
+    it('should return custom error message when SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE is set', () => {
+        // Set environment variable
+        process.env.SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE =
+            "You don't have access to the {snowflakeTable} table. Please go to 'analytics_{snowflakeSchema}' in sailpoint and request access";
+        const error = {
+            message: "SQL compilation error: Object 'SNOWFLAKE_DATABASE_STAGING.JAFFLE.EVENTS' does not exist or not authorized.",
+            code: 'COMPILATION',
+            data: { type: 'COMPILATION' },
+        };
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const result = warehouse.parseError(error);
+        expect(result.message).toBe("You don't have access to the EVENTS table. Please go to 'analytics_JAFFLE' in sailpoint and request access");
+    });
+    it('should return original error message when SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE is not set', () => {
+        // Make sure environment variable is not set
+        delete process.env.SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE;
+        const error = {
+            message: "SQL compilation error: Object 'SNOWFLAKE_DATABASE_STAGING.JAFFLE.EVENTS' does not exist or not authorized.",
+            code: 'COMPILATION',
+            data: { type: 'COMPILATION' },
+        };
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const result = warehouse.parseError(error);
+        expect(result.message).toBe("SQL compilation error: Object 'SNOWFLAKE_DATABASE_STAGING.JAFFLE.EVENTS' does not exist or not authorized.");
+    });
+    it('should return original error message for non-unauthorized errors', () => {
+        // Set environment variable
+        process.env.SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE =
+            "You don't have access to the {snowflakeTable} table. Please go to 'analytics_{snowflakeSchema}' in sailpoint and request access";
+        const error = {
+            message: 'Some other SQL error',
+            code: 'COMPILATION',
+            data: { type: 'COMPILATION' },
+        };
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const result = warehouse.parseError(error);
+        expect(result.message).toBe('Some other SQL error');
+    });
+    it('should handle table names with different formats', () => {
+        process.env.SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE =
+            'Access denied for {snowflakeTable} in {snowflakeSchema}';
+        const error = {
+            message: "Object 'DB.MY_SCHEMA.MY_TABLE' does not exist or not authorized.",
+            code: 'COMPILATION',
+            data: { type: 'COMPILATION' },
+        };
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const result = warehouse.parseError(error);
+        expect(result.message).toBe('Access denied for MY_TABLE in MY_SCHEMA');
+    });
+    it('should handle errors without table information gracefully', () => {
+        process.env.SNOWFLAKE_UNAUTHORIZED_ERROR_MESSAGE =
+            "You don't have access to the {snowflakeTable} table. Please go to 'analytics_{snowflakeSchema}' in sailpoint and request access";
+        const error = {
+            message: "Object 'INCOMPLETE_TABLE_NAME' does not exist or not authorized.",
+            code: 'COMPILATION',
+            data: { type: 'COMPILATION' },
+        };
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const result = warehouse.parseError(error);
+        // Should still use custom message but without variable replacement
+        expect(result.message).toBe("You don't have access to the {snowflakeTable} table. Please go to 'analytics_{snowflakeSchema}' in sailpoint and request access");
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/warehouses",
-  "version": "0.1992.1",
+  "version": "0.1992.2",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,7 +16,7 @@
     "snowflake-sdk": "~2.1.3",
     "ssh2": "^1.14.0",
     "trino-client": "0.2.6",
-    "@lightdash/common": "0.1992.1"
+    "@lightdash/common": "0.1992.2"
   },
   "devDependencies": {
     "@types/pg": "^8.11.10",