feat: add endpoint to find table categories with associated tables by Artuomka · Pull Request #1597 · rocket-admin/rocketadmin

Artuomka · 2026-02-12T14:27:13Z

No description provided.

Copilot

Pull request overview

Adds a new GET /table-categories/v2/:connectionId endpoint that returns table categories along with the resolved tables (including permissions/display metadata), and validates it via a new SaaS E2E test.

Changes:

Added GET /table-categories/v2/:connectionId controller route + DI wiring for a new “find categories with tables” use case.
Implemented FindTableCategoriesWithTablesUseCase to fetch tables, apply permissions, enrich with display names, and group by categories (plus an “All tables” bucket).
Added a new response DTO and an E2E test covering the new endpoint.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
backend/test/ava-tests/saas-tests/table-categories-e2e.test.ts	Adds E2E coverage for the new v2 endpoint response shape and contents.
backend/src/entities/table-categories/use-cases/table-categories-use-cases.interface.ts	Introduces a new use case interface for fetching categories with tables.
backend/src/entities/table-categories/use-cases/find-table-categories-with-tables.use.case.ts	New use case implementing the endpoint behavior (tables + permissions + grouping).
backend/src/entities/table-categories/table-categories.module.ts	Wires new use case provider and applies auth middleware to the new route.
backend/src/entities/table-categories/table-categories.controller.ts	Exposes `GET /table-categories/v2/:connectionId` and calls the new use case.
backend/src/entities/table-categories/dto/found-table-categories-with-tables.ro.ts	Adds response model for “categories with tables” endpoint.
backend/src/common/data-injection.tokens.ts	Adds a new `UseCaseType` token for the use case wiring.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-12T14:32:21Z

