nestia 3.1.1 → 3.1.2-dev.20221016

package/template/src/providers/bbs/BbsArticleProvider.ts

@@ -1,217 +0,0 @@
-import { ForbiddenException, NotFoundException } from "@nestjs/common";
-import { v4 } from "uuid";
-
-import { IBbsArticle } from "@ORGANIZATION/PROJECT-api/lib/structures/bbs/IBbsArticle";
-import { IPage } from "@ORGANIZATION/PROJECT-api/lib/structures/common/IPage";
-
-import { MapUtil } from "../../utils/MapUtil";
-
-/**
- * This is a fake provider.
- *
- * Remove it or change it to be stored on the real DB.
- */
-export namespace BbsArticleProvider {
-    export async function index(
-        section: string,
-        input: IBbsArticle.IRequest,
-    ): Promise<IPage<IBbsArticle.ISummary>> {
-        // GET ENTIRE ARTICLES
-        const dict = storage.get(section);
-        if (dict === undefined)
-            throw new NotFoundException(
-                `Error on BbsArticleProvider.index(): unable to find the matched section "${section}".`,
-            );
-
-        /* disable-eslint */
-        let articles: IBbsArticle[] = Array.from(dict.values()).map(
-            (rec) => rec.article,
-        );
-
-        // SEARCH
-        if (input.search !== undefined) {
-            if (input.search.writer)
-                articles = articles.filter(
-                    (x) => x.writer.indexOf(input.search!.writer!) !== -1,
-                );
-            if (input.search.title)
-                articles = articles.filter(
-                    (x) =>
-                        x.contents
-                            .at(-1)!
-                            .title.indexOf(input.search!.title!) !== -1,
-                );
-            if (input.search.body)
-                articles = articles.filter(
-                    (x) =>
-                        x.contents.at(-1)!.body.indexOf(input.search!.body!) !==
-                        -1,
-                );
-        }
-
-        // SORT
-        if (input.sort?.length) {
-            for (const comp of input.sort.reverse())
-                articles = articles.sort((x, y) => {
-                    const sign = comp[0];
-                    const column = comp.substring(1);
-                    const closure = () => {
-                        if (column === "created_at")
-                            return (
-                                new Date(x.created_at).getTime() -
-                                new Date(y.created_at).getTime()
-                            );
-                        else if (column === "updated_at")
-                            return (
-                                new Date(
-                                    x.contents.at(-1)!.created_at,
-                                ).getTime() -
-                                new Date(
-                                    y.contents.at(-1)!.created_at,
-                                ).getTime()
-                            );
-                        else if (column === "writer")
-                            return x.writer.localeCompare(y.writer);
-                        else
-                            return x.contents
-                                .at(-1)!
-                                .title.localeCompare(y.contents.at(-1)!.title);
-                    };
-                    return sign === "+" ? closure() : -closure();
-                });
-        } else {
-            articles.sort(
-                (a, b) =>
-                    new Date(b.created_at).getTime() -
-                    new Date(a.created_at).getTime(),
-            );
-        }
-
-        // PAGINATION
-        const limit: number = input.limit || 100;
-        const start: number = ((input.page || 1) - 1) * limit;
-        return {
-            pagination: {
-                page: input.page || 1,
-                limit: limit,
-                total_count: articles.length,
-                total_pages: Math.ceil(articles.length / limit),
-            },
-            data: articles.slice(start, start + limit).map((article) => ({
-                id: article.id,
-                section: article.section,
-                writer: article.writer,
-                title: article.contents.at(-1)!.title,
-                created_at: article.created_at,
-                updated_at: article.contents.at(-1)!.created_at,
-            })),
-        };
-    }
-
-    export async function find(
-        section: string,
-        id: string,
-        password?: string,
-    ): Promise<IBbsArticle> {
-        const dict = storage.get(section);
-        if (dict === undefined)
-            throw new NotFoundException(
-                `Error on BbsArticleProvider.find(): unable to find the matched section "${section}".`,
-            );
-
-        const record = dict.get(id);
-        if (record === undefined)
-            throw new NotFoundException(
-                `Error on BbsArticleProvider.find(): unable to find the matched article "${id}".`,
-            );
-        else if (password !== undefined && password !== record.password)
-            throw new ForbiddenException(
-                `Error on BbsArticleProvider.find(): different password.`,
-            );
-        return record.article;
-    }
-
-    export async function store(
-        section: string,
-        input: IBbsArticle.IStore,
-    ): Promise<IBbsArticle> {
-        const now: string = datetime_to_string(new Date());
-        const article: IBbsArticle = {
-            id: v4(),
-            section,
-            writer: input.writer,
-            contents: [
-                {
-                    ...{
-                        ...input,
-                        password: undefined,
-                    },
-                    id: v4(),
-                    created_at: now,
-                },
-            ],
-            created_at: now,
-        };
-
-        const dict: Map<string, IRecord> = MapUtil.take(
-            storage,
-            section,
-            () => new Map(),
-        );
-        dict.set(article.id, {
-            article,
-            password: input.password,
-        });
-
-        return article;
-    }
-
-    export async function update(
-        section: string,
-        id: string,
-        input: IBbsArticle.IUpdate,
-    ): Promise<IBbsArticle.IContent> {
-        const article: IBbsArticle = await find(section, id, input.password);
-        const content: IBbsArticle.IContent = {
-            ...{
-                ...input,
-                password: undefined,
-            },
-            id: v4(),
-            created_at: datetime_to_string(new Date()),
-        };
-        article.contents.push(content);
-        return content;
-    }
-}
-
-interface IRecord {
-    article: IBbsArticle;
-    password: string;
-}
-const storage: Map<string, Map<string, IRecord>> = new Map();
-
-function datetime_to_string(date: Date): string {
-    return (
-        cipher(4)(date.getFullYear()) +
-        "-" +
-        ([
-            [date.getMonth() + 1, date.getDate()].map(cipher(2)).join("-"),
-            [date.getHours(), date.getMinutes(), date.getSeconds()]
-                .map(cipher(2))
-                .join(":"),
-        ].join(" ") +
-            "." +
-            precision(date.getMilliseconds()))
-    );
-}
-
-const cipher = (digit: number) => (value: number) => {
-    const str: string = String(value);
-    return "0".repeat(digit - str.length) + str;
-};
-
-const precision = (value: number) => {
-    const str: string = String(value);
-    return str + "0".repeat(3 - str.length);
-};

