@lightdash/cli 3.70.0 → 3.72.0

package/dist/handlers/apps/preview.d.ts

@@ -1,4 +1,5 @@
 import { type DataAppManifest } from '@lightdash/common';
+import { type CompiledQueryLogEntry } from './previewProxy';
 /**
  * Environment passed to the `npm run dev` child process. Only the small set of
  * host variables needed to launch a portable child process is inherited. In
@@ -70,9 +71,11 @@ type AppsPreviewOptions = {
     url?: string;
     token?: string;
     port?: string;
+    showSql: boolean;
     assumeYes: boolean;
     verbose: boolean;
 };
+export declare const formatCompiledQueryLog: (entry: CompiledQueryLogEntry) => string;
 export declare const resolvePreviewPort: (raw: string | undefined) => number | undefined;
 export declare const appsPreviewHandler: (pathArg: string | undefined, options: AppsPreviewOptions) => Promise<void>;
 export {};

package/dist/handlers/apps/preview.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"preview.d.ts","sourceRoot":"","sources":["../../../src/handlers/apps/preview.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,KAAK,eAAe,EACvB,MAAM,mBAAmB,CAAC;AAgB3B;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,SAAU;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CACjC,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CA+CxB,CAAC;AAEF,eAAO,MAAM,wBAAwB,SAAgB;IACjD,QAAQ,EAAE,eAAe,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;CAC1B,KAAG,OAAO,CAAC,MAAM,EAAE,CA8EnB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qCAAqC,WACtC,MAAM,KACf,OAAO,CAAC,IAAI,CAWd,CAAC;AAEF,eAAO,MAAM,oBAAoB,SAAgB;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;CACf,KAAG,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CA2BlD,CAAC;AAQF,eAAO,MAAM,wBAAwB,WACzB,MAAM,KACf,OAAO,CAAC,IAAI,CAMd,CAAC;AAyBF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,SAAgB;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;CACtB,KAAG,OAAO,CAAC,IAAI,CAwEf,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,SAAU;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACrB,KAAG,MACgT,CAAC;AAErT,eAAO,MAAM,uBAAuB,SAAgB;IAChD,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;CAC1B,KAAG,OAAO,CAAC,OAAO,CAoBlB,CAAC;AAKF,eAAO,MAAM,6BAA6B,WAC9B,MAAM,KACf,OAAO,CAAC,OAAO,CAmBjB,CAAC;AAkBF,KAAK,kBAAkB,GAAG;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,eAAO,MAAM,kBAAkB,QACtB,MAAM,GAAG,SAAS,KACxB,MAAM,GAAG,SASX,CAAC;AAEF,eAAO,MAAM,kBAAkB,YAClB,MAAM,GAAG,SAAS,WAClB,kBAAkB,KAC5B,OAAO,CAAC,IAAI,CA8Id,CAAC"}
+{"version":3,"file":"preview.d.ts","sourceRoot":"","sources":["../../../src/handlers/apps/preview.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,KAAK,eAAe,EACvB,MAAM,mBAAmB,CAAC;AAc3B,OAAO,EAAqB,KAAK,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,SAAU;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CACjC,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CA+CxB,CAAC;AAEF,eAAO,MAAM,wBAAwB,SAAgB;IACjD,QAAQ,EAAE,eAAe,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;CAC1B,KAAG,OAAO,CAAC,MAAM,EAAE,CA8EnB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qCAAqC,WACtC,MAAM,KACf,OAAO,CAAC,IAAI,CAWd,CAAC;AAEF,eAAO,MAAM,oBAAoB,SAAgB;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;CACf,KAAG,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CA2BlD,CAAC;AAQF,eAAO,MAAM,wBAAwB,WACzB,MAAM,KACf,OAAO,CAAC,IAAI,CAMd,CAAC;AAyBF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,SAAgB;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;CACtB,KAAG,OAAO,CAAC,IAAI,CAwEf,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,SAAU;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACrB,KAAG,MACgT,CAAC;AAErT,eAAO,MAAM,uBAAuB,SAAgB;IAChD,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;CAC1B,KAAG,OAAO,CAAC,OAAO,CAoBlB,CAAC;AAKF,eAAO,MAAM,6BAA6B,WAC9B,MAAM,KACf,OAAO,CAAC,OAAO,CAmBjB,CAAC;AAkBF,KAAK,kBAAkB,GAAG;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,eAAO,MAAM,sBAAsB,UACxB,qBAAqB,KAC7B,MA4BF,CAAC;AAEF,eAAO,MAAM,kBAAkB,QACtB,MAAM,GAAG,SAAS,KACxB,MAAM,GAAG,SASX,CAAC;AAEF,eAAO,MAAM,kBAAkB,YAClB,MAAM,GAAG,SAAS,WAClB,kBAAkB,KAC5B,OAAO,CAAC,IAAI,CAiJd,CAAC"}

package/dist/handlers/apps/preview.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.appsPreviewHandler = exports.resolvePreviewPort = exports.removeLegacyPreviewCredential = exports.preflightPreviewRequest = exports.projectNotFoundMessage = exports.ensureNodeModules = exports.assertNodeModulesPresent = exports.resolvePreviewTarget = exports.assertScaffoldingSupportsPreviewProxy = exports.fetchBrowserImageOrigins = exports.buildPreviewChildEnv = void 0;
+exports.appsPreviewHandler = exports.resolvePreviewPort = exports.formatCompiledQueryLog = exports.removeLegacyPreviewCredential = exports.preflightPreviewRequest = exports.projectNotFoundMessage = exports.ensureNodeModules = exports.assertNodeModulesPresent = exports.resolvePreviewTarget = exports.assertScaffoldingSupportsPreviewProxy = exports.fetchBrowserImageOrigins = exports.buildPreviewChildEnv = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@lightdash/common");
 const crypto_1 = require("crypto");
@@ -328,6 +328,31 @@ const isUserStoppedDevServer = (error) => {
         exitCode === 130 ||
         exitCode === 143);
 };
+const formatCompiledQueryLog = (entry) => {
+    const fields = [
+        entry.dimensions.length > 0
+            ? `dimensions: ${entry.dimensions.join(', ')}`
+            : null,
+        entry.metrics.length > 0
+            ? `metrics: ${entry.metrics.join(', ')}`
+            : null,
+    ].filter((line) => line !== null);
+    const sql = entry.compiledSql !== null
+        ? entry.compiledSql.trim()
+        : 'Could not compile this query (see any errors above, or check your access to the explore).';
+    return [
+        styles.title(`\n— Query against explore '${entry.exploreName}'`),
+        ...fields.map((line) => styles.secondary(`  ${line}`)),
+        ...entry.compilationErrors.map((error) => styles.warning(`  ${error}`)),
+        ...(entry.runtimeOnlyTransformations.length > 0
+            ? [
+                styles.warning(`  Note: this query also applies ${entry.runtimeOnlyTransformations.join(' and ')} at run time, which the SQL below does not include.`),
+            ]
+            : []),
+        sql,
+    ].join('\n');
+};
+exports.formatCompiledQueryLog = formatCompiledQueryLog;
 const resolvePreviewPort = (raw) => {
     if (raw === undefined)
         return undefined;
@@ -412,6 +437,9 @@ const appsPreviewHandler = async (pathArg, options) => {
         proxyAuthorization,
         projectUuid: target.projectUuid,
         nonce: proxyNonce,
+        onCompiledQuery: options.showSql
+            ? (entry) => globalState_1.default.log((0, exports.formatCompiledQueryLog)(entry))
+            : undefined,
     });
     globalState_1.default.log(`Auth proxy on 127.0.0.1:${proxy.port} (not the app URL) — your credential is not passed to the app; SDK traffic is restricted to project ${target.projectUuid}.`);
     globalState_1.default.log(styles.warning(`Preview renders YOUR data with YOUR permissions and user attributes — viewers of the deployed app may see different data.`));

package/dist/handlers/apps/previewProxy.d.ts

@@ -3,6 +3,15 @@ export type PreviewProxyHandle = {
     port: number;
     close: () => Promise<void>;
 };
+/** What --show-sql reports for each metric query the previewed app runs. */
+export type CompiledQueryLogEntry = {
+    exploreName: string;
+    dimensions: string[];
+    metrics: string[];
+    compiledSql: string | null;
+    compilationErrors: string[];
+    runtimeOnlyTransformations: string[];
+};
 /**
  * Loopback proxy that owns the preview credential. The vite dev server
  * forwards /api traffic here; only routes a deployed app could reach through
@@ -16,5 +25,6 @@ export declare const startPreviewProxy: (args: {
     proxyAuthorization?: string;
     projectUuid: string;
     nonce: string;
+    onCompiledQuery?: (entry: CompiledQueryLogEntry) => void;
 }) => Promise<PreviewProxyHandle>;
 //# sourceMappingURL=previewProxy.d.ts.map

package/dist/handlers/apps/previewProxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"previewProxy.d.ts","sourceRoot":"","sources":["../../../src/handlers/apps/previewProxy.ts"],"names":[],"mappings":"AAkBA,eAAO,MAAM,0BAA0B,8BAA8B,CAAC;AA6CtE,MAAM,MAAM,kBAAkB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B,CAAC;AAyCF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,SAAU;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;CACjB,KAAG,OAAO,CAAC,kBAAkB,CAsM7B,CAAC"}
+{"version":3,"file":"previewProxy.d.ts","sourceRoot":"","sources":["../../../src/handlers/apps/previewProxy.ts"],"names":[],"mappings":"AAmBA,eAAO,MAAM,0BAA0B,8BAA8B,CAAC;AA6CtE,MAAM,MAAM,kBAAkB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B,CAAC;AAEF,4EAA4E;AAC5E,MAAM,MAAM,qBAAqB,GAAG;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAG5B,0BAA0B,EAAE,MAAM,EAAE,CAAC;CACxC,CAAC;AAyCF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,SAAU;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IAGd,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,CAAC;CAC5D,KAAG,OAAO,CAAC,kBAAkB,CAwU7B,CAAC"}

package/dist/handlers/apps/previewProxy.js

@@ -111,6 +111,85 @@ const startPreviewProxy = (args) => {
         upstreamReq.on('error', () => resolve(null));
         upstreamReq.end();
     });
+    // Resolves the parsed body of a successful upstream POST, or null.
+    const postUpstreamJson = (path, body) => new Promise((resolve) => {
+        const payload = Buffer.from(body, 'utf-8');
+        const upstreamReq = requestFn({
+            protocol: upstream.protocol,
+            hostname: upstream.hostname,
+            port: upstream.port || undefined,
+            path,
+            method: 'POST',
+            headers: withUpstreamCredentials({
+                accept: 'application/json',
+                'content-type': 'application/json',
+                'content-length': payload.length,
+            }),
+        }, (upstreamRes) => {
+            readBody(upstreamRes).then((text) => {
+                const status = upstreamRes.statusCode ?? 502;
+                resolve(status >= 200 && status < 300
+                    ? parseJson(text)
+                    : null);
+            }, () => resolve(null));
+        });
+        upstreamReq.on('error', () => resolve(null));
+        upstreamReq.end(payload);
+    });
+    // --show-sql: compile the metric query the app just ran (same payload the
+    // customer-facing compileQuery endpoint takes) and report the SQL.
+    const compileAndReport = async (requestBody) => {
+        const report = args.onCompiledQuery;
+        if (report === undefined)
+            return;
+        const parsed = parseJson(requestBody);
+        if (typeof parsed !== 'object' || parsed === null)
+            return;
+        const { query, parameters, usePreAggregateCache, pivotConfiguration, dateZoom, dashboardFilters, } = parsed;
+        if (typeof query !== 'object' || query === null)
+            return;
+        const metricQuery = query;
+        if (typeof metricQuery.exploreName !== 'string')
+            return;
+        const toStrings = (value) => Array.isArray(value)
+            ? value.filter((item) => typeof item === 'string')
+            : [];
+        // compileQuery cannot apply these execution-time transformations, so
+        // the printed SQL would silently diverge — disclose them instead.
+        const hasDashboardFilters = typeof dashboardFilters === 'object' &&
+            dashboardFilters !== null &&
+            Object.values(dashboardFilters).some((group) => Array.isArray(group) && group.length > 0);
+        const runtimeOnlyTransformations = [
+            ...(dateZoom !== undefined || metricQuery.dateZoom !== undefined
+                ? ['date zoom']
+                : []),
+            ...(hasDashboardFilters ? ['dashboard filters'] : []),
+        ];
+        const entry = {
+            exploreName: metricQuery.exploreName,
+            dimensions: toStrings(metricQuery.dimensions),
+            metrics: toStrings(metricQuery.metrics),
+            compiledSql: null,
+            compilationErrors: [],
+            runtimeOnlyTransformations,
+        };
+        const compiled = await postUpstreamJson(`/api/v1/projects/${encodeURIComponent(args.projectUuid)}/explores/${encodeURIComponent(metricQuery.exploreName)}/compileQuery`, JSON.stringify({
+            ...query,
+            parameters,
+            usePreAggregateCache,
+            pivotConfiguration,
+        }));
+        if (typeof compiled === 'object' && compiled !== null) {
+            const { results } = compiled;
+            if (typeof results === 'object' && results !== null) {
+                const { query: sql, compilationErrors } = results;
+                if (typeof sql === 'string')
+                    entry.compiledSql = sql;
+                entry.compilationErrors = toStrings(compilationErrors);
+            }
+        }
+        report(entry);
+    };
     // Host-answered virtual route: replies with only the explore's base
     // table, never the explore itself.
     const answerExploreBaseTable = async (req, res) => {
@@ -189,7 +268,17 @@ const startPreviewProxy = (args) => {
                 res.destroy();
             }
         });
-        req.pipe(upstreamReq);
+        if (args.onCompiledQuery !== undefined &&
+            (0, common_1.isAppSdkMetricQueryRoute)(method, pathname)) {
+            // Buffer so the same bytes are both forwarded and compiled.
+            readBody(req).then((body) => {
+                upstreamReq.end(body);
+                compileAndReport(body).catch(() => { });
+            }, () => upstreamReq.destroy());
+        }
+        else {
+            req.pipe(upstreamReq);
+        }
     });
     return new Promise((resolve, reject) => {
         server.once('error', reject);

package/dist/index.js

@@ -558,6 +558,7 @@ appsProgram
     .option('--token <token>', 'API key / personal access token (default: your login config)')
     .option('-y, --assume-yes', 'assume yes to the dependency install prompts when node_modules is missing', false)
     .option('--port <port>', 'port for the app dev server (default: Vite picks one, usually 5173)')
+    .option('--show-sql', 'print the compiled SQL for each metric query the app runs', false)
     .option('--verbose', undefined, false)
     .action(preview_1.appsPreviewHandler);
 appsProgram

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "3.70.0",
+  "version": "3.72.0",
   "description": "Lightdash CLI tool",
   "license": "MIT",
   "repository": {
@@ -22,8 +22,8 @@
     "@actions/core": "1.11.1",
     "@aws-sdk/credential-providers": "3.995.0",
     "@casl/ability": "6.8.0",
-    "@lightdash/common": "3.70.0",
-    "@lightdash/warehouses": "3.70.0",
+    "@lightdash/common": "3.72.0",
+    "@lightdash/warehouses": "3.72.0",
     "@sidvind/better-ajv-errors": "7.0.0",
     "@types/columnify": "1.5.1",
     "ajv": "8.18.0",