feat: Remove project IDs from workspace role export data and update tests

[Meeran-Tofiq]

User description

Description

Give a summary of the change that you have made

Changed the exportData function in the workspace controller to no longer return project IDs. I updated the e2e test to now check for the important fields that are supposed to be returned by exportData.

Fixes #425

Dependencies

Mention any dependencies/packages used
None

Future Improvements

Mention any improvements to be done in future related to any file/feature
The test currently doesn't test if there is extra fields that is not needed/not supposed to be there, only that the important fields are there. If necessary, I will change the test to be more precise.

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

enhancement, tests

---

Description

• Removed project IDs from the exportData function in the workspace service to streamline the data returned.
• Updated end-to-end tests to verify that workspaceRoles contain the expected fields such as name, description, hasAdminAuthority, authorities, and colorCode.

---

Changes walkthrough 📝

	Relevant files
Enhancement	workspace.service.ts Remove project ID selection from exportData function          apps/api/src/workspace/service/workspace.service.ts Removed the selection of project IDs from the exportData function. Kept other fields like name, description, and authorities. +1/-6
Tests	workspace.e2e.spec.ts Update e2e test to verify workspaceRole fields                      apps/api/src/workspace/workspace.e2e.spec.ts Updated test to check for specific fields in workspaceRoles. Ensured workspaceRoles contains expected properties. +7/-0

---

💡 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 Data Consistency Removal of project IDs from workspace role export data might affect data consistency or cause issues in other parts of the application that may depend on this information. Test Precision The updated test checks for the presence of expected fields but doesn't verify the absence of unnecessary fields or the correctness of the data.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	Use a type assertion or interface for the workspace role structure in the test Consider using a type assertion or interface to define the structure of exampleWorkspaceRole. This will provide better type safety and make the expected structure more explicit. apps/api/src/workspace/workspace.e2e.spec.ts [533-538] -const exampleWorkspaceRole = body.workspaceRoles[0] +interface WorkspaceRole { + name: string; + description: string; + hasAdminAuthority: boolean; + authorities: string[]; + colorCode: string; +} +const exampleWorkspaceRole = body.workspaceRoles[0] as WorkspaceRole; expect(exampleWorkspaceRole).toHaveProperty('name') expect(exampleWorkspaceRole).toHaveProperty('description') expect(exampleWorkspaceRole).toHaveProperty('hasAdminAuthority') expect(exampleWorkspaceRole).toHaveProperty('authorities') expect(exampleWorkspaceRole).toHaveProperty('colorCode') Apply this suggestion Suggestion importance[1-10]: 8 Why: Using a type assertion or interface enhances type safety and clarity, making the expected structure explicit, which is a best practice in TypeScript.	8
Maintainability	Add a comment explaining the removal of project IDs from the select statement Consider adding a comment explaining why projects were removed from the select statement. This will help future developers understand the reasoning behind this change. apps/api/src/workspace/service/workspace.service.ts [275-281] select: { name: true, description: true, colorCode: true, hasAdminAuthority: true, authorities: true } +// Project IDs are no longer included in workspace role export data Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding a comment to explain the removal of project IDs would improve code maintainability and help future developers understand the change rationale, though it is not critical for functionality.	7
Enhancement	Assert the types of workspace role properties instead of just checking for their presence Instead of checking for the presence of properties, consider asserting the types of these properties. This will provide stronger guarantees about the structure of the exampleWorkspaceRole object. apps/api/src/workspace/workspace.e2e.spec.ts [534-538] -expect(exampleWorkspaceRole).toHaveProperty('name') -expect(exampleWorkspaceRole).toHaveProperty('description') -expect(exampleWorkspaceRole).toHaveProperty('hasAdminAuthority') -expect(exampleWorkspaceRole).toHaveProperty('authorities') -expect(exampleWorkspaceRole).toHaveProperty('colorCode') +expect(typeof exampleWorkspaceRole.name).toBe('string') +expect(typeof exampleWorkspaceRole.description).toBe('string') +expect(typeof exampleWorkspaceRole.hasAdminAuthority).toBe('boolean') +expect(Array.isArray(exampleWorkspaceRole.authorities)).toBe(true) +expect(typeof exampleWorkspaceRole.colorCode).toBe('string') Apply this suggestion Suggestion importance[1-10]: 7 Why: Asserting the types of properties provides stronger guarantees about the object's structure, improving test robustness, though it is a minor enhancement.	7

💡 Need additional feedback ? start a PR chat

[rajdip-b]

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