vendure/server/mock-data/mock-data.service.ts

import faker from 'faker/locale/en_GB';
import fs from 'fs-extra';
import gql from 'graphql-tag';
import path from 'path';

import { CREATE_FACET } from '../../admin-ui/src/app/data/definitions/facet-definitions';
import {
    ADD_OPTION_GROUP_TO_PRODUCT,
    CREATE_PRODUCT,
    CREATE_PRODUCT_OPTION_GROUP,
    GENERATE_PRODUCT_VARIANTS,
    UPDATE_PRODUCT_VARIANTS,
} from '../../admin-ui/src/app/data/definitions/product-definitions';
import {
    CREATE_CHANNEL,
    CREATE_COUNTRY,
    CREATE_TAX_RATE,
    CREATE_ZONE,
    GET_CHANNELS,
    UPDATE_CHANNEL,
} from '../../admin-ui/src/app/data/definitions/settings-definitions';
import { CREATE_SHIPPING_METHOD } from '../../admin-ui/src/app/data/definitions/shipping-definitions';
import {
    AddOptionGroupToProduct,
    Asset,
    Channel,
    CreateAddressInput,
    CreateChannel,
    CreateCountry,
    CreateCustomerInput,
    CreateFacet,
    CreateFacetValueWithFacetInput,
    CreateProduct,
    CreateProductOptionGroup,
    CreateShippingMethod,
    CreateTaxRate,
    CreateZone,
    CurrencyCode,
    GenerateProductVariants,
    GetChannels,
    LanguageCode,
    ProductTranslationInput,
    ProductVariant,
    UpdateChannel,
    UpdateProductVariants,
    Zone,
} from '../../shared/generated-types';
import { defaultShippingCalculator } from '../src/config/shipping-method/default-shipping-calculator';
import { defaultShippingEligibilityChecker } from '../src/config/shipping-method/default-shipping-eligibility-checker';
import { Customer } from '../src/entity/customer/customer.entity';

import { SimpleGraphQLClient } from './simple-graphql-client';
import TaxCategory = ProductVariant.TaxCategory;

// tslint:disable:no-console
/**
 * A service for creating mock data via the GraphQL API.
 */
export class MockDataService {
    apiUrl: string;

    constructor(private client: SimpleGraphQLClient, private logging = true) {
        // make the generated results deterministic
        faker.seed(1);
    }

    async populateChannels(channelCodes: string[]): Promise<Channel.Fragment[]> {
        const channels: Channel.Fragment[] = [];
        for (const code of channelCodes) {
            const channel = await this.client.query<CreateChannel.Mutation, CreateChannel.Variables>(
                CREATE_CHANNEL,
                {
                    input: {
                        code,
                        pricesIncludeTax: true,
                        token: `${code}_token`,
                        currencyCode: CurrencyCode.USD,
                        defaultLanguageCode: LanguageCode.en,
                    },
                },
            );
            channels.push(channel.createChannel);
            this.log(`Created Channel: ${channel.createChannel.code}`);
        }
        return channels;
    }

    async populateCountries(all = false): Promise<Zone.Fragment[]> {
        const countriesFile = await fs.readFile(
            path.join(__dirname, 'data-sources', 'countries.json'),
            'utf8',
        );
        const limitedCountries = ['GB', 'DE', 'FR', 'AT', 'US', 'CN', 'JP', 'AU', 'ZA'];
        const countries: any[] = JSON.parse(countriesFile).filter(c => {
            if (all) {
                return true;
            } else {
                return limitedCountries.includes(c['alpha-2']);
            }
        });
        const zones: { [zoneName: string]: string[] } = {};
        for (const country of countries) {
            const result = await this.client.query<CreateCountry.Mutation, CreateCountry.Variables>(
                CREATE_COUNTRY,
                {
                    input: {
                        code: country['alpha-2'],
                        translations: [{ languageCode: LanguageCode.en, name: country.name }],
                        enabled: true,
                    },
                },
            );
            if (!zones[country.region]) {
                zones[country.region] = [];
            }
            zones[country.region].push(result.createCountry.id);
        }

        const createdZones: Zone.Fragment[] = [];
        for (const [name, memberIds] of Object.entries(zones)) {
            const result = await this.client.query<CreateZone.Mutation, CreateZone.Variables>(CREATE_ZONE, {
                input: {
                    name,
                    memberIds,
                },
            });
            createdZones.push(result.createZone);
        }
        this.log(`Created ${countries.length} Countries in ${Object.keys(zones).length} Zones`);
        return createdZones;
    }

