EotvosCollegium / mars

Unified IT System of the Eötvös József College for Advanced Studies.
https://uran.eotvos.elte.hu
MIT License
2 stars 15 forks source link

Letting tenants view rooms #608

Closed viktorcsimma closed 1 month ago

viktorcsimma commented 1 month ago

As in the title. Based on a user request.

coderabbitai[bot] commented 1 month ago
Walkthrough ## Walkthrough The recent changes to the `RoomPolicy` class enhance the access control logic by permitting users with the `TENANT` role to view any room. This modification broadens the authorisation scope, allowing additional users to engage with room-related functionalities, thus reflecting a more inclusive permission model. ## Changes | File | Change Summary | |----------------------------------|----------------------------------------------------------------------------------------------------| | `app/Policies/RoomPolicy.php` | Modified the `viewAny` method to include `Role::TENANT`, expanding access to users with the tenant role. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant RoomPolicy participant AuthorisationSystem User->>RoomPolicy: Request to view any room RoomPolicy->>AuthorisationSystem: Check user role alt User is Tenant AuthorisationSystem-->>RoomPolicy: Authorise access RoomPolicy-->>User: Access granted else User is not Tenant AuthorisationSystem-->>RoomPolicy: Deny access RoomPolicy-->>User: Access denied end ```

Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between e74a4306921e76d4f45e3f82fe4198e96c1ea743 and a8591440b9be1153f0fc59c75b2551ab2b3c0218.
Files selected for processing (1) * app/Policies/RoomPolicy.php (1 hunks)
Additional comments not posted (1)
app/Policies/RoomPolicy.php (1)
Line range hint `14-19`: **LGTM! But verify the definition and usage of the `TENANT` role.** The code changes to include the `TENANT` role in the `viewAny` method are approved. However, ensure that the `TENANT` role is correctly defined and used elsewhere in the codebase.
Verification successful --- **The `TENANT` role is correctly defined and extensively used throughout the codebase.** The code changes to include the `TENANT` role in the `viewAny` method are sound and consistent with the existing usage of the `TENANT` role. - `app/Models/Role.php`: Definition of the `TENANT` role. - `tests/Unit/RoleTest.php`: Usage in unit tests. - `resources/views/auth/register.blade.php`: Usage in views. - `database/seeders/UsersTableSeeder.php`: Usage in seeders. - `app/Policies/RoomPolicy.php`: Usage in policies. - `app/Providers/AuthServiceProvider.php`: Usage in providers. - `app/Models/User.php`: Usage in models. - `app/Http/Controllers/Auth/RegisterController.php`: Usage in controllers. - `app/Http/Middleware/EnsureVerified.php`: Usage in middleware.
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify the definition and usage of the `TENANT` role. # Test: Search for the definition of the `TENANT` role. Expect: Definition of the `TENANT` role. rg --type php 'const TENANT' -A 5 # Test: Search for the usage of the `TENANT` role. Expect: Usage of the `TENANT` role. rg --type php 'Role::TENANT' -A 5 ``` Length of output: 15625
--- 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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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.
kdmnk commented 1 month ago

I don't know if the collegists can see tenants now, but I'm not sure if the people want that anyone in the building can see where do they live. Thoughts?

viktorcsimma commented 1 month ago

As far as I can see, neither collegists see tenants nor vice versa.

Actually, it's a wish of some former collegists who want to interact with people inside. Maybe we could tie this to the alumni role. WDYT?

kdmnk commented 1 month ago

As far as I can see, neither collegists see tenants nor vice versa.

Then what's the point of this issue? btw, I just wanted to raise my concerns, I don't really care or want to make a statement. Ask the student council what makes sense.

The code itself is fine, I'll approve it

viktorcsimma commented 1 month ago

It's been voted down; I close this. Probably we should solve these user requests individually.