package/template/src/test/features/api/bbs/test_api_bbs_article_at.ts

@@ -1,52 +0,0 @@
-import TSON from "typescript-json";
-import { v4 } from "uuid";
-
-import api from "@ORGANIZATION/PROJECT-api/lib/index";
-import { IBbsArticle } from "@ORGANIZATION/PROJECT-api/lib/structures/bbs/IBbsArticle";
-
-import { exception_must_be_thrown } from "../../../internal/exception_must_be_thrown";
-
-export async function test_api_bbs_article_at(
-    connection: api.IConnection,
-): Promise<void> {
-    // STORE A NEW ARTICLE
-    const stored: IBbsArticle = await api.functional.bbs.articles.store(
-        connection,
-        "general",
-        {
-            writer: "Robot",
-            title: "Hello, world!",
-            body: "Hello, I'm test automation robot",
-            format: "txt",
-            files: [
-                {
-                    name: "logo",
-                    extension: "png",
-                    url: "https://somewhere.com/logo.png",
-                },
-            ],
-            password: "1234",
-        },
-    );
-    TSON.assertEquals(stored);
-
-    // READ IT
-    const read: IBbsArticle = await api.functional.bbs.articles.at(
-        connection,
-        stored.section,
-        stored.id,
-    );
-    TSON.assertEquals(read);
-
-    // CHECK EQUALITY
-    if (api.Primitive.equal_to(stored, read) === false)
-        throw new Error("Bug on BbsArticleProvider.at(): different data.");
-
-    // TRY 404 ERRORS
-    await exception_must_be_thrown("wrong section", () =>
-        api.functional.bbs.articles.at(connection, v4(), stored.id),
-    );
-    await exception_must_be_thrown("wrong id", () =>
-        api.functional.bbs.articles.at(connection, stored.section, v4()),
-    );
-}

package/template/src/test/features/api/bbs/test_api_bbs_article_index_search.ts