    async setChannelDefaultZones(zones: Zone.Fragment[]) {
        const defaultZone = zones.find(z => z.name === 'UK');
        if (!defaultZone) {
            this.log(`Default zone could not be found`);
            return;
        }
        const result = await this.client.query<GetChannels.Query>(GET_CHANNELS);
        for (const channel of result.channels) {
            await this.client.query<UpdateChannel.Mutation, UpdateChannel.Variables>(UPDATE_CHANNEL, {
                input: {
                    id: channel.id,
                    defaultTaxZoneId: defaultZone.id,
                    defaultShippingZoneId: defaultZone.id,
                },
            });
        }
        this.log(`Set default zones for ${result.channels.length} Channels`);
    }

    async populateOptions(): Promise<string> {
        return this.client
            .query<CreateProductOptionGroup.Mutation, CreateProductOptionGroup.Variables>(
                CREATE_PRODUCT_OPTION_GROUP,
                {
                    input: {
                        code: 'size',
                        translations: [
                            { languageCode: LanguageCode.en, name: 'Size' },
                            { languageCode: LanguageCode.de, name: 'Größe' },
                        ],
                        options: [
                            {
                                code: 'small',
                                translations: [
                                    { languageCode: LanguageCode.en, name: 'Small' },
                                    { languageCode: LanguageCode.de, name: 'Klein' },
                                ],
                            },
                            {
                                code: 'large',
                                translations: [
                                    { languageCode: LanguageCode.en, name: 'Large' },
                                    { languageCode: LanguageCode.de, name: 'Groß' },
                                ],
                            },
                        ],
                    },
                },
            )
            .then(data => {
                this.log('Created option group:', data.createProductOptionGroup.name);
                return data.createProductOptionGroup.id;
            });
    }

    async populateTaxCategories(zones: Zone.Fragment[]) {
        const taxCategories = [{ name: 'Standard Tax' }, { name: 'Reduced Tax' }, { name: 'Zero Tax' }];

        const createdTaxCategories: TaxCategory[] = [];

        for (const category of taxCategories) {
            const result = await this.client.query(
                gql`
                    mutation($input: CreateTaxCategoryInput!) {
                        createTaxCategory(input: $input) {
                            id
                        }
                    }
                `,
                {
                    input: {
                        name: category.name,
                    },
                },
            );
            createdTaxCategories.push(result.createTaxCategory);
        }
        this.log(`Created ${createdTaxCategories.length} tax categories`);

        // create tax rates
        for (const zone of zones) {
            await this.client.query<CreateTaxRate.Mutation, CreateTaxRate.Variables>(CREATE_TAX_RATE, {
                input: {
                    name: `Standard Tax for ${zone.name}`,
                    enabled: true,
                    value: 20,
                    categoryId: createdTaxCategories[0].id,
                    zoneId: zone.id,
                },
            });
        }

        return createdTaxCategories;
    }

