Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add [Feature] attribute to the permission providers that are associated with a feature in a module #15787

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

MikeAlhayek
Copy link
Member

@MikeAlhayek MikeAlhayek commented Apr 18, 2024

Based on the findings in #15782 the ShellContainerFactory associate types based on the Feature attribute.

var attribute = type.GetCustomAttributes<FeatureAttribute>(false).FirstOrDefault();
if (attribute is not null)
{
feature = featureServiceCollection.Key.Extension.Features
.FirstOrDefault(f => f.Id == attribute.FeatureName)
?? feature;
}
}

Applying [Feature] attribute to the permissions that are registered with a feature is important since RoleUpdater service used ITypeFeatureProvider to check if the permission provider is associated with a given feature ID.

.Where(provider => _typeFeatureProvider.GetFeatureForDependency(provider.GetType()).Id == feature.Id);

Summary by CodeRabbit

  • New Features
    • Added feature attributes to enhance module-specific permissions across various OrchardCore modules including Facebook Pixel, Google Analytics, Google Authentication, Google Tag Manager, Azure Media Storage, Media Cache, SQL Queries, and Shortcodes Templates.
  • Bug Fixes
    • Corrected a typo in a comment within the OrchardCore.Seo module.
  • Chores
    • Removed unnecessary empty lines in the OrchardCore.ArchiveLater and OrchardCore.PublishLater modules.
  • Revert
    • Removed the ReCaptcha feature attribute from the Startup and DeploymentStartup classes in the OrchardCore.ReCaptcha module.

Copy link

This pull request has merge conflicts. Please resolve those before requesting a review.

@Piedone
Copy link
Member

Piedone commented Apr 18, 2024

Would you like to check this, @gvkries?

Copy link
Contributor

@gvkries gvkries left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@gvkries
Copy link
Contributor

gvkries commented Apr 19, 2024

We may still have a problem with types that are used by more than one feature, e.g. OrchardCore.Microsoft.Authentication.Permissions.

@Piedone
Copy link
Member

Piedone commented Apr 19, 2024

Let's wait with #15793 for this, because if we have that then no attributes are necessary.

@MikeAlhayek
Copy link
Member Author

MikeAlhayek commented Apr 30, 2024

@Piedone this should be merged. I don't think #15793 will be ready anytime soon. When that PR is ready, we'll be able to remove the new [Feature()] attribute from all classes except from controller and startup. But this also mean existing attributes. So this is a good fix that we should take.

Copy link
Contributor

coderabbitai bot commented Apr 30, 2024

Walkthrough

The recent updates across various OrchardCore modules primarily involve the addition of feature attributes to specific classes, enhancing modularity and feature management. Minor adjustments include syntax changes in service registration and the removal of redundant lines. Notably, the ReCaptcha module saw the removal of feature attributes from two classes, signaling a change in how features are managed within that module.

Changes

File Path Change Summary
.../OrchardCore.ArchiveLater/Startup.cs Removed an empty line within the class.
.../OrchardCore.PublishLater/Startup.cs Removed an empty line within the class.
.../OrchardCore.Facebook/... Added [Feature(FacebookConstants.Features.Pixel)] to PixelPermissionProvider.
.../OrchardCore.Google/... Added feature attributes for Google Analytics, Google Authentication, and Google Tag Manager.
.../OrchardCore.Media.Azure/Permissions.cs Added [Feature("OrchardCore.Media.Azure.Storage")].
.../OrchardCore.Media/MediaCachePermissions.cs Added [Feature("OrchardCore.Media.Cache")].
.../OrchardCore.OpenId/Startup.cs Modified syntax for service registration using TryAddEnumerable.
.../OrchardCore.Queries/Sql/Permissions.cs Added [Feature("OrchardCore.Queries.Sql")].
.../OrchardCore.ReCaptcha/Startup.cs Removed [Feature("OrchardCore.ReCaptcha")] from Startup and DeploymentStartup classes.
.../OrchardCore.Seo/Startup.cs Corrected a typo in a comment.
.../OrchardCore.Shortcodes/Permissions.cs Added feature attribute OrchardCore.Shortcodes.Templates.
.../OrchardCore.Users/CustomUserSettingsPermissions.cs Added feature attribute for OrchardCore.Users.CustomUserSettings.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@Piedone
Copy link
Member

Piedone commented May 2, 2024

I'll try to wrap my head around #15793 and get back here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants