adding and using analytics group

Eldies commented 2 months ago

Motivation and context

We need to be able to give access to analytics without assigning people to "admin" group

How has this been tested?

Checklist

[ ] I submit my changes into the develop branch
[ ] I have created a changelog fragment
[ ] I have updated the documentation accordingly
[ ] I have added tests to cover my changes
[ ] I have linked related issues (see GitHub docs)
[ ] I have increased versions of npm packages if it is necessary (cvat-canvas, cvat-core, cvat-data and cvat-ui)

License

[ ] I submit my code changes under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

New Features
- Introduced a new user role, 'analytics', enhancing user categorization and permissions.
- Added an "Analytics" button for users in the 'analytics' group, improving access to analytics features.
- Implemented a new privilege level, ANALYTICS, for refined user access control.
- Automatically assign staff members to the 'IAM_ANALYTICS_ROLE' group for streamlined management.
Bug Fixes
- Expanded permission checks to allow users with the 'analytics' role access to resources.
Chores
- Updated role management to include the new 'analytics' role, improving overall role hierarchy.

coderabbitai[bot] commented 2 months ago

[!IMPORTANT]

Review skipped

Auto incremental reviews are disabled on this repository.

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

The changes introduce a new user role, analytics, to the CVAT system, affecting user permissions and access control. Modifications are made across several files to accommodate this role, including updates to user group definitions, access checks, and role management structures. The overall aim is to enhance the application's capability to manage user permissions more effectively and streamline group assignments for staff members.

Changes

File	Change Summary
`cvat-core/src/user.ts`	Expanded `groups` property in the `User` class to include the new `'analytics'` role.
`cvat-ui/src/components/header/header.tsx`	Updated conditional rendering logic in `HeaderComponent` to show the "Analytics" button for users in the 'analytics' group, in addition to superusers.
`cvat/apps/iam/rules/utils.rego`	Introduced `ANALYTICS` privilege level with a priority of 70 and added `is_analytics` function for checking user privileges.
`cvat/apps/iam/signals.py`	Added logic in `create_user` function to automatically assign staff members to the `IAM_ANALYTICS_ROLE` group.
`cvat/apps/log_viewer/rules/analytics.rego`	Enhanced permission logic in the `allow` rule to include users with analytics permissions.
`cvat/settings/base.py`	Introduced `IAM_ANALYTICS_ROLE` and updated `IAM_ROLES` list to include this new role, adjusting the hierarchy.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HeaderComponent
    participant IAM
    participant RoleManagement

    User->>HeaderComponent: Request to view header
    HeaderComponent->>IAM: Check user groups
    IAM-->>HeaderComponent: Return user groups (includes analytics)
    HeaderComponent->>User: Render header with "Analytics" button visible

🐰 Hopping through the code, what a delightful sight,
New roles and permissions, everything feels right!
From users to analytics, we spread our cheer,
With buttons and groups, the path is clear!
A world of access, so bright and anew,
Celebrating the changes, let's leap and pursue! 🌟

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@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. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov-commenter commented 2 months ago

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 83.57%. Comparing base (4aa2a4e) to head (9144012).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #8355 +/- ## =========================================== - Coverage 83.59% 83.57% -0.03% =========================================== Files 396 396 Lines 41830 41833 +3 Branches 3881 3881 =========================================== - Hits 34969 34960 -9 - Misses 6861 6873 +12 ``` | [Components](https://app.codecov.io/gh/cvat-ai/cvat/pull/8355/components?src=pr&el=components&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cvat-ai) | Coverage Δ | | |---|---|---| | [cvat-ui](https://app.codecov.io/gh/cvat-ai/cvat/pull/8355/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cvat-ai) | `79.56% <ø> (-0.06%)` | :arrow_down: | | [cvat-server](https://app.codecov.io/gh/cvat-ai/cvat/pull/8355/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cvat-ai) | `87.14% <33.33%> (-0.01%)` | :arrow_down: |

Eldies commented 2 months ago

@nmanovic I am not sure I correctly understood how it should work. In this PR, every new or updated user who is staff will be added to the "analytics" group. Already existing staff users will not be added to the group and will not get access to analytics, unless someone updates them. Please confirm - is this behaviour satisfactory?