@lightdash/cli 2.228.1 → 2.229.0

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

@@ -1,155 +0,0 @@
-"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 yaml = tslib_1.__importStar(require("js-yaml"));
-const os = tslib_1.__importStar(require("os"));
-const path = tslib_1.__importStar(require("path"));
-const vitest_1 = require("vitest");
-const apiClient_1 = require("../dbt/apiClient");
-const users_1 = require("./users");
-vitest_1.vi.mock('../dbt/apiClient', async (importOriginal) => ({
-    ...(await importOriginal()),
-    lightdashApi: vitest_1.vi.fn(),
-}));
-describe('users as code', () => {
-    let tmpDir;
-    const user = (email, overrides = {}) => ({
-        version: 1,
-        email,
-        disabled: false,
-        role: { type: 'system', name: common_1.OrganizationMemberRole.EDITOR },
-        ...overrides,
-    });
-    const writeUser = async (filename, value) => {
-        const folder = (0, users_1.getUsersFolder)(tmpDir);
-        await fs_1.promises.mkdir(folder, { recursive: true });
-        await fs_1.promises.writeFile(path.join(folder, filename), yaml.dump(value, { sortKeys: true }));
-    };
-    beforeEach(async () => {
-        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockReset();
-        tmpDir = await fs_1.promises.mkdtemp(path.join(os.tmpdir(), 'users-test-'));
-    });
-    afterEach(async () => {
-        vitest_1.vi.restoreAllMocks();
-        await fs_1.promises.rm(tmpDir, { recursive: true, force: true });
-    });
-    it('formats upload results using CRUD statuses only', () => {
-        expect((0, users_1.formatUserUploadSummary)({
-            created: 1,
-            updated: 2,
-            unchanged: 3,
-            awaitingAuthentication: 4,
-            invited: 5,
-            skippedAuthenticated: 6,
-            skippedDisabled: 7,
-            skippedValidInvite: 8,
-            failed: 9,
-            failures: [],
-        })).toBe('1 created, 2 updated, 3 unchanged, 9 failed');
-    });
-    it('downloads deterministic portable users and preserves unknown YAML', async () => {
-        const folder = (0, users_1.getUsersFolder)(tmpDir);
-        await fs_1.promises.mkdir(folder, { recursive: true });
-        await fs_1.promises.writeFile(path.join(folder, 'stale.yml'), 'stale: true');
-        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockResolvedValueOnce({
-            users: [
-                user('z@example.com', {
-                    disabled: true,
-                    role: { type: 'custom', name: 'Data steward' },
-                }),
-                user('a@example.com'),
-            ],
-        });
-        await expect((0, users_1.downloadUsers)('organization-uuid', tmpDir)).resolves.toBe(2);
-        expect((await fs_1.promises.readdir(folder)).sort()).toStrictEqual([
-            'a-example-com.yml',
-            'stale.yml',
-            'z-example-com.yml',
-        ]);
-        expect(yaml.load(await fs_1.promises.readFile(path.join(folder, 'z-example-com.yml'), 'utf8'))).toStrictEqual({
-            disabled: true,
-            email: 'z@example.com',
-            role: { name: 'Data steward', type: 'custom' },
-            version: 1,
-        });
-    });
-    it('rejects case-insensitive duplicate emails before upload', async () => {
-        await writeUser('one.yml', user('duplicate@example.com'));
-        await writeUser('two.yml', user('DUPLICATE@example.com'));
-        await expect((0, users_1.readUserFiles)(tmpDir)).rejects.toThrow('Duplicate user email "duplicate@example.com"');
-        expect(apiClient_1.lightdashApi).not.toHaveBeenCalled();
-    });
-    it('is a backward-compatible no-op when the users folder is missing', async () => {
-        await expect((0, users_1.uploadUsers)('organization-uuid', tmpDir)).resolves.toMatchObject({
-            created: 0,
-            updated: 0,
-            unchanged: 0,
-            failed: 0,
-        });
-        expect(apiClient_1.lightdashApi).not.toHaveBeenCalled();
-    });
-    it('does not request invitations by default', async () => {
-        await writeUser('user.yml', user('person@example.com'));
-        vitest_1.vi.mocked(apiClient_1.lightdashApi)
-            .mockResolvedValueOnce({ users: [] })
-            .mockResolvedValueOnce({
-            action: common_1.PromotionAction.CREATE,
-            lifecycle: common_1.UserAsCodeLifecycleStatus.AWAITING_AUTHENTICATION,
-            invitation: common_1.UserAsCodeInvitationStatus.NOT_REQUESTED,
-        });
-        const summary = await (0, users_1.uploadUsers)('organization-uuid', tmpDir);
-        expect(summary).toMatchObject({
-            created: 1,
-            awaitingAuthentication: 1,
-            invited: 0,
-            failed: 0,
-        });
-        expect(apiClient_1.lightdashApi).toHaveBeenNthCalledWith(2, {
-            method: 'POST',
-            url: '/api/v2/orgs/organization-uuid/code/users',
-            body: expect.any(String),
-        });
-    });
-    it('passes sendInvite and reports invitation outcomes', async () => {
-        await writeUser('user.yml', user('person@example.com'));
-        vitest_1.vi.mocked(apiClient_1.lightdashApi)
-            .mockResolvedValueOnce({ users: [] })
-            .mockResolvedValueOnce({
-            action: common_1.PromotionAction.CREATE,
-            lifecycle: common_1.UserAsCodeLifecycleStatus.AWAITING_AUTHENTICATION,
-            invitation: common_1.UserAsCodeInvitationStatus.SENT,
-        });
-        const summary = await (0, users_1.uploadUsers)('organization-uuid', tmpDir, true);
-        expect(summary.invited).toBe(1);
-        expect(apiClient_1.lightdashApi).toHaveBeenNthCalledWith(2, {
-            method: 'POST',
-            url: '/api/v2/orgs/organization-uuid/code/users?sendInvite=true',
-            body: expect.any(String),
-        });
-    });
-    it('promotes an enabled admin before demoting the current admin', async () => {
-        const currentAdmin = user('current@example.com', {
-            role: { type: 'system', name: common_1.OrganizationMemberRole.ADMIN },
-        });
-        const desiredAdmin = user('new@example.com', {
-            role: { type: 'system', name: common_1.OrganizationMemberRole.ADMIN },
-        });
-        const desiredDemotion = user('current@example.com');
-        await writeUser('a-demote.yml', desiredDemotion);
-        await writeUser('z-promote.yml', desiredAdmin);
-        vitest_1.vi.mocked(apiClient_1.lightdashApi)
-            .mockResolvedValueOnce({ users: [currentAdmin] })
-            .mockResolvedValue({
-            action: common_1.PromotionAction.UPDATE,
-            lifecycle: common_1.UserAsCodeLifecycleStatus.READY,
-            invitation: common_1.UserAsCodeInvitationStatus.NOT_REQUESTED,
-        });
-        await (0, users_1.uploadUsers)('organization-uuid', tmpDir);
-        const firstBody = JSON.parse(vitest_1.vi.mocked(apiClient_1.lightdashApi).mock.calls[1][0].body);
-        const secondBody = JSON.parse(vitest_1.vi.mocked(apiClient_1.lightdashApi).mock.calls[2][0].body);
-        expect(firstBody.email).toBe('new@example.com');
-        expect(secondBody.email).toBe('current@example.com');
-    });
-});

