@lightdash/cli 0.1440.4 → 0.1440.5

package/dist/globalState.d.ts

@@ -1,11 +1,19 @@
 import ora from 'ora';
+type PromptAnswer = {
+    useFallbackDbtVersion?: boolean;
+};
 declare class GlobalState {
     private verbose;
     private activeSpinner;
+    private savedPromptAnswers;
+    constructor();
     getActiveSpinner(): ora.Ora | undefined;
     startSpinner(options?: ora.Options | string): ora.Ora;
     log(message: unknown, ...optionalParams: unknown[]): void;
     setVerbose(verbose: boolean): void;
+    getSavedPromptAnswer<T extends keyof PromptAnswer>(prompt: T): PromptAnswer[T] | undefined;
+    savePromptAnswer<T extends keyof PromptAnswer>(prompt: T, value: PromptAnswer[T]): void;
+    clearPromptAnswer(): void;
     debug(message: string): void;
 }
 declare const _default: GlobalState;

package/dist/globalState.js

@@ -6,6 +6,10 @@ const styles = tslib_1.__importStar(require("./styles"));
 class GlobalState {
     verbose = false;
     activeSpinner;
+    savedPromptAnswers;
+    constructor() {
+        this.savedPromptAnswers = {};
+    }
     getActiveSpinner() {
         return this.activeSpinner;
     }
@@ -26,6 +30,15 @@ class GlobalState {
     setVerbose(verbose) {
         this.verbose = verbose;
     }
+    getSavedPromptAnswer(prompt) {
+        return this.savedPromptAnswers[prompt];
+    }
+    savePromptAnswer(prompt, value) {
+        this.savedPromptAnswers[prompt] = value;
+    }
+    clearPromptAnswer() {
+        this.savedPromptAnswers = {};
+    }
     debug(message) {
         if (this.verbose) {
             this.log(styles.debug(message));

package/dist/handlers/compile.js

@@ -4,7 +4,6 @@ exports.compileHandler = exports.compile = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@lightdash/common");
 const warehouses_1 = require("@lightdash/warehouses");
-const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const uuid_1 = require("uuid");
 const analytics_1 = require("../analytics/analytics");
@@ -25,29 +24,12 @@ const compile = async (options) => {
         event: 'compile.started',
         properties: {
             executionId,
-            dbtVersion,
+            dbtVersion: dbtVersion.verboseVersion,
             useDbtList: !!options.useDbtList,
             skipWarehouseCatalog: !!options.skipWarehouseCatalog,
             skipDbtCompile: !!options.skipDbtCompile,
         },
     });
-    if (!(0, getDbtVersion_1.isSupportedDbtVersion)(dbtVersion)) {
-        if (process.env.CI === 'true') {
-            console.error(`Your dbt version ${dbtVersion} does not match our supported versions (1.3.* - 1.9.*), this could cause problems on compile or validation.`);
-        }
-        else {
-            const answers = await inquirer_1.default.prompt([
-                {
-                    type: 'confirm',
-                    name: 'isConfirm',
-                    message: `${styles.warning(`Your dbt version ${dbtVersion} does not match our supported version (1.3.* - 1.9.*), this could cause problems on compile or validation.`)}\nDo you still want to continue?`,
-                },
-            ]);
-            if (!answers.isConfirm) {
-                throw new Error(`Unsupported dbt version ${dbtVersion}`);
-            }
-        }
-    }
     const absoluteProjectPath = path_1.default.resolve(options.projectDir);
     const absoluteProfilesPath = path_1.default.resolve(options.profilesDir);
     globalState_1.default.debug(`> Compiling with project dir ${absoluteProjectPath}`);
@@ -95,7 +77,7 @@ ${errors.join('')}`));
             event: 'compile.error',
             properties: {
                 executionId,
-                dbtVersion,
+                dbtVersion: dbtVersion.verboseVersion,
                 error: `Dbt adapter ${manifest.metadata.adapter_type} is not supported`,
             },
         });
@@ -130,7 +112,7 @@ ${errors.join('')}`));
             explores: explores.length,
             errors,
             dbtMetrics: Object.values(manifest.metrics).length,
-            dbtVersion,
+            dbtVersion: dbtVersion.verboseVersion,
         },
     });
     return explores;

