From 5fb6467bcf49c587178798124168e785d79756a5 Mon Sep 17 00:00:00 2001 From: josuemc Date: Wed, 26 Aug 2026 10:42:11 -0300 Subject: [PATCH 1/3] Feat: Listar e buscar tipos de relevo Api.v2 --- src/application/create-app.ts | 4 +- .../relevo/BuscarRelevoController.ts | 41 +++++++ .../relevo/ListaRelevosController.ts | 50 ++++++++ src/application/relevo/index.ts | 35 ++++++ src/domain/relevo/BuscarRelevoPorIdUseCase.ts | 20 ++++ src/domain/relevo/ListaRelevosUseCase.ts | 20 ++++ src/domain/relevo/Relevo.ts | 24 ++++ src/domain/relevo/RelevoCollection.ts | 18 +++ .../RelevoCollectionKnexAdapter.ts | 46 ++++++++ test/integration/relevo/lista-relevos.test.ts | 107 ++++++++++++++++++ 10 files changed, 364 insertions(+), 1 deletion(-) create mode 100644 src/application/relevo/BuscarRelevoController.ts create mode 100644 src/application/relevo/ListaRelevosController.ts create mode 100644 src/application/relevo/index.ts create mode 100644 src/domain/relevo/BuscarRelevoPorIdUseCase.ts create mode 100644 src/domain/relevo/ListaRelevosUseCase.ts create mode 100644 src/domain/relevo/Relevo.ts create mode 100644 src/domain/relevo/RelevoCollection.ts create mode 100644 src/infrastructure/RelevoCollectionKnexAdapter.ts create mode 100644 test/integration/relevo/lista-relevos.test.ts diff --git a/src/application/create-app.ts b/src/application/create-app.ts index 0f53e372..3eadddf9 100644 --- a/src/application/create-app.ts +++ b/src/application/create-app.ts @@ -14,6 +14,7 @@ import legacyErrors from '../middlewares/erros-middleware' import { generatePreview, reportPreview } from '../reports/controller' import { routes as createEstadoRoutes } from './estado' import { routes as createPaisRoutes } from './pais' +import { routes as createRelevoRoutes } from './relevo' interface CorsParameters { origins: string[] @@ -55,7 +56,8 @@ export function createApp({ }: Parameters) { const routes: Route[] = [ ...createPaisRoutes(knex), - ...createEstadoRoutes(knex) + ...createEstadoRoutes(knex), + ...createRelevoRoutes(knex) ] const application = new ExpressApplication({ logger }) diff --git a/src/application/relevo/BuscarRelevoController.ts b/src/application/relevo/BuscarRelevoController.ts new file mode 100644 index 00000000..81e4e844 --- /dev/null +++ b/src/application/relevo/BuscarRelevoController.ts @@ -0,0 +1,41 @@ +import { BuscarRelevoPorIdUseCase } from '@/domain/relevo/BuscarRelevoPorIdUseCase' +import { + HttpRequest, HttpResponse, StatusCode +} from '@/library/http/common' +import { BadRequestError } from '@/library/http/error/BadRequestError' +import { HttpError } from '@/library/http/error/HttpError' +import { InternalServerError } from '@/library/http/error/InternalServerError' +import { NotFoundError } from '@/library/http/error/NotFoundError' +import { NextHandler, RequestHandler } from '@/library/http/Server' + +interface Dependencies { + buscarRelevoPorIdUseCase: BuscarRelevoPorIdUseCase +} + +export class BuscarRelevoController implements RequestHandler { + private readonly buscarRelevoPorIdUseCase: BuscarRelevoPorIdUseCase + + constructor(dependencies: Dependencies) { + this.buscarRelevoPorIdUseCase = dependencies.buscarRelevoPorIdUseCase + } + + async handle(request: HttpRequest, _next: NextHandler): Promise { + const { relevoId } = request.params as { relevoId?: string } + + if (relevoId === undefined || relevoId === null || relevoId === '' || !/^\d+$/.test(relevoId)) { + return new BadRequestError({ message: 'relevoId inválido' }) + } + + const result = await this.buscarRelevoPorIdUseCase.execute({ id: Number(relevoId) }) + + if (result.left()) { + return new InternalServerError({ message: result.value.message }) + } + + if (!result.value) { + return new NotFoundError({ message: 'Relevo não encontrado' }) + } + + return { statusCode: StatusCode.Ok, body: result.value } + } +} diff --git a/src/application/relevo/ListaRelevosController.ts b/src/application/relevo/ListaRelevosController.ts new file mode 100644 index 00000000..191d7904 --- /dev/null +++ b/src/application/relevo/ListaRelevosController.ts @@ -0,0 +1,50 @@ +import { ListaRelevosUseCase } from '@/domain/relevo/ListaRelevosUseCase' +import { + HttpRequest, HttpResponse, StatusCode +} from '@/library/http/common' +import { HttpError } from '@/library/http/error/HttpError' +import { InternalServerError } from '@/library/http/error/InternalServerError' +import { NextHandler, RequestHandler } from '@/library/http/Server' + +interface Dependencies { + listaRelevosUseCase: ListaRelevosUseCase +} + +export class ListaRelevosController implements RequestHandler { + private readonly listaRelevosUseCase: ListaRelevosUseCase + + constructor(dependencies: Dependencies) { + this.listaRelevosUseCase = dependencies.listaRelevosUseCase + } + + async handle(request: HttpRequest, _next: NextHandler): Promise { + const { nome, order } = request.params as { + nome?: string + order?: string + } + + const result = await this.listaRelevosUseCase.execute({ + nome, + order: parseOrder(order) + }) + + if (result.left()) { + return new InternalServerError({ message: result.value.message }) + } + + return { statusCode: StatusCode.Ok, body: result.value } + } +} + +function parseOrder(order?: string): { column: 'id' | 'nome'; direction: 'asc' | 'desc' } | undefined { + if (!order) return undefined + + const [column, direction] = order.split(':') + const normalizedColumn = column === 'nome' || column === 'id' ? column : 'id' + const normalizedDirection = direction === 'asc' || direction === 'desc' ? direction : 'desc' + + return { + column: normalizedColumn, + direction: normalizedDirection + } +} diff --git a/src/application/relevo/index.ts b/src/application/relevo/index.ts new file mode 100644 index 00000000..69e9bd03 --- /dev/null +++ b/src/application/relevo/index.ts @@ -0,0 +1,35 @@ +import { type Knex } from 'knex' + +import { BuscarRelevoPorIdUseCase } from '@/domain/relevo/BuscarRelevoPorIdUseCase' +import { ListaRelevosUseCase } from '@/domain/relevo/ListaRelevosUseCase' +import { RelevoCollectionKnexAdapter } from '@/infrastructure/RelevoCollectionKnexAdapter' +import { Method } from '@/library/http/common' +import { Route } from '@/library/http/Router' + +import { BuscarRelevoController } from './BuscarRelevoController' +import { ListaRelevosController } from './ListaRelevosController' + +export function routes(knex: Knex): Route[] { + const relevoCollection = new RelevoCollectionKnexAdapter({ knex }) + + return [ + { + handlers: [ + new ListaRelevosController({ + listaRelevosUseCase: new ListaRelevosUseCase({ relevoCollection }) + }) + ], + method: Method.Get, + path: '/v2/relevos' + }, + { + handlers: [ + new BuscarRelevoController({ + buscarRelevoPorIdUseCase: new BuscarRelevoPorIdUseCase({ relevoCollection }) + }) + ], + method: Method.Get, + path: '/v2/relevos/:relevoId' + } + ] +} diff --git a/src/domain/relevo/BuscarRelevoPorIdUseCase.ts b/src/domain/relevo/BuscarRelevoPorIdUseCase.ts new file mode 100644 index 00000000..5ae33c45 --- /dev/null +++ b/src/domain/relevo/BuscarRelevoPorIdUseCase.ts @@ -0,0 +1,20 @@ +import { Either } from '@/library/either/Either' + +import { Attributes } from './Relevo' +import { RelevoCollection } from './RelevoCollection' + +interface Dependencies { + relevoCollection: RelevoCollection +} + +export class BuscarRelevoPorIdUseCase { + private readonly relevoCollection: RelevoCollection + + constructor(dependencies: Dependencies) { + this.relevoCollection = dependencies.relevoCollection + } + + execute({ id }: { id: number }): Promise> { + return this.relevoCollection.findById(id) + } +} diff --git a/src/domain/relevo/ListaRelevosUseCase.ts b/src/domain/relevo/ListaRelevosUseCase.ts new file mode 100644 index 00000000..993bab0c --- /dev/null +++ b/src/domain/relevo/ListaRelevosUseCase.ts @@ -0,0 +1,20 @@ +import { Either } from '@/library/either/Either' + +import { Attributes } from './Relevo' +import { RelevoCollection, RelevoFilters } from './RelevoCollection' + +interface Dependencies { + relevoCollection: RelevoCollection +} + +export class ListaRelevosUseCase { + private readonly relevoCollection: RelevoCollection + + constructor(dependencies: Dependencies) { + this.relevoCollection = dependencies.relevoCollection + } + + execute(filters: RelevoFilters): Promise> { + return this.relevoCollection.findAll(filters) + } +} diff --git a/src/domain/relevo/Relevo.ts b/src/domain/relevo/Relevo.ts new file mode 100644 index 00000000..073ed1b6 --- /dev/null +++ b/src/domain/relevo/Relevo.ts @@ -0,0 +1,24 @@ +import { Either } from '@/library/either/Either' + +export interface Attributes { + id: number + nome: string +} + +export class Relevo { + readonly id: number + readonly nome: string + + private constructor(attributes: Attributes) { + this.id = attributes.id + this.nome = attributes.nome + } + + static create(attributes: Attributes): Either { + if (!attributes.nome.trim()) { + return Either.left(new Error('Nome do relevo não pode ser vazio')) + } + + return Either.right(new Relevo(attributes)) + } +} diff --git a/src/domain/relevo/RelevoCollection.ts b/src/domain/relevo/RelevoCollection.ts new file mode 100644 index 00000000..c63f3cdb --- /dev/null +++ b/src/domain/relevo/RelevoCollection.ts @@ -0,0 +1,18 @@ +import { Either } from '@/library/either/Either' + +import { Attributes } from './Relevo' + +export interface RelevoOrder { + column: 'id' | 'nome' + direction: 'asc' | 'desc' +} + +export interface RelevoFilters { + nome?: string + order?: RelevoOrder +} + +export interface RelevoCollection { + findAll(filters: RelevoFilters): Promise> + findById(id: number): Promise> +} diff --git a/src/infrastructure/RelevoCollectionKnexAdapter.ts b/src/infrastructure/RelevoCollectionKnexAdapter.ts new file mode 100644 index 00000000..ba4581d5 --- /dev/null +++ b/src/infrastructure/RelevoCollectionKnexAdapter.ts @@ -0,0 +1,46 @@ +import { Knex } from 'knex' + +import { Attributes } from '@/domain/relevo/Relevo' +import { RelevoCollection, RelevoFilters } from '@/domain/relevo/RelevoCollection' +import { Either } from '@/library/either/Either' + +import { CollectionError } from './error/CollectionError' + +interface Dependencies { + knex: Knex +} + +export class RelevoCollectionKnexAdapter implements RelevoCollection { + private readonly knex: Knex + + constructor(dependencies: Dependencies) { + this.knex = dependencies.knex + } + + async findAll(filters: RelevoFilters): Promise> { + try { + const query = this.knex('relevos') + .select(['id', 'nome']) + + if (filters.nome) { + query.whereILike('nome', `%${filters.nome}%`) + } + + const order = filters.order ?? { column: 'id', direction: 'desc' } + query.orderBy(order.column, order.direction) + + return Either.right(await query) + } catch (error) { + return Either.left(new CollectionError({ message: 'Failed to list relevos', cause: error })) + } + } + + async findById(id: number): Promise> { + try { + const relevo = await this.knex('relevos').select(['id', 'nome']).where({ id }).first() + return Either.right(relevo ?? null) + } catch (error) { + return Either.left(new CollectionError({ message: 'Failed to find relevo', cause: error })) + } + } +} diff --git a/test/integration/relevo/lista-relevos.test.ts b/test/integration/relevo/lista-relevos.test.ts new file mode 100644 index 00000000..e261e071 --- /dev/null +++ b/test/integration/relevo/lista-relevos.test.ts @@ -0,0 +1,107 @@ +import { + afterAll, describe, expect, test +} from 'vitest' + +import { createTestApp } from '../setup/app-factory' + +type Relevo = { id: number; nome: string } + +const returning = ['id', 'nome'] as const + +describe('GET /api/v2/relevos', () => { + const { agent, knex } = createTestApp() + + afterAll(() => knex.destroy()) + + test('retorna a lista ordenada por id decrescente como padrão', async () => { + const nomes = [ + 'XREL Plano', + 'XREL Inclinado', + 'XREL Ondulado' + ] + + const inserted = await knex('relevos') + .insert(nomes.map(nome => ({ nome }))) + .returning(returning) + + try { + const response = await agent.get('/api/v2/relevos').expect(200) + const expected = [...inserted].sort((a, b) => b.id - a.id) + expect(response.body).toEqual(expected) + } finally { + await knex('relevos').whereIn('nome', nomes).delete() + } + }) + + test('filtra por nome sem diferenciar maiúsculas e minúsculas', async () => { + const nomes = [ + 'XREL Plano', + 'XREL Inclinado', + 'XREL Ondulado' + ] + + const inserted = await knex('relevos') + .insert(nomes.map(nome => ({ nome }))) + .returning(returning) + + try { + const response = await agent.get('/api/v2/relevos?nome=plano').expect(200) + expect(response.body).toEqual(inserted.filter(item => item.nome === 'XREL Plano')) + } finally { + await knex('relevos').whereIn('nome', nomes).delete() + } + }) + + test('aceita ordenação customizada por nome e id', async () => { + const nomes = [ + 'XREL Z', + 'XREL A', + 'XREL M' + ] + + const inserted = await knex('relevos') + .insert(nomes.map(nome => ({ nome }))) + .returning(returning) + + try { + const byNameAsc = await agent.get('/api/v2/relevos?order=nome:asc').expect(200) + expect(byNameAsc.body).toEqual([...inserted].sort((a, b) => a.nome.localeCompare(b.nome))) + + const byIdAsc = await agent.get('/api/v2/relevos?order=id:asc').expect(200) + expect(byIdAsc.body).toEqual([...inserted].sort((a, b) => a.id - b.id)) + } finally { + await knex('relevos').whereIn('nome', nomes).delete() + } + }) +}) + +describe('GET /api/v2/relevos/:relevoId', () => { + const { agent, knex } = createTestApp() + + afterAll(() => knex.destroy()) + + test('retorna o registro encontrado', async () => { + const [relevo] = await knex('relevos') + .insert({ nome: 'XREL Relevo Encontrado' }) + .returning(returning) + + try { + const response = await agent.get(`/api/v2/relevos/${relevo.id}`).expect(200) + expect(response.body).toEqual({ id: relevo.id, nome: relevo.nome }) + } finally { + await knex('relevos').where({ id: relevo.id }).delete() + } + }) + + test('retorna 404 para id inexistente', async () => { + const response = await agent.get('/api/v2/relevos/999999').expect(404) + // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access + expect(response.body.error.message).toMatch(/não encontrado|not found|not found/i) + }) + + test('retorna 400 para id inválido', async () => { + const response = await agent.get('/api/v2/relevos/abc').expect(400) + // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access + expect(response.body.error.message).toMatch(/inválido|invalid/i) + }) +}) From 1215edb233ee8895a018b1e513fdc649448c76dd Mon Sep 17 00:00:00 2001 From: josuemc Date: Wed, 26 Aug 2026 11:11:14 -0300 Subject: [PATCH 2/3] fix: test --- test/integration/relevo/lista-relevos.test.ts | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/test/integration/relevo/lista-relevos.test.ts b/test/integration/relevo/lista-relevos.test.ts index e261e071..eb477bae 100644 --- a/test/integration/relevo/lista-relevos.test.ts +++ b/test/integration/relevo/lista-relevos.test.ts @@ -95,13 +95,15 @@ describe('GET /api/v2/relevos/:relevoId', () => { test('retorna 404 para id inexistente', async () => { const response = await agent.get('/api/v2/relevos/999999').expect(404) - // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access - expect(response.body.error.message).toMatch(/não encontrado|not found|not found/i) + const body = response.body as { error: { message: string } } + + expect(body.error.message).toMatch(/não encontrad[ao]|not found/i) }) test('retorna 400 para id inválido', async () => { const response = await agent.get('/api/v2/relevos/abc').expect(400) - // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access - expect(response.body.error.message).toMatch(/inválido|invalid/i) + const body = response.body as { error: { message: string } } + + expect(body.error.message).toMatch(/inválido|invalid/i) }) }) From c18d6c9a38d090bcfeb2896b3b085c490850b7f4 Mon Sep 17 00:00:00 2001 From: josuemc Date: Tue, 1 Sep 2026 12:54:11 -0300 Subject: [PATCH 3/3] =?UTF-8?q?fix:=20Corre=C3=A7=C3=A3o=20no=20parserOrde?= =?UTF-8?q?r=20e=20no=20test?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../relevo/ListaRelevosController.ts | 29 ++++++++--- test/integration/relevo/lista-relevos.test.ts | 52 +++++++++++++------ 2 files changed, 59 insertions(+), 22 deletions(-) diff --git a/src/application/relevo/ListaRelevosController.ts b/src/application/relevo/ListaRelevosController.ts index 191d7904..f26ecbb9 100644 --- a/src/application/relevo/ListaRelevosController.ts +++ b/src/application/relevo/ListaRelevosController.ts @@ -2,6 +2,7 @@ import { ListaRelevosUseCase } from '@/domain/relevo/ListaRelevosUseCase' import { HttpRequest, HttpResponse, StatusCode } from '@/library/http/common' +import { BadRequestError } from '@/library/http/error/BadRequestError' import { HttpError } from '@/library/http/error/HttpError' import { InternalServerError } from '@/library/http/error/InternalServerError' import { NextHandler, RequestHandler } from '@/library/http/Server' @@ -23,9 +24,14 @@ export class ListaRelevosController implements RequestHandler { order?: string } + const parsedOrder = parseOrder(order) + if (parsedOrder instanceof Error) { + return new BadRequestError({ message: parsedOrder.message }) + } + const result = await this.listaRelevosUseCase.execute({ nome, - order: parseOrder(order) + order: parsedOrder }) if (result.left()) { @@ -36,15 +42,24 @@ export class ListaRelevosController implements RequestHandler { } } -function parseOrder(order?: string): { column: 'id' | 'nome'; direction: 'asc' | 'desc' } | undefined { +function parseOrder(order?: string): { column: 'id' | 'nome'; direction: 'asc' | 'desc' } | Error | undefined { if (!order) return undefined - const [column, direction] = order.split(':') - const normalizedColumn = column === 'nome' || column === 'id' ? column : 'id' - const normalizedDirection = direction === 'asc' || direction === 'desc' ? direction : 'desc' + const pieces = order.split(':') + if (pieces.length !== 2) { + return new Error('order inválido. Use o formato "id:asc", "id:desc", "nome:asc" ou "nome:desc"') + } + + const [rawColumn, rawDirection] = pieces + const column = rawColumn.trim().toLowerCase() + const direction = rawDirection.trim().toLowerCase() + + if ((column !== 'id' && column !== 'nome') || (direction !== 'asc' && direction !== 'desc')) { + return new Error('order inválido. Use o formato "id:asc", "id:desc", "nome:asc" ou "nome:desc"') + } return { - column: normalizedColumn, - direction: normalizedDirection + column, + direction } } diff --git a/test/integration/relevo/lista-relevos.test.ts b/test/integration/relevo/lista-relevos.test.ts index eb477bae..8efa1af6 100644 --- a/test/integration/relevo/lista-relevos.test.ts +++ b/test/integration/relevo/lista-relevos.test.ts @@ -13,11 +13,12 @@ describe('GET /api/v2/relevos', () => { afterAll(() => knex.destroy()) - test('retorna a lista ordenada por id decrescente como padrão', async () => { + test('retorna a lista ordenada por id decrescente como padrão dentro do prefixo do teste', async () => { + const prefix = 'XREL' const nomes = [ - 'XREL Plano', - 'XREL Inclinado', - 'XREL Ondulado' + `${prefix} Plano`, + `${prefix} Inclinado`, + `${prefix} Ondulado` ] const inserted = await knex('relevos') @@ -25,7 +26,7 @@ describe('GET /api/v2/relevos', () => { .returning(returning) try { - const response = await agent.get('/api/v2/relevos').expect(200) + const response = await agent.get(`/api/v2/relevos?nome=${prefix}`).expect(200) const expected = [...inserted].sort((a, b) => b.id - a.id) expect(response.body).toEqual(expected) } finally { @@ -34,10 +35,11 @@ describe('GET /api/v2/relevos', () => { }) test('filtra por nome sem diferenciar maiúsculas e minúsculas', async () => { + const prefix = 'XREL' const nomes = [ - 'XREL Plano', - 'XREL Inclinado', - 'XREL Ondulado' + `${prefix} Plano`, + `${prefix} Inclinado`, + `${prefix} Ondulado` ] const inserted = await knex('relevos') @@ -45,18 +47,19 @@ describe('GET /api/v2/relevos', () => { .returning(returning) try { - const response = await agent.get('/api/v2/relevos?nome=plano').expect(200) - expect(response.body).toEqual(inserted.filter(item => item.nome === 'XREL Plano')) + const response = await agent.get(`/api/v2/relevos?nome=${prefix} plano`).expect(200) + expect(response.body).toEqual(inserted.filter(item => item.nome === `${prefix} Plano`)) } finally { await knex('relevos').whereIn('nome', nomes).delete() } }) test('aceita ordenação customizada por nome e id', async () => { + const prefix = 'XREL' const nomes = [ - 'XREL Z', - 'XREL A', - 'XREL M' + `${prefix} Z`, + `${prefix} A`, + `${prefix} M` ] const inserted = await knex('relevos') @@ -64,15 +67,34 @@ describe('GET /api/v2/relevos', () => { .returning(returning) try { - const byNameAsc = await agent.get('/api/v2/relevos?order=nome:asc').expect(200) + const byNameAsc = await agent.get(`/api/v2/relevos?nome=${prefix}&order=nome:asc`).expect(200) expect(byNameAsc.body).toEqual([...inserted].sort((a, b) => a.nome.localeCompare(b.nome))) - const byIdAsc = await agent.get('/api/v2/relevos?order=id:asc').expect(200) + const byIdAsc = await agent.get(`/api/v2/relevos?nome=${prefix}&order=id:asc`).expect(200) expect(byIdAsc.body).toEqual([...inserted].sort((a, b) => a.id - b.id)) } finally { await knex('relevos').whereIn('nome', nomes).delete() } }) + + test('retorna 400 quando a ordenação é inválida', async () => { + const prefix = 'XREL' + const nomes = [ + `${prefix} Z`, + `${prefix} A`, + `${prefix} M` + ] + + await knex('relevos').insert(nomes.map(nome => ({ nome }))) + + try { + const response = await agent.get(`/api/v2/relevos?nome=${prefix}&order=foo:bar`).expect(400) + const body = response.body as { error: { message: string } } + expect(body.error.message).toMatch(/inválido|invalid/i) + } finally { + await knex('relevos').whereIn('nome', nomes).delete() + } + }) }) describe('GET /api/v2/relevos/:relevoId', () => {