package/dist/handlers/preAggregateAudit.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=preAggregateAudit.test.d.ts.map

package/dist/handlers/preAggregateAudit.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"preAggregateAudit.test.d.ts","sourceRoot":"","sources":["../../src/handlers/preAggregateAudit.test.ts"],"names":[],"mappings":""}

package/dist/handlers/preAggregateAudit.test.js

@@ -1,102 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const common_1 = require("@lightdash/common");
-const preAggregateAudit_1 = require("./preAggregateAudit");
-vi.mock('./dbt/apiClient', () => ({
-    lightdashApi: vi.fn(),
-    checkLightdashVersion: vi.fn(),
-}));
-const { renderSingle, exitIfFailOnMiss } = preAggregateAudit_1.testHelpers;
-const makeAudit = (partial = {}) => ({
-    dashboardUuid: 'd-1',
-    dashboardSlug: 'd1',
-    dashboardName: 'D1',
-    tabs: [{ tabUuid: null, tabName: null, tiles: [] }],
-    summary: { hitCount: 0, missCount: 0, ineligibleCount: 0 },
-    ...partial,
-});
-describe('renderSingle JSON mode', () => {
-    it('prints DashboardPreAggregateAudit as JSON', () => {
-        const audit = makeAudit({
-            summary: { hitCount: 2, missCount: 1, ineligibleCount: 0 },
-        });
-        const spy = vi
-            .spyOn(process.stdout, 'write')
-            .mockImplementation(() => true);
-        renderSingle(audit, { json: true, verbose: false });
-        expect(spy).toHaveBeenCalledWith(`${JSON.stringify(audit, null, 2)}\n`);
-        spy.mockRestore();
-    });
-});
-describe('renderSingle human output', () => {
-    const missTileWithoutChartName = {
-        status: 'miss',
-        tileUuid: 't-1',
-        tileName: 'Orders over time',
-        tileType: common_1.DashboardTileTypes.SAVED_CHART,
-        savedChartUuid: 'sc-1',
-        exploreName: 'orders',
-        miss: { reason: common_1.PreAggregateMissReason.NO_PRE_AGGREGATES_DEFINED },
-        missFieldLabel: null,
-    };
-    it('does not crash when tiles lack chartName/exploreLabel', () => {
-        const audit = makeAudit({
-            summary: { hitCount: 0, missCount: 1, ineligibleCount: 0 },
-            tabs: [
-                {
-                    tabUuid: null,
-                    tabName: null,
-                    tiles: [missTileWithoutChartName],
-                },
-            ],
-        });
-        const writes = [];
-        const spy = vi
-            .spyOn(process.stdout, 'write')
-            .mockImplementation((chunk) => {
-            writes.push(String(chunk));
-            return true;
-        });
-        expect(() => renderSingle(audit, { json: false, verbose: false })).not.toThrow();
-        expect(writes.join('')).toContain('Orders over time');
-        spy.mockRestore();
-    });
-});
-describe('exitIfFailOnMiss', () => {
-    it('does nothing if flag unset', () => {
-        const spy = vi
-            .spyOn(process, 'exit')
-            .mockImplementation(() => undefined);
-        exitIfFailOnMiss([
-            makeAudit({
-                summary: { hitCount: 0, missCount: 5, ineligibleCount: 0 },
-            }),
-        ], false);
-        expect(spy).not.toHaveBeenCalled();
-        spy.mockRestore();
-    });
-    it('exits 1 when flag set and any miss present', () => {
-        const spy = vi
-            .spyOn(process, 'exit')
-            .mockImplementation(() => undefined);
-        exitIfFailOnMiss([
-            makeAudit({
-                summary: { hitCount: 1, missCount: 2, ineligibleCount: 0 },
-            }),
-        ], true);
-        expect(spy).toHaveBeenCalledWith(1);
-        spy.mockRestore();
-    });
-    it('does not exit when flag set and no misses', () => {
-        const spy = vi
-            .spyOn(process, 'exit')
-            .mockImplementation(() => undefined);
-        exitIfFailOnMiss([
-            makeAudit({
-                summary: { hitCount: 3, missCount: 0, ineligibleCount: 2 },
-            }),
-        ], true);
-        expect(spy).not.toHaveBeenCalled();
-        spy.mockRestore();
-    });
-});

package/dist/handlers/renameHandler.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=renameHandler.test.d.ts.map

package/dist/handlers/renameHandler.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"renameHandler.test.d.ts","sourceRoot":"","sources":["../../src/handlers/renameHandler.test.ts"],"names":[],"mappings":""}

package/dist/handlers/renameHandler.test.js

@@ -1,189 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const common_1 = require("@lightdash/common");
-const analytics_1 = require("../analytics/analytics");
-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 renameHandler_1 = require("./renameHandler");
-vi.mock('../analytics/analytics');
-vi.mock('../config');
-vi.mock('./dbt/apiClient');
-vi.mock('./dbt/refresh');
-const baseOptions = {
-    verbose: false,
-    type: common_1.RenameType.FIELD,
-    project: '11111111-1111-4111-8111-111111111111',
-    from: 'old_name',
-    to: 'new_name',
-    dryRun: false,
-    assumeYes: true,
-    list: false,
-    validate: true,
-};
-const emptyResults = {
-    charts: [],
-    dashboards: [],
-    alerts: [],
-    dashboardSchedulers: [],
-};
-const RENAME_JOB_ID = 'rename-job-id';
-const VALIDATION_JOB_ID = 'validation-job-id';
-const PREVIEW_PROJECT = '33333333-3333-4333-8333-333333333333';
-describe('renameHandler follow-up validation', () => {
-    let errorOutput;
-    const mockApi = (failingJobId) => {
-        vi.mocked(apiClient_1.lightdashApi).mockImplementation(async ({ method, url }) => {
-            if (method === 'POST' && url.endsWith('/rename')) {
-                return { jobId: RENAME_JOB_ID };
-            }
-            if (method === 'POST' && url.endsWith('/validate')) {
-                return { jobId: VALIDATION_JOB_ID };
-            }
-            if (url.includes(`/schedulers/job/${failingJobId}/status`)) {
-                return {
-                    status: common_1.SchedulerJobStatus.ERROR,
-                    details: { error: 'job blew up' },
-                };
-            }
-            if (url.includes('/schedulers/job/')) {
-                return {
-                    status: common_1.SchedulerJobStatus.COMPLETED,
-                    details: { results: emptyResults },
-                };
-            }
-            if (url.includes('/validate?jobId=')) {
-                return [];
-            }
-            if (method === 'GET' &&
-                url === `/api/v1/projects/${PREVIEW_PROJECT}`) {
-                return {
-                    projectUuid: PREVIEW_PROJECT,
-                    type: common_1.ProjectType.PREVIEW,
-                };
-            }
-            throw new Error(`Unexpected API call: ${method} ${url}`);
-        });
-    };
-    beforeEach(() => {
-        vi.clearAllMocks();
-        vi.stubEnv('LIGHTDASH_PROJECT', undefined);
-        vi.mocked(apiClient_1.checkLightdashVersion).mockResolvedValue(undefined);
-        vi.mocked(config_1.getConfig).mockResolvedValue({
-            context: {
-                apiKey: 'test-key',
-                serverUrl: 'http://localhost',
-                project: '11111111-1111-4111-8111-111111111111',
-            },
-        });
-        vi.mocked(refresh_1.getProject).mockResolvedValue({
-            name: 'test project',
-        });
-        errorOutput = [];
-        vi.spyOn(console, 'error').mockImplementation((...args) => {
-            errorOutput.push(args.map(String).join(' '));
-        });
-        vi.spyOn(console, 'info').mockImplementation(() => { });
-    });
-    afterEach(() => {
-        vi.restoreAllMocks();
-        vi.unstubAllEnvs();
-    });
-    const trackedEvents = () => vi.mocked(analytics_1.LightdashAnalytics.track).mock.calls.map(([payload]) => ({
-        event: payload.event,
-        properties: payload.properties,
-    }));
-    test.each([undefined, baseOptions.project])('targets the environment project unless --project overrides it (%s)', async (explicitProject) => {
-        const envProject = '22222222-2222-4222-8222-222222222222';
-        vi.stubEnv('LIGHTDASH_PROJECT', envProject);
-        vi.spyOn(globalState_1.default, 'isNonInteractive').mockReturnValue(true);
-        vi.mocked(config_1.getConfig).mockResolvedValue({
-            context: {
-                apiKey: 'test-key',
-                serverUrl: 'http://localhost',
-                project: envProject,
-                previewProject: PREVIEW_PROJECT,
-                previewName: 'Stale preview',
-            },
-        });
-        mockApi(null);
-        await (0, renameHandler_1.renameHandler)({ ...baseOptions, project: explicitProject });
-        const expectedProject = explicitProject || envProject;
-        expect(apiClient_1.lightdashApi).toHaveBeenCalledWith(expect.objectContaining({
-            method: 'POST',
-            url: `/api/v1/projects/${expectedProject}/rename`,
-        }));
-        const output = errorOutput.join('\n');
-        expect(output).toContain(`Renaming in project: ${expectedProject}`);
-        if (explicitProject) {
-            expect(output).not.toContain('Stale preview');
-        }
-        else {
-            expect(output).toContain('active preview "Stale preview" ignored');
-        }
-    });
-    test('reports a failed validation job as a validation failure, not a rename failure', async () => {
-        mockApi(VALIDATION_JOB_ID);
-        await (0, renameHandler_1.renameHandler)({ ...baseOptions });
-        const output = errorOutput.join('\n');
-        expect(output).toContain('Rename completed');
-        expect(output).toContain('Validation failed: job blew up');
-        expect(output).not.toContain('Rename failed');
-        expect(output).not.toContain('unexpected error');
-    });
-    test('counts a rename whose follow-up validation failed as completed', async () => {
-        mockApi(VALIDATION_JOB_ID);
-        await (0, renameHandler_1.renameHandler)({ ...baseOptions });
-        expect(trackedEvents()).toEqual([
-            {
-                event: 'rename.completed',
-                properties: expect.objectContaining({
-                    validationStatus: 'failed',
-                }),
-            },
-        ]);
-    });
-    test('still reports a failed rename job as a rename failure', async () => {
-        mockApi(RENAME_JOB_ID);
-        await (0, renameHandler_1.renameHandler)({ ...baseOptions });
-        const output = errorOutput.join('\n');
-        expect(output).toContain('Rename failed: job blew up');
-        expect(output).not.toContain('Validation failed');
-        expect(trackedEvents()).toEqual([
-            { event: 'rename.error', properties: expect.anything() },
-        ]);
-    });
-    test('records a passing validation on the completed event', async () => {
-        mockApi(null);
-        await (0, renameHandler_1.renameHandler)({ ...baseOptions });
-        expect(trackedEvents()).toEqual([
-            {
-                event: 'rename.completed',
-                properties: expect.objectContaining({
-                    validationStatus: 'passed',
-                }),
-            },
-        ]);
-    });
-    test('does not run the validation job when --validate is not set', async () => {
-        mockApi(null);
-        await (0, renameHandler_1.renameHandler)({ ...baseOptions, validate: false });
-        const validationCalls = vi
-            .mocked(apiClient_1.lightdashApi)
-            .mock.calls.filter(([{ url }]) => url.endsWith('/validate'));
-        expect(validationCalls).toEqual([]);
-        const output = errorOutput.join('\n');
-        expect(output).not.toContain('failed');
-        expect(output).not.toContain('unexpected error');
-        expect(trackedEvents()).toEqual([
-            {
-                event: 'rename.completed',
-                properties: expect.objectContaining({
-                    validationStatus: 'skipped',
-                }),
-            },
-        ]);
-    });
-});

package/dist/handlers/resolveProjectFlag.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=resolveProjectFlag.test.d.ts.map

package/dist/handlers/resolveProjectFlag.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"resolveProjectFlag.test.d.ts","sourceRoot":"","sources":["../../src/handlers/resolveProjectFlag.test.ts"],"names":[],"mappings":""}

package/dist/handlers/resolveProjectFlag.test.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const common_1 = require("@lightdash/common");
-const apiClient_1 = require("./dbt/apiClient");
-const resolveProjectFlag_1 = require("./resolveProjectFlag");
-vi.mock('./dbt/apiClient', () => ({
-    lightdashApi: vi.fn(),
-}));
-const mockLightdashApi = apiClient_1.lightdashApi;
-const PROJECT_UUID = '00000000-0000-0000-0000-000000000001';
-const OTHER_UUID = '00000000-0000-0000-0000-000000000002';
-const mockOrgProjects = (projects) => {
-    mockLightdashApi.mockResolvedValueOnce(projects.map((project) => ({
-        ...project,
-        type: common_1.ProjectType.DEFAULT,
-    })));
-};
-describe('resolveProjectFlag', () => {
-    afterEach(() => {
-        vi.clearAllMocks();
-    });
-    it('returns a UUID as-is without calling the API', async () => {
-        await expect((0, resolveProjectFlag_1.resolveProjectFlag)(PROJECT_UUID)).resolves.toBe(PROJECT_UUID);
-        expect(mockLightdashApi).not.toHaveBeenCalled();
-    });
-    it('resolves a slug to the matching project UUID', async () => {
-        mockOrgProjects([
-            { projectUuid: OTHER_UUID, slug: 'other', name: 'Other' },
-            { projectUuid: PROJECT_UUID, slug: 'jaffle-shop', name: 'Jaffle' },
-        ]);
-        await expect((0, resolveProjectFlag_1.resolveProjectFlag)('jaffle-shop')).resolves.toBe(PROJECT_UUID);
-        expect(mockLightdashApi).toHaveBeenCalledWith(expect.objectContaining({ url: '/api/v1/org/projects' }));
-    });
-    it('fails with an actionable error for an unknown slug', async () => {
-        mockOrgProjects([
-            { projectUuid: PROJECT_UUID, slug: 'jaffle-shop', name: 'Jaffle' },
-            { projectUuid: OTHER_UUID, name: 'No slug' },
-        ]);
-        await expect((0, resolveProjectFlag_1.resolveProjectFlag)('missing')).rejects.toThrow(common_1.ParameterError);
-    });
-    it('fails when a slug matches more than one project', async () => {
-        mockOrgProjects([
-            { projectUuid: PROJECT_UUID, slug: 'dup', name: 'A' },
-            { projectUuid: OTHER_UUID, slug: 'dup', name: 'B' },
-        ]);
-        await expect((0, resolveProjectFlag_1.resolveProjectFlag)('dup')).rejects.toThrow(/more than one project/);
-    });
-});

package/dist/handlers/selectProject.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=selectProject.test.d.ts.map

package/dist/handlers/selectProject.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"selectProject.test.d.ts","sourceRoot":"","sources":["../../src/handlers/selectProject.test.ts"],"names":[],"mappings":""}