fix(api): Only user's default workspace returns isDefault: true

[csehatt741]

User description

Description

workspace.isDefault property mapping takes into account the owner in order to avoid returning multiple defaults.

Fixes #587

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

---

Description

• Fixes the issue of multiple workspaces being marked as isDefault.

• Ensures only the user's default workspace has isDefault: true.

• Updates logic in getWorkspaceBySlug to validate ownership for isDefault.

• Adjusts getAllWorkspaces to correctly map isDefault based on ownership.

---

Changes walkthrough 📝

	Relevant files
Bug fix	workspace.service.ts Fix `isDefault` property logic in workspace service            apps/api/src/workspace/service/workspace.service.ts Updated getWorkspaceBySlug to ensure isDefault is true only for the owner's default workspace. Modified getAllWorkspaces to map isDefault based on ownership. Added logic to validate isDefault against ownerId for both methods. +19/-7

---

Need help?

Type /help how to ... in the comments thread for any question about Qodo Merge usage.

Check out the documentation for more information.

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 587 - PR Code Verified Compliant requirements: Fix bug where all workspaces are returned with isDefault:true Only one workspace (user's default workspace) should have isDefault:true Fix affected endpoints: /workspace and /workspace/:workspaceSlug Requires further human verification: Verify that the fix works when a user is invited to multiple workspaces Test the API responses in real scenarios to confirm only one default workspace

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Logic Validation Verify that comparing ownerId with user.id is the correct approach for determining default workspace status. Consider if there are edge cases where this logic might not work as expected. isDefault: workspace.isDefault && workspace.ownerId == user.id

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
General	✅ Use strict equality comparison ✅ Suggestion Impact: Changed the equality operator from == to === in the workspace comparison logic code diff: + isDefault: workspace.isDefault && workspace.ownerId === user.id Use strict equality operator (===) instead of loose equality (==) when comparing IDs to ensure type safety and prevent potential type coercion issues. apps/api/src/workspace/service/workspace.service.ts [184] -isDefault: workspace.isDefault && workspace.ownerId == user.id +isDefault: workspace.isDefault && workspace.ownerId === user.id [Suggestion has been applied] Suggestion importance[1-10]: 5 Why: Using strict equality (===) instead of loose equality (==) is a TypeScript best practice that prevents potential type coercion issues, though in this context with ID comparison, the practical impact is minimal since IDs are likely of the same type.	5

[codiumai-pr-agent-free]

Suggestion: ✅ Use strict equality comparison [General, importance: 5]

Suggested change

	isDefault: workspace.isDefault && workspace.ownerId === user.id
	isDefault: workspace.isDefault && workspace.ownerId === user.id

[rajdip-b]

The entire file shows changes. Can you once revert everything and do it again?

[csehatt741]

Changes updated

[rajdip-b]

I feel the best thing todo here would be to move this default checking to authorityService.checkAuthorityOverWorkspace. That way, we will ensure that these changes are propagated to any endpoint that fetches single workspaces aswell.

The change in the next section of this file stays as is ofcourse

[csehatt741]

WorkspaceService.getWorkspacesOfUser does not invoke AuthorityCheckerService.checkAuthorityOverWorkspace, as the user is authorized to access all of their workspaces. Moving mapping logic into AuthorityCheckerService does not help where authorization is unnecessary.

[csehatt741]

To my mind, isolating the internal model from the model returned via the controller (DTO) by introducing the Workspace DTO and extracting mapping logic from the service would solve the issue. At least, mapping logic should be extracted from the service.

[rajdip-b]

I agree with you. The thing is, we don't have mapping dtos at all. Introducting one might make us introduce others aswell. So i guess, for now we can let this be.

[rajdip-b]

🎉 This PR is included in version 2.10.0-stage.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.79%. Comparing base (ce50743) to head (eb9ad02).
Report is 382 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #647      +/-   ##
===========================================
- Coverage    91.71%   86.79%   -4.92%     
===========================================
  Files          111      113       +2     
  Lines         2510     2969     +459     
  Branches       469      447      -22     
===========================================
+ Hits          2302     2577     +275     
- Misses         208      392     +184     

Flag	Coverage Δ
api-e2e-tests	86.79% <100.00%> (-4.92%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rajdip-b]

🎉 This PR is included in version 2.10.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