@claryai/cli 0.1.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/handlers/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,OAAO,EACP,YAAY,EAOZ,kBAAkB,EAGlB,gBAAgB,EACnB,MAAM,mBAAmB,CAAC;AAO3B,OAAO,EAAW,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAG3D,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,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;CAC3C,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAAU,SAAS,MAAM,KAAG,OAAO,CAAC,MAAM,CAYvE,CAAC;AAEF,eAAO,MAAM,eAAe,GAAU,SAAS,sBAAsB,kBAyOpE,CAAC"}

package/dist/handlers/validate.js

@@ -0,0 +1,201 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateHandler = exports.waitUntilFinished = exports.getValidation = exports.getJobState = exports.requestValidation = void 0;
+exports.delay = delay;
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const columnify_1 = tslib_1.__importDefault(require("columnify"));
+const uuid_1 = require("uuid");
+const analytics_1 = require("../analytics/analytics");
+const config_1 = require("../config");
+const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const styles = tslib_1.__importStar(require("../styles"));
+const compile_1 = require("./compile");
+const apiClient_1 = require("./dbt/apiClient");
+const requestValidation = async (projectUuid, explores, validationTargets) => (0, apiClient_1.lightdashApi)({
+    method: 'POST',
+    url: `/api/v1/projects/${projectUuid}/validate`,
+    body: JSON.stringify({ explores, validationTargets }),
+});
+exports.requestValidation = requestValidation;
+const getJobState = async (jobUuid) => (0, apiClient_1.lightdashApi)({
+    method: 'GET',
+    url: `/api/v1/schedulers/job/${jobUuid}/status`,
+    body: undefined,
+});
+exports.getJobState = getJobState;
+const getValidation = async (projectUuid, jobId) => (0, apiClient_1.lightdashApi)({
+    method: 'GET',
+    url: `/api/v1/projects/${projectUuid}/validate?jobId=${jobId}`,
+    body: undefined,
+});
+exports.getValidation = getValidation;
+function delay(ms) {
+    return new Promise((resolve) => {
+        setTimeout(resolve, ms);
+    });
+}
+function styleTotalErrors(total) {
+    if (total > 0) {
+        return styles.error(`${styles.bold(total)} errors`);
+    }
+    return styles.success(`${styles.bold(total)} errors`);
+}
+const REFETCH_JOB_INTERVAL = 3000;
+const waitUntilFinished = async (jobUuid) => {
+    const job = await (0, exports.getJobState)(jobUuid);
+    if (job.status === common_1.SchedulerJobStatus.COMPLETED) {
+        return job.status;
+    }
+    if (job.status === common_1.SchedulerJobStatus.ERROR) {
+        throw new common_1.UnexpectedServerError(`\nValidation failed: ${job.details?.error || 'unknown error'}`);
+    }
+    return delay(REFETCH_JOB_INTERVAL).then(() => (0, exports.waitUntilFinished)(jobUuid));
+};
+exports.waitUntilFinished = waitUntilFinished;
+const validateHandler = async (options) => {
+    globalState_1.default.setVerbose(options.verbose);
+    await (0, apiClient_1.checkLightdashVersion)();
+    const executionId = (0, uuid_1.v4)();
+    const startTime = Date.now();
+    const config = await (0, config_1.getConfig)();
+    // Log current project info
+    globalState_1.default.logProjectInfo(config);
+    const selectedProject = options.preview
+        ? config.context?.previewProject
+        : config.context?.project;
+    const projectUuid = options.project || selectedProject;
+    if (projectUuid === undefined) {
+        throw new common_1.ParameterError(`No project specified, select a project to validate using ${styles.bold(`--project <projectUuid>`)} or create a preview environment using ${styles.bold(`clary start-preview`)} or configure your default project using ${styles.bold(`clary config set-project`)}`);
+    }
+    const isPreview = projectUuid === config.context?.previewProject;
+    if (isPreview) {
+        console.error(`Validating preview project ${styles.bold(config.context?.previewName)}\n`);
+    }
+    else if (projectUuid === config.context?.project) {
+        console.error(`Validating default project ${styles.bold(config.context?.projectName || projectUuid)}\n`);
+    }
+    else {
+        console.error(`Validating project ${projectUuid}\n`);
+    }
+    const validationTargets = options.only ? options.only : [];
+    await analytics_1.LightdashAnalytics.track({
+        event: 'validate.started',
+        properties: {
+            executionId,
+            projectId: projectUuid,
+            isPreview,
+            validationTargets,
+        },
+    });
+    let shouldExitWithError = false;
+    try {
+        const explores = await (0, compile_1.compile)(options);
+        globalState_1.default.debug(`> Compiled ${explores.length} explores`);
+        const validationJob = await (0, exports.requestValidation)(projectUuid, explores, validationTargets);
+        const { jobId } = validationJob;
+        const spinner = globalState_1.default.startSpinner(`  Waiting for validation to finish`);
+        await (0, exports.waitUntilFinished)(jobId);
+        const allValidation = await (0, exports.getValidation)(projectUuid, jobId);
+        // Filter out chart configuration warnings unless explicitly requested
+        const validation = options.showChartConfigurationWarnings
+            ? allValidation
+            : allValidation.filter((v) => !(0, common_1.isChartValidationError)(v) ||
+                v.errorType !== common_1.ValidationErrorType.ChartConfiguration);
+        const hiddenWarningsCount = allValidation.length - validation.length;
+        const tableErrors = validation.filter(common_1.isTableValidationError);
+        const chartErrors = validation.filter(common_1.isChartValidationError);
+        const dashboardErrors = validation.filter(common_1.isDashboardValidationError);
+        await analytics_1.LightdashAnalytics.track({
+            event: 'validate.completed',
+            properties: {
+                executionId,
+                projectId: projectUuid,
+                isPreview,
+                validationTargets,
+                durationMs: Date.now() - startTime,
+                success: validation.length === 0,
+                totalErrors: validation.length,
+                tableErrors: tableErrors.length,
+                chartErrors: chartErrors.length,
+                dashboardErrors: dashboardErrors.length,
+            },
+        });
+        if (validation.length === 0) {
+            const elapsedMs = Date.now() - startTime;
+            const hiddenMessage = hiddenWarningsCount > 0
+                ? ` (${hiddenWarningsCount} chart configuration warning${hiddenWarningsCount > 1 ? 's' : ''} hidden, use --show-chart-configuration-warnings to show)`
+                : '';
+            spinner?.succeed(`  Validation finished without errors in ${Math.trunc(elapsedMs / 1000)}s${hiddenMessage}`);
+        }
+        else {
+            const elapsedMs = Date.now() - startTime;
+            spinner?.fail(`  Validation finished in ${Math.trunc(elapsedMs / 1000)}s with ${validation.length} errors`);
+            const validationTargetsSet = new Set(validationTargets);
+            const hasValidationTargets = validationTargetsSet.size > 0;
+            console.error('\n');
+            if (!hasValidationTargets ||
+                validationTargetsSet.has(common_1.ValidationTarget.TABLES)) {
+                console.error(`- Tables: ${styleTotalErrors(tableErrors.length)}`);
+            }
+            if (!hasValidationTargets ||
+                validationTargetsSet.has(common_1.ValidationTarget.CHARTS)) {
+                console.error(`- Charts: ${styleTotalErrors(chartErrors.length)}`);
+            }
+            if (!hasValidationTargets ||
+                validationTargetsSet.has(common_1.ValidationTarget.DASHBOARDS)) {
+                console.error(`- Dashboards: ${styleTotalErrors(dashboardErrors.length)}`);
+            }
+            console.error('\n');
+            const validationOutput = validation.map((v) => ({
+                name: styles.error(v.name),
+                error: styles.warning((0, common_1.isChartValidationError)(v) &&
+                    v.errorType ===
+                        common_1.ValidationErrorType.ChartConfiguration &&
+                    v.fieldName
+                    ? `Chart configuration warning: '${v.fieldName}' - ${v.error}`
+                    : v.error),
+                'last updated by': (0, common_1.isChartValidationError)(v) || (0, common_1.isDashboardValidationError)(v)
+                    ? styles.secondary(v.lastUpdatedBy)
+                    : '',
+                'last updated at': (0, common_1.isChartValidationError)(v) || (0, common_1.isDashboardValidationError)(v)
+                    ? styles.secondary((0, common_1.formatDate)(v.lastUpdatedAt))
+                    : '',
+            }));
+            const columns = (0, columnify_1.default)(validationOutput, {
+                columns: [
+                    'name',
+                    'last updated by',
+                    'last updated at',
+                    'error',
+                ],
+                config: {
+                    'last updated at': {
+                        align: 'center',
+                    },
+                },
+            });
+            console.error(columns);
+            console.error(`\n--> To see these errors in Clary, run ${styles.bold(`clary preview`)}`);
+            if (hiddenWarningsCount > 0) {
+                console.error(`\n${styles.secondary(`Note: ${hiddenWarningsCount} chart configuration warning${hiddenWarningsCount > 1 ? 's' : ''} hidden. Use --show-chart-configuration-warnings to show.`)}`);
+            }
+            shouldExitWithError = true;
+        }
+    }
+    catch (e) {
+        await analytics_1.LightdashAnalytics.track({
+            event: 'validate.error',
+            properties: {
+                executionId,
+                error: (0, common_1.getErrorMessage)(e),
+                errorCategory: (0, analytics_1.categorizeError)(e),
+            },
+        });
+        throw e;
+    }
+    if (shouldExitWithError) {
+        process.exit(1);
+    }
+};
+exports.validateHandler = validateHandler;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

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