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

RoleSet + Role: shareable role management #4544

Merged
merged 54 commits into from
Oct 1, 2024
Merged

RoleSet + Role: shareable role management #4544

merged 54 commits into from
Oct 1, 2024

Conversation

techsmyth
Copy link
Member

@techsmyth techsmyth commented Sep 16, 2024

The key goal of this PR is to
a) make the management of a set of roles re-usable
b) have the set of roles to be data driven, not hard coded

For the former there will need to be later work to make the events based on role changes to be done actually via events, so that different listeners can hook onto them.

For the latter we do still have with this PR the same set of roles (member, lead, admin) but they are now entries in the RoleSet so we can relatively easily from here expand the set (e.g. communityManager, processGuide etc).

This PR should be seen as setting the base for having a single way of managing Roles across multiple contexts (Platform, Org, Community), as well as allowing for much more flexibility in the set of roles that are used (data driven, not hard coded). On the client this will also allow for one set of controls for working with roles.

RoleSet entity:

  • has 'entryRoleType' to specify what is the required role if that flag is set (e.g. Member is required to be Lead)
  • Fields have been cleaned up to be consistent, including names used in DTOs

Client is updated in that codegen is running and there are no compilation errors.

Community no longer has a pointer to its parent Community.

Todo:

  • test migration with more full data set
  • update logic to use the new flags that were added
  • test suites: codegen is running, compilation still to be updated
  • domain model updated to show these entities + explain them

After all is running check if community still needs to know its parent, either via ORM relation or via ID

Out of scope for this PR:

  • changing the set of roles on a Community
  • splitting the event handling around communities to be properly event driven
  • using RoleSet in Organizations / Platform level
  • extending Role definitions to e.g. include authorization related flags

Removed

  • Community Policy module
  • Community Role module

For reference, the old community policy JSON:
image

which now looks like:
image

So the data is now much more structured in the db.

Copy link
Contributor

coderabbitai bot commented Sep 16, 2024

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

63 files out of 157 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits.

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


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>, please review it.
    • 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 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 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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

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.

@techsmyth techsmyth changed the base branch from develop to templates September 16, 2024 08:37
Base automatically changed from templates to develop September 17, 2024 08:21
@techsmyth techsmyth requested a review from ccanos September 23, 2024 07:27
@ccanos ccanos marked this pull request as ready for review October 1, 2024 06:28
ccanos
ccanos previously approved these changes Oct 1, 2024
@ccanos ccanos merged commit e105203 into develop Oct 1, 2024
3 checks passed
@ccanos ccanos deleted the roles branch October 1, 2024 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants