@lightdash/cli 0.1421.0 → 0.1423.0

package/dist/analytics/analytics.d.ts

@@ -190,11 +190,39 @@ type CliLogin = BaseTrack & {
     event: 'login.started' | 'login.completed';
     properties: {
         userId?: string;
+        organizationId?: string;
         method: string;
         url: string;
     };
 };
-type Track = CliGenerateStarted | CliGenerateCompleted | CliGenerateError | CliDbtCommand | CliDbtError | CliPreviewStarted | CliPreviewCompleted | CliPreviewStopped | CliPreviewError | CliRefreshStarted | CliRefreshCompleted | CliRefreshError | CliCompileStarted | CliCompileCompleted | CliCompileError | CliDeployTriggered | CliCreateStarted | CliCreateCompleted | CliCreateError | CliStartStopPreview | CliStopPreviewMissing | CliGenerateExposuresStarted | CliGenerateExposuresCompleted | CliGenerateExposuresError | CliLogin;
+type CliContentAsCode = BaseTrack & ({
+    event: 'download.started' | 'upload.started';
+    properties: {
+        userId?: string;
+        organizationId?: string;
+        projectId: string;
+    };
+} | {
+    event: 'download.completed' | 'upload.completed';
+    properties: {
+        userId?: string;
+        organizationId?: string;
+        projectId: string;
+        chartsNum?: number;
+        dashboardsNum?: number;
+        timeToCompleted: number;
+    };
+} | {
+    event: 'download.error' | 'upload.error';
+    properties: {
+        userId?: string;
+        organizationId?: string;
+        projectId: string;
+        type?: 'charts' | 'dashboards';
+        error: string;
+    };
+});
+type Track = CliGenerateStarted | CliGenerateCompleted | CliGenerateError | CliDbtCommand | CliDbtError | CliPreviewStarted | CliPreviewCompleted | CliPreviewStopped | CliPreviewError | CliRefreshStarted | CliRefreshCompleted | CliRefreshError | CliCompileStarted | CliCompileCompleted | CliCompileError | CliDeployTriggered | CliCreateStarted | CliCreateCompleted | CliCreateError | CliStartStopPreview | CliStopPreviewMissing | CliGenerateExposuresStarted | CliGenerateExposuresCompleted | CliGenerateExposuresError | CliLogin | CliContentAsCode;
 export declare class LightdashAnalytics {
     static track(payload: Track): Promise<void>;
 }

package/dist/analytics/analytics.js

