@lightdash/cli 0.1621.2 → 0.1622.0

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

@@ -1,4 +1,5 @@
-import { JobStep } from '@lightdash/common';
+import { JobStep, Project } from '@lightdash/common';
+export declare const getProject: (projectUuid: string) => Promise<Project>;
 export declare const getRunningStepsMessage: (steps: JobStep[]) => string;
 export declare const getErrorStepsMessage: (steps: JobStep[]) => string;
 type RefreshHandlerOptions = {

package/dist/handlers/dbt/refresh.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.refreshHandler = exports.getErrorStepsMessage = exports.getRunningStepsMessage = void 0;
+exports.refreshHandler = exports.getErrorStepsMessage = exports.getRunningStepsMessage = exports.getProject = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@lightdash/common");
 const uuid_1 = require("uuid");
@@ -14,6 +14,7 @@ const getProject = async (projectUuid) => (0, apiClient_1.lightdashApi)({
     url: `/api/v1/projects/${projectUuid}`,
     body: undefined,
 });
+exports.getProject = getProject;
 const refreshProject = async (projectUuid) => (0, apiClient_1.lightdashApi)({
     method: 'POST',
     url: `/api/v1/projects/${projectUuid}/refresh`,
@@ -63,7 +64,7 @@ const refreshHandler = async (options) => {
         throw new common_1.AuthorizationError(`No active Lightdash project. Run 'lightdash login --help'`);
     }
     const projectUuid = config.context.project;
-    const project = await getProject(projectUuid);
+    const project = await (0, exports.getProject)(projectUuid);
     if (project.dbtConnection.type === common_1.DbtProjectType.NONE) {
         throw new common_1.ParameterError('Lightdash project must be connected to a remote repository. eg: GitHub, Gitlab, etc');
     }

package/dist/handlers/renameHandler.d.ts

@@ -0,0 +1,15 @@
+import { RenameType } from '@lightdash/common';
+type RenameHandlerOptions = {
+    verbose: boolean;
+    type: RenameType;
+    project?: string;
+    model?: string;
+    from: string;
+    to: string;
+    dryRun: boolean;
+    assumeYes: boolean;
+    list: boolean;
+    validate: boolean;
+};
+export declare const renameHandler: (options: RenameHandlerOptions) => Promise<void>;
+export {};

package/dist/handlers/renameHandler.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renameHandler = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const styles = tslib_1.__importStar(require("../styles"));
+const config_1 = require("../config");
+const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const apiClient_1 = require("./dbt/apiClient");
+const refresh_1 = require("./dbt/refresh");
+const validate_1 = require("./validate");
+const REFETCH_JOB_INTERVAL = 2000;
+const waitUntilFinished = async (jobUuid) => {
+    const job = await (0, validate_1.getJobState)(jobUuid);
+    if (job.status === common_1.SchedulerJobStatus.COMPLETED) {
+        return job.status;
+    }
+    if (job.status === common_1.SchedulerJobStatus.ERROR) {
+        throw new Error(`\nRename failed: ${job.details?.error || 'unknown error'}`);
+    }
+    return (0, validate_1.delay)(REFETCH_JOB_INTERVAL).then(() => waitUntilFinished(jobUuid));
+};
+const listResources = (resources, type, list) => {
+    if (resources.length === 0)
+        return;
+    const maxList = 5;
+    const resourcesToShow = list ? resources : resources.slice(0, maxList);
+    console.info(`- ${resourcesToShow.map((r) => r.name).join('\n- ')}`);
+    if (!list && resources.length > maxList) {
+        console.info(`${styles.secondary(`...\nShowing ${maxList} of ${resources.length} ${type}, use --list to see all`)}`);
+    }
+};
+const renameHandler = async (options) => {
+    globalState_1.default.setVerbose(options.verbose);
+    await (0, apiClient_1.checkLightdashVersion)();
+    const config = await (0, config_1.getConfig)();
+    if (!config.context?.apiKey || !config.context.serverUrl) {
+        throw new common_1.AuthorizationError(`Not logged in. Run 'lightdash login --help'`);
+    }
+    const projectUuid = options.project ||
+        config.context.previewProject ||
+        config.context.project;
+    if (!projectUuid) {
+        throw new Error('No project selected. Run lightdash config set-project');
+    }
+    const isValidInput = (input) => /^[a-z_]+$/.test(input);
+    if (!isValidInput(options.from) || !isValidInput(options.to)) {
+        throw new Error('Invalid input: Only lowercase letters (a-z) and underscores (_) are allowed.');
+    }
+    const project = await (0, refresh_1.getProject)(projectUuid);
+    if (!options.assumeYes && !options.dryRun) {
+        const answers = await inquirer_1.default.prompt([
+            {
+                type: 'confirm',
+                name: 'isConfirm',
+                message: `This command will replace all ${styles.title(options.type)} occurrences from ${styles.title(options.from)} to ${styles.title(options.to)} in all charts and dashboards in project ${styles.title(project.name)} (${projectUuid}).\nAre you sure you want to continue? `,
+            },
+        ]);
+        if (!answers.isConfirm) {
+            console.info('Aborting rename');
+            return;
+        }
+    }
+    try {
+        const jobResponse = await (0, apiClient_1.lightdashApi)({
+            method: 'POST',
+            url: `/api/v1/projects/${projectUuid}/rename`,
+            body: JSON.stringify(options),
+        });
+        globalState_1.default.debug(`Rename job scheduled with id: ${jobResponse.jobId}`);
+        const status = await waitUntilFinished(jobResponse.jobId);
+        globalState_1.default.debug(`Rename job finished with status: ${status}`);
+        const job = await (0, validate_1.getJobState)(jobResponse.jobId);
+        const results = job.details?.results;
+        globalState_1.default.debug(`Updated results: ${JSON.stringify(results, null, 2)}`);
+        console.info(`${styles.bold('Total updated charts:')} ${results.charts.length}`);
+        listResources(results.charts, 'charts', options.list);
+        console.info(`${styles.bold('Total updated dashboards:')} ${results.dashboards.length}`);
+        listResources(results.dashboards, 'dashboards', options.list);
+        if (results.alerts.length > 0) {
+            console.info(`${styles.bold('Total updated alerts:')} ${results.alerts.length}`);
+            listResources(results.alerts, 'chart alerts', options.list);
+        }
+        if (results.dashboardSchedulers.length > 0) {
+            console.info(`${styles.bold('Total updated dashboard schedulers:')} ${results.dashboardSchedulers.length}`);
+            listResources(results.dashboardSchedulers, 'dashboard schedulers', options.list);
+        }
+        const hasResults = results.charts.length > 0 ||
+            results.dashboards.length > 0 ||
+            results.alerts.length > 0 ||
+            results.dashboardSchedulers.length > 0;
+        if (options.dryRun) {
+            console.info(`\n${styles.warning(`This is a test run, no changes were committed to the database, remove ${styles.bold('--dry-run')} flag to make changes`)}\n`);
+        }
+        else if (hasResults) {
+            const currentDate = new Date().toISOString().split('T')[0];
+            const filePath = path_1.default.join(__dirname, `rename ${options.from} to ${options.to} ${currentDate}.json`);
+            fs_1.default.writeFileSync(filePath, JSON.stringify(results, null, 2), 'utf-8');
+            console.info(`Rename changes saved to: ${styles.success(` ${filePath}`)}`);
+        }
+        if (options.validate && !options.dryRun) {
+            // Can't validate if tests is true, changes need to be committed first
+            const validationJob = await (0, validate_1.requestValidation)(projectUuid, [], []);
+            const { jobId } = validationJob;
+            await waitUntilFinished(jobId);
+            const validation = await (0, validate_1.getValidation)(projectUuid, jobId);
+            console.info(validation);
+        }
+    }
+    catch (e) {
+        // We lose the error type on the waitUntilFinished method
+        const errorString = `${e}`;
+        if (errorString.includes(`Rename failed`)) {
+            console.error(errorString);
+            if (errorString.includes('was found on multiple models'))
+                console.info(`Use argument ${styles.bold('--model')} to specify a model to filter on`);
+        }
+        else {
+            console.error('Unable to rename, unexpected error:', e);
+        }
+    }
+};
+exports.renameHandler = renameHandler;

package/dist/handlers/validate.d.ts

@@ -1,10 +1,20 @@
-import { ValidationTarget } from '@lightdash/common';
+import { Explore, ExploreError, SchedulerJobStatus, ValidationTarget } from '@lightdash/common';
 import { CompileHandlerOptions } from './compile';
+export declare const requestValidation: (projectUuid: string, explores: (Explore | ExploreError)[], validationTargets: ValidationTarget[]) => Promise<{
+    jobId: string;
+}>;
+export declare const getJobState: (jobUuid: string) => Promise<{
+    status: SchedulerJobStatus;
+    details: Record<string, import("@lightdash/common").AnyType> | null;
+}>;
+export declare const getValidation: (projectUuid: string, jobId: string) => Promise<import("@lightdash/common").ValidationResponse[]>;
+export declare function delay(ms: number): Promise<unknown>;
 type ValidateHandlerOptions = CompileHandlerOptions & {
     project?: string;
     verbose: boolean;
     preview: boolean;
     only: ValidationTarget[];
 };
+export declare const waitUntilFinished: (jobUuid: string) => Promise<string>;
 export declare const validateHandler: (options: ValidateHandlerOptions) => Promise<void>;
 export {};

package/dist/handlers/validate.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateHandler = void 0;
+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"));
@@ -14,16 +15,19 @@ const requestValidation = async (projectUuid, explores, validationTargets) => (0
     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);
@@ -31,15 +35,16 @@ function delay(ms) {
 }
 const REFETCH_JOB_INTERVAL = 3000;
 const waitUntilFinished = async (jobUuid) => {
-    const job = await getJobState(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(() => waitUntilFinished(jobUuid));
+    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)();
@@ -64,11 +69,11 @@ const validateHandler = async (options) => {
     }
     const timeStart = new Date();
     const validationTargets = options.only ? options.only : [];
-    const validationJob = await requestValidation(projectUuid, explores, validationTargets);
+    const validationJob = await (0, exports.requestValidation)(projectUuid, explores, validationTargets);
     const { jobId } = validationJob;
     const spinner = globalState_1.default.startSpinner(`  Waiting for validation to finish`);
-    await waitUntilFinished(jobId);
-    const validation = await getValidation(projectUuid, jobId);
+    await (0, exports.waitUntilFinished)(jobId);
+    const validation = await (0, exports.getValidation)(projectUuid, jobId);
     if (validation.length === 0) {
         spinner?.succeed(`  Validation finished without errors`);
     }

package/dist/index.js

@@ -15,6 +15,7 @@ const generate_1 = require("./handlers/generate");
 const generateExposures_1 = require("./handlers/generateExposures");
 const login_1 = require("./handlers/login");
 const preview_1 = require("./handlers/preview");
+const renameHandler_1 = require("./handlers/renameHandler");
 const setProject_1 = require("./handlers/setProject");
 const validate_1 = require("./handlers/validate");
 const styles = tslib_1.__importStar(require("./styles"));
@@ -314,6 +315,19 @@ ${styles.bold('Examples:')}
     .option('--exclude-meta', 'exclude Lightdash metadata from the generated .yml', false)
     .option('--verbose', undefined, false)
     .action(generate_1.generateHandler);
+commander_1.program
+    .command('rename')
+    .description('Rename models and fields on Lightdash content')
+    .option('--verbose', undefined, false)
+    .option('-p, --project <project uuid>', 'specify a project UUID to rename', parseProjectArgument, undefined)
+    .option('-m, --model <model>', 'When renaming a field, specify which model the field belongs to', undefined)
+    .option('-y, --assume-yes', 'assume yes to prompts', false)
+    .requiredOption('-t, --type <type>', 'model or field', common_1.RenameType.MODEL)
+    .requiredOption('--from <from>', 'Name to replace from', undefined)
+    .requiredOption('--to <to>', 'Name to replace to', undefined)
+    .option('--dry-run', 'Test the rename, no changes will be made', false)
+    .option('--list', 'List all charts and dashboards that are renamed', false)
+    .action(renameHandler_1.renameHandler);
 commander_1.program
     .command('generate-exposures')
     .description('[Experimental command] Generates a .yml file for Lightdash exposures')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "0.1621.2",
+  "version": "0.1622.0",
   "license": "MIT",
   "bin": {
     "lightdash": "dist/index.js"
@@ -30,8 +30,8 @@
     "parse-node-version": "^2.0.0",
     "unique-names-generator": "^4.7.1",
     "uuid": "^11.0.3",
-    "@lightdash/common": "0.1621.2",
-    "@lightdash/warehouses": "0.1621.2"
+    "@lightdash/common": "0.1622.0",
+    "@lightdash/warehouses": "0.1622.0"
   },
   "description": "Lightdash CLI tool",
   "devDependencies": {