9728081600

Committed 30 Jun 2024 12:45AM UTC coverage: 98.517% (+0.09%) from 98.423%

Build # 9728081600

Build Type

Pull #592

github

Committed by

web-flow

Commit Message

Merge ef24fe6ea into 002c44bca

Pull Request Pull Request #592: refactor: improve the logic for setting options in readMany and search

Run Details

1022 of 1052 branches covered (97.15%)

Branch coverage included in aggregate %.

8 of 8 new or added lines in 3 files covered. (100.0%)

1 existing line in 1 file now uncovered.

1038 of 1039 relevant lines covered (99.9%)

632.84 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.78

/src/lib/request/read-many.request.ts

import _ from 'lodash';

import { CRUD_POLICY } from '../crud.policy';
import { Method, PaginationType } from '../interface';
import { PaginationHelper } from '../provider';

import type { PaginationRequest, PaginationResponse, Sort } from '../interface';
import type { FindManyOptions, FindOptionsOrder, FindOptionsSelect, FindOptionsWhere } from 'typeorm';

type Where<T> = FindOptionsWhere<T> | Array<FindOptionsWhere<T>>;
export class CrudReadManyRequest<T> {
    private _paginationKeys: string[] = [];
    private _findOptions: FindManyOptions<T> & {
        where: Where<T>;
        take: number;
        order: FindOptionsOrder<T>;
    } = {
        where: {},
        take: CRUD_POLICY[Method.READ_MANY].default.numberOfTake,
        order: {},
    };
    private _sort: Sort;
    private _pagination: PaginationRequest;
    private _deserialize: (crudReadManyRequest: CrudReadManyRequest<T>) => Where<T>;
    private _selectColumnSet: Set<string | number> = new Set();
    private _excludeColumnSet: Set<string> = new Set();

    get paginationKeys(): string[] {
        return this._paginationKeys;
    }

    get findOptions(): FindManyOptions<T> & {
        where: Where<T>;
        take: number;
        order: FindOptionsOrder<T>;
    } {
        return this._findOptions;
    }

    get pagination(): PaginationRequest {
        return this._pagination;
    }

    get sort(): Sort {
        return this._sort;
    }

    excludedColumns(columns: string[]): this {
        this._findOptions.select = columns.filter((column) => {
            if (this._excludeColumnSet.has(column)) {
                return false;
            }
            if (this._selectColumnSet.size === 0) {
                return true;
            }
            return this._selectColumnSet.has(column);
        }) as unknown as FindOptionsSelect<T>;
        return this;
    }

    setPagination(pagination: PaginationRequest): this {
        this._pagination = pagination;
        return this;
    }

    setPaginationKeys(paginationKeys: string[]): this {
        this._paginationKeys = paginationKeys;
        return this;
    }

    setWithDeleted(withDeleted: boolean): this {
        this._findOptions.withDeleted = withDeleted;
        return this;
    }

    setSelectColumn(columns: Array<string | number> | undefined): this {
        if (!columns || columns.length === 0) {
            return this;
        }
        for (const column of columns) {
            this._selectColumnSet.add(column);
        }
        return this;
    }

    setExcludeColumn(columns: string[] | undefined): this {
        if (!columns || columns.length === 0) {
            return this;
        }
        for (const column of columns) {
            this._excludeColumnSet.add(column);
        }
        return this;
    }

    setWhere(where: (FindOptionsWhere<T> & Partial<T>) | Array<FindOptionsWhere<T>>): this {
        this._findOptions.where = where;
        return this;
    }

    setTake(take: number): this {
        this._findOptions.take = take;
        return this;
    }

    setSort(sort: Sort): this {
        this._sort = sort;
        return this;
    }

    setOrder(order: FindOptionsOrder<T>): this {
        this._findOptions.order = order;
        return this;
    }

    setRelations(relations: string[] | undefined): this {
        this._findOptions.relations = relations;
        return this;
    }

    setDeserialize(deserialize: (crudReadManyRequest: CrudReadManyRequest<T>) => FindOptionsWhere<T> | Array<FindOptionsWhere<T>>): this {
        this._deserialize = deserialize;
        return this;
    }

    generate(): this {
        if (this.pagination.type === PaginationType.OFFSET && Number.isFinite(this.pagination.offset)) {
            this._findOptions.where = this._deserialize(this);
            this._findOptions.skip = this.pagination.offset;
        }

        if (this.pagination.type === PaginationType.CURSOR && this.pagination.nextCursor) {
            this._findOptions.where = this._deserialize(this);
        }

        return this;
    }

    toString(): string {
        return JSON.stringify(_.omit(this, ['_deserialize']));
    }

    toResponse(data: T[], total: number): PaginationResponse<T> {
        const take = this.findOptions.take;
        const dataLength = data.length;
        const orderKeys = Object.keys(this._findOptions.order);
        const nextCursor = PaginationHelper.serialize(_.pick(data.at(-1), orderKeys) as FindOptionsWhere<T>);

        if (this.pagination.type === PaginationType.OFFSET) {
            return {
                data,
                metadata: this.pagination.metadata(take, dataLength, total, nextCursor),
            };
        }
        return {
            data,
            metadata: this.pagination.metadata(take, dataLength, total, nextCursor),
        };
    }
}

