feat: Translation labels - Settings

[dkrizan]

~Marked as draft while waiting for @ZuzanaOdstrcilova to provide the correct color values for the palette input.~

https://github.com/tolgee/tolgee-platform/issues/3075

Summary by CodeRabbit

• New Features

  • Introduced project label management, allowing users to create, edit, delete, and list labels within project settings.
  • Added a dedicated "Labels" tab in project settings for managing labels.
  • Provided a color palette selector for label colors, supporting both light and dark themes.
  • Labels can have custom names, colors, and optional descriptions.
  • Implemented pagination for label lists.

• Bug Fixes

  • None.

• Tests

  • Added comprehensive backend and end-to-end tests for label management features.

• Documentation

  • Updated API schema and documentation to include label management endpoints and validation rules.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This change introduces a comprehensive label management feature for projects, spanning backend, database, test, and frontend layers. It adds label entities, REST API endpoints, service logic, database schema, test data, and user interfaces for creating, editing, listing, and deleting labels, along with supporting validation, color palettes, and end-to-end tests.

Changes

Files / Groups	Change Summary
backend/api/src/main/kotlin/io/tolgee/api/v2/controllers/LabelsController.kt	New REST controller for CRUD operations on project labels.
backend/api/src/main/kotlin/io/tolgee/hateoas/label/LabelModel.kt, LabelModelAssembler.kt	New HATEOAS model and assembler for label API responses.
backend/app/src/test/kotlin/io/tolgee/api/v2/controllers/labels/LabelsControllerTest.kt	New test class for label API endpoints, covering CRUD and validation.
backend/data/src/main/kotlin/io/tolgee/constants/Message.kt	Added LABEL_NOT_FOUND enum for error handling.
backend/data/src/main/kotlin/io/tolgee/development/testDataBuilder/TestDataService.kt	Added label persistence in test data builder.
backend/data/src/main/kotlin/io/tolgee/development/testDataBuilder/builders/LabelBuilder.kt, ProjectBuilder.kt	New builder for labels and support in project builder for test data.
backend/data/src/main/kotlin/io/tolgee/development/testDataBuilder/data/LabelsTestData.kt	New test data class for labels with sample projects, translations, and labels.
backend/data/src/main/kotlin/io/tolgee/dtos/request/label/LabelRequest.kt	New DTO for label creation and update requests with validation.
backend/data/src/main/kotlin/io/tolgee/model/translation/Label.kt, Translation.kt	New Label entity and many-to-many relationship with Translation.
backend/data/src/main/kotlin/io/tolgee/repository/LabelRepository.kt	New repository for label entity with project-scoped queries.
backend/data/src/main/kotlin/io/tolgee/service/label/LabelService.kt	New service for label CRUD logic, enforcing project scope.
backend/data/src/main/resources/db/changelog/schema.xml	New tables: label, translation_label; constraints for label-project and label-translation relations.
backend/development/src/main/kotlin/io/tolgee/controllers/internal/e2eData/LabelE2eDataController.kt	New controller for generating label test data for E2E testing.
backend/testing/src/main/kotlin/io/tolgee/AbstractSpringTest.kt	Injected LabelService for use in tests.
e2e/cypress/common/apiCalls/testData/testData.ts	Added exported constant for label test data.
e2e/cypress/e2e/projects/labels.cy.ts	New Cypress E2E tests for label management UI.
e2e/cypress/support/dataCyType.d.ts	Extended data-cy type union with label and color palette selectors for E2E tests.
webapp/src/ThemeProvider.tsx, figmaTheme.ts, colors.tsx, custom.d.ts	Added label color palette definitions and typings for theme support.
webapp/src/component/common/form/fields/ColorPaletteField.tsx	New color palette form field component for selecting label colors.
webapp/src/constants/GlobalValidationSchema.tsx	Added validation schema for label forms.
webapp/src/constants/links.tsx	Added route constant for project label editing.
webapp/src/service/apiSchema.generated.ts	API schema updated: label endpoints, models, error codes, and operation references.
webapp/src/views/projects/project/ProjectSettingsLabels.tsx	New UI for managing project labels (list, create, update, delete, pagination).
webapp/src/views/projects/project/ProjectSettingsView.tsx	Added "Labels" tab to project settings and routing logic.
webapp/src/views/projects/project/components/Labels/LabelForm.tsx, LabelItem.tsx, LabelModal.tsx	New components for label form, item display, and modal dialog.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WebApp
    participant API
    participant LabelService
    participant DB

    User->>WebApp: Open Project Settings > Labels
    WebApp->>API: GET /v2/projects/{projectId}/labels
    API->>LabelService: getProjectLabels(projectId, pageable)
    LabelService->>DB: Query labels for project
    DB-->>LabelService: Label list
    LabelService-->>API: Paginated LabelModel list
    API-->>WebApp: Paginated LabelModel list
    WebApp-->>User: Display label list

    User->>WebApp: Add/Edit/Delete Label
    WebApp->>API: POST/PUT/DELETE /v2/projects/{projectId}/labels
    API->>LabelService: create/update/deleteLabel(...)
    LabelService->>DB: Persist changes
    DB-->>LabelService: Result
    LabelService-->>API: LabelModel/Status
    API-->>WebApp: Response
    WebApp-->>User: Update UI

Poem

In a warren where projects grow, Labels bloom in colors aglow. From backend roots to frontend flair, They’re sorted, paged, and everywhere! With tests and palettes, bright and neat, This rabbit hops to label each feat. 🐇✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[dkrizan]

@coderabbitai review

[coderabbitai[bot]]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.