upstream-mattermost/e2e-tests/playwright/specs/functional/system_console/board_attributes/setup.ts

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

import type {Client4} from '@mattermost/client';

import type {SystemConsolePage, PlaywrightExtended} from '@mattermost/playwright-lib';

export const BOARDS_GROUP = 'boards';
export const OBJECT_TYPE_POST = 'post';
export const SYSTEM_TARGET_TYPE = 'system';

export type BoardAttributeType = 'Text' | 'Select' | 'Multi-select' | 'Date' | 'User';

export type ColorTokenName = 'Default' | 'Brown' | 'Orange' | 'Yellow' | 'Green' | 'Blue' | 'Purple' | 'Pink' | 'Red';

export const COLOR_TOKEN_NAMES: ColorTokenName[] = [
    'Default',
    'Brown',
    'Orange',
    'Yellow',
    'Green',
    'Blue',
    'Purple',
    'Pink',
    'Red',
];

// Server-side color tokens map to the UI labels above. The hex/wire token is
// the lowercase form except 'default' which doubles as the fallback.
export const SERVER_COLOR_BY_UI_LABEL: Record<ColorTokenName, string> = {
    Default: 'default',
    Brown: 'brown',
    Orange: 'orange',
    Yellow: 'yellow',
    Green: 'green',
    Blue: 'blue',
    Purple: 'purple',
    Pink: 'pink',
    Red: 'red',
};

export type BoardAttributesTestContext = {
    adminClient: Client4;
    systemConsolePage: SystemConsolePage;
};

let cachedAdminClient: Client4 | null = null;

export async function setupBoardAttributesTest(pw: PlaywrightExtended): Promise<BoardAttributesTestContext> {
    await pw.ensureLicense();
    await pw.skipIfNoLicense();

    // Feature flags are read at server start from MM_FEATUREFLAGS_* env,
    // not from runtime config patches — CI sets it in server.generate.sh;
    // locally, export it before running the server.
    await pw.skipIfFeatureFlagNotSet('IntegratedBoards', true);

    const {adminUser, adminClient} = await pw.initSetup();
    cachedAdminClient = adminClient;

    await deleteNonProtectedFields(adminClient);

    const {systemConsolePage} = await pw.testBrowser.login(adminUser);
    await systemConsolePage.goto();
    await systemConsolePage.toBeVisible();

    return {adminClient, systemConsolePage};
}

/**
 * Best-effort teardown for custom (non-protected) board fields.
 *
 * Pass `nameFilter` (recommended) to scope cleanup to fields this spec
 * created — important when multiple board_attributes specs share the same
 * server. Without a filter, all non-protected fields in the system group
 * are removed.
 */
export async function cleanupCustomBoardFields(nameFilter?: (name: string) => boolean): Promise<void> {
    if (!cachedAdminClient) {
        return;
    }
    try {
        await deleteNonProtectedFields(cachedAdminClient, nameFilter);
    } catch {
        // best-effort
    }
}

async function deleteNonProtectedFields(adminClient: Client4, nameFilter?: (name: string) => boolean): Promise<void> {
    try {
        const fields = await adminClient.getPropertyFields(BOARDS_GROUP, OBJECT_TYPE_POST, SYSTEM_TARGET_TYPE);
        for (const field of fields ?? []) {
            if (field.protected) {
                continue;
            }
            if (nameFilter && !nameFilter(field.name)) {
                continue;
            }
            await adminClient.deletePropertyField(BOARDS_GROUP, OBJECT_TYPE_POST, field.id);
        }
    } catch (error: unknown) {
        const statusCode =
            typeof error === 'object' && error !== null && 'status_code' in error
                ? (error as {status_code?: number}).status_code
                : undefined;
        if (statusCode === 404) {
            // Boards group not yet seeded — first board creation will trigger
            // doSetupBoardsProperties.
            return;
        }
        throw error;
    }
}