@@ -1,82 +0,0 @@
-import TSON from "typescript-json";
-
-import api from "@ORGANIZATION/PROJECT-api/lib/index";
-import { IBbsArticle } from "@ORGANIZATION/PROJECT-api/lib/structures/bbs/IBbsArticle";
-import { IPage } from "@ORGANIZATION/PROJECT-api/lib/structures/common/IPage";
-
-import { ArrayUtil } from "../../../../utils/ArrayUtil";
-import { RandomGenerator } from "../../../internal/RandomGenerator";
-import { validate_index } from "../../../internal/validate_index";
-
-export async function test_api_bbs_article_index_search(
-    connection: api.IConnection,
-): Promise<void> {
-    // GENERATE 100 ARTICLES
-    const section: string = "general";
-    const articles: IBbsArticle[] = await ArrayUtil.asyncRepeat(100, () =>
-        api.functional.bbs.articles.store(connection, section, {
-            writer: RandomGenerator.name(),
-            title: RandomGenerator.paragraph(),
-            body: RandomGenerator.content(),
-            format: "txt",
-            files: [],
-            password: RandomGenerator.alphabets(8),
-        }),
-    );
-    TSON.assertEquals(articles);
-
-    // DO SEARCH
-    const validator = search(connection, articles);
-    await validator(
-        "writer",
-        (x) => x.writer,
-        (elem, word) => elem.writer.indexOf(word) !== -1,
-    );
-    await validator(
-        "title",
-        (x) => x.contents.at(-1)!.title,
-        (elem, word) => elem.contents.at(-1)!.title.indexOf(word) !== -1,
-    );
-    await validator(
-        "body",
-        (x) => x.contents.at(-1)!.body,
-        (elem, word) => elem.contents.at(-1)!.body.indexOf(word) !== -1,
-    );
-}
-
-const search =
-    (connection: api.IConnection, total: IBbsArticle[]) =>
-    async (
-        field: string,
-        getter: (
-            record: IBbsArticle,
-            input: IBbsArticle.IRequest.ISearch,
-        ) => string,
-        filter: (record: IBbsArticle, word: string) => boolean,
-    ): Promise<void> => {
-        const input: IBbsArticle.IRequest = {
-            limit: total.length,
-            search: {},
-        };
-        const value: string = getter(
-            RandomGenerator.pick(total),
-            input.search!,
-        );
-        const matched: IBbsArticle[] = total.filter((elem) =>
-            filter(elem, value),
-        );
-
-        const page: IPage<IBbsArticle.ISummary> =
-            await api.functional.bbs.articles.index(
-                connection,
-                "general",
-                input,
-            );
-        TSON.assertEquals(page);
-
-        validate_index(
-            `BbsArticleProvider.index() with ${field} searching`,
-            matched,
-            page.data,
-        );
-    };

package/template/src/test/features/api/bbs/test_api_bbs_article_index_sort.ts

@@ -1,49 +0,0 @@
-import TSON from "typescript-json";
-
-import api from "@ORGANIZATION/PROJECT-api/lib/index";
-import { IBbsArticle } from "@ORGANIZATION/PROJECT-api/lib/structures/bbs/IBbsArticle";
-
-import { ArrayUtil } from "../../../../utils/ArrayUtil";
-import { GaffComparator } from "../../../internal/GaffComparator";
-import { RandomGenerator } from "../../../internal/RandomGenerator";
-import { validate_index_sort } from "../../../internal/validate_index_sort";
-
-export async function test_api_bbs_article_index_sort(
-    connection: api.IConnection,
-): Promise<void> {
-    // GENERATE 100 ARTICLES
-    const section: string = "general";
-    const articles: IBbsArticle[] = await ArrayUtil.asyncRepeat(100, () =>
-        api.functional.bbs.articles.store(connection, section, {
-            writer: RandomGenerator.name(),
-            title: RandomGenerator.paragraph(),
-            body: RandomGenerator.content(),
-            format: "txt",
-            files: [],
-            password: RandomGenerator.alphabets(8),
-        }),
-    );
-    TSON.assertEquals(articles);
-
-    // PREPARE VALIDATOR
-    const validator = validate_index_sort("BbsArticleProvider.idex()")(
-        (input: IBbsArticle.IRequest) =>
-            api.functional.bbs.articles.index(connection, section, input),
-    );
-
-    // DO VALIDATE
-    const components = [
-        validator("created_at")(GaffComparator.dates((x) => x.created_at)),
-        validator("updated_at")(GaffComparator.dates((x) => x.updated_at)),
-        validator("title")(GaffComparator.strings((x) => x.title)),
-        validator("writer")(GaffComparator.strings((x) => x.writer)),
-        validator(
-            "writer",
-            "title",
-        )(GaffComparator.strings((x) => [x.writer, x.title])),
-    ];
-    for (const comp of components) {
-        await comp("+");
-        await comp("-");
-    }
-}

package/template/src/test/features/api/bbs/test_api_bbs_article_store.ts

@@ -1,44 +0,0 @@
-import TSON from "typescript-json";
-import { v4 } from "uuid";
-
-import api from "@ORGANIZATION/PROJECT-api/lib/index";
-import { IBbsArticle } from "@ORGANIZATION/PROJECT-api/lib/structures/bbs/IBbsArticle";
-
-import { RandomGenerator } from "../../../internal/RandomGenerator";
-
-export async function test_api_bbs_article_store(
-    connection: api.IConnection,
-): Promise<void> {
-    // STORE A NEW ARTICLE
-    const stored: IBbsArticle = await api.functional.bbs.articles.store(
-        connection,
-        "general",
-        {
-            writer: RandomGenerator.name(),
-            title: RandomGenerator.paragraph(),
-            body: RandomGenerator.content(),
-            format: "txt",
-            files: [
-                {
-                    name: "logo",
-                    extension: "png",
-                    url: "https://somewhere.com/logo.png",
-                },
-            ],
-            password: v4(),
-        },
-    );
-    TSON.assertEquals(stored);
-
-    // READ THE DATA AGAIN
-    const read: IBbsArticle = await api.functional.bbs.articles.at(
-        connection,
-        stored.section,
-        stored.id,
-    );
-    TSON.assertEquals(read);
-
-    // CHECK EXISTENCE
-    if (read.id !== stored.id)
-        throw new Error("Bug on BbsArticleProvider.store(): failed to store.");
-}

package/template/src/test/features/api/bbs/test_api_bbs_article_update.ts

@@ -1,66 +0,0 @@
-import TSON from "typescript-json";
-import { v4 } from "uuid";
-
-import api from "@ORGANIZATION/PROJECT-api/lib/index";
-import { IBbsArticle } from "@ORGANIZATION/PROJECT-api/lib/structures/bbs/IBbsArticle";
-
-import { RandomGenerator } from "../../../internal/RandomGenerator";
-import { exception_must_be_thrown } from "../../../internal/exception_must_be_thrown";
-
-export async function test_api_bbs_article_update(
-    connection: api.IConnection,
-): Promise<void> {
-    // STORE A NEW ARTICLE
-    const password: string = v4();
-    const article: IBbsArticle = await api.functional.bbs.articles.store(
-        connection,
-        "general",
-        {
-            writer: RandomGenerator.name(),
-            title: RandomGenerator.paragraph(),
-            body: RandomGenerator.content(),
-            format: "txt",
-            files: [
-                {
-                    name: "logo",
-                    extension: "png",
-                    url: "https://somewhere.com/logo.png",
-                },
-            ],
-            password,
-        },
-    );
-    TSON.assertEquals(article);
-
-    // UPDATE WITH EXACT PASSWORD
-    const content: IBbsArticle.IContent =
-        await api.functional.bbs.articles.update(
-            connection,
-            article.section,
-            article.id,
-            {
-                title: RandomGenerator.paragraph(),
-                body: RandomGenerator.content(),
-                format: "txt",
-                files: [],
-                password,
-            },
-        );
-    article.contents.push(TSON.assertEquals(content));
-
-    // TRY UPDATE WITH WRONG PASSWORD
-    await exception_must_be_thrown("update with wrong password", () =>
-        api.functional.bbs.articles.update(
-            connection,
-            article.section,
-            article.id,
-            {
-                title: RandomGenerator.paragraph(),
-                body: RandomGenerator.content(),
-                format: "txt",
-                files: [],
-                password: v4(),
-            },
-        ),
-    );
-}

package/template/src/test/index.ts

@@ -1,45 +0,0 @@
-import { sleep_for } from "tstl/thread/global";
-
-import api from "@ORGANIZATION/PROJECT-api";
-
-import { Backend } from "../Backend";
-import { Configuration } from "../Configuration";
-import { DynamicImportIterator } from "./internal/DynamicImportIterator";
-
-async function main(): Promise<void> {
-    // BACKEND SERVER
-    const backend: Backend = new Backend();
-    await backend.open();
-
-    //----
-    // CLINET CONNECTOR
-    //----
-    // DO TEST
-    const connection: api.IConnection = {
-        host: `http://127.0.0.1:${await Configuration.API_PORT()}`,
-        encryption: await Configuration.ENCRYPTION_PASSWORD(),
-    };
-    const exceptions: Error[] = await DynamicImportIterator.force(
-        __dirname + "/features",
-        {
-            prefix: "test",
-            parameters: () => [connection],
-        },
-    );
-
-    // WAIT FOR A WHILE FOR THE EVENTS
-    await sleep_for(2500);
-
-    // TERMINATE
-    await backend.close();
-
-    if (exceptions.length === 0) console.log("Success");
-    else {
-        for (const exp of exceptions) console.log(exp);
-        process.exit(-1);
-    }
-}
-main().catch((exp) => {
-    console.log(exp);
-    process.exit(-1);
-});

package/template/src/test/internal/DynamicImportIterator.ts

@@ -1,119 +0,0 @@
-import chalk from "chalk";
-import cli from "cli";
-import fs from "fs";
-
-import { IPointer } from "./IPointer";
-import { StopWatch } from "./StopWatch";
-
-const EXTENSION = __filename.substr(-2);
-if (EXTENSION === "js") require("source-map-support/register");
-
-interface ICommand {
-    include?: string;
-    exclude?: string;
-}
-
-export namespace DynamicImportIterator {
-    export type Closure<Arguments extends any[], Ret = any> = (
-        ...args: Arguments
-    ) => Promise<Ret>;
-    type Module<Arguments extends any[]> = {
-        [key: string]: Closure<Arguments>;
-    };
-
-    export interface IOptions<Parameters extends any[], Ret = any> {
-        prefix: string;
-        parameters: (name: string) => Parameters;
-        wrapper?: (
-            name: string,
-            closure: Closure<Parameters, Ret>,
-        ) => Promise<any>;
-        counter?: IPointer<number>;
-        showElapsedTime?: boolean;
-    }
-
-    export async function main<Arguments extends any[]>(
-        path: string,
-        options: IOptions<Arguments>,
-    ): Promise<void> {
-        const command: ICommand = cli.parse();
-        await iterate(options, command, path);
-    }
-
-    export async function force<Arguments extends any[]>(
-        path: string,
-        options: IOptions<Arguments>,
-    ): Promise<Error[]> {
-        const command: ICommand = cli.parse();
-        const exceptions: Error[] = [];
-
-        await iterate(options, command, path, exceptions);
-        return exceptions;
-    }
-
-    async function iterate<Arguments extends any[]>(
-        options: IOptions<Arguments>,
-        command: ICommand,
-        path: string,
-        exceptions?: Error[],
-    ): Promise<void> {
-        const directory: string[] = await fs.promises.readdir(path);
-        for (const file of directory) {
-            const current: string = `${path}/${file}`;
-            const stats: fs.Stats = await fs.promises.lstat(current);
-
-            if (stats.isDirectory() === true) {
-                await iterate(options, command, current, exceptions);
-                continue;
-            } else if (file.substr(-3) !== `.${EXTENSION}`) continue;
-
-            const external: Module<Arguments> = await import(current);
-            await execute(options, command, external, exceptions);
-        }
-    }
-
-    async function execute<Arguments extends any[]>(
-        options: IOptions<Arguments>,
-        command: ICommand,
-        external: Module<Arguments>,
-        exceptions?: Error[],
-    ): Promise<void> {
-        for (const key in external) {
-            if (command.exclude && key.indexOf(command.exclude) !== -1)
-                continue;
-            else if (command.include && key.indexOf(command.include) === -1)
-                continue;
-            else if (key.substr(0, options.prefix.length) !== options.prefix)
-                continue;
-            else if (!(external[key] instanceof Function)) continue;
-
-            const closure: Closure<Arguments> = external[key];
-            const func = async () => {
-                if (options.wrapper !== undefined)
-                    await options.wrapper(key, closure);
-                else await closure(...options.parameters(key));
-            };
-            const label: string = chalk.greenBright(key);
-            try {
-                if (options.counter) ++options.counter.value;
-                if (options.showElapsedTime === false) {
-                    await func();
-                    console.log(`  - ${label}`);
-                } else {
-                    const time: number = await StopWatch.measure(func);
-                    console.log(
-                        `  - ${label}: ${chalk.yellowBright(
-                            time.toLocaleString(),
-                        )} ms`,
-                    );
-                }
-            } catch (exp) {
-                if (!(exp instanceof Error)) return;
-
-                console.log(`  - ${label} -> ${chalk.redBright(exp.name)}`);
-                if (exceptions !== undefined) exceptions.push(exp);
-                else throw exp;
-            }
-        }
-    }
-}