@@ -27,6 +27,7 @@ const identifyUser = async () => {
     return {
         anonymousUuid: config.user?.anonymousUuid,
         userUuid: config.user?.userUuid,
+        organizationUuid: config.user?.organizationUuid,
     };
 };
 class LightdashAnalytics {

package/dist/config.d.ts

@@ -3,6 +3,7 @@ export type Config = {
     user?: {
         userUuid?: string;
         anonymousUuid?: string;
+        organizationUuid?: string;
     };
     context?: {
         serverUrl?: string;
@@ -22,6 +23,6 @@ export declare const getConfig: () => Promise<Config>;
 export declare const setProject: (projectUuid: string, projectName: string) => Promise<void>;
 export declare const setPreviewProject: (projectUuid: string, name: string) => Promise<void>;
 export declare const unsetPreviewProject: () => Promise<void>;
-export declare const setDefaultUser: (userUuid: string) => Promise<void>;
+export declare const setDefaultUser: (userUuid: string, organizationUuid: string) => Promise<void>;
 export declare const setContext: (context: Config['context']) => Promise<void>;
 export declare const setAnswer: (answer: Config['answers']) => Promise<void>;

package/dist/config.js

@@ -93,13 +93,14 @@ const unsetPreviewProject = async () => {
     });
 };
 exports.unsetPreviewProject = unsetPreviewProject;
-const setDefaultUser = async (userUuid) => {
+const setDefaultUser = async (userUuid, organizationUuid) => {
     const config = await getRawConfig();
     await (0, exports.setConfig)({
         ...config,
         user: {
             ...(config.user || {}),
             userUuid,
+            organizationUuid,
         },
     });
 };

package/dist/handlers/download.js

@@ -8,6 +8,7 @@ const common_1 = require("@lightdash/common");
 const fs_1 = require("fs");
 const yaml = tslib_1.__importStar(require("js-yaml"));
 const path = tslib_1.__importStar(require("path"));
+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"));
@@ -95,64 +96,104 @@ const downloadHandler = async (options) => {
     if (!projectId) {
         throw new Error('No project selected. Run lightdash config set-project');
     }
-    // If any filter is provided, we skip those items without filters
-    // eg: if a --charts filter is provided, we skip dashboards if no --dashboards filter is provided
-    const hasFilters = options.charts.length > 0 || options.dashboards.length > 0;
-    // Download charts
-    if (hasFilters && options.charts.length === 0) {
-        console.info(styles.warning(`No charts filters provided, skipping`));
-    }
-    else {
-        const spinner = globalState_1.default.startSpinner(`Downloading charts`);
-        const chartFilters = parseContentFilters(options.charts);
-        let chartsAsCode;
-        let offset = 0;
-        do {
-            globalState_1.default.debug(`Downloading charts with offset "${offset}" and filters "${chartFilters}"`);
-            const queryParams = chartFilters
-                ? `${chartFilters}&offset=${offset}`
-                : `?offset=${offset}`;
-            chartsAsCode = await (0, apiClient_1.lightdashApi)({
-                method: 'GET',
-                url: `/api/v1/projects/${projectId}/charts/code${queryParams}`,
-                body: undefined,
-            });
-            spinner.start(`Downloaded ${chartsAsCode.offset} of ${chartsAsCode.total} charts`);
-            chartsAsCode.missingIds.forEach((missingId) => {
-                console.warn(styles.warning(`\nNo chart with id "${missingId}"`));
-            });
-            await dumpIntoFiles('charts', chartsAsCode.charts);
-            offset = chartsAsCode.offset;
-        } while (chartsAsCode.offset < chartsAsCode.total);
-        spinner.succeed(`Downloaded ${chartsAsCode.total} charts`);
-    }
-    // Download dashboards
-    if (hasFilters && options.dashboards.length === 0) {
-        console.info(styles.warning(`No dashboards filters provided, skipping`));
+    // For analytics
+    let chartTotal;
+    let dashboardTotal;
+    const start = Date.now();
+    await analytics_1.LightdashAnalytics.track({
+        event: 'download.started',
+        properties: {
+            userId: config.user?.userUuid,
+            organizationId: config.user?.organizationUuid,
+            projectId,
+        },
+    });
+    try {
+        // If any filter is provided, we skip those items without filters
+        // eg: if a --charts filter is provided, we skip dashboards if no --dashboards filter is provided
+        const hasFilters = options.charts.length > 0 || options.dashboards.length > 0;
+        // Download charts
+        if (hasFilters && options.charts.length === 0) {
+            console.info(styles.warning(`No charts filters provided, skipping`));
+        }
+        else {
+            const spinner = globalState_1.default.startSpinner(`Downloading charts`);
+            const chartFilters = parseContentFilters(options.charts);
+            let chartsAsCode;
+            let offset = 0;
+            do {
+                globalState_1.default.debug(`Downloading charts with offset "${offset}" and filters "${chartFilters}"`);
+                const queryParams = chartFilters
+                    ? `${chartFilters}&offset=${offset}`
+                    : `?offset=${offset}`;
+                chartsAsCode = await (0, apiClient_1.lightdashApi)({
+                    method: 'GET',
+                    url: `/api/v1/projects/${projectId}/charts/code${queryParams}`,
+                    body: undefined,
+                });
+                spinner.start(`Downloaded ${chartsAsCode.offset} of ${chartsAsCode.total} charts`);
+                chartsAsCode.missingIds.forEach((missingId) => {
+                    console.warn(styles.warning(`\nNo chart with id "${missingId}"`));
+                });
+                await dumpIntoFiles('charts', chartsAsCode.charts);
+                offset = chartsAsCode.offset;
+            } while (chartsAsCode.offset < chartsAsCode.total);
+            chartTotal = chartsAsCode.total;
+            spinner.succeed(`Downloaded ${chartsAsCode.total} charts`);
+        }
+        // Download dashboards
+        if (hasFilters && options.dashboards.length === 0) {
+            console.info(styles.warning(`No dashboards filters provided, skipping`));
+        }
+        else {
+            const spinner = globalState_1.default.startSpinner(`Downloading dashboards`);
+            const dashboardFilters = parseContentFilters(options.dashboards);
+            let offset = 0;
+            let dashboardsAsCode;
+            do {
+                globalState_1.default.debug(`Downloading dashboards with offset "${offset}" and filters "${dashboardFilters}"`);
+                const queryParams = dashboardFilters
+                    ? `${dashboardFilters}&offset=${offset}`
+                    : `?offset=${offset}`;
+                dashboardsAsCode = await (0, apiClient_1.lightdashApi)({
+                    method: 'GET',
+                    url: `/api/v1/projects/${projectId}/dashboards/code${queryParams}`,
+                    body: undefined,
+                });
+                dashboardsAsCode.missingIds.forEach((missingId) => {
+                    console.warn(styles.warning(`\nNo dashboard with id "${missingId}"`));
+                });
+                spinner?.start(`Downloaded ${dashboardsAsCode.offset} of ${dashboardsAsCode.total} dashboards`);
+                await dumpIntoFiles('dashboards', dashboardsAsCode.dashboards);
+                offset = dashboardsAsCode.offset;
+            } while (dashboardsAsCode.offset < dashboardsAsCode.total);
+            dashboardTotal = dashboardsAsCode.total;
+            spinner.succeed(`Downloaded ${dashboardsAsCode.total} dashboards`);
+        }
+        const end = Date.now();
+        await analytics_1.LightdashAnalytics.track({
+            event: 'download.completed',
+            properties: {
+                userId: config.user?.userUuid,
+                organizationId: config.user?.organizationUuid,
+                projectId,
+                chartsNum: chartTotal,
+                dashboardsNum: dashboardTotal,
+                timeToCompleted: (end - start) / 1000, // in seconds
+            },
+        });
     }
-    else {
-        const spinner = globalState_1.default.startSpinner(`Downloading dashboards`);
-        const dashboardFilters = parseContentFilters(options.dashboards);
-        let offset = 0;
-        let dashboardsAsCode;
-        do {
-            globalState_1.default.debug(`Downloading dashboards with offset "${offset}" and filters "${dashboardFilters}"`);
-            const queryParams = dashboardFilters
-                ? `${dashboardFilters}&offset=${offset}`
-                : `?offset=${offset}`;
-            dashboardsAsCode = await (0, apiClient_1.lightdashApi)({
-                method: 'GET',
-                url: `/api/v1/projects/${projectId}/dashboards/code${queryParams}`,
-                body: undefined,
-            });
-            dashboardsAsCode.missingIds.forEach((missingId) => {
-                console.warn(styles.warning(`\nNo dashboard with id "${missingId}"`));
-            });
-            spinner?.start(`Downloaded ${dashboardsAsCode.offset} of ${dashboardsAsCode.total} dashboards`);
-            await dumpIntoFiles('dashboards', dashboardsAsCode.dashboards);
-            offset = dashboardsAsCode.offset;
-        } while (dashboardsAsCode.offset < dashboardsAsCode.total);
-        spinner.succeed(`Downloaded ${dashboardsAsCode.total} dashboards`);
+    catch (error) {
+        console.error(styles.error(`\nError downloading ${error}`));
+        await analytics_1.LightdashAnalytics.track({
+            event: 'download.error',
+            properties: {
+                userId: config.user?.userUuid,
+                organizationId: config.user?.organizationUuid,
+                projectId,
+                error: `${error}`,
+            },
+        });
     }
     // TODO delete files if chart don't exist ?*/
 };
@@ -203,6 +244,7 @@ const logUploadChanges = (changes) => {
  * @param slugs if slugs are provided, we only force upsert the charts/dashboards that match the slugs, if slugs are empty, we upload files that were locally updated
  */
 const upsertResources = async (type, projectId, changes, force, slugs) => {
+    const config = await (0, config_1.getConfig)();
     const items = await readCodeFiles(type);
     console.info(`Found ${items.length} ${type} files`);
     const hasFilter = slugs.length > 0;
@@ -241,10 +283,20 @@ const upsertResources = async (type, projectId, changes, force, slugs) => {
         catch (error) {
             changes[`${type} with errors`] =
                 (changes[`${type} with errors`] ?? 0) + 1;
-            console.error(`Error upserting ${type}`, error);
+            console.error(styles.error(`Error upserting ${type}: ${error}`));
+            await analytics_1.LightdashAnalytics.track({
+                event: 'download.error',
+                properties: {
+                    userId: config.user?.userUuid,
+                    organizationId: config.user?.organizationUuid,
+                    projectId,
+                    type,
+                    error: `${error}`,
+                },
+            });
         }
     }
-    return changes;
+    return { changes, total: filteredItems.length };
 };
 const uploadHandler = async (options) => {
     globalState_1.default.setVerbose(options.verbose);
@@ -258,21 +310,63 @@ const uploadHandler = async (options) => {
         throw new Error('No project selected. Run lightdash config set-project');
     }
     let changes = {};
-    // If any filter is provided, we skip those items without filters
-    // eg: if a --charts filter is provided, we skip dashboards if no --dashboards filter is provided
-    const hasFilters = options.charts.length > 0 || options.dashboards.length > 0;
-    if (hasFilters && options.charts.length === 0) {
-        console.info(styles.warning(`No charts filters provided, skipping`));
-    }
-    else {
-        changes = await upsertResources('charts', projectId, changes, options.force, options.charts);
-    }
-    if (hasFilters && options.dashboards.length === 0) {
-        console.info(styles.warning(`No dashboard filters provided, skipping`));
+    // For analytics
+    let chartTotal;
+    let dashboardTotal;
+    const start = Date.now();
+    await analytics_1.LightdashAnalytics.track({
+        event: 'upload.started',
+        properties: {
+            userId: config.user?.userUuid,
+            organizationId: config.user?.organizationUuid,
+            projectId,
+        },
+    });
+    try {
+        // If any filter is provided, we skip those items without filters
+        // eg: if a --charts filter is provided, we skip dashboards if no --dashboards filter is provided
+        const hasFilters = options.charts.length > 0 || options.dashboards.length > 0;
+        if (hasFilters && options.charts.length === 0) {
+            console.info(styles.warning(`No charts filters provided, skipping`));
+        }
+        else {
+            const { changes: chartChanges, total } = await upsertResources('charts', projectId, changes, options.force, options.charts);
+            changes = chartChanges;
+            chartTotal = total;
+        }
+        if (hasFilters && options.dashboards.length === 0) {
+            console.info(styles.warning(`No dashboard filters provided, skipping`));
+        }
+        else {
+            const { changes: dashboardChanges, total } = await upsertResources('dashboards', projectId, changes, options.force, options.dashboards);
+            changes = dashboardChanges;
+            dashboardTotal = total;
+        }
+        const end = Date.now();
+        await analytics_1.LightdashAnalytics.track({
+            event: 'upload.completed',
+            properties: {
+                userId: config.user?.userUuid,
+                organizationId: config.user?.organizationUuid,
+                projectId,
+                chartsNum: chartTotal,
+                dashboardsNum: dashboardTotal,
+                timeToCompleted: (end - start) / 1000, // in seconds
+            },
+        });
+        logUploadChanges(changes);
     }
-    else {
-        changes = await upsertResources('dashboards', projectId, changes, options.force, options.dashboards);
+    catch (error) {
+        console.error(styles.error(`\nError downloading ${error}`));
+        await analytics_1.LightdashAnalytics.track({
+            event: 'download.error',
+            properties: {
+                userId: config.user?.userUuid,
+                organizationId: config.user?.organizationUuid,
+                projectId,
+                error: `${error}`,
+            },
+        });
     }
-    logUploadChanges(changes);
 };
 exports.uploadHandler = uploadHandler;

package/dist/handlers/login.js

@@ -30,9 +30,10 @@ const loginWithToken = async (url, token, proxyAuthorization) => {
         throw new common_1.AuthorizationError(`Cannot sign in with token:\n${JSON.stringify(await response.json())}`);
     }
     const userBody = await response.json();
-    const { userUuid } = userBody;
+    const { userUuid, organizationUuid } = userBody;
     return {
         userUuid,
+        organizationUuid,
         token,
     };
 };
@@ -71,7 +72,7 @@ const loginWithPassword = async (url) => {
     if (header === null) {
         throw new common_1.AuthorizationError(`Cannot sign in:\n${JSON.stringify(loginBody)}`);
     }
-    const { userUuid } = loginBody.results;
+    const { userUuid, organizationUuid } = loginBody.results;
     const cookie = header.split(';')[0].split('=')[1];
     const patUrl = new url_1.URL(`/api/v1/user/me/personal-access-tokens`, url).href;
     const now = new Date();
@@ -90,6 +91,7 @@ const loginWithPassword = async (url) => {
     const { token } = patResponseBody.results;
     return {
         userUuid,
+        organizationUuid,
         token,
     };
 };
@@ -109,7 +111,7 @@ const login = async (url, options) => {
         console.error(`\n${styles.title('Warning')}: Login URL ${styles.secondary(url)} does not match a valid cloud server, perhaps you meant ${styles.secondary(cloudServer)} ?\n`);
     }
     const proxyAuthorization = process.env.LIGHTDASH_PROXY_AUTHORIZATION;
-    const { userUuid, token } = options.token
+    const { userUuid, token, organizationUuid } = options.token
         ? await loginWithToken(url, options.token, proxyAuthorization)
         : await loginWithPassword(url);
     globalState_1.default.debug(`> Logged in with userUuid: ${userUuid}`);
@@ -117,13 +119,14 @@ const login = async (url, options) => {
         event: 'login.completed',
         properties: {
             userId: userUuid,
+            organizationId: organizationUuid,
             url,
             method: options.token ? 'token' : 'password',
         },
     });
     await (0, config_1.setContext)({ serverUrl: url, apiKey: token });
     globalState_1.default.debug(`> Saved config on: ${config_1.configFilePath}`);
-    await (0, config_1.setDefaultUser)(userUuid);
+    await (0, config_1.setDefaultUser)(userUuid, organizationUuid);
     console.error(`\n  ✅️ Login successful\n`);
     try {
         if (process.env.CI === 'true') {

package/package.json

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