+	}
+
+	protected async implementation(inputData: FindTablesDs): Promise<Array<FoundTableCategoriesWithTablesRo>> {
+		const { connectionId, masterPwd, userId } = inputData;


FindTablesDs includes hiddenTablesOption, but this use case ignores it (it destructures only connectionId, masterPwd, userId) and always filters out hidden tables. Either honor hiddenTablesOption (including the same permission/guard behavior as the existing find-tables use cases) or remove the field from this endpoint’s input to avoid misleading callers.

Suggested change

const { connectionId, masterPwd, userId } = inputData;

const { connectionId, masterPwd, userId, hiddenTablesOption } = inputData;

if (typeof hiddenTablesOption !== 'undefined' && hiddenTablesOption !== null) {

// This use case intentionally always excludes hidden tables.

// To avoid misleading callers, explicitly reject requests that try to

// control hidden table visibility via `hiddenTablesOption`.

throw new HttpException(

{

message: 'The hiddenTablesOption parameter is not supported for this endpoint.',

},

HttpStatus.BAD_REQUEST,

);

}

Copilot · 2026-02-12T14:32:21Z

+	private async addDisplayNamesForTables(
+		connectionId: string,
+		tablesObjArr: Array<ITableAndViewPermissionData>,
+	): Promise<Array<FoundTableDs>> {
+		const tableSettings = await this._dbContext.tableSettingsRepository.findTableSettingsInConnectionPure(connectionId);


This use case duplicates substantial logic from the existing table listing use cases (e.g., display-name enrichment and permissions calculation). Keeping multiple copies increases the risk of behavior drift when one copy changes. Consider extracting these helpers into a shared service/util or reusing the existing implementation where possible.

Copilot · 2026-02-12T14:32:22Z

+	@ApiProperty({ type: String })
+	category_color: string;


category_color is returned as null for the "All tables" category (see use case), but this response model declares it as non-nullable string. Update the DTO type to string | null and mark it nullable in the Swagger decorator.

Suggested change

@ApiProperty({ type: String })

category_color: string;

@ApiProperty({ type: String, nullable: true })

category_color: string | null;

Copilot · 2026-02-12T14:32:22Z

+		const foundTableCategories =
+			await this._dbContext.tableCategoriesRepository.findTableCategoriesForConnection(connectionId);
+
+		const sortedTables = tablesRO.sort((tableRO1, tableRO2) => {
+			const name1 = tableRO1.display_name || tableRO1.table;


findTableCategoriesForConnection() has no ORDER BY, so category order in the response can be nondeterministic. To keep the API output stable (and avoid flaky tests), sort the returned categories (e.g., by category_name/category_id) or add an orderBy in the repository query.

Copilot · 2026-02-12T14:32:22Z

+		t.is(findTableCategoriesWithTablesRO[1].category_name, 'Category 1');
+		t.is(findTableCategoriesWithTablesRO[1].category_color, '#FF5733');
+		t.is(findTableCategoriesWithTablesRO[1].category_id, 'cat-001');
+		t.is(findTableCategoriesWithTablesRO[1].tables.length, 1);
+		t.is(findTableCategoriesWithTablesRO[1].tables[0].table, firstTestTableName);
+
+		t.is(findTableCategoriesWithTablesRO[2].category_name, 'Category 2');
+		t.is(findTableCategoriesWithTablesRO[2].category_color, '#33FF57');
+		t.is(findTableCategoriesWithTablesRO[2].category_id, 'cat-002');
+		t.is(findTableCategoriesWithTablesRO[2].tables.length, 1);
+		t.is(findTableCategoriesWithTablesRO[2].tables[0].table, secondTestTableName);


This test assumes a stable ordering of categories in the response (using indexes [1] and [2]). Since the underlying repository query doesn’t specify an ORDER BY, DB return order can be nondeterministic and make the test flaky. Prefer asserting by locating categories via category_id/category_name (e.g., find()) instead of relying on array positions (other than the special "All tables" element).

Suggested change

t.is(findTableCategoriesWithTablesRO[1].category_name, 'Category 1');

t.is(findTableCategoriesWithTablesRO[1].category_color, '#FF5733');

t.is(findTableCategoriesWithTablesRO[1].category_id, 'cat-001');

t.is(findTableCategoriesWithTablesRO[1].tables.length, 1);

t.is(findTableCategoriesWithTablesRO[1].tables[0].table, firstTestTableName);

t.is(findTableCategoriesWithTablesRO[2].category_name, 'Category 2');

t.is(findTableCategoriesWithTablesRO[2].category_color, '#33FF57');

t.is(findTableCategoriesWithTablesRO[2].category_id, 'cat-002');

t.is(findTableCategoriesWithTablesRO[2].tables.length, 1);

t.is(findTableCategoriesWithTablesRO[2].tables[0].table, secondTestTableName);

const category1 = findTableCategoriesWithTablesRO.find(

(category) => category.category_id === 'cat-001',

);

t.truthy(category1);

t.is(category1.category_name, 'Category 1');

t.is(category1.category_color, '#FF5733');

t.is(category1.category_id, 'cat-001');

t.is(category1.tables.length, 1);

t.is(category1.tables[0].table, firstTestTableName);

const category2 = findTableCategoriesWithTablesRO.find(

(category) => category.category_id === 'cat-002',

);

t.truthy(category2);

t.is(category2.category_name, 'Category 2');

t.is(category2.category_color, '#33FF57');

t.is(category2.category_id, 'cat-002');

t.is(category2.tables.length, 1);

t.is(category2.tables[0].table, secondTestTableName);

Copilot · 2026-02-12T14:32:23Z

+	@ApiParam({ name: 'connectionId', required: true })
+	@UseGuards(TablesReceiveGuard)
+	@Get('/v2/:connectionId')
+	async findTableCategoriesWithTAbles(


Method name findTableCategoriesWithTAbles has inconsistent casing (capital "A" in the middle), which makes the API surface harder to scan and search. Rename to standard lowerCamelCase (e.g., findTableCategoriesWithTables).

Suggested change

async findTableCategoriesWithTAbles(

async findTableCategoriesWithTables(

Copilot · 2026-02-12T14:32:23Z

+	@ApiProperty({ type: String })
+	category_id: string;


category_id is returned as null for the "All tables" category (see use case), but this response model declares it as non-nullable string. Update the DTO type to string | null and mark it nullable in the Swagger decorator.

Suggested change

@ApiProperty({ type: String })

category_id: string;

@ApiProperty({ type: String, nullable: true })

category_id: string | null;

…es-with-tables.ro.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

feat: add endpoint to find table categories with associated tables

6b4a1b9

Copilot AI review requested due to automatic review settings February 12, 2026 14:27

Artuomka enabled auto-merge February 12, 2026 14:27

Copilot started reviewing on behalf of Artuomka February 12, 2026 14:27 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

Artuomka and others added 2 commits February 12, 2026 16:33

Update backend/src/entities/table-categories/dto/found-table-categori…

1f4946a

…es-with-tables.ro.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

refactor: remove unused Query import in table categories controller

5ef191d

Artuomka disabled auto-merge February 12, 2026 14:35

Artuomka merged commit 7a1008f into main Feb 12, 2026
16 checks passed

Artuomka deleted the backend_table_folders_improvement branch February 12, 2026 14:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: add endpoint to find table categories with associated tables#1597

feat: add endpoint to find table categories with associated tables#1597
Artuomka merged 3 commits into
mainfrom
backend_table_folders_improvement

Artuomka commented Feb 12, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-		const { connectionId, masterPwd, userId } = inputData;
+		const { connectionId, masterPwd, userId, hiddenTablesOption } = inputData;
+		if (typeof hiddenTablesOption !== 'undefined' && hiddenTablesOption !== null) {
+			// This use case intentionally always excludes hidden tables.
+			// To avoid misleading callers, explicitly reject requests that try to
+			// control hidden table visibility via `hiddenTablesOption`.
+			throw new HttpException(
+				{
+					message: 'The hiddenTablesOption parameter is not supported for this endpoint.',
+				},
+				HttpStatus.BAD_REQUEST,
+			);
+		}

-		t.is(findTableCategoriesWithTablesRO[1].category_name, 'Category 1');
-		t.is(findTableCategoriesWithTablesRO[1].category_color, '#FF5733');
-		t.is(findTableCategoriesWithTablesRO[1].category_id, 'cat-001');
-		t.is(findTableCategoriesWithTablesRO[1].tables.length, 1);
-		t.is(findTableCategoriesWithTablesRO[1].tables[0].table, firstTestTableName);
-		t.is(findTableCategoriesWithTablesRO[2].category_name, 'Category 2');
-		t.is(findTableCategoriesWithTablesRO[2].category_color, '#33FF57');
-		t.is(findTableCategoriesWithTablesRO[2].category_id, 'cat-002');
-		t.is(findTableCategoriesWithTablesRO[2].tables.length, 1);
-		t.is(findTableCategoriesWithTablesRO[2].tables[0].table, secondTestTableName);
+		const category1 = findTableCategoriesWithTablesRO.find(
+			(category) => category.category_id === 'cat-001',
+		);
+		t.truthy(category1);
+		t.is(category1.category_name, 'Category 1');
+		t.is(category1.category_color, '#FF5733');
+		t.is(category1.category_id, 'cat-001');
+		t.is(category1.tables.length, 1);
+		t.is(category1.tables[0].table, firstTestTableName);
+		const category2 = findTableCategoriesWithTablesRO.find(
+			(category) => category.category_id === 'cat-002',
+		);
+		t.truthy(category2);
+		t.is(category2.category_name, 'Category 2');
+		t.is(category2.category_color, '#33FF57');
+		t.is(category2.category_id, 'cat-002');
+		t.is(category2.tables.length, 1);
+		t.is(category2.tables[0].table, secondTestTableName);

	async findTableCategoriesWithTAbles(
	async findTableCategoriesWithTables(

Uh oh!

Uh oh!

Conversation

Artuomka commented Feb 12, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants