@lightdash/cli 0.1418.1 → 0.1419.0

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

@@ -49,7 +49,13 @@ export declare const lightdashApi: <T extends string | boolean | unknown[] | imp
     owner: string;
 } | import("@lightdash/common").KnexPaginatedData<import("@lightdash/common").ApiMetricsCatalogResults> | import("@lightdash/common").MetricsExplorerQueryResults | import("@lightdash/common").KnexPaginatedData<import("@lightdash/common").Group[] | import("@lightdash/common").GroupWithMembers[]> | {
     tagUuid: string;
-} | import("@lightdash/common").ChartAsCode[] | {
+} | {
+    charts: import("@lightdash/common").ChartAsCode[];
+    missingIds: string[];
+} | {
+    dashboards: import("@lightdash/common").DashboardAsCode[];
+    missingIds: string[];
+} | {
     edges: import("@lightdash/common").CatalogMetricsTreeEdge[];
 } | import("@lightdash/common").MetricTotalResults | null | undefined>({ method, url, body, }: LightdashApiProps) => Promise<T>;
 export declare const checkLightdashVersion: () => Promise<void>;

package/dist/handlers/download.d.ts

@@ -1,5 +1,7 @@
 export type DownloadHandlerOptions = {
     verbose: boolean;
+    charts: string[];
+    dashboards: string[];
     force: boolean;
 };
 export declare const downloadHandler: (options: DownloadHandlerOptions) => Promise<void>;

package/dist/handlers/download.js

@@ -10,11 +10,26 @@ const yaml = tslib_1.__importStar(require("js-yaml"));
 const path = tslib_1.__importStar(require("path"));
 const config_1 = require("../config");
 const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const styles = tslib_1.__importStar(require("../styles"));
 const apiClient_1 = require("./dbt/apiClient");
 const DOWNLOAD_FOLDER = 'lightdash';
+/*
+    This function is used to parse the content filters.
+    It can be slugs, uuids or urls
+    We remove the URL part (if any) and return a list of `slugs or uuids` that can be used in the API call
+*/
+const parseContentFilters = (items) => {
+    if (items.length === 0)
+        return '';
+    const parsedItems = items.map((item) => {
+        const uuidMatch = item.match(/https?:\/\/.+\/(?:saved|dashboards)\/([a-f0-9-]+)/i);
+        return uuidMatch ? uuidMatch[1] : item;
+    });
+    return `?${new URLSearchParams(parsedItems.map((item) => ['ids', item])).toString()}`;
+};
 const dumpIntoFiles = async (folder, items) => {
     const outputDir = path.join(process.cwd(), DOWNLOAD_FOLDER, folder);
-    console.info(`Writting ${items.length} ${folder} into ${outputDir}`);
+    console.info(`Writing ${items.length} ${folder} into ${outputDir}`);
     // Make directory
     const created = await fs_1.promises.mkdir(outputDir, { recursive: true });
     if (created)
@@ -80,22 +95,43 @@ 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
-    globalState_1.default.debug('Downloading charts');
-    const chartsAsCode = await (0, apiClient_1.lightdashApi)({
-        method: 'GET',
-        url: `/api/v1/projects/${projectId}/charts/code`,
-        body: undefined,
-    });
-    await dumpIntoFiles('charts', chartsAsCode);
+    if (hasFilters && options.charts.length === 0) {
+        console.info(styles.warning(`No charts filters provided, skipping`));
+    }
+    else {
+        globalState_1.default.debug(`Downloading charts`);
+        const chartFilters = parseContentFilters(options.charts);
+        const chartsAsCode = await (0, apiClient_1.lightdashApi)({
+            method: 'GET',
+            url: `/api/v1/projects/${projectId}/charts/code${chartFilters}`,
+            body: undefined,
+        });
+        chartsAsCode.missingIds.forEach((missingId) => {
+            console.warn(styles.warning(`No chart with id "${missingId}"`));
+        });
+        await dumpIntoFiles('charts', chartsAsCode.charts);
+    }
     // Download dashboards
-    globalState_1.default.debug('Downloading dashboards');
-    const dashboardsAsCode = await (0, apiClient_1.lightdashApi)({
-        method: 'GET',
-        url: `/api/v1/projects/${projectId}/dashboards/code`,
-        body: undefined,
-    });
-    await dumpIntoFiles('dashboards', dashboardsAsCode);
+    if (hasFilters && options.dashboards.length === 0) {
+        console.info(styles.warning(`No dashboards filters provided, skipping`));
+    }
+    else {
+        globalState_1.default.debug(`Downloading dashboards`);
+        const dashboardFilters = parseContentFilters(options.dashboards);
+        const dashboardsAsCode = await (0, apiClient_1.lightdashApi)({
+            method: 'GET',
+            url: `/api/v1/projects/${projectId}/dashboards/code${dashboardFilters}`,
+            body: undefined,
+        });
+        dashboardsAsCode.missingIds.forEach((missingId) => {
+            console.warn(styles.warning(`No dashboard with id "${missingId}"`));
+        });
+        await dumpIntoFiles('dashboards', dashboardsAsCode.dashboards);
+    }
     // TODO delete files if chart don't exist ?*/
 };
 exports.downloadHandler = downloadHandler;