    async populateShippingMethods() {
        await this.client.query<CreateShippingMethod.Mutation, CreateShippingMethod.Variables>(
            CREATE_SHIPPING_METHOD,
            {
                input: {
                    code: 'standard-flat-rate',
                    description: 'Standard Shipping',
                    checker: {
                        code: defaultShippingEligibilityChecker.code,
                        arguments: [],
                    },
                    calculator: {
                        code: defaultShippingCalculator.code,
                        arguments: [{ name: 'rate', value: '500' }],
                    },
                },
            },
        );
        this.log(`Created standard ShippingMethod`);
        await this.client.query<CreateShippingMethod.Mutation, CreateShippingMethod.Variables>(
            CREATE_SHIPPING_METHOD,
            {
                input: {
                    code: 'express-flat-rate',
                    description: 'Express Shipping',
                    checker: {
                        code: defaultShippingEligibilityChecker.code,
                        arguments: [],
                    },
                    calculator: {
                        code: defaultShippingCalculator.code,
                        arguments: [{ name: 'rate', value: '1000' }],
                    },
                },
            },
        );
        this.log(`Created express ShippingMethod`);
    }

    async populateCustomers(count: number = 5): Promise<any> {
        for (let i = 0; i < count; i++) {
            const firstName = faker.name.firstName();
            const lastName = faker.name.lastName();

            const query1 = gql`
                mutation CreateCustomer($input: CreateCustomerInput!, $password: String) {
                    createCustomer(input: $input, password: $password) {
                        id
                        emailAddress
                    }
                }
            `;

            const variables1 = {
                input: {
                    firstName,
                    lastName,
                    emailAddress: faker.internet.email(firstName, lastName),
                    phoneNumber: faker.phone.phoneNumber(),
                } as CreateCustomerInput,
                password: 'test',
            };

            const customer: { id: string; emailAddress: string } | void = await this.client
                .query(query1, variables1)
                .then((data: any) => data.createCustomer, err => this.log(err));

            if (customer) {
                const query2 = gql`
                    mutation($customerId: ID!, $input: CreateAddressInput!) {
                        createCustomerAddress(customerId: $customerId, input: $input) {
                            id
                            streetLine1
                        }
                    }
                `;

                const variables2 = {
                    input: {
                        fullName: `${firstName} ${lastName}`,
                        streetLine1: faker.address.streetAddress(),
                        city: faker.address.city(),
                        province: faker.address.county(),
                        postalCode: faker.address.zipCode(),
                        countryCode: 'GB',
                    } as CreateAddressInput,
                    customerId: customer.id,
                };

                await this.client.query(query2, variables2).then(
                    data => {
                        this.log(`Created Customer ${i + 1}:`, data);
                        return data as Customer;
                    },
                    err => this.log(err),
                );
            }
        }
    }

    async populateAssets(): Promise<Asset[]> {
        const fileNames = await fs.readdir(path.join(__dirname, 'assets'));
        const filePaths = fileNames
            .map(fileName => path.join(__dirname, 'assets', fileName))
            // Sorting is needed because readdir order is not determnistic on Windows.
            // See https://github.com/nodejs/node/issues/3232
            .sort((a, b) => (a > b ? 1 : -1));
        return this.client.uploadAssets(filePaths).then(response => {
            this.log(`Created ${response.createAssets.length} Assets`);
            return response.createAssets;
        });
    }

    async populateProducts(
        count: number = 5,
        optionGroupId: string,
        assets: Asset[],
        taxCategories: TaxCategory[],
    ): Promise<any> {
        for (let i = 0; i < count; i++) {
            const query = CREATE_PRODUCT;

            const name = faker.commerce.productName();
            const slug = name.toLowerCase().replace(/\s+/g, '-');
            const description = faker.lorem.sentence();
            const languageCodes = [LanguageCode.en, LanguageCode.de];

            // get 2 (pseudo) random asset ids
            const randomAssets = this.shuffleArray(assets).slice(0, 2);

            const variables: CreateProduct.Variables = {
                input: {
                    translations: languageCodes.map(code =>
                        this.makeProductTranslation(code, name, slug, description),
                    ),
                    assetIds: randomAssets.map(a => a.id),
                    featuredAssetId: randomAssets[0].id,
                },
            };

            const product = await this.client
                .query<CreateProduct.Mutation, CreateProduct.Variables>(query, variables)
                .then(
                    data => {
                        this.log(`Created Product ${i + 1}:`, data.createProduct.name);
                        return data;
                    },
                    err => this.log(err),
                );

            if (product) {
                await this.client.query<AddOptionGroupToProduct.Mutation, AddOptionGroupToProduct.Variables>(
                    ADD_OPTION_GROUP_TO_PRODUCT,
                    {
                        productId: product.createProduct.id,
                        optionGroupId,
                    },
                );
                const prodWithVariants = await this.makeProductVariant(
                    product.createProduct.id,
                    taxCategories[0],
                );
                const variants = prodWithVariants.generateVariantsForProduct.variants;
                for (const variant of variants) {
                    const variantEN = variant.translations[0];
                    const variantDE = { ...variantEN };
                    variantDE.languageCode = LanguageCode.de;
                    variantDE.name = variantDE.name.replace(LanguageCode.en, LanguageCode.de);
                    delete variantDE.id;
                    variant.translations.push(variantDE);
                }
                await this.client.query<UpdateProductVariants.Mutation, UpdateProductVariants.Variables>(
                    UPDATE_PRODUCT_VARIANTS,
                    {
                        input: variants.map(({ id, translations, sku, price }) => ({
                            id,
                            translations,
                            sku,
                            price,
                        })),
                    },
                );
            }
        }
    }

    async populateFacets() {
        await this.client.query<CreateFacet.Mutation, CreateFacet.Variables>(CREATE_FACET, {
            input: {
                code: 'brand',
                translations: [
                    {
                        languageCode: LanguageCode.en,
                        name: 'Brand',
                    },
                    {
                        languageCode: LanguageCode.en,
                        name: 'Marke',
                    },
                ],
                values: this.makeFacetValues(10),
            },
        });
        this.log('Created "brand" Facet');
    }

    private makeFacetValues(count: number): CreateFacetValueWithFacetInput[] {
        return Array.from({ length: count }).map(() => {
            const brand = faker.company.companyName();
            return {
                code: brand.toLowerCase().replace(/[^a-zA-Z]+/g, '-'),
                translations: [
                    {
                        languageCode: LanguageCode.en,
                        name: brand,
                    },
                    {
                        languageCode: LanguageCode.de,
                        name: brand,
                    },
                ],
            };
        });
    }

    private makeProductTranslation(
        languageCode: LanguageCode,
        name: string,
        slug: string,
        description: string,
    ): ProductTranslationInput {
        return {
            languageCode,
            name: `${languageCode} ${name}`,
            slug: `${languageCode} ${slug}`,
            description: `${languageCode} ${description}`,
        };
    }

    private async makeProductVariant(
        productId: string,
        taxCategory: TaxCategory,
    ): Promise<GenerateProductVariants.Mutation> {
        const query = GENERATE_PRODUCT_VARIANTS;
        return this.client.query<GenerateProductVariants.Mutation, GenerateProductVariants.Variables>(query, {
            productId,
            defaultTaxCategoryId: taxCategory.id,
            defaultSku: faker.random.alphaNumeric(5),
            defaultPrice: faker.random.number({
                min: 100,
                max: 1000,
            }),
        });
    }

    private log(...args: any[]) {
        if (this.logging) {
            console.log(...args);
        }
    }

    /**
     * Deterministacally randomize array element order. Returns a new
     * shuffled array and leaves the input array intact.
     * Using Durstenfeld shuffle algorithm.
     *
     * Source: https://stackoverflow.com/a/12646864/772859
     */
    private shuffleArray<T>(array: T[]): T[] {
        const clone = array.slice(0);
        for (let i = clone.length - 1; i > 0; i--) {
            const j = Math.floor((faker.random.number(1000) / 1000) * (i + 1));
            const temp = clone[i];
            clone[i] = clone[j];
            clone[j] = temp;
        }
        return clone;
    }
}