@lightdash/cli 0.3456.0 → 0.3457.0

package/dist/handlers/validate.d.ts

@@ -15,6 +15,7 @@ type ValidateHandlerOptions = CompileHandlerOptions & {
     verbose: boolean;
     preview: boolean;
     only: ValidationTarget[];
+    validateWarehouseColumns: boolean;
     showChartConfigurationWarnings: boolean;
     includeSpaces?: string[];
     excludeSpaces?: string[];

package/dist/handlers/validate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/handlers/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAKH,OAAO,EACP,YAAY,EAOZ,kBAAkB,EAGlB,gBAAgB,EACnB,MAAM,mBAAmB,CAAC;AAO3B,OAAO,EAAW,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAS3D,eAAO,MAAM,iBAAiB,GAC1B,aAAa,MAAM,EACnB,UAAU,CAAC,OAAO,GAAG,YAAY,CAAC,EAAE,EACpC,mBAAmB,gBAAgB,EAAE;;EAMnC,CAAC;AAEP,eAAO,MAAM,WAAW,GAAU,SAAS,MAAM;;;EAK3C,CAAC;AAEP,eAAO,MAAM,aAAa,GAAU,aAAa,MAAM,EAAE,OAAO,MAAM,8DAKhE,CAAC;AAEP,eAAO,MAAM,gBAAgB,GAAU,aAAa,MAAM,wDAKpD,CAAC;AAEP,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,oBAI/B;AAWD,KAAK,sBAAsB,GAAG,qBAAqB,GAAG;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,gBAAgB,EAAE,CAAC;IACzB,8BAA8B,EAAE,OAAO,CAAC;IACxC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAAU,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAYvE,CAAC;AAEF,eAAO,MAAM,eAAe,GACxB,iBAAiB,sBAAsB,kBA2S1C,CAAC"}
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/handlers/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAKH,OAAO,EACP,YAAY,EAOZ,kBAAkB,EAGlB,gBAAgB,EACnB,MAAM,mBAAmB,CAAC;AAO3B,OAAO,EAAW,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAS3D,eAAO,MAAM,iBAAiB,GAC1B,aAAa,MAAM,EACnB,UAAU,CAAC,OAAO,GAAG,YAAY,CAAC,EAAE,EACpC,mBAAmB,gBAAgB,EAAE;;EAMnC,CAAC;AAEP,eAAO,MAAM,WAAW,GAAU,SAAS,MAAM;;;EAK3C,CAAC;AAEP,eAAO,MAAM,aAAa,GAAU,aAAa,MAAM,EAAE,OAAO,MAAM,8DAKhE,CAAC;AAEP,eAAO,MAAM,gBAAgB,GAAU,aAAa,MAAM,wDAKpD,CAAC;AAEP,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,oBAI/B;AAWD,KAAK,sBAAsB,GAAG,qBAAqB,GAAG;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,gBAAgB,EAAE,CAAC;IACzB,wBAAwB,EAAE,OAAO,CAAC;IAClC,8BAA8B,EAAE,OAAO,CAAC;IACxC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAAU,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAYvE,CAAC;AAEF,eAAO,MAAM,eAAe,GACxB,iBAAiB,sBAAsB,kBA2T1C,CAAC"}

package/dist/handlers/validate.js

@@ -100,6 +100,7 @@ const validateHandler = async (originalOptions) => {
             projectId: projectUuid,
             isPreview,
             validationTargets,
+            validateWarehouseColumns: options.validateWarehouseColumns,
             includedSpacesCount: options.includeSpaces?.length ?? 0,
             excludedSpacesCount: options.excludeSpaces?.length ?? 0,
         },
@@ -117,7 +118,15 @@ const validateHandler = async (originalOptions) => {
                 selectedSpaceUuids: (0, validateSpaceFilter_1.resolveSpaceSelection)(spaces, spaceFilterSlugs),
             };
         }
-        const explores = await (0, compile_1.compile)(options);
+        const includesTableValidation = validationTargets.length === 0 ||
+            validationTargets.includes(common_1.ValidationTarget.TABLES);
+        if (options.validateWarehouseColumns && !includesTableValidation) {
+            console.error(styles.warning('> Skipping warehouse column validation because --only does not include the tables validation target'));
+        }
+        const explores = await (0, compile_1.compile)({
+            ...options,
+            validateWarehouseColumns: options.validateWarehouseColumns && includesTableValidation,
+        });
         globalState_1.default.debug(`> Compiled ${explores.length} explores`);
         const validationJob = await (0, exports.requestValidation)(projectUuid, explores, validationTargets);
         const { jobId } = validationJob;
@@ -148,6 +157,7 @@ const validateHandler = async (originalOptions) => {
                 projectId: projectUuid,
                 isPreview,
                 validationTargets,
+                validateWarehouseColumns: options.validateWarehouseColumns,
                 includedSpacesCount: options.includeSpaces?.length ?? 0,
                 excludedSpacesCount: options.excludeSpaces?.length ?? 0,
                 durationMs: Date.now() - startTime,

package/dist/handlers/validate.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=validate.test.d.ts.map

package/dist/handlers/validate.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.test.d.ts","sourceRoot":"","sources":["../../src/handlers/validate.test.ts"],"names":[],"mappings":""}

package/dist/handlers/validate.test.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("@lightdash/common");
+const compile_1 = require("./compile");
+const apiClient_1 = require("./dbt/apiClient");
+const validate_1 = require("./validate");
+vi.mock('../analytics/analytics');
+vi.mock('../config', () => ({
+    getConfig: vi.fn().mockResolvedValue({ user: null, context: null }),
+}));
+vi.mock('./compile');
+vi.mock('./dbt/apiClient');
+vi.mock('./timestampConversion');
+const baseOptions = {
+    project: 'test-project-uuid',
+    preview: false,
+    only: Object.values(common_1.ValidationTarget),
+    validateWarehouseColumns: false,
+    showChartConfigurationWarnings: false,
+    projectDir: '.',
+    profilesDir: '.',
+    target: undefined,
+    profile: undefined,
+    vars: undefined,
+    verbose: false,
+    startOfWeek: 0,
+    skipWarehouseCatalog: undefined,
+    skipDbtCompile: true,
+    useDbtList: false,
+    select: undefined,
+    models: undefined,
+    threads: undefined,
+    noVersionCheck: false,
+    exclude: undefined,
+    selector: undefined,
+    state: undefined,
+    fullRefresh: false,
+    defer: false,
+    targetPath: undefined,
+    favorState: false,
+    combineManifest: undefined,
+    warehouseCredentials: false,
+    disableTimestampConversion: false,
+};
+const TARGET_SKIP_WARNING = 'Skipping warehouse column validation because --only does not include the tables validation target';
+describe('validateHandler warehouse column validation', () => {
+    let errorOutput;
+    const skipWarnings = () => errorOutput.filter((line) => line.includes('Skipping warehouse column validation'));
+    beforeEach(() => {
+        vi.clearAllMocks();
+        vi.mocked(apiClient_1.checkLightdashVersion).mockResolvedValue(undefined);
+        vi.mocked(compile_1.compile).mockResolvedValue([]);
+        vi.mocked(apiClient_1.lightdashApi).mockImplementation(async ({ method, url }) => {
+            if (method === 'POST' && url.endsWith('/validate')) {
+                return { jobId: 'test-job-id' };
+            }
+            if (url.includes('/schedulers/job/')) {
+                return { status: common_1.SchedulerJobStatus.COMPLETED, details: null };
+            }
+            if (url.includes('/validate?jobId=')) {
+                return [];
+            }
+            throw new Error(`Unexpected API call: ${method} ${url}`);
+        });
+        errorOutput = [];
+        vi.spyOn(console, 'error').mockImplementation((...args) => {
+            errorOutput.push(args.map(String).join(' '));
+        });
+    });
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+    test('does not request warehouse column validation by default', async () => {
+        await (0, validate_1.validateHandler)({ ...baseOptions });
+        expect(compile_1.compile).toHaveBeenCalledTimes(1);
+        expect(compile_1.compile).toHaveBeenCalledWith(expect.objectContaining({ validateWarehouseColumns: false }));
+        expect(skipWarnings()).toEqual([]);
+    });
+    test('requests warehouse column validation when the flag is set and every target is validated', async () => {
+        await (0, validate_1.validateHandler)({
+            ...baseOptions,
+            validateWarehouseColumns: true,
+        });
+        expect(compile_1.compile).toHaveBeenCalledWith(expect.objectContaining({ validateWarehouseColumns: true }));
+        expect(skipWarnings()).toEqual([]);
+    });
+    test('requests warehouse column validation when the flag is set and only tables are validated', async () => {
+        await (0, validate_1.validateHandler)({
+            ...baseOptions,
+            only: [common_1.ValidationTarget.TABLES],
+            validateWarehouseColumns: true,
+        });
+        expect(compile_1.compile).toHaveBeenCalledWith(expect.objectContaining({ validateWarehouseColumns: true }));
+        expect(skipWarnings()).toEqual([]);
+    });
+    test('requests warehouse column validation when the flag is set and a mixed target list includes tables', async () => {
+        await (0, validate_1.validateHandler)({
+            ...baseOptions,
+            only: [common_1.ValidationTarget.TABLES, common_1.ValidationTarget.CHARTS],
+            validateWarehouseColumns: true,
+        });
+        expect(compile_1.compile).toHaveBeenCalledWith(expect.objectContaining({ validateWarehouseColumns: true }));
+        expect(skipWarnings()).toEqual([]);
+    });
+    test('does not request warehouse column validation when tables are not validated', async () => {
+        await (0, validate_1.validateHandler)({
+            ...baseOptions,
+            only: [common_1.ValidationTarget.CHARTS, common_1.ValidationTarget.DASHBOARDS],
+            validateWarehouseColumns: true,
+        });
+        expect(compile_1.compile).toHaveBeenCalledWith(expect.objectContaining({ validateWarehouseColumns: false }));
+        const warnings = skipWarnings();
+        expect(warnings).toHaveLength(1);
+        expect(warnings[0]).toContain(TARGET_SKIP_WARNING);
+    });
+    test('warns exactly once when the flag is set and only charts are validated', async () => {
+        await (0, validate_1.validateHandler)({
+            ...baseOptions,
+            only: [common_1.ValidationTarget.CHARTS],
+            validateWarehouseColumns: true,
+        });
+        expect(compile_1.compile).toHaveBeenCalledWith(expect.objectContaining({ validateWarehouseColumns: false }));
+        const warnings = skipWarnings();
+        expect(warnings).toHaveLength(1);
+        expect(warnings[0]).toContain(TARGET_SKIP_WARNING);
+    });
+    test('does not warn when only charts are validated without the flag', async () => {
+        await (0, validate_1.validateHandler)({
+            ...baseOptions,
+            only: [common_1.ValidationTarget.CHARTS],
+            validateWarehouseColumns: false,
+        });
+        expect(compile_1.compile).toHaveBeenCalledWith(expect.objectContaining({ validateWarehouseColumns: false }));
+        expect(skipWarnings()).toEqual([]);
+    });
+});

package/dist/index.js

@@ -481,6 +481,7 @@ commander_1.program
     .addOption(new commander_1.Option('--only <elems...>', 'Specify project elements to validate')
     .choices(Object.values(common_1.ValidationTarget))
     .default(Object.values(common_1.ValidationTarget)))
+    .option('--validate-warehouse-columns', `Check physical \${TABLE}.column references in dimensions and metrics by executing zero-row queries against the warehouse. Requires warehouse credentials and only applies when tables are validated.`, false)
     .option('--include-spaces <spaceSlugs...>', 'Only report validation errors for charts and dashboards in these spaces (and their sub-spaces). Spaces must be visible to your credentials')
     .option('--exclude-spaces <spaceSlugs...>', 'Skip validation errors for charts and dashboards in these spaces (and their sub-spaces). Spaces must be visible to your credentials')
     .action(validate_1.validateHandler);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "0.3456.0",
+  "version": "0.3457.0",
   "description": "Lightdash CLI tool",
   "license": "MIT",
   "repository": {
@@ -41,8 +41,8 @@
     "unique-names-generator": "4.7.1",
     "uuid": "11.1.1",
     "yaml": "2.8.3",
-    "@lightdash/common": "0.3456.0",
-    "@lightdash/warehouses": "0.3456.0"
+    "@lightdash/common": "0.3457.0",
+    "@lightdash/warehouses": "0.3457.0"
   },
   "devDependencies": {
     "@types/inquirer": "8.2.4",