feat(API): Added icon and removed description field from workspace

[unamdev0]

User description

Description

Added icon and removed description field from workspace

Fixes #229

Screenshots of relevant screens

Additional changes Required

• [] Postman updation

Sample response for fetching all workspace of a user

            "id": "006bd5bf-43ac-41ad-b7a9-b1317d08f8ee",
            "name": "My first workspace 2",
            "slug": "my-first-workspace-2-0",
            "isFreeTier": true,
            "createdAt": "2024-09-15T13:32:58.131Z",
            "updatedAt": "2024-09-15T13:32:58.131Z",
            "ownerId": "cm0v65bm00000130sigtvry7y",
            "isDefault": false,
            "icon": "🤓",
            "lastUpdatedById": null
        },

Request Body for creating a new Workspace

   "name": "My first workspace 2",
   "icon":"🤓"
}

---

PR Type

enhancement, tests

---

Description

• Replaced the description field with an icon field in the workspace model, affecting creation and update operations.
• Updated database schema and migration scripts to reflect the removal of description and addition of icon.
• Modified all relevant tests to accommodate the change from description to icon.
• Adjusted DTOs and service logic to handle the new icon field.

---

Changes walkthrough 📝

	Relevant files
Enhancement	workspace.ts Replace description with icon in workspace creation            apps/api/src/common/workspace.ts Replaced description field with icon in workspace creation. +1/-1      create.workspace.ts Update DTO to include icon instead of description                apps/api/src/workspace/dto/create.workspace/create.workspace.ts Changed optional field from description to icon in DTO. +1/-1      workspace.service.ts Update workspace service to use icon instead of description apps/api/src/workspace/service/workspace.service.ts Replaced description with icon in workspace service logic. Removed search functionality for description. +8/-23    migration.sql Database migration to replace description with icon            apps/api/src/prisma/migrations/20240915122629_add_icon_remove_description_from_workspace/migration.sql Dropped description column and added icon column in Workspace table. +9/-0      schema.prisma Update Prisma schema for workspace icon                                    apps/api/src/prisma/schema.prisma Removed description field and added icon field in Workspace model. +1/-1
Tests	event.e2e.spec.ts Update tests to reflect workspace icon change                        apps/api/src/event/event.e2e.spec.ts Updated tests to use icon instead of description for workspace. +12/-12  workspace-membership.e2e.spec.ts Modify tests for workspace icon update                                      apps/api/src/workspace-membership/workspace-membership.e2e.spec.ts Modified tests to use icon instead of description for workspace. +4/-4      workspace.e2e.spec.ts Update workspace tests for icon field                                        apps/api/src/workspace/workspace.e2e.spec.ts Updated workspace tests to use icon instead of description. +12/-12

---

💡 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: 3 🔵🔵🔵⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Key issues to review Search Functionality The search functionality has been modified to only search in the 'name' field, removing the ability to search in the 'description' field. This might impact existing search behavior. Data Validation The icon field is added as an optional string without any specific validation. Consider adding validation for allowed icon formats or characters.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	Add a maximum length constraint to the icon field in the database schema Consider adding a maximum length constraint to the icon field to prevent excessively long icon strings and ensure consistent data storage. apps/api/src/prisma/schema.prisma [457] -icon String? +icon String? @db.VarChar(255) Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding a length constraint ensures data consistency and prevents potential issues with excessively long strings, which is a good practice for database schema design.	8
	Use a more descriptive icon in workspace creation tests Consider using a more descriptive icon in the test case to better represent a real-world scenario and improve test readability. apps/api/src/workspace/workspace.e2e.spec.ts [195] -icon: "🤓" +icon: "🏢" // Office building icon to represent a workspace Apply this suggestion Suggestion importance[1-10]: 5 Why: While using a more descriptive icon can improve test readability, it is a minor improvement and does not significantly impact the functionality or correctness of the tests.	5
Maintainability	Use a constant for repeated icon values in tests Consider using a constant for the repeated icon value "🤓" to improve maintainability and consistency across tests. apps/api/src/event/event.e2e.spec.ts [102] +const WORKSPACE_ICON = "🤓"; const workspace = await workspaceService.createWorkspace(user, { name: 'My workspace', - icon: "🤓" + icon: WORKSPACE_ICON }) Apply this suggestion Suggestion importance[1-10]: 7 Why: Using a constant for repeated values improves maintainability and consistency, making it easier to update the icon value across multiple tests if needed.	7
Performance	Use a more specific search condition for workspace names Consider using a more specific search condition for the workspace name, such as 'startsWith' instead of 'contains', to potentially improve search performance and accuracy. apps/api/src/workspace/service/workspace.service.ts [214-216] name: { - contains: search + startsWith: search } Apply this suggestion Suggestion importance[1-10]: 6 Why: Using 'startsWith' instead of 'contains' can improve search performance and accuracy, but it may limit the flexibility of search functionality.	6

[rajdip-b]

Hey bro, I think you misunderstood the issue. We didn't want to remove the description field. We just wanted to have an additional icon field.

[unamdev0]

oh, it was mentioned by @kriptonian1 in issue's description, @kriptonian1 can you confirm if you meant to remove it from the frontend

[rajdip-b]

Oh right, yes, my bad.

[rajdip-b]

You would need to update the types and tests in the api-client package. You would need to update these files:

• workspace.types.ts
• workspace.spec.ts

Do let me know if you run into some issue.

[rajdip-b]

LGTM

[rajdip-b]

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