vendure/packages/core/e2e/localization.e2e-spec.ts

import { pick } from '@vendure/common/lib/pick';
import { createTestEnvironment } from '@vendure/testing';
import gql from 'graphql-tag';
import path from 'path';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';

import { initialData } from '../../../e2e-common/e2e-initial-data';
import { testConfig, TEST_SETUP_TIMEOUT_MS } from '../../../e2e-common/test-config';

import { LanguageCode } from './graphql/generated-e2e-admin-types';
import * as Codegen from './graphql/generated-e2e-admin-types';
import { GET_PRODUCT_WITH_VARIANTS, UPDATE_PRODUCT } from './graphql/shared-definitions';

/* eslint-disable @typescript-eslint/no-non-null-assertion */
describe('Localization', () => {
    const { server, adminClient } = createTestEnvironment(testConfig());

    beforeAll(async () => {
        await server.init({
            initialData,
            productsCsvPath: path.join(__dirname, 'fixtures/e2e-products-minimal.csv'),
            customerCount: 1,
        });
        await adminClient.asSuperAdmin();

        const { updateProduct } = await adminClient.query<
            Codegen.UpdateProductMutation,
            Codegen.UpdateProductMutationVariables
        >(UPDATE_PRODUCT, {
            input: {
                id: 'T_1',
                translations: [
                    {
                        languageCode: LanguageCode.en,
                        name: 'en name',
                        slug: 'en-slug',
                        description: 'en-description',
                    },
                    {
                        languageCode: LanguageCode.de,
                        name: 'de name',
                        slug: 'de-slug',
                        description: 'de-description',
                    },
                    {
                        languageCode: LanguageCode.zh,
                        name: 'zh name',
                        slug: 'zh-slug',
                        description: 'zh-description',
                    },
                ],
            },
        });

        await adminClient.query<
            Codegen.UpdateOptionGroupMutation,
            Codegen.UpdateOptionGroupMutationVariables
        >(UPDATE_OPTION_GROUP, {
            input: {
                id: 'T_1',
                translations: [
                    { languageCode: LanguageCode.en, name: 'en name' },
                    { languageCode: LanguageCode.de, name: 'de name' },
                    { languageCode: LanguageCode.zh, name: 'zh name' },
                ],
            },
        });
    }, TEST_SETUP_TIMEOUT_MS);

    afterAll(async () => {
        await server.destroy();
    });

    it('returns default language when none specified', async () => {
        const { product } = await adminClient.query<
            Codegen.GetProductWithVariantsQuery,
            Codegen.GetProductWithVariantsQueryVariables
        >(GET_PRODUCT_WITH_VARIANTS, {
            id: 'T_1',
        });
        expect(pick(product!, ['name', 'slug', 'description'])).toEqual({
            name: 'en name',
            slug: 'en-slug',
            description: 'en-description',
        });
    });

    it('returns specified language', async () => {
        const { product } = await adminClient.query<
            Codegen.GetProductWithVariantsQuery,
            Codegen.GetProductWithVariantsQueryVariables
        >(
            GET_PRODUCT_WITH_VARIANTS,
            {
                id: 'T_1',
            },
            { languageCode: LanguageCode.de },
        );
        expect(pick(product!, ['name', 'slug', 'description'])).toEqual({
            name: 'de name',
            slug: 'de-slug',
            description: 'de-description',
        });
    });

    it('falls back to default language code', async () => {
        const { product } = await adminClient.query<
            Codegen.GetProductWithVariantsQuery,
            Codegen.GetProductWithVariantsQueryVariables
        >(
            GET_PRODUCT_WITH_VARIANTS,
            {
                id: 'T_1',
            },
            { languageCode: LanguageCode.ga },
        );
        expect(pick(product!, ['name', 'slug', 'description'])).toEqual({
            name: 'en name',
            slug: 'en-slug',
            description: 'en-description',
        });
    });

    it('nested entites are translated', async () => {
        const { product } = await adminClient.query<
            Codegen.GetProductWithVariantsQuery,
            Codegen.GetProductWithVariantsQueryVariables
        >(
            GET_PRODUCT_WITH_VARIANTS,
            {
                id: 'T_1',
            },
            { languageCode: LanguageCode.zh },
        );
        expect(pick(product!.optionGroups[0], ['name'])).toEqual({
            name: 'zh name',
        });
    });

    it('translates results of mutation', async () => {
        const { updateProduct } = await adminClient.query<
            Codegen.UpdateProductMutation,
            Codegen.UpdateProductMutationVariables
        >(
            UPDATE_PRODUCT,
            {
                input: {
                    id: 'T_1',
                    enabled: true,
                },
            },
            { languageCode: LanguageCode.zh },
        );
        expect(updateProduct.name).toBe('zh name');
        expect(pick(updateProduct.optionGroups[0], ['name'])).toEqual({
            name: 'zh name',
        });
    });
});

const UPDATE_OPTION_GROUP = gql`
    mutation UpdateOptionGroup($input: UpdateProductOptionGroupInput!) {
        updateProductOptionGroup(input: $input) {
            id
        }
    }
`;