@lightdash/warehouses 2.128.1 → 2.130.0

package/dist/warehouseClients/DatabricksWarehouseStartupRetry.test.js

@@ -0,0 +1,129 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const HiveDriverError_1 = __importDefault(require("@databricks/sql/dist/errors/HiveDriverError"));
+const OperationStateError_1 = __importStar(require("@databricks/sql/dist/errors/OperationStateError"));
+const StatusError_1 = __importDefault(require("@databricks/sql/dist/errors/StatusError"));
+const TCLIService_types_1 = require("@databricks/sql/thrift/TCLIService_types");
+const DatabricksWarehouseStartupRetry_1 = require("./DatabricksWarehouseStartupRetry");
+const statusError = (errorMessage) => new StatusError_1.default({ statusCode: TCLIService_types_1.TStatusCode.ERROR_STATUS, errorMessage });
+const sessionHandleError = statusError('requirement failed: Session handle: SessionHandle [01f19fd1-ac81-1e09-bb7c-357018ed26f1] has not been initialized or had already closed.');
+const diskDirectoryError = statusError("Couldn't create directory /local_disk0/tmp/a1b2c3d4-0000-1111-2222-333344445555/_resources");
+const warehouseStartingError = statusError('SQL warehouse xyz is not ready to accept connections (current state: STARTING)');
+// Pro/classic warehouse in STARTING: 503s until the driver's own HTTP retries give up
+const driverRetriesExhaustedError = new HiveDriverError_1.default('Hive driver: 503 when connecting to resource. Max retry count exceeded.');
+describe('isDatabricksWarehouseStartingError', () => {
+    it('matches the errors Databricks returns while a SQL warehouse is stopped or starting', () => {
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(sessionHandleError)).toBe(true);
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(diskDirectoryError)).toBe(true);
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(warehouseStartingError)).toBe(true);
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(driverRetriesExhaustedError)).toBe(true);
+    });
+    it('does not match other HTTP failures the driver gave up on', () => {
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(new HiveDriverError_1.default('Hive driver: 500 when connecting to resource. Max retry count exceeded.'))).toBe(false);
+    });
+    it('matches the same messages when the operation fails during polling', () => {
+        const error = new OperationStateError_1.default(OperationStateError_1.OperationStateErrorCode.Error, {
+            displayMessage: diskDirectoryError.message,
+        });
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(error)).toBe(true);
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(new OperationStateError_1.default(OperationStateError_1.OperationStateErrorCode.Timeout))).toBe(false);
+    });
+    it('does not match SQL, permission or auth failures', () => {
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(statusError('[PARSE_SYNTAX_ERROR] Syntax error at or near FROM'))).toBe(false);
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(statusError('PERMISSION_DENIED: User does not have USE SCHEMA on Schema'))).toBe(false);
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(new Error('Request failed with status 401: Unauthorized'))).toBe(false);
+    });
+    it('only matches driver status errors, not other errors with the same text', () => {
+        expect((0, DatabricksWarehouseStartupRetry_1.isDatabricksWarehouseStartingError)(new Error(sessionHandleError.message))).toBe(false);
+    });
+});
+describe('getDatabricksWarehouseStartupRetryDelayMs', () => {
+    it('backs off exponentially from 2s, capped at 30s', () => {
+        const delays = [1, 2, 3, 4, 5, 6].map((attempt) => (0, DatabricksWarehouseStartupRetry_1.getDatabricksWarehouseStartupRetryDelayMs)(attempt, 0));
+        expect(delays).toEqual([2000, 4000, 8000, 16000, 30000, 30000]);
+    });
+    it('stops once the next wait would pass the deadline', () => {
+        const { deadlineMs } = DatabricksWarehouseStartupRetry_1.DATABRICKS_WAREHOUSE_STARTUP_RETRY;
+        expect((0, DatabricksWarehouseStartupRetry_1.getDatabricksWarehouseStartupRetryDelayMs)(9, deadlineMs - 30000)).toBe(30000);
+        expect((0, DatabricksWarehouseStartupRetry_1.getDatabricksWarehouseStartupRetryDelayMs)(9, deadlineMs - 29999)).toBeNull();
+    });
+});
+describe('DatabricksWarehouseStartupRetry', () => {
+    beforeEach(() => {
+        vi.useFakeTimers();
+        vi.spyOn(console, 'warn').mockImplementation(() => { });
+    });
+    afterEach(() => {
+        vi.useRealTimers();
+        vi.restoreAllMocks();
+    });
+    // Drains the backoff timer so the wait resolves under fake timers
+    const waitBeforeRetry = async (retry, error) => {
+        const result = retry.waitBeforeRetry(error);
+        await vi.runAllTimersAsync();
+        return result;
+    };
+    it('waits with backoff before retrying a warehouse startup error', async () => {
+        const retry = new DatabricksWarehouseStartupRetry_1.DatabricksWarehouseStartupRetry();
+        const start = Date.now();
+        await expect(waitBeforeRetry(retry, sessionHandleError)).resolves.toBe(true);
+        expect(Date.now() - start).toBe(2000);
+        await expect(waitBeforeRetry(retry, diskDirectoryError)).resolves.toBe(true);
+        expect(Date.now() - start).toBe(6000);
+        expect(console.warn).toHaveBeenCalledTimes(2);
+        expect(vi.mocked(console.warn).mock.calls[0][0]).toContain('has not been initialized');
+    });
+    it('does not wait for errors that are not warehouse startup errors', async () => {
+        const retry = new DatabricksWarehouseStartupRetry_1.DatabricksWarehouseStartupRetry();
+        await expect(retry.waitBeforeRetry(statusError('Syntax error near FROM'))).resolves.toBe(false);
+        expect(vi.getTimerCount()).toBe(0);
+    });
+    it('counts time spent outside the wait against the deadline', async () => {
+        const retry = new DatabricksWarehouseStartupRetry_1.DatabricksWarehouseStartupRetry();
+        const start = Date.now();
+        let retries = 0;
+        // eslint-disable-next-line no-await-in-loop
+        while (await waitBeforeRetry(retry, sessionHandleError)) {
+            retries += 1;
+            vi.advanceTimersByTime(31000); // the driver's own HTTP retries per attempt
+        }
+        expect(retries).toBe(11);
+        expect(Date.now() - start).toBeLessThanOrEqual(DatabricksWarehouseStartupRetry_1.DATABRICKS_WAREHOUSE_STARTUP_RETRY.deadlineMs + 31000);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/warehouses",
-  "version": "2.128.1",
+  "version": "2.130.0",
   "description": "Warehouse connectors for Lightdash",
   "license": "MIT",
   "repository": {
@@ -28,7 +28,7 @@
     "snowflake-sdk": "2.3.4",
     "ssh2": "1.14.0",
     "trino-client": "0.2.9",
-    "@lightdash/common": "2.128.1"
+    "@lightdash/common": "2.130.0"
   },
   "devDependencies": {
     "oxlint": "1.75.0",