feat(api): Replace projectId with name and slug in workspace-role response.

[Nil2000]

User description

Description

Resolved according to the requirement and also added fixed test file as well

Fixes #429

Dependencies

Mention any dependencies/packages used

Future Improvements

Mention any improvements to be done in future related to any file/feature

Mentions

Mention and tag the people

Screenshots of relevant screens

Add screenshots of relevant screens

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

PR Type

Bug fix, Tests

---

Description

• Enhanced the workspace-role service to include slug and name fields in the project data response.
• Updated end-to-end tests to verify the presence of slug and name fields in the project data.
• These changes ensure that the API response now provides more detailed project information, improving data accessibility.

---

Changes walkthrough 📝

	Relevant files
Enhancement	workspace-role.service.ts Enhance project data retrieval in workspace-role service  apps/api/src/workspace-role/service/workspace-role.service.ts Added slug and name fields to project selection in workspace-role service. Updated include statements to fetch additional project details. +25/-3
Tests	workspace-role.e2e.spec.ts Update workspace-role tests for additional project fields apps/api/src/workspace-role/workspace-role.e2e.spec.ts Updated tests to check for slug and name fields in project data. Ensured test cases reflect changes in workspace-role response structure. +12/-4

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Key issues to review Code Duplication The project selection logic is repeated in three different places. Consider extracting this into a reusable function to improve maintainability.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Type safety	Use a more specific type for the query result instead of type casting Consider using a more specific type for the workspaceRole variable instead of casting it to WorkspaceRoleWithProjects. apps/api/src/workspace-role/service/workspace-role.service.ts [453-470] -const workspaceRole = (await this.prisma.workspaceRole.findUnique({ +const workspaceRole = await this.prisma.workspaceRole.findUnique({ where: { slug: workspaceRoleSlug }, include: { projects: { select: { projectId: true, project: { select: { slug: true, name: true } } } } } -})) as WorkspaceRoleWithProjects +}) +if (!workspaceRole) { + // Handle the case when workspaceRole is null + throw new NotFoundException(`Workspace role with slug ${workspaceRoleSlug} not found`) +} + Apply this suggestion Suggestion importance[1-10]: 8 Why: The suggestion enhances type safety by avoiding type casting, which can prevent potential runtime errors and improve code reliability.	8
Maintainability	Extract repeated project selection logic into a reusable constant or function Consider using a constant or a reusable function for the project selection object to avoid code duplication and improve maintainability. apps/api/src/workspace-role/service/workspace-role.service.ts [98-107] projects: { - select: { - projectId: true, - project: { - select: { - slug: true, - name: true - } - } - } + select: PROJECT_SELECTION } Apply this suggestion Suggestion importance[1-10]: 7 Why: This suggestion improves maintainability by reducing code duplication, making it easier to manage changes to the project selection logic in one place.	7
Test improvement	Create a helper function for project object comparison in tests Consider using a custom matcher or a helper function to compare the project objects in the test assertions, improving readability and reducing duplication. apps/api/src/workspace-role/workspace-role.e2e.spec.ts [604-620] expect(response.json()).toEqual({ ...adminRole1, createdAt: expect.any(String), updatedAt: expect.any(String), - projects: expect.arrayContaining([ - { - projectId: projects[0].id, - slug: projects[0].slug, - name: projects[0].name - }, - { - projectId: projects[1].id, - slug: projects[1].slug, - name: projects[1].name - } - ]) + projects: expect.arrayContaining( + projects.map(project => expectProjectMatch(project)) + ) }) +// Helper function (define outside the test) +function expectProjectMatch(project) { + return expect.objectContaining({ + projectId: project.id, + slug: project.slug, + name: project.name + }); +} + Suggestion importance[1-10]: 6 Why: This suggestion improves test readability and reduces duplication by using a helper function for project object comparison, making the tests easier to maintain.	6

[rajdip-b]

@Nil2000 could you please self assign the issue?

[rajdip-b]

For all the select blocks, unselect the projectId field and instead, select project.select.id. That way, things look more organized.

[rajdip-b]

@Nil2000 the pr looks good. Would you be open to making the changes to api-client package in this PR? Since the changes are directly related.

[Nil2000]

Yeah sure, but I am not aware where I need to make the change.
May be in the following file

1. In workspace-role.types.d.ts interface WorkspaceRole

Is that it? Or are there more changes left? 🤔

[rajdip-b]

• keyshade/packages/api-client/src/types/workspace-role.types.d.ts

  Lines 14 to 16 in e167f53

  	projects: {
  	projectId: string
  	}[]

• https://github.com/keyshade-xyz/keyshade/blob/develop/packages/api-client/tests/workspace-role.spec.ts

These are the places. You can run the tests using pnpm test:api-client

[rajdip-b]

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