@lightdash/cli 0.3387.0 → 0.3389.0

package/dist/handlers/organizationContent/groups.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadGroups = exports.uploadGroups = exports.countDependencySkippedGroups = exports.readGroupFiles = exports.formatGroupUploadSummary = exports.getGroupsFolder = void 0;
+const tslib_1 = require("tslib");
+/* eslint-disable no-await-in-loop */
+const common_1 = require("@lightdash/common");
+const fs_1 = require("fs");
+const yaml = tslib_1.__importStar(require("js-yaml"));
+const groupBy_1 = tslib_1.__importDefault(require("lodash/groupBy"));
+const path = tslib_1.__importStar(require("path"));
+const apiClient_1 = require("../dbt/apiClient");
+const fileNames_1 = require("./fileNames");
+const getGroupsFolder = (organizationContentPath) => path.join(organizationContentPath, 'groups');
+exports.getGroupsFolder = getGroupsFolder;
+const formatGroupUploadSummary = (summary) => `${summary.created} created, ${summary.updated} updated, ${summary.unchanged} unchanged, ${summary.failed} failed, ${summary.dependencySkipped} dependency-skipped`;
+exports.formatGroupUploadSummary = formatGroupUploadSummary;
+const getGroupName = (group) => {
+    if (typeof group !== 'object' || group === null || Array.isArray(group)) {
+        return undefined;
+    }
+    const { name } = group;
+    return typeof name === 'string' ? name : undefined;
+};
+const readGroupFileResults = async (organizationContentPath) => {
+    const folder = (0, exports.getGroupsFolder)(organizationContentPath);
+    let entries;
+    try {
+        entries = await fs_1.promises.readdir(folder, { withFileTypes: true });
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            return { groupFiles: [], failures: [] };
+        }
+        throw error;
+    }
+    const files = entries
+        .filter((entry) => entry.isFile() && entry.name.endsWith('.yml'))
+        .sort((left, right) => left.name.localeCompare(right.name));
+    const results = await Promise.all(files.map(async (file) => {
+        const filePath = path.join(folder, file.name);
+        try {
+            return {
+                kind: 'group',
+                groupFile: {
+                    filePath,
+                    group: yaml.load(await fs_1.promises.readFile(filePath, 'utf8')),
+                },
+            };
+        }
+        catch (error) {
+            return {
+                kind: 'failure',
+                failure: {
+                    message: `Unable to parse group file "${filePath}": ${(0, common_1.getErrorMessage)(error)}`,
+                },
+            };
+        }
+    }));
+    const parsedGroupFiles = results.flatMap((result) => result.kind === 'group' ? [result.groupFile] : []);
+    const failures = results.flatMap((result) => result.kind === 'failure' ? [result.failure] : []);
+    const namedGroupFiles = parsedGroupFiles.flatMap((groupFile) => {
+        const name = getGroupName(groupFile.group);
+        return name === undefined ? [] : [{ name, groupFile }];
+    });
+    const filesByName = (0, groupBy_1.default)(namedGroupFiles, ({ name }) => name);
+    const duplicateNames = new Set(Object.entries(filesByName)
+        .filter(([, matchingFiles]) => matchingFiles.length > 1)
+        .map(([name]) => name));
+    for (const duplicateName of [...duplicateNames].sort()) {
+        for (const { groupFile } of filesByName[duplicateName]) {
+            failures.push({
+                message: `Duplicate group name "${duplicateName}" in "${groupFile.filePath}"`,
+            });
+        }
+    }
+    return {
+        groupFiles: parsedGroupFiles.filter(({ group }) => !duplicateNames.has(getGroupName(group) ?? '')),
+        failures,
+    };
+};
+const readGroupFiles = async (organizationContentPath) => {
+    const { groupFiles, failures } = await readGroupFileResults(organizationContentPath);
+    if (failures.length > 0) {
+        throw new common_1.ParameterError(failures.map(({ message }) => message).join('\n'));
+    }
+    return groupFiles.map(({ group }) => group);
+};
+exports.readGroupFiles = readGroupFiles;
+const countDependencySkippedGroups = async (organizationContentPath) => {
+    const folder = (0, exports.getGroupsFolder)(organizationContentPath);
+    try {
+        const entries = await fs_1.promises.readdir(folder, { withFileTypes: true });
+        return entries.filter((entry) => entry.isFile() && entry.name.endsWith('.yml')).length;
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            return 0;
+        }
+        throw error;
+    }
+};
+exports.countDependencySkippedGroups = countDependencySkippedGroups;
+const uploadGroups = async (organizationUuid, organizationContentPath) => {
+    const { groupFiles, failures } = await readGroupFileResults(organizationContentPath);
+    const summary = {
+        created: 0,
+        updated: 0,
+        unchanged: 0,
+        failed: 0,
+        dependencySkipped: 0,
+        failures,
+    };
+    for (const { filePath, group } of groupFiles) {
+        try {
+            const result = await (0, apiClient_1.lightdashApi)({
+                method: 'POST',
+                url: `/api/v2/orgs/${organizationUuid}/groups/code`,
+                body: JSON.stringify(group),
+            });
+            switch (result.action) {
+                case common_1.PromotionAction.CREATE:
+                    summary.created += 1;
+                    break;
+                case common_1.PromotionAction.UPDATE:
+                    summary.updated += 1;
+                    break;
+                case common_1.PromotionAction.NO_CHANGES:
+                    summary.unchanged += 1;
+                    break;
+                default:
+                    throw new common_1.ParameterError(`Unsupported group promotion action: ${result.action}`);
+            }
+        }
+        catch (error) {
+            summary.failures.push({
+                message: `Invalid group file "${filePath}": ${(0, common_1.getErrorMessage)(error)}`,
+            });
+        }
+    }
+    summary.failed = summary.failures.length;
+    return summary;
+};
+exports.uploadGroups = uploadGroups;
+const downloadGroups = async (organizationUuid, organizationContentPath) => {
+    const { groups } = await (0, apiClient_1.lightdashApi)({
+        method: 'GET',
+        url: `/api/v2/orgs/${organizationUuid}/groups/code`,
+        body: undefined,
+    });
+    const folder = (0, exports.getGroupsFolder)(organizationContentPath);
+    await fs_1.promises.mkdir(folder, { recursive: true });
+    const existingFiles = await fs_1.promises.readdir(folder, { withFileTypes: true });
+    await Promise.all(existingFiles
+        .filter((entry) => entry.isFile() && entry.name.endsWith('.yml'))
+        .map((entry) => fs_1.promises.unlink(path.join(folder, entry.name))));
+    const sortedGroups = [...groups]
+        .map((group) => ({
+        ...group,
+        members: [...group.members].sort(),
+    }))
+        .sort((left, right) => left.name.localeCompare(right.name));
+    const filenames = (0, fileNames_1.getOrganizationContentFileNames)({
+        values: sortedGroups.map(({ name }) => name),
+        fallbackPrefix: 'group',
+    });
+    await Promise.all(sortedGroups.map(async (group, index) => {
+        await fs_1.promises.writeFile(path.join(folder, filenames[index]), yaml.dump(group, { quotingType: '"', sortKeys: true }));
+    }));
+    return sortedGroups.length;
+};
+exports.downloadGroups = downloadGroups;