@@ -127,13 +163,31 @@ const logUploadChanges = (changes) => {
         console.info(`Total ${key}: ${value} `);
     });
 };
-const upsertResources = async (type, projectId, changes, force) => {
+/**
+ *
+ * @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 items = await readCodeFiles(type);
     console.info(`Found ${items.length} ${type} files`);
-    for (const item of items) {
+    const hasFilter = slugs.length > 0;
+    const filteredItems = hasFilter
+        ? items.filter((item) => slugs.includes(item.slug))
+        : items;
+    if (hasFilter) {
+        console.info(`Filtered ${filteredItems.length} ${type} with slugs: ${slugs.join(', ')}`);
+        const missingItems = slugs.filter((slug) => !items.find((item) => item.slug === slug));
+        missingItems.forEach((slug) => {
+            console.warn(styles.warning(`No ${type} with slug: "${slug}"`));
+        });
+    }
+    for (const item of filteredItems) {
         // If a chart fails to update, we keep updating the rest
         try {
             if (!force && !item.needsUpdating) {
+                if (hasFilter) {
+                    console.warn(styles.warning(`Skipping ${type} "${item.slug}" with no local changes`));
+                }
                 globalState_1.default.debug(`Skipping ${type} "${item.slug}" with no local changes`);
                 changes[`${type} skipped`] =
                     (changes[`${type} skipped`] ?? 0) + 1;
@@ -169,8 +223,8 @@ const uploadHandler = async (options) => {
         throw new Error('No project selected. Run lightdash config set-project');
     }
     let changes = {};
-    changes = await upsertResources('charts', projectId, changes, options.force);
-    changes = await upsertResources('dashboards', projectId, changes, options.force);
+    changes = await upsertResources('charts', projectId, changes, options.force, options.charts);
+    changes = await upsertResources('dashboards', projectId, changes, options.force, options.dashboards);
     logUploadChanges(changes);
 };
 exports.uploadHandler = uploadHandler;

package/dist/index.js

@@ -194,11 +194,15 @@ commander_1.program
     .command('download')
     .description('Downloads charts and dashboards as code')
     .option('--verbose', undefined, false)
+    .option('-c, --charts <charts...>', 'specify chart slugs, uuids, or urls to download', [])
+    .option('-d, --dashboards <dashboards...>', 'specify dashboard slugs, uuids or urls to download', [])
     .action(download_1.downloadHandler);
 commander_1.program
     .command('upload')
     .description('Uploads charts and dashboards as code')
     .option('--verbose', undefined, false)
+    .option('-c, --charts <charts...>', 'specify chart slugs to force upload', [])
+    .option('-d, --dashboards <dashboards...>', 'specify dashboard slugs to force upload', [])
     .option('--force', 'Force upload even if local files have not changed, use this when you want to upload files to a new project', false)
     .action(download_1.uploadHandler);
 commander_1.program

package/package.json

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