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

MikeAlhayek · 2024-04-18T17:41:55Z

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

OrchardCore/src/OrchardCore/OrchardCore/Shell/Builders/ShellContainerFactory.cs

Lines 150 to 158 in dc6729b

    
               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.

OrchardCore/src/OrchardCore.Modules/OrchardCore.Roles/Services/RoleUpdater.cs

Line 57 in 9688beb

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

…ed with a feature in a module

github-actions · 2024-04-18T19:25:29Z

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

Piedone · 2024-04-18T22:05:02Z

Would you like to check this, @gvkries?

gvkries

LGTM 👍

gvkries · 2024-04-19T12:06:39Z

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

Piedone · 2024-04-19T14:00:17Z

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

MikeAlhayek · 2024-04-30T21:28:39Z

@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.

coderabbitai · 2024-04-30T21:29:52Z

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 · 2024-05-02T00:32:25Z

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

MikeAlhayek · 2024-05-23T19:03:03Z

#15793 is almost ready and should be merged soon. So I'll close this PR

MikeAlhayek added 3 commits April 18, 2024 10:38

Add [Feature] attribute to the permission providers that are associat…

6c297a6

…ed with a feature in a module

cleanup

e64d1aa

Merge branch 'main' into ma/permission-providers-w-feature

113b03b

github-actions bot added the merge conflict label Apr 18, 2024

Merge branch 'main' into ma/permission-providers-w-feature

4ae16cf

github-actions bot removed the merge conflict label Apr 18, 2024

Merge branch 'main' into ma/permission-providers-w-feature

eebf07c

gvkries approved these changes Apr 19, 2024

View reviewed changes

Piedone mentioned this pull request Apr 19, 2024

Corrects the mapping of types to features in ITypeFeatureProvider #15793

Merged

Piedone added the don't merge label Apr 19, 2024

Merge branch 'main' into ma/permission-providers-w-feature

ca97961

This was referenced May 1, 2024

Monthly community metrics report for 2024-04-01..2024-04-30 #15929

Closed

Monthly community metrics report for 2024-04-01..2024-04-30 Emmanjr/OrchardCore#2

Open

Merge branch 'main' into ma/permission-providers-w-feature

67f9c2c

MikeAlhayek closed this May 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

MikeAlhayek commented Apr 18, 2024 •

edited by coderabbitai bot

Loading

github-actions bot commented Apr 18, 2024

Piedone commented Apr 18, 2024

gvkries left a comment

gvkries commented Apr 19, 2024

Piedone commented Apr 19, 2024

MikeAlhayek commented Apr 30, 2024 •

edited

Loading

coderabbitai bot commented Apr 30, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Piedone commented May 2, 2024 •

edited

Loading

MikeAlhayek commented May 23, 2024

	var attribute = type.GetCustomAttributes<FeatureAttribute>(false).FirstOrDefault();

	if (attribute is not null)
	{
	feature = featureServiceCollection.Key.Extension.Features
	.FirstOrDefault(f => f.Id == attribute.FeatureName)
	?? feature;
	}
	}

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

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

Conversation

MikeAlhayek commented Apr 18, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

github-actions bot commented Apr 18, 2024

Piedone commented Apr 18, 2024

gvkries left a comment

Choose a reason for hiding this comment

gvkries commented Apr 19, 2024

Piedone commented Apr 19, 2024

MikeAlhayek commented Apr 30, 2024 • edited Loading

coderabbitai bot commented Apr 30, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Piedone commented May 2, 2024 • edited Loading

MikeAlhayek commented May 23, 2024

MikeAlhayek commented Apr 18, 2024 •

edited by coderabbitai bot

Loading

MikeAlhayek commented Apr 30, 2024 •

edited

Loading

coderabbitai bot commented Apr 30, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

Piedone commented May 2, 2024 •

edited

Loading