package/dist/handlers/createProject.js

@@ -55,7 +55,7 @@ const askPermissionToStoreWarehouseCredentials = async () => {
     return savedAnswer;
 };
 const createProject = async (options) => {
-    const dbtVersion = await (0, getDbtVersion_1.getSupportedDbtVersion)();
+    const dbtVersion = await (0, getDbtVersion_1.getDbtVersion)();
     const absoluteProjectPath = path_1.default.resolve(options.projectDir);
     const absoluteProfilesPath = path_1.default.resolve(options.profilesDir);
     const context = await (0, context_1.getDbtContext)({ projectDir: absoluteProjectPath });
@@ -102,7 +102,7 @@ const createProject = async (options) => {
             target: targetName,
         },
         upstreamProjectUuid: options.upstreamProjectUuid,
-        dbtVersion,
+        dbtVersion: dbtVersion.versionOption,
     };
     return (0, apiClient_1.lightdashApi)({
         method: 'POST',

package/dist/handlers/dbt/compile.js

@@ -90,8 +90,8 @@ async function dbtList(options) {
             'unique_id',
         ];
         const version = await (0, getDbtVersion_1.getDbtVersion)();
-        // older dbt versions don't support --quiet flag
-        if (!version.startsWith('1.3.') && !version.startsWith('1.4.')) {
+        // only dbt 1.5 and above support --quiet flag
+        if (version.versionOption !== common_1.SupportedDbtVersions.V1_4) {
             args.push('--quiet');
         }
         globalState_1.default.debug(`> Running: dbt ls ${args.join(' ')}`);

package/dist/handlers/dbt/getDbtVersion.d.ts

@@ -1,4 +1,7 @@
-import { SupportedDbtVersions } from '@lightdash/common';
-export declare const getDbtVersion: () => Promise<string>;
-export declare const getSupportedDbtVersion: () => Promise<SupportedDbtVersions | import("@lightdash/common").DbtVersionOptionLatest.LATEST>;
-export declare const isSupportedDbtVersion: (version: string) => boolean;
+import { DbtVersionOption } from '@lightdash/common';
+type DbtVersion = {
+    verboseVersion: string;
+    versionOption: DbtVersionOption;
+};
+export declare const getDbtVersion: () => Promise<DbtVersion>;
+export {};

package/dist/handlers/dbt/getDbtVersion.js

@@ -1,19 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSupportedDbtVersion = exports.getSupportedDbtVersion = exports.getDbtVersion = void 0;
+exports.getDbtVersion = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@lightdash/common");
 const execa_1 = tslib_1.__importDefault(require("execa"));
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const globalState_1 = tslib_1.__importDefault(require("../../globalState"));
 const styles = tslib_1.__importStar(require("../../styles"));
-const getDbtVersion = async () => {
+const DBT_CORE_VERSION_REGEX = /installed:.*/;
+const getDbtCLIVersion = async () => {
     try {
         const { all } = await (0, execa_1.default)('dbt', ['--version'], {
             all: true,
             stdio: ['pipe', 'pipe', 'pipe'],
         });
         const logs = all || '';
-        const coreVersionRegex = /installed:.*/;
-        const version = await logs.match(coreVersionRegex);
+        const version = logs.match(DBT_CORE_VERSION_REGEX);
         if (version === null || version.length === 0)
             throw new common_1.ParseError(`Can't locate dbt --version: ${logs}`);
         return version[0].split(':')[1].trim();
@@ -23,9 +25,7 @@ const getDbtVersion = async () => {
         throw new common_1.ParseError(`Failed to get dbt --version:\n  ${msg}`);
     }
 };
-exports.getDbtVersion = getDbtVersion;
-const getSupportedDbtVersion = async () => {
-    const version = await (0, exports.getDbtVersion)();
+const getSupportedDbtVersionOption = (version) => {
     if (version.startsWith('1.4.'))
         return common_1.SupportedDbtVersions.V1_4;
     if (version.startsWith('1.5.'))
@@ -38,20 +38,47 @@ const getSupportedDbtVersion = async () => {
         return common_1.SupportedDbtVersions.V1_8;
     if (version.startsWith('1.9.'))
         return common_1.SupportedDbtVersions.V1_9;
-    console.error(styles.warning(`We don't currently support version ${version} on Lightdash, we'll be using ${common_1.DefaultSupportedDbtVersion} instead when dbt is refresh from the UI.`));
-    return common_1.DefaultSupportedDbtVersion;
+    // No supported version found
+    return null;
+};
+const getFallbackDbtVersionOption = (version) => {
+    if (version.startsWith('1.3.'))
+        return common_1.SupportedDbtVersions.V1_4; // legacy|deprecated support for dbt 1.3
+    return (0, common_1.getLatestSupportDbtVersion)();
 };
-exports.getSupportedDbtVersion = getSupportedDbtVersion;
-const isSupportedDbtVersion = (version) => {
-    const supportedVersions = [
-        '1.3.',
-        '1.4.',
-        '1.5.',
-        '1.6.',
-        '1.7',
-        '1.8',
-        '1.9',
-    ];
-    return supportedVersions.some((supportedVersion) => version.startsWith(supportedVersion));
+const getDbtVersion = async () => {
+    const verboseVersion = await getDbtCLIVersion();
+    const supportedVersionOption = getSupportedDbtVersionOption(verboseVersion);
+    const fallbackVersionOption = getFallbackDbtVersionOption(verboseVersion);
+    const isSupported = !!supportedVersionOption;
+    if (!isSupported &&
+        !globalState_1.default.getSavedPromptAnswer('useFallbackDbtVersion')) {
+        const versions = Object.values(common_1.SupportedDbtVersions);
+        const supportedVersionsRangeMessage = `${versions[0]}.* - ${versions[versions.length - 1]}.*`;
+        const message = `We don't currently support version ${verboseVersion} on Lightdash. We'll interpret it as version ${fallbackVersionOption} instead, which might cause unexpected errors or behavior. For the best experience, please use a supported version (${supportedVersionsRangeMessage}).`;
+        const spinner = globalState_1.default.getActiveSpinner();
+        spinner?.stop();
+        if (process.env.CI === 'true') {
+            console.error(styles.warning(message));
+        }
+        else {
+            const answers = await inquirer_1.default.prompt([
+                {
+                    type: 'confirm',
+                    name: 'isConfirm',
+                    message: `${styles.warning(message)}\nDo you still want to continue?`,
+                },
+            ]);
+            if (!answers.isConfirm) {
+                throw new Error(`Unsupported dbt version ${verboseVersion}. Please consider using a supported version (${supportedVersionsRangeMessage}).`);
+            }
+        }
+        spinner?.start();
+        globalState_1.default.savePromptAnswer('useFallbackDbtVersion', true);
+    }
+    return {
+        verboseVersion,
+        versionOption: supportedVersionOption ?? fallbackVersionOption,
+    };
 };
-exports.isSupportedDbtVersion = isSupportedDbtVersion;
+exports.getDbtVersion = getDbtVersion;

package/dist/handlers/dbt/getDbtVersion.mocks.d.ts

@@ -0,0 +1,8 @@
+import { ExecaError, ExecaReturnValue } from 'execa';
+export declare const cliMocks: {
+    dbt1_3: Partial<ExecaReturnValue<string>>;
+    dbt1_4: Partial<ExecaReturnValue<string>>;
+    dbt1_9: Partial<ExecaReturnValue<string>>;
+    dbt20_1: Partial<ExecaReturnValue<string>>;
+    error: Partial<ExecaError<string>>;
+};

package/dist/handlers/dbt/getDbtVersion.mocks.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cliMocks = void 0;
+exports.cliMocks = {
+    dbt1_3: {
+        all: 'Core:\n' +
+            '  - installed: 1.3.0\n' +
+            '  - latest:    1.9.1 - Update available!\n',
+    },
+    dbt1_4: {
+        all: 'Core:\n' +
+            '  - installed: 1.4.9\n' +
+            '  - latest:    1.9.1 - Update available!\n' +
+            '\n' +
+            '  Your version of dbt-core is out of date!\n' +
+            '  You can find instructions for upgrading here:\n' +
+            '  https://docs.getdbt.com/docs/installation\n' +
+            '\n' +
+            'Plugins:\n' +
+            '  - trino:      1.4.2 - Update available!\n' +
+            '  - databricks: 1.4.3 - Update available!\n' +
+            '  - redshift:   1.4.1 - Update available!\n' +
+            '  - spark:      1.4.3 - Update available!\n' +
+            '  - bigquery:   1.4.5 - Update available!\n' +
+            '  - snowflake:  1.4.5 - Update available!\n' +
+            '  - postgres:   1.4.9 - Update available!\n' +
+            '\n' +
+            '  At least one plugin is out of date or incompatible with dbt-core.\n' +
+            '  You can find instructions for upgrading here:\n' +
+            '  https://docs.getdbt.com/docs/installation\n',
+    },
+    dbt1_9: {
+        all: 'Core:\n' +
+            '  - installed: 1.9.1\n' +
+            '  - latest:    1.9.1 - Up to date!\n' +
+            '\n' +
+            'Plugins:\n' +
+            '  - databricks: 1.9.1 - Up to date!\n' +
+            '  - redshift:   1.9.0 - Up to date!\n' +
+            '  - spark:      1.9.0 - Up to date!\n' +
+            '  - bigquery:   1.9.0 - Up to date!\n' +
+            '  - snowflake:  1.9.0 - Up to date!\n' +
+            '  - postgres:   1.9.0 - Up to date!\n',
+    },
+    dbt20_1: {
+        all: 'Core:\n' +
+            '  - installed: 20.1.0\n' +
+            '  - latest:    20.2.0 - Update available!\n',
+    },
+    error: {
+        shortMessage: 'error message',
+        all: 'all error messages',
+    },
+};

package/dist/handlers/dbt/getDbtVersion.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/handlers/dbt/getDbtVersion.test.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const execa_1 = tslib_1.__importDefault(require("execa"));
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const globalState_1 = tslib_1.__importDefault(require("../../globalState"));
+const getDbtVersion_1 = require("./getDbtVersion");
+const getDbtVersion_mocks_1 = require("./getDbtVersion.mocks");
+jest.mock('execa');
+const execaMock = execa_1.default;
+jest.mock('inquirer', () => ({
+    prompt: jest.fn(),
+}));
+const promptMock = inquirer_1.default.prompt;
+const consoleError = jest.spyOn(console, 'error').mockImplementation(() => { });
+describe('Get dbt version', () => {
+    const { env } = process;
+    beforeEach(() => {
+        jest.resetAllMocks();
+        jest.resetModules();
+        process.env = { ...env };
+        execaMock.mockImplementation(async () => getDbtVersion_mocks_1.cliMocks.dbt1_4);
+        promptMock.mockImplementation(async () => ({ isConfirm: true }));
+        globalState_1.default.clearPromptAnswer();
+    });
+    afterEach(() => {
+        process.env = env;
+    });
+    describe('getDbtVersion', () => {
+        test('should return error if dbt cli is not installed', async () => {
+            execaMock.mockImplementation(async () => getDbtVersion_mocks_1.cliMocks.error);
+            await expect((0, getDbtVersion_1.getDbtVersion)()).rejects.toThrowError();
+        });
+        test('should return supported dbt versions', async () => {
+            // Test for 1.4
+            const version = await (0, getDbtVersion_1.getDbtVersion)();
+            expect(version.verboseVersion).toEqual('1.4.9');
+            expect(version.versionOption).toEqual(common_1.SupportedDbtVersions.V1_4);
+            // Test for 1.9
+            execaMock.mockImplementation(async () => getDbtVersion_mocks_1.cliMocks.dbt1_9);
+            const version2 = await (0, getDbtVersion_1.getDbtVersion)();
+            expect(version2.verboseVersion).toEqual('1.9.1');
+            expect(version2.versionOption).toEqual(common_1.SupportedDbtVersions.V1_9);
+        });
+        test('when CI=true, should warn user about unsupported version and return fallback', async () => {
+            process.env.CI = 'true';
+            // Test for 1.3
+            execaMock.mockImplementation(async () => getDbtVersion_mocks_1.cliMocks.dbt1_3);
+            const version = await (0, getDbtVersion_1.getDbtVersion)();
+            expect(version.verboseVersion).toEqual('1.3.0');
+            expect(version.versionOption).toEqual(common_1.SupportedDbtVersions.V1_4);
+            expect(consoleError).toHaveBeenCalledTimes(1);
+            expect(consoleError).nthCalledWith(1, expect.stringContaining("We don't currently support version 1.3.0"));
+            // Clear saved prompt answer
+            globalState_1.default.clearPromptAnswer();
+            // Test for future version
+            execaMock.mockImplementation(async () => getDbtVersion_mocks_1.cliMocks.dbt20_1);
+            const version2 = await (0, getDbtVersion_1.getDbtVersion)();
+            expect(version2.verboseVersion).toEqual('20.1.0');
+            expect(version2.versionOption).toEqual((0, common_1.getLatestSupportDbtVersion)());
+            expect(consoleError).toHaveBeenCalledTimes(2);
+            expect(consoleError).nthCalledWith(2, expect.stringContaining("We don't currently support version 20.1.0"));
+        });
+        test('when CI=false, should return fallback version if user confirms', async () => {
+            process.env.CI = 'false';
+            execaMock.mockImplementation(async () => getDbtVersion_mocks_1.cliMocks.dbt1_3);
+            const version = await (0, getDbtVersion_1.getDbtVersion)();
+            expect(version.verboseVersion).toEqual('1.3.0');
+            expect(version.versionOption).toEqual(common_1.SupportedDbtVersions.V1_4);
+            expect(promptMock).toHaveBeenCalledTimes(1);
+            expect(consoleError).toHaveBeenCalledTimes(0);
+        });
+        test('when CI=false, should return error if user declines fallback', async () => {
+            process.env.CI = 'false';
+            execaMock.mockImplementation(async () => getDbtVersion_mocks_1.cliMocks.dbt1_3);
+            promptMock.mockImplementation(async () => ({ isConfirm: false }));
+            await expect((0, getDbtVersion_1.getDbtVersion)()).rejects.toThrowError();
+            expect(promptMock).toHaveBeenCalledTimes(1);
+            expect(consoleError).toHaveBeenCalledTimes(0);
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lightdash/cli",
-    "version": "0.1440.4",
+    "version": "0.1440.5",
     "license": "MIT",
     "bin": {
         "lightdash": "dist/index.js"
@@ -11,8 +11,8 @@
     ],
     "dependencies": {
         "@actions/core": "^1.11.1",
-        "@lightdash/common": "^0.1440.4",
-        "@lightdash/warehouses": "^0.1440.4",
+        "@lightdash/common": "^0.1440.5",
+        "@lightdash/warehouses": "^0.1440.5",
         "@types/columnify": "^1.5.1",
         "ajv": "^8.11.0",
         "ajv-formats": "^2.1.1",