1	import _ from 'lodash';	332✔
2
3	import { CRUD_POLICY } from '../crud.policy';	332✔
4	import { Method, PaginationType } from '../interface';	332✔
5	import { PaginationHelper } from '../provider';	332✔
6
7	import type { PaginationRequest, PaginationResponse, Sort } from '../interface';
8	import type { FindManyOptions, FindOptionsOrder, FindOptionsSelect, FindOptionsWhere } from 'typeorm';
9
10	type Where<T> = FindOptionsWhere<T> \| Array<FindOptionsWhere<T>>;
11	export class CrudReadManyRequest<T> {	332✔
12	private _paginationKeys: string[] = [];	868✔
13	private _findOptions: FindManyOptions<T> & {	868✔
14	where: Where<T>;
15	take: number;
16	order: FindOptionsOrder<T>;
17	} = {
18	where: {},
19	take: CRUD_POLICY[Method.READ_MANY].default.numberOfTake,
20	order: {},
21	};
22	private _sort: Sort;
23	private _pagination: PaginationRequest;
24	private _deserialize: (crudReadManyRequest: CrudReadManyRequest<T>) => Where<T>;
25	private _selectColumnSet: Set<string \| number> = new Set();	868✔
26	private _excludeColumnSet: Set<string> = new Set();	868✔
27
28	get paginationKeys(): string[] {
UNCOV 29	return this._paginationKeys;	×
30	}
31
32	get findOptions(): FindManyOptions<T> & {
33	where: Where<T>;
34	take: number;
35	order: FindOptionsOrder<T>;
36	} {
37	return this._findOptions;	3,316✔
38	}
39
40	get pagination(): PaginationRequest {
41	return this._pagination;	5,516✔
42	}
43
44	get sort(): Sort {
45	return this._sort;	140✔
46	}
47
48	excludedColumns(columns: string[]): this {
49	this._findOptions.select = columns.filter((column) => {	860✔
50	if (this._excludeColumnSet.has(column)) {	4,656✔
51	return false;	8✔
52	}
53	if (this._selectColumnSet.size === 0) {	4,648✔
54	return true;	4,584✔
55	}
56	return this._selectColumnSet.has(column);	64✔
57	}) as unknown as FindOptionsSelect<T>;
58	return this;	860✔
59	}
60
61	setPagination(pagination: PaginationRequest): this {
62	this._pagination = pagination;	864✔
63	return this;	864✔
64	}
65
66	setPaginationKeys(paginationKeys: string[]): this {
67	this._paginationKeys = paginationKeys;	864✔
68	return this;	864✔
69	}
70
71	setWithDeleted(withDeleted: boolean): this {
72	this._findOptions.withDeleted = withDeleted;	864✔
73	return this;	864✔
74	}
75
76	setSelectColumn(columns: Array<string \| number> \| undefined): this {
77	if (!columns \|\| columns.length === 0) {	428✔
78	return this;	412✔
79	}
80	for (const column of columns) {	16✔
81	this._selectColumnSet.add(column);	32✔
82	}
83	return this;	16✔
84	}
85
86	setExcludeColumn(columns: string[] \| undefined): this {
87	if (!columns \|\| columns.length === 0) {	864✔
88	return this;	852✔
89	}
90	for (const column of columns) {	12✔
91	this._excludeColumnSet.add(column);	12✔
92	}
93	return this;	12✔
94	}
95
96	setWhere(where: (FindOptionsWhere<T> & Partial<T>) \| Array<FindOptionsWhere<T>>): this {
97	this._findOptions.where = where;	864✔
98	return this;	864✔
99	}
100
101	setTake(take: number): this {
102	this._findOptions.take = take;	864✔
103	return this;	864✔
104	}
105
106	setSort(sort: Sort): this {
107	this._sort = sort;	864✔
108	return this;	864✔
109	}
110
111	setOrder(order: FindOptionsOrder<T>): this {
112	this._findOptions.order = order;	864✔
113	return this;	864✔
114	}
115
116	setRelations(relations: string[] \| undefined): this {
117	this._findOptions.relations = relations;	864✔
118	return this;	864✔
119	}
120
121	setDeserialize(deserialize: (crudReadManyRequest: CrudReadManyRequest<T>) => FindOptionsWhere<T> \| Array<FindOptionsWhere<T>>): this {
122	this._deserialize = deserialize;	864✔
123	return this;	864✔
124	}
125
126	generate(): this {
127	if (this.pagination.type === PaginationType.OFFSET && Number.isFinite(this.pagination.offset)) {	864✔
128	this._findOptions.where = this._deserialize(this);	72✔
129	this._findOptions.skip = this.pagination.offset;	72✔
130	}
131
132	if (this.pagination.type === PaginationType.CURSOR && this.pagination.nextCursor) {	864✔
133	this._findOptions.where = this._deserialize(this);	68✔
134	}
135
136	return this;	864✔
137	}
138
139	toString(): string {
140	return JSON.stringify(_.omit(this, ['_deserialize']));	864✔
141	}
142
143	toResponse(data: T[], total: number): PaginationResponse<T> {
144	const take = this.findOptions.take;	860✔
145	const dataLength = data.length;	860✔
146	const orderKeys = Object.keys(this._findOptions.order);	860✔
147	const nextCursor = PaginationHelper.serialize(_.pick(data.at(-1), orderKeys) as FindOptionsWhere<T>);	860✔
148
149	if (this.pagination.type === PaginationType.OFFSET) {	860✔
150	return {	160✔
151	data,
152	metadata: this.pagination.metadata(take, dataLength, total, nextCursor),
153	};
154	}
155	return {	700✔
156	data,
157	metadata: this.pagination.metadata(take, dataLength, total, nextCursor),
158	};
159	}
160	}

woowabros / nestjs-library-crud / 9728081600

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous