@lightdash/cli 1.137.1 → 1.139.0

package/dist/handlers/organizationContent/themes.test.js

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const fs_1 = require("fs");
+const node_fetch_1 = require("node-fetch");
+const os = tslib_1.__importStar(require("os"));
+const path = tslib_1.__importStar(require("path"));
+const yaml_1 = require("yaml");
+const apiClient_1 = require("../dbt/apiClient");
+const themes_1 = require("./themes");
+vi.mock('../dbt/apiClient', () => ({
+    lightdashApi: vi.fn(),
+    lightdashRawApi: vi.fn(),
+}));
+const manifest = (slug) => ({
+    codeVersion: 1,
+    slug,
+    name: 'Acme Brand',
+    description: null,
+    extraInstructions: null,
+});
+const createThemeDirectory = async (contentRoot, slug) => {
+    const directory = path.join(contentRoot, 'themes', slug);
+    await Promise.all(['css', 'fonts', 'images', 'instructions'].map((folder) => fs_1.promises.mkdir(path.join(directory, folder), { recursive: true })));
+    await fs_1.promises.writeFile(path.join(directory, 'lightdash-theme.yml'), (0, yaml_1.stringify)(manifest(slug)));
+    await fs_1.promises.writeFile(path.join(directory, 'css', 'theme.css'), ':root { --brand: #123456; }');
+    return directory;
+};
+describe('organization theme content-as-code', () => {
+    let temporaryRoot;
+    beforeEach(async () => {
+        vi.clearAllMocks();
+        vi.mocked(apiClient_1.lightdashApi).mockResolvedValue([]);
+        temporaryRoot = await fs_1.promises.mkdtemp(path.join(os.tmpdir(), 'themes-test-'));
+    });
+    afterEach(async () => {
+        await fs_1.promises.rm(temporaryRoot, { recursive: true, force: true });
+    });
+    it('treats a missing themes directory as an empty upload', async () => {
+        await expect((0, themes_1.prepareThemeUploads)(temporaryRoot)).resolves.toEqual([]);
+    });
+    it('rejects nested paths during preflight', async () => {
+        const themeDirectory = await createThemeDirectory(temporaryRoot, 'acme-brand');
+        await fs_1.promises.mkdir(path.join(themeDirectory, 'css', 'nested'));
+        await expect((0, themes_1.prepareThemeUploads)(temporaryRoot)).rejects.toThrow('without symlinks or nested directories');
+    });
+    it('rejects symlinked files during preflight', async () => {
+        const themeDirectory = await createThemeDirectory(temporaryRoot, 'acme-brand');
+        await fs_1.promises.symlink(path.join(themeDirectory, 'css', 'theme.css'), path.join(themeDirectory, 'css', 'linked.css'));
+        await expect((0, themes_1.prepareThemeUploads)(temporaryRoot)).rejects.toThrow('without symlinks or nested directories');
+    });
+    it('accepts Git-dropped empty directories and ignores local filesystem artifacts', async () => {
+        const themeDirectory = await createThemeDirectory(temporaryRoot, 'acme-brand');
+        await Promise.all(['fonts', 'images', 'instructions'].map((folder) => fs_1.promises.rmdir(path.join(themeDirectory, folder))));
+        await Promise.all([
+            fs_1.promises.writeFile(path.join(temporaryRoot, 'themes', '.DS_Store'), 'metadata'),
+            fs_1.promises.writeFile(path.join(themeDirectory, '.DS_Store'), 'metadata'),
+            fs_1.promises.writeFile(path.join(themeDirectory, 'css', '.DS_Store'), 'metadata'),
+            fs_1.promises.mkdir(path.join(temporaryRoot, 'themes', '.lightdash-theme-ABC123')),
+            fs_1.promises.mkdir(path.join(temporaryRoot, 'themes', 'acme-brand.backup-00000000-0000-4000-8000-000000000001')),
+        ]);
+        const prepared = await (0, themes_1.prepareThemeUploads)(temporaryRoot);
+        expect(prepared).toHaveLength(1);
+        expect(prepared[0].manifest.slug).toBe('acme-brand');
+    });
+    it('round-trips a downloaded package and replaces stale theme files', async () => {
+        const sourceRoot = path.join(temporaryRoot, 'source');
+        const destinationRoot = path.join(temporaryRoot, 'destination');
+        await createThemeDirectory(sourceRoot, 'acme-brand');
+        const [prepared] = await (0, themes_1.prepareThemeUploads)(sourceRoot);
+        const staleDirectory = await createThemeDirectory(destinationRoot, 'acme-brand');
+        await createThemeDirectory(destinationRoot, 'remotely-deleted');
+        await fs_1.promises.writeFile(path.join(staleDirectory, 'stale.txt'), 'stale');
+        vi.mocked(apiClient_1.lightdashApi).mockResolvedValue([
+            { slug: 'acme-brand' },
+        ]);
+        vi.mocked(apiClient_1.lightdashRawApi).mockResolvedValue(new node_fetch_1.Response(prepared.archive));
+        await expect((0, themes_1.downloadThemes)(destinationRoot)).resolves.toBe(1);
+        await expect(fs_1.promises.readFile(path.join(destinationRoot, 'themes', 'acme-brand', 'css', 'theme.css'), 'utf8')).resolves.toContain('--brand');
+        await expect(fs_1.promises.stat(path.join(destinationRoot, 'themes', 'acme-brand', 'stale.txt'))).rejects.toMatchObject({ code: 'ENOENT' });
+        await expect(fs_1.promises.stat(path.join(destinationRoot, 'themes', 'remotely-deleted'))).rejects.toMatchObject({ code: 'ENOENT' });
+        const [downloaded] = await (0, themes_1.prepareThemeUploads)(destinationRoot);
+        expect(downloaded.archive).toEqual(prepared.archive);
+    });
+    it('keeps the previous local theme set when a package download fails', async () => {
+        const sourceRoot = path.join(temporaryRoot, 'source');
+        const destinationRoot = path.join(temporaryRoot, 'destination');
+        await createThemeDirectory(sourceRoot, 'first-theme');
+        const [prepared] = await (0, themes_1.prepareThemeUploads)(sourceRoot);
+        const existingDirectory = await createThemeDirectory(destinationRoot, 'existing-theme');
+        await fs_1.promises.writeFile(path.join(existingDirectory, 'local-marker.txt'), 'keep me');
+        vi.mocked(apiClient_1.lightdashApi).mockResolvedValue([
+            { slug: 'first-theme' },
+            { slug: 'second-theme' },
+        ]);
+        vi.mocked(apiClient_1.lightdashRawApi)
+            .mockResolvedValueOnce(new node_fetch_1.Response(prepared.archive))
+            .mockResolvedValueOnce(new node_fetch_1.Response(Buffer.from('not a tar')));
+        await expect((0, themes_1.downloadThemes)(destinationRoot)).rejects.toThrow();
+        await expect(fs_1.promises.readFile(path.join(existingDirectory, 'local-marker.txt'), 'utf8')).resolves.toBe('keep me');
+        await expect(fs_1.promises.stat(path.join(destinationRoot, 'themes', 'first-theme'))).rejects.toMatchObject({ code: 'ENOENT' });
+    });
+    it('reports completed and failed imports without claiming full success', async () => {
+        await createThemeDirectory(temporaryRoot, 'first-theme');
+        await createThemeDirectory(temporaryRoot, 'second-theme');
+        const prepared = await (0, themes_1.prepareThemeUploads)(temporaryRoot);
+        vi.mocked(apiClient_1.lightdashRawApi)
+            .mockResolvedValueOnce(new node_fetch_1.Response(JSON.stringify({
+            status: 'ok',
+            results: {
+                slug: 'first-theme',
+                action: common_1.PromotionAction.CREATE,
+            },
+        })))
+            .mockRejectedValueOnce(new Error('remote failure'));
+        const summary = await (0, themes_1.uploadThemes)(prepared);
+        expect(summary).toEqual({
+            created: 1,
+            updated: 0,
+            unchanged: 0,
+            failed: 1,
+            completedSlugs: ['first-theme'],
+            failures: [
+                {
+                    message: 'Failed to upload theme "second-theme": remote failure',
+                },
+            ],
+        });
+    });
+    it('reports the action returned for every successful import', async () => {
+        await createThemeDirectory(temporaryRoot, 'created-theme');
+        await createThemeDirectory(temporaryRoot, 'updated-theme');
+        await createThemeDirectory(temporaryRoot, 'unchanged-theme');
+        const prepared = await (0, themes_1.prepareThemeUploads)(temporaryRoot);
+        for (const theme of prepared) {
+            const actionBySlug = {
+                'created-theme': common_1.PromotionAction.CREATE,
+                'updated-theme': common_1.PromotionAction.UPDATE,
+                'unchanged-theme': common_1.PromotionAction.NO_CHANGES,
+            };
+            vi.mocked(apiClient_1.lightdashRawApi).mockResolvedValueOnce(new node_fetch_1.Response(JSON.stringify({
+                status: 'ok',
+                results: {
+                    slug: theme.manifest.slug,
+                    action: actionBySlug[theme.manifest.slug],
+                },
+            })));
+        }
+        await expect((0, themes_1.uploadThemes)(prepared)).resolves.toMatchObject({
+            created: 1,
+            updated: 1,
+            unchanged: 1,
+            failed: 0,
+        });
+    });
+    it('classifies successful imports returned by older servers', async () => {
+        await createThemeDirectory(temporaryRoot, 'existing-theme');
+        await createThemeDirectory(temporaryRoot, 'new-theme');
+        const prepared = await (0, themes_1.prepareThemeUploads)(temporaryRoot);
+        vi.mocked(apiClient_1.lightdashApi).mockResolvedValue([
+            { slug: 'existing-theme' },
+        ]);
+        vi.mocked(apiClient_1.lightdashRawApi)
+            .mockResolvedValueOnce(new node_fetch_1.Response(JSON.stringify({
+            status: 'ok',
+            results: { slug: 'existing-theme' },
+        })))
+            .mockResolvedValueOnce(new node_fetch_1.Response(JSON.stringify({
+            status: 'ok',
+            results: { slug: 'new-theme' },
+        })));
+        await expect((0, themes_1.uploadThemes)(prepared)).resolves.toMatchObject({
+            created: 1,
+            updated: 1,
+            unchanged: 0,
+            failed: 0,
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "1.137.1",
+  "version": "1.139.0",
   "description": "Lightdash CLI tool",
   "license": "MIT",
   "repository": {
@@ -38,11 +38,12 @@
     "ora": "5.4.1",
     "p-limit": "3.1.0",
     "parse-node-version": "2.0.0",
+    "tar-stream": "3.1.8",
     "unique-names-generator": "4.7.1",
     "uuid": "11.1.1",
     "yaml": "2.8.3",
-    "@lightdash/common": "1.137.1",
-    "@lightdash/warehouses": "1.137.1"
+    "@lightdash/common": "1.139.0",
+    "@lightdash/warehouses": "1.139.0"
   },
   "devDependencies": {
     "@types/inquirer": "8.2.4",
@@ -53,6 +54,7 @@
     "@types/node-fetch": "2.6.13",
     "@types/nunjucks": "3.2.1",
     "@types/parse-node-version": "1.0.0",
+    "@types/tar-stream": "3.1.4",
     "@types/uuid": "10.0.0",
     "@vercel/ncc": "0.38.4",
     "@yao-pkg/pkg": "6.7.0",