chore: Use annotations to indicate required features in controllers
Depends on #3003
Walkthrough
This change introduces a declarative feature authorization mechanism using new annotations (@RequiresFeatures and @RequiresOneOfFeatures) and a FeatureAuthorizationInterceptor. Controllers now specify required features via annotations, and the interceptor enforces feature gating at the HTTP request level. Explicit, imperative feature checks are removed from controller methods.
Changes
| Files / Areas | Change Summary |
|---|---|
| backend/app/src/main/kotlin/io/tolgee/configuration/WebSecurityConfig.kt | Registers FeatureAuthorizationInterceptor in web security config. |
| backend/security/src/main/kotlin/io/tolgee/security/authorization/FeatureAuthorizationInterceptor.kt | Adds new interceptor to enforce feature-based authorization using annotations. |
| backend/security/src/main/kotlin/io/tolgee/security/authorization/RequiresFeatures.kt backend/security/src/main/kotlin/io/tolgee/security/authorization/RequiresOneOfFeatures.kt |
Introduces new method-level annotations for feature requirements. |
| backend/security/src/test/kotlin/io/tolgee/security/authorization/FeatureAuthorizationInterceptorTest.kt | Adds comprehensive tests for the new interceptor and annotations. |
| ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/controllers/* (AdvancedPermissionController, AiPromptCustomizationController, ContentStorageController, SsoProviderController, TaskController, WebhookConfigController) | Replaces imperative feature checks with declarative annotations; removes EnabledFeaturesProvider dependencies. |
| ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/controllers/glossary/* (GlossaryController, GlossaryLanguagesController, GlossaryTermController, GlossaryTermHighlightsController, GlossaryTermTranslationController) | Applies new annotations for glossary-related endpoints; removes manual feature checks and related dependencies. |
| ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/controllers/slack/OrganizationSlackController.kt | Annotates Slack integration endpoint with feature requirement; removes explicit feature check. |
Sequence Diagram(s)
sequenceDiagram
participant Client
participant WebSecurityConfig
participant FeatureAuthorizationInterceptor
participant Controller
Client->>WebSecurityConfig: HTTP Request
WebSecurityConfig->>FeatureAuthorizationInterceptor: Intercept request
FeatureAuthorizationInterceptor->>Controller: Check for @RequiresFeatures / @RequiresOneOfFeatures
alt No annotation
FeatureAuthorizationInterceptor->>Controller: Allow request
else @RequiresFeatures present
FeatureAuthorizationInterceptor->>Controller: Check all features enabled
alt All features enabled
FeatureAuthorizationInterceptor->>Controller: Allow request
else Any feature missing
FeatureAuthorizationInterceptor-->>Client: Reject with error
end
else @RequiresOneOfFeatures present
FeatureAuthorizationInterceptor->>Controller: Check any feature enabled
alt At least one enabled
FeatureAuthorizationInterceptor->>Controller: Allow request
else None enabled
FeatureAuthorizationInterceptor-->>Client: Reject with error
end
end
Controller-->>Client: Response
Possibly related PRs
- tolgee/tolgee-platform#3003: Implements glossary features, which are now enforced using the new feature authorization mechanism introduced in this PR.
Suggested labels
enhancement
Suggested reviewers
- JanCizmar
Poem
In the warren of code, a new path appears,
Features now checked without manual fears.
Annotations declare whatβs needed to play,
The interceptor guards, keeping trouble at bay.
Controllers are lighter, the logic more clearβ
A hop, a skip, and a featureful cheer!
πβ¨
π Recent review details
Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro
π₯ Commits
Reviewing files that changed from the base of the PR and between 9ca60f82feb1ffbedd579876bbce4de9eabb9fc4 and 6d30b32cf530c080cb888bb22c6e8d230ef9b9b9.
π Files selected for processing (1)
ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/controllers/glossary/GlossaryController.kt(8 hunks)
π§ Files skipped from review as they are similar to previous changes (1)
- ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/controllers/glossary/GlossaryController.kt
β° Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Build backend ποΈ
- GitHub Check: Build frontend ποΈ
- GitHub Check: Frontend static check πͺ²
β¨ Finishing Touches
- [ ] π Generate Docstrings
πͺ§ 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
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.