feat: project insights resource with hardcoded data #6610
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 2 Ignored Deployments
|
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
There was a problem hiding this comment.
❌ Code Health Quality Gates: FAILED
- Declining Code Health: 2 findings(s) 🚩
- Improving Code Health: 0 findings(s) ✅
- Affected Hotspots: 0 files(s) 🔥
Recommended Review Level: Detailed -- Inspect the code that degrades in code health.
View detailed results in CodeScene
🚩 Declining Code Health (highest to lowest):
- Large Method project-controller.ts: ProjectController.constructor
- Code Duplication project-controller.ts
| @@ -20,16 +20,14 @@ import { | |||
| deprecatedProjectOverviewSchema, | |||
| type ProjectDoraMetricsSchema, | |||
| projectDoraMetricsSchema, | |||
| projectInsightsSchema, | |||
There was a problem hiding this comment.
❌ New issue: Code Duplication
The module contains 2 functions with similar structure: ProjectController.getDeprecatedProjectOverview,ProjectController.getProjectOverview
Why does this problem occur?
Avoid duplicated, aka copy-pasted, code inside the module. More duplication lowers the code health. Read more.
To ignore this warning click here.
| this.route({ | ||
| method: 'get', | ||
| path: '/:projectId/insights', | ||
| handler: this.getProjectInsights, | ||
| permission: NONE, | ||
| middleware: [ | ||
| this.openApiService.validPath({ | ||
| tags: ['Unstable'], | ||
| operationId: 'getProjectInsights', | ||
| summary: 'Get an overview of a project insights.', | ||
| description: | ||
| 'This endpoint returns insights into the specified projects stats, health, lead time for changes, feature types used, members and change requests.', | ||
| responses: { | ||
| 200: createResponseSchema('projectInsightsSchema'), | ||
| ...getStandardResponses(401, 403, 404), | ||
| }, | ||
| }), | ||
| ], | ||
| }); | ||
|
|
There was a problem hiding this comment.
❌ Getting worse: Large Method
ProjectController.constructor increases from 128 to 145 lines of code, threshold = 70
Why does this problem occur?
Large functions with many lines of code are generally harder to understand and lower the code health. Avoid adding more lines to this function. Read more.
To ignore this warning click here.
| @@ -287,3 +287,15 @@ test('response should include last seen at per environment for multiple environm | |||
|
|
|||
| expect(body.features[1].lastSeenAt).toBe('2023-10-01T12:34:56.000Z'); | |||
| }); | |||
|
|
|||
| test('project insights happy path', async () => { | |||
There was a problem hiding this comment.
smoke test for now
About the changes
Hardcoded data powering this screen:
This PR introduces a new resource (/insights) and corresponding openapi schemas.
Important files
Discussion points