package/dist/handlers/organizationContent/groups.test.d.ts

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

package/dist/handlers/organizationContent/groups.test.d.ts.map

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

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

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const crypto_1 = require("crypto");
+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 groups_1 = require("./groups");
+vitest_1.vi.mock('../dbt/apiClient', async (importOriginal) => ({
+    ...(await importOriginal()),
+    lightdashApi: vitest_1.vi.fn(),
+}));
+describe('groups as code', () => {
+    let tmpDir;
+    const group = (name, members = []) => ({
+        version: 1,
+        name,
+        members,
+    });
+    const writeGroup = async (filename, value) => {
+        const folder = (0, groups_1.getGroupsFolder)(tmpDir);
+        await fs_1.promises.mkdir(folder, { recursive: true });
+        await fs_1.promises.writeFile(path.join(folder, filename), typeof value === 'string'
+            ? value
+            : 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(), 'groups-test-'));
+    });
+    afterEach(async () => {
+        vitest_1.vi.restoreAllMocks();
+        await fs_1.promises.rm(tmpDir, { recursive: true, force: true });
+    });
+    it('downloads deterministic groups, empty groups, and collision-safe filenames', async () => {
+        const folder = (0, groups_1.getGroupsFolder)(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({
+            groups: [
+                group('Finance?', ['z@example.com', 'a@example.com']),
+                group('Empty'),
+                group('Finance!'),
+            ],
+        });
+        await expect((0, groups_1.downloadGroups)('organization-uuid', tmpDir)).resolves.toBe(3);
+        const financeBangHash = (0, crypto_1.createHash)('sha256')
+            .update('Finance!')
+            .digest('hex')
+            .slice(0, 8);
+        const financeQuestionHash = (0, crypto_1.createHash)('sha256')
+            .update('Finance?')
+            .digest('hex')
+            .slice(0, 8);
+        expect((await fs_1.promises.readdir(folder)).sort()).toStrictEqual([
+            'empty.yml',
+            `finance-${financeBangHash}.yml`,
+            `finance-${financeQuestionHash}.yml`,
+        ].sort());
+        expect(yaml.load(await fs_1.promises.readFile(path.join(folder, `finance-${financeQuestionHash}.yml`), 'utf8'))).toStrictEqual({
+            version: 1,
+            name: 'Finance?',
+            members: ['a@example.com', 'z@example.com'],
+        });
+        expect(yaml.load(await fs_1.promises.readFile(path.join(folder, 'empty.yml'), 'utf8'))).toStrictEqual({ version: 1, name: 'Empty', members: [] });
+    });
+    it('rejects duplicate exact names but preserves case-sensitive identity', async () => {
+        await writeGroup('one.yml', group('Finance'));
+        await writeGroup('two.yml', group('Finance'));
+        await expect((0, groups_1.readGroupFiles)(tmpDir)).rejects.toThrow('Duplicate group name "Finance"');
+        await fs_1.promises.rm((0, groups_1.getGroupsFolder)(tmpDir), { recursive: true });
+        await writeGroup('upper.yml', group('Finance'));
+        await writeGroup('lower.yml', group('finance'));
+        await expect((0, groups_1.readGroupFiles)(tmpDir)).resolves.toHaveLength(2);
+    });
+    it('is a backward-compatible no-op when the groups folder is missing', async () => {
+        await expect((0, groups_1.uploadGroups)('organization-uuid', tmpDir)).resolves.toMatchObject({
+            created: 0,
+            updated: 0,
+            unchanged: 0,
+            failed: 0,
+            dependencySkipped: 0,
+        });
+        expect(apiClient_1.lightdashApi).not.toHaveBeenCalled();
+    });
+    it('continues after malformed and API-failing group files', async () => {
+        await writeGroup('bad-yaml.yml', 'name: [unterminated');
+        await writeGroup('api-error.yml', group('API error'));
+        await writeGroup('valid.yml', group('Valid'));
+        vitest_1.vi.mocked(apiClient_1.lightdashApi)
+            .mockRejectedValueOnce(new Error('unknown member'))
+            .mockResolvedValueOnce({ action: common_1.PromotionAction.CREATE });
+        await expect((0, groups_1.uploadGroups)('organization-uuid', tmpDir)).resolves.toMatchObject({
+            created: 1,
+            updated: 0,
+            unchanged: 0,
+            failed: 2,
+        });
+        expect(apiClient_1.lightdashApi).toHaveBeenCalledTimes(2);
+    });
+    it('reports all promotion actions and sends the portable body', async () => {
+        await writeGroup('create.yml', group('Create'));
+        await writeGroup('same.yml', group('Same'));
+        await writeGroup('update.yml', group('Update', ['member@example.com']));
+        vitest_1.vi.mocked(apiClient_1.lightdashApi)
+            .mockResolvedValueOnce({ action: common_1.PromotionAction.CREATE })
+            .mockResolvedValueOnce({
+            action: common_1.PromotionAction.NO_CHANGES,
+        })
+            .mockResolvedValueOnce({ action: common_1.PromotionAction.UPDATE });
+        await expect((0, groups_1.uploadGroups)('organization-uuid', tmpDir)).resolves.toMatchObject({
+            created: 1,
+            updated: 1,
+            unchanged: 1,
+            failed: 0,
+        });
+        expect(apiClient_1.lightdashApi).toHaveBeenNthCalledWith(3, {
+            method: 'POST',
+            url: '/api/v2/orgs/organization-uuid/groups/code',
+            body: expect.any(String),
+        });
+        expect(JSON.parse(vitest_1.vi.mocked(apiClient_1.lightdashApi).mock.calls[2][0].body)).toStrictEqual(group('Update', ['member@example.com']));
+    });
+    it('counts files skipped because a dependency phase failed', async () => {
+        await writeGroup('one.yml', group('One'));
+        await writeGroup('two.yml', 'invalid: [yaml');
+        await fs_1.promises.writeFile(path.join((0, groups_1.getGroupsFolder)(tmpDir), 'ignored.yaml'), 'name: ignored');
+        await expect((0, groups_1.countDependencySkippedGroups)(tmpDir)).resolves.toBe(2);
+    });
+});

package/dist/handlers/organizationContent/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAW3C,KAAK,0BAA0B,GAAG;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAsBF,eAAO,MAAM,4BAA4B,GAAI,aAAa,MAAM,KAAG,MAClC,CAAC;AAElC,eAAO,MAAM,2BAA2B,GAAU,yBAG/C,0BAA0B,KAAG,OAAO,CAAC,IAAI,CAkE3C,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAAU,sCAI7C,0BAA0B,KAAG,OAAO,CAAC,IAAI,CA6F3C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAiB3C,KAAK,0BAA0B,GAAG;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAmCF,eAAO,MAAM,4BAA4B,GAAI,aAAa,MAAM,KAAG,MAClC,CAAC;AAElC,eAAO,MAAM,2BAA2B,GAAU,yBAG/C,0BAA0B,KAAG,OAAO,CAAC,IAAI,CAqF3C,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAAU,sCAI7C,0BAA0B,KAAG,OAAO,CAAC,IAAI,CAiI3C,CAAC"}

package/dist/handlers/organizationContent/index.js

@@ -8,8 +8,10 @@ const globalState_1 = tslib_1.__importDefault(require("../../globalState"));
 const styles = tslib_1.__importStar(require("../../styles"));
 const contentAsCodePaths_1 = require("../contentAsCodePaths");
 const customRoles_1 = require("./customRoles");
+const groups_1 = require("./groups");
 const users_1 = require("./users");
 const customRolePartialUploadErrors = new WeakSet();
+const groupPartialUploadErrors = new WeakSet();
 const userPartialUploadErrors = new WeakSet();
 const createCustomRolePartialUploadError = (message) => {
     const error = new common_1.ParameterError(message);
@@ -21,9 +23,18 @@ const createUserPartialUploadError = (message) => {
     userPartialUploadErrors.add(error);
     return error;
 };
+const createGroupPartialUploadError = (message) => {
+    const error = new common_1.ParameterError(message);
+    groupPartialUploadErrors.add(error);
+    return error;
+};
 const isPartialUploadError = (error) => error instanceof Error &&
     (customRolePartialUploadErrors.has(error) ||
+        groupPartialUploadErrors.has(error) ||
         userPartialUploadErrors.has(error));
+const isGroupServiceDisabledError = (error) => error instanceof common_1.LightdashError &&
+    error.statusCode === 403 &&
+    error.message === 'Group service is not enabled';
 const getOrganizationContentFolder = (customPath) => (0, contentAsCodePaths_1.getDownloadFolder)(customPath);
 exports.getOrganizationContentFolder = getOrganizationContentFolder;
 const downloadOrganizationContent = async ({ customPath, config, }) => {
@@ -48,6 +59,19 @@ const downloadOrganizationContent = async ({ customPath, config, }) => {
         spinner.start(`Downloading users`);
         const usersTotal = await (0, users_1.downloadUsers)(organizationUuid, organizationContentPath);
         spinner.succeed(`Downloaded ${usersTotal} users`);
+        spinner.start(`Downloading groups`);
+        let groupsTotal = 0;
+        try {
+            groupsTotal = await (0, groups_1.downloadGroups)(organizationUuid, organizationContentPath);
+            spinner.succeed(`Downloaded ${groupsTotal} groups`);
+        }
+        catch (error) {
+            if (!isGroupServiceDisabledError(error)) {
+                throw error;
+            }
+            spinner.stop();
+            globalState_1.default.debug('> Warning: groups were not downloaded because the group service is not enabled');
+        }
         globalState_1.default.log(styles.success(`Downloaded organization content saved to ${organizationContentPath}`));
         await analytics_1.LightdashAnalytics.track({
             event: 'download.completed',
@@ -57,6 +81,7 @@ const downloadOrganizationContent = async ({ customPath, config, }) => {
                 scope: 'organization',
                 customRolesNum: customRolesTotal,
                 usersNum: usersTotal,
+                groupsNum: groupsTotal,
                 timeToCompleted: (Date.now() - start) / 1000,
             },
         });
@@ -98,6 +123,8 @@ const uploadOrganizationContent = async ({ customPath, config, sendInvites = fal
         if (summary.failed > 0) {
             summary.failures.forEach(({ message }) => globalState_1.default.log(styles.error(message)));
             spinner.stop();
+            const skippedGroups = await (0, groups_1.countDependencySkippedGroups)(organizationContentPath);
+            globalState_1.default.log(styles.warning(`Skipped users and ${skippedGroups} groups because custom roles failed`));
             throw createCustomRolePartialUploadError(`Processed custom roles: ${summaryMessage}`);
         }
         spinner.succeed(`Uploaded custom roles: ${summaryMessage}`);
@@ -107,9 +134,20 @@ const uploadOrganizationContent = async ({ customPath, config, sendInvites = fal
         if (userSummary.failed > 0) {
             userSummary.failures.forEach(({ message }) => globalState_1.default.log(styles.error(message)));
             spinner.stop();
+            const skippedGroups = await (0, groups_1.countDependencySkippedGroups)(organizationContentPath);
+            globalState_1.default.log(styles.warning(`Skipped ${skippedGroups} groups because users failed`));
             throw createUserPartialUploadError(`Processed users: ${userSummaryMessage}`);
         }
         spinner.succeed(`Uploaded users: ${userSummaryMessage}`);
+        spinner.start(`Uploading groups`);
+        const groupSummary = await (0, groups_1.uploadGroups)(organizationUuid, organizationContentPath);
+        const groupSummaryMessage = (0, groups_1.formatGroupUploadSummary)(groupSummary);
+        if (groupSummary.failed > 0) {
+            groupSummary.failures.forEach(({ message }) => globalState_1.default.log(styles.error(message)));
+            spinner.stop();
+            throw createGroupPartialUploadError(`Processed groups: ${groupSummaryMessage}`);
+        }
+        spinner.succeed(`Uploaded groups: ${groupSummaryMessage}`);
         globalState_1.default.log(styles.success(`Uploaded organization content from ${organizationContentPath}`));
         await analytics_1.LightdashAnalytics.track({
             event: 'upload.completed',
@@ -125,6 +163,9 @@ const uploadOrganizationContent = async ({ customPath, config, sendInvites = fal
                 usersUnchanged: userSummary.unchanged,
                 usersAwaitingAuthentication: userSummary.awaitingAuthentication,
                 usersInvited: userSummary.invited,
+                groupsCreated: groupSummary.created,
+                groupsUpdated: groupSummary.updated,
+                groupsUnchanged: groupSummary.unchanged,
                 timeToCompleted: (Date.now() - start) / 1000,
             },
         });

package/dist/handlers/organizationContent/index.test.d.ts

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

package/dist/handlers/organizationContent/index.test.d.ts.map

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

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

@@ -0,0 +1,155 @@
+"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 globalState_1 = tslib_1.__importDefault(require("../../globalState"));
+const customRoles_1 = require("./customRoles");
+const groups_1 = require("./groups");
+const index_1 = require("./index");
+const users_1 = require("./users");
+vi.mock('./customRoles', async (importOriginal) => ({
+    ...(await importOriginal()),
+    downloadCustomRoles: vi.fn(),
+    uploadCustomRoles: vi.fn(),
+}));
+vi.mock('./users', async (importOriginal) => ({
+    ...(await importOriginal()),
+    downloadUsers: vi.fn(),
+    uploadUsers: vi.fn(),
+}));
+vi.mock('./groups', async (importOriginal) => ({
+    ...(await importOriginal()),
+    downloadGroups: vi.fn(),
+    uploadGroups: vi.fn(),
+    countDependencySkippedGroups: vi.fn(),
+}));
+describe('organization content download', () => {
+    const spinner = {
+        start: vi.fn(),
+        succeed: vi.fn(),
+        stop: vi.fn(),
+        fail: vi.fn(),
+    };
+    const config = {
+        user: {
+            userUuid: 'user-uuid',
+            organizationUuid: 'organization-uuid',
+        },
+    };
+    beforeEach(() => {
+        vi.clearAllMocks();
+        vi.spyOn(globalState_1.default, 'startSpinner').mockReturnValue(spinner);
+        vi.spyOn(globalState_1.default, 'log').mockImplementation(() => undefined);
+        vi.spyOn(globalState_1.default, 'debug').mockImplementation(() => undefined);
+        vi.spyOn(analytics_1.LightdashAnalytics, 'track').mockResolvedValue(undefined);
+        vi.mocked(customRoles_1.downloadCustomRoles).mockResolvedValue(2);
+        vi.mocked(users_1.downloadUsers).mockResolvedValue(3);
+        vi.mocked(groups_1.downloadGroups).mockResolvedValue(4);
+    });
+    it('skips groups when the group service is disabled', async () => {
+        vi.mocked(groups_1.downloadGroups).mockRejectedValue(new common_1.LightdashError({
+            message: 'Group service is not enabled',
+            name: 'ForbiddenError',
+            statusCode: 403,
+            data: {},
+        }));
+        await expect((0, index_1.downloadOrganizationContent)({ config })).resolves.toBeUndefined();
+        expect(spinner.stop).toHaveBeenCalledOnce();
+        expect(spinner.fail).not.toHaveBeenCalled();
+        expect(globalState_1.default.debug).toHaveBeenCalledWith('> Warning: groups were not downloaded because the group service is not enabled');
+    });
+    it('still fails for other group download errors', async () => {
+        vi.mocked(groups_1.downloadGroups).mockRejectedValue(new Error('Network error'));
+        await expect((0, index_1.downloadOrganizationContent)({ config })).rejects.toThrow('Network error');
+        expect(spinner.fail).toHaveBeenCalledOnce();
+    });
+});
+describe('organization content upload sequencing', () => {
+    const spinner = {
+        start: vi.fn(),
+        succeed: vi.fn(),
+        stop: vi.fn(),
+        fail: vi.fn(),
+    };
+    const config = {
+        user: {
+            userUuid: 'user-uuid',
+            organizationUuid: 'organization-uuid',
+        },
+    };
+    const customRoleSummary = (failed = 0) => ({
+        created: 0,
+        updated: 0,
+        unchanged: 0,
+        failed,
+        failures: failed > 0 ? [{ message: 'role failure' }] : [],
+    });
+    const userSummary = (failed = 0) => ({
+        created: 0,
+        updated: 0,
+        unchanged: 0,
+        awaitingAuthentication: 0,
+        invited: 0,
+        skippedAuthenticated: 0,
+        skippedDisabled: 0,
+        skippedValidInvite: 0,
+        failed,
+        failures: failed > 0 ? [{ message: 'user failure' }] : [],
+    });
+    const groupSummary = (failed = 0) => ({
+        created: 0,
+        updated: 0,
+        unchanged: 0,
+        failed,
+        dependencySkipped: 0,
+        failures: failed > 0 ? [{ message: 'group failure' }] : [],
+    });
+    beforeEach(() => {
+        vi.clearAllMocks();
+        vi.spyOn(globalState_1.default, 'startSpinner').mockReturnValue(spinner);
+        vi.spyOn(globalState_1.default, 'log').mockImplementation(() => undefined);
+        vi.spyOn(analytics_1.LightdashAnalytics, 'track').mockResolvedValue(undefined);
+        vi.mocked(customRoles_1.uploadCustomRoles).mockResolvedValue(customRoleSummary());
+        vi.mocked(users_1.uploadUsers).mockResolvedValue(userSummary());
+        vi.mocked(groups_1.uploadGroups).mockResolvedValue(groupSummary());
+        vi.mocked(groups_1.countDependencySkippedGroups).mockResolvedValue(2);
+    });
+    it('awaits custom roles, then users, then groups', async () => {
+        const phaseOrder = [];
+        vi.mocked(customRoles_1.uploadCustomRoles).mockImplementation(async () => {
+            phaseOrder.push('roles:start', 'roles:end');
+            return customRoleSummary();
+        });
+        vi.mocked(users_1.uploadUsers).mockImplementation(async () => {
+            phaseOrder.push('users:start', 'users:end');
+            return userSummary();
+        });
+        vi.mocked(groups_1.uploadGroups).mockImplementation(async () => {
+            phaseOrder.push('groups:start', 'groups:end');
+            return groupSummary();
+        });
+        await (0, index_1.uploadOrganizationContent)({ config });
+        expect(phaseOrder).toStrictEqual([
+            'roles:start',
+            'roles:end',
+            'users:start',
+            'users:end',
+            'groups:start',
+            'groups:end',
+        ]);
+    });
+    it('does not start users or groups when custom roles fail', async () => {
+        vi.mocked(customRoles_1.uploadCustomRoles).mockResolvedValue(customRoleSummary(1));
+        await expect((0, index_1.uploadOrganizationContent)({ config })).rejects.toThrow('Processed custom roles');
+        expect(users_1.uploadUsers).not.toHaveBeenCalled();
+        expect(groups_1.uploadGroups).not.toHaveBeenCalled();
+        expect(groups_1.countDependencySkippedGroups).toHaveBeenCalledOnce();
+    });
+    it('does not start groups when users fail', async () => {
+        vi.mocked(users_1.uploadUsers).mockResolvedValue(userSummary(1));
+        await expect((0, index_1.uploadOrganizationContent)({ config })).rejects.toThrow('Processed users');
+        expect(groups_1.uploadGroups).not.toHaveBeenCalled();
+        expect(groups_1.countDependencySkippedGroups).toHaveBeenCalledOnce();
+    });
+});

package/dist/handlers/organizationContent/users.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/users.ts"],"names":[],"mappings":"AAsBA,MAAM,MAAM,iBAAiB,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CACjC,CAAC;AAgBF,eAAO,MAAM,cAAc,GAAI,yBAAyB,MAAM,KAAG,MAClB,CAAC;AAEhD,eAAO,MAAM,uBAAuB,GAAI,SAAS,iBAAiB,KAAG,MAUpE,CAAC;AAwHF,eAAO,MAAM,aAAa,GACtB,yBAAyB,MAAM,KAChC,OAAO,CAAC,OAAO,EAAE,CAUnB,CAAC;AAsCF,eAAO,MAAM,WAAW,GACpB,kBAAkB,MAAM,EACxB,yBAAyB,MAAM,EAC/B,cAAa,OAAe,KAC7B,OAAO,CAAC,iBAAiB,CAkG3B,CAAC;AAEF,eAAO,MAAM,aAAa,GACtB,kBAAkB,MAAM,EACxB,yBAAyB,MAAM,KAChC,OAAO,CAAC,MAAM,CAqDhB,CAAC"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/users.ts"],"names":[],"mappings":"AAoBA,MAAM,MAAM,iBAAiB,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CACjC,CAAC;AAgBF,eAAO,MAAM,cAAc,GAAI,yBAAyB,MAAM,KAAG,MAClB,CAAC;AAEhD,eAAO,MAAM,uBAAuB,GAAI,SAAS,iBAAiB,KAAG,MAUpE,CAAC;AAyGF,eAAO,MAAM,aAAa,GACtB,yBAAyB,MAAM,KAChC,OAAO,CAAC,OAAO,EAAE,CAUnB,CAAC;AAsCF,eAAO,MAAM,WAAW,GACpB,kBAAkB,MAAM,EACxB,yBAAyB,MAAM,EAC/B,cAAa,OAAe,KAC7B,OAAO,CAAC,iBAAiB,CAkG3B,CAAC;AAEF,eAAO,MAAM,aAAa,GACtB,kBAAkB,MAAM,EACxB,yBAAyB,MAAM,KAChC,OAAO,CAAC,MAAM,CAkChB,CAAC"}

package/dist/handlers/organizationContent/users.js

@@ -4,13 +4,12 @@ exports.downloadUsers = exports.uploadUsers = exports.readUserFiles = exports.fo
 const tslib_1 = require("tslib");
 /* eslint-disable no-await-in-loop */
 const common_1 = require("@lightdash/common");
-const crypto_1 = require("crypto");
 const fs_1 = require("fs");
 const yaml = tslib_1.__importStar(require("js-yaml"));
 const groupBy_1 = tslib_1.__importDefault(require("lodash/groupBy"));
 const path = tslib_1.__importStar(require("path"));
 const apiClient_1 = require("../dbt/apiClient");
-const USER_FILENAME_MAX_LENGTH = 200;
+const fileNames_1 = require("./fileNames");
 const getUsersFolder = (organizationContentPath) => path.join(organizationContentPath, 'users');
 exports.getUsersFolder = getUsersFolder;
 const formatUserUploadSummary = (summary) => {
@@ -49,19 +48,6 @@ const asUserAsCode = (user) => {
     }
     return user;
 };
-const getUserFilenameBase = (email) => {
-    const normalizedEmail = email.toLowerCase();
-    const slug = normalizedEmail
-        .normalize('NFKD')
-        .replace(/[\u0300-\u036f]/g, '')
-        .replace(/[^a-z0-9]+/g, '-')
-        .replace(/^-+|-+$/g, '');
-    const emailHash = (0, crypto_1.createHash)('sha256')
-        .update(normalizedEmail)
-        .digest('hex')
-        .slice(0, 8);
-    return (slug || `user-${emailHash}`).slice(0, USER_FILENAME_MAX_LENGTH);
-};
 const readUserFileResults = async (organizationContentPath) => {
     const folder = (0, exports.getUsersFolder)(organizationContentPath);
     let entries;
@@ -245,21 +231,12 @@ const downloadUsers = async (organizationUuid, organizationContentPath) => {
         .filter((entry) => entry.isFile() && entry.name.endsWith('.yml'))
         .map((entry) => fs_1.promises.unlink(path.join(folder, entry.name))));
     const sortedUsers = [...users].sort((left, right) => left.email.localeCompare(right.email));
-    const filenameBases = sortedUsers.map(({ email }) => getUserFilenameBase(email));
-    const baseCounts = filenameBases.reduce((counts, filenameBase) => ({
-        ...counts,
-        [filenameBase]: (counts[filenameBase] ?? 0) + 1,
-    }), {});
+    const filenames = (0, fileNames_1.getOrganizationContentFileNames)({
+        values: sortedUsers.map(({ email }) => email.toLowerCase()),
+        fallbackPrefix: 'user',
+    });
     await Promise.all(sortedUsers.map(async (user, index) => {
-        const filenameBase = filenameBases[index];
-        const collisionSuffix = `-${(0, crypto_1.createHash)('sha256')
-            .update(user.email.toLowerCase())
-            .digest('hex')
-            .slice(0, 8)}`;
-        const uniqueFilenameBase = baseCounts[filenameBase] > 1
-            ? `${filenameBase.slice(0, USER_FILENAME_MAX_LENGTH - collisionSuffix.length)}${collisionSuffix}`
-            : filenameBase;
-        await fs_1.promises.writeFile(path.join(folder, `${uniqueFilenameBase}.yml`), yaml.dump(user, { quotingType: '"', sortKeys: true }));
+        await fs_1.promises.writeFile(path.join(folder, filenames[index]), yaml.dump(user, { quotingType: '"', sortKeys: true }));
     }));
     return sortedUsers.length;
 };