feat: implement report by rjsdn0 · Pull Request #276 · sparcs-kaist/students

rjsdn0 · 2025-08-11T06:58:08Z

요약 *

It closes #262

이후 Task *

API 완성 (O)
에러 처리 로직 추가 (O)
API Test (O)
API Endpoint URL 작성
API 명세 업데이트
필요한 API 추가
previousbudgetincome/expense 확인

Copilot

Pull Request Overview

This PR implements comprehensive report functionality by adding API endpoints, services, and data models for project reports and budget reports. The implementation includes list/detail views for project reports, CRUD operations for project report revisions and timelines, and management of budget report income/expenses.

Adds API endpoints (apiRpt001-024) for project reports, budget reports, and their revisions
Implements service layers for handling report operations with proper business logic
Updates database schemas and repository mappings to support new report features

Reviewed Changes

Copilot reviewed 48 out of 48 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
packages/interface/src/api/report/type/project-report.type.ts	Defines TypeScript types and Zod schemas for project report APIs
packages/interface/src/api/report/endpoint/*.ts	Implements API endpoint configurations for all report-related operations
packages/api/src/feature/report/service/*.ts	Implements business logic services for project and budget reports
packages/api/src/feature/report/controller/report.controller.ts	Adds REST API endpoints with proper validation and routing
Database schemas and repositories	Updates to support new report data structures and relationships

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-11T11:28:28Z

packages/interface/src/api/report/type/project-report.type.ts

    timelines: z.array(
      z.object({
        // name: z.string().max(255),
+        projectReportRevision: z.object({ id: zId }).optional(),


[nitpick] The timeline object contains an optional projectReportRevision field that should be consistent with how other revision references are handled. Consider using zExtractId(zProjectReportRevision) for consistency with the established pattern used elsewhere in the codebase.

Suggested change

projectReportRevision: z.object({ id: zId }).optional(),

projectReportRevision: zExtractId(zProjectReportRevision).optional(),

packages/interface/src/api/report/type/project-report.type.ts

packages/interface/src/api/report/endpoint/apiRpt001.ts

packages/interface/src/api/report/endpoint/apiRpt024.ts

packages/api/src/feature/report/service/project-report.service.ts

Copilot · 2025-09-11T11:28:30Z

packages/api/src/feature/report/service/project-report.public.service.ts

+            return Array.from(budgetReportInfoMap, ([key, value]) => {
+              // eslint-disable-next-line
+              const { reportSubmittedAt, proposalSubmittedAt, ...info } = value;
+              return { id: key.id, ...info };


Same issue as in project-report.service.ts - accessing key.id is incorrect since key is the map key (a number). This should be { id: key, ...info }.

Suggested change

return { id: key.id, ...info };

return { id: key, ...info };

Copilot · 2025-09-11T11:28:30Z

packages/api/src/feature/report/repository/budget-report-income-revision.repository.ts

    > = {
      id: BudgetReportIncomeRevision,
-      budgetReportIncome: BudgetReportIncomeRevision,
+      budgetReportIncomeId: BudgetReportIncomeRevision,


[nitpick] The field mapping appears to have been corrected from budgetReportIncome to budgetReportIncomeId, but this change should be verified to ensure it aligns with the actual database column name and usage patterns.

Copilot · 2025-09-11T11:28:30Z

packages/api/src/feature/report/repository/project-report-revision.repository.ts

          endTerm: timeline.duration.endTerm,
          detail: timeline.detail,
          note: timeline.note,
+          projectReportRevisionId: timeline.projectReportRevision.id,


The timeline mapping assumes timeline.projectReportRevision.id exists, but according to the type definition, this field is optional. Add null checking or make the field required to prevent potential runtime errors.

Suggested change

projectReportRevisionId: timeline.projectReportRevision.id,

projectReportRevisionId: timeline.projectReportRevision?.id,

Copilot · 2025-09-11T11:28:31Z

packages/api/src/feature/report/repository/project-report-revision.repository.ts

          endTerm: timeline.duration.endTerm,
          detail: timeline.detail,
          note: timeline.note,
+          projectReportRevisionId: timeline.projectReportRevision.id,


The timeline mapping assumes timeline.projectReportRevision.id exists, but according to the type definition, this field is optional. Add null checking or make the field required to prevent potential runtime errors.

litmify · 2025-09-17T14:29:29Z

packages/api/src/feature/report/controller/report.controller.ts

혹시 이 수많은 apiRpt00X 들은 뭐하는 친구들일까요?

결산안 + 사업보고서 관련 API들입니다!

각 api문서들에 description이 빠져 있는 것 같습니다!

thxx132

오타랑 conflict 해결하고 다시 리뷰가 필요할 것 같습니다. 그런데 api 구성 자체는 큰 문제 없긴 한데 예산안 쪽이랑 달라서... 프론트에서 괜찮을까요?

malloc3141 · 2025-09-18T11:02:50Z

근데 어차피 연결하다보면 또 문제가 생길 수도 있어서 일단 연결을 한번 해보고 결정하는 것도 괜찮아 보이네요

litmify · 2025-09-21T12:39:42Z

전체적으로 copilot 리뷰 내용에 더해서 any 가 꽤 많이 사용된 것 같던데, 어쩔 수 없는 부분일까요?

packages/api/src/feature/report/service/budget-report.service.ts

litmify · 2025-10-27T08:34:42Z

이 PR 남은 부분은 제가 목요일 미팅 전까지 얼추 해서 리뷰 가능한 상태로 만들어둬보겠습니다

thxx132 · 2025-10-27T17:58:04Z

화이팅입니다! 아 그런데 previousProposalIncome 같은 항목들은 어차피 organization이랑 semester id들로 특정되기도 하고 넣으면 괜히 오류가 생길 수 있어서 빼는 것이 좋을 것 같습니다!

feat: report interface

c064fba

rjsdn0 changed the title ~~feat: report interface~~ feat: implement report Aug 11, 2025

rjsdn0 added 8 commits August 17, 2025 19:31

fix: api numbering

3f33b84

fix: interface

20c677d

fix: schema

6f8da4a

feat: report / budget report api implement

78b8099

fix: export module

56e3274

feat: add zod pipe

c032e27

fix: api errors

5307d2c

fix: add error handling

e8a170a

rjsdn0 marked this pull request as ready for review August 25, 2025 08:51

malloc3141 requested review from Copilot, malloc3141 and thxx132 and removed request for Copilot and thxx132 September 11, 2025 11:25

Copilot AI reviewed Sep 11, 2025

View reviewed changes

litmify reviewed Sep 17, 2025

View reviewed changes

malloc3141 added the backend label Sep 18, 2025

thxx132 reviewed Sep 18, 2025

View reviewed changes

Merge branch 'dev' into 262-impl-report-api

74fa785

thxx132 reviewed Oct 26, 2025

View reviewed changes

packages/api/src/feature/report/service/budget-report.service.ts Show resolved Hide resolved

fix: typos

a6c76a5

	projectReportRevision: z.object({ id: zId }).optional(),
	projectReportRevision: zExtractId(zProjectReportRevision).optional(),

	projectReportRevisionId: timeline.projectReportRevision.id,
	projectReportRevisionId: timeline.projectReportRevision?.id,

Comments

Conversation

rjsdn0 commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

요약 *

이후 Task *

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

litmify Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

rjsdn0 Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

thxx132 Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

thxx132 left a comment

Choose a reason for hiding this comment

Uh oh!

malloc3141 commented Sep 18, 2025

Uh oh!

litmify commented Sep 21, 2025

Uh oh!

Uh oh!

litmify commented Oct 27, 2025

Uh oh!

thxx132 commented Oct 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rjsdn0 commented Aug 11, 2025 •

edited

Loading