Roles with time constraints

[viktorcsimma]

Closes #392. Thanks to @kdmnk for the idea:)

Changes

• Adds the columns created_at and valid_until to the role_users table.
• Changes relationships so as to only include currently valid roles.
• Detaching a role now actually means setting the valid_until field to the current date. This might also close Log the end of collegist status #482.
• Replaces the tenant role and the "resident" and "extern" role objects with a simple resident role:
  • Permanent residents have both a collegist and an indefinite resident role.
  • "Resident-externs" have a collegist role as well as a resident role that has an expiry date.
    • But essentially, the same applies to externs living here as guests, just like in the old system. So we do not actually hard-wire the role into the system.
  • Externs simply have a collegist role with no resident role.
  • Tenants have a resident role with no collegist role.

[coderabbitai]

Walkthrough

Walkthrough

The changes revolve around enhancing role management within the User model by incorporating time constraints. Roles are now validated based on valid_from and valid_until timestamps, allowing for the retrieval of both current and expired roles. Several methods were consequently updated to reflect these changes, including those for role checks and user locale preferences. Additionally, references to roles were renamed for clarity, and new methods were added to facilitate the retrieval of expired roles.

Changes

Files	Change Summary
app/Models/User.php	Added everHadRoles method; modified roles method for time-based filtering; updated methods like preferredLocale, isTenant; renamed Role::TENANT to Role::RESIDENT; added collegistsIncludingExpired and updated studentCouncilSecretary.
resources/views/auth/register.blade.php	Updated references from \App\Models\Role::TENANT to \App\Http\Controllers\Auth\RegisterController::TENANT.

Sequence Diagram(s)

Role Retrieval and Validation

sequenceDiagram
    participant User
    participant Role
    participant Carbon

    User->>Role: Request current roles
    Role->>Carbon: Get current time
    Carbon-->>Role: Return current time
    Role-->>User: Return current roles (filtered by valid_from and valid_until)
    
    User->>Role: Request all roles
    Role-->>User: Return all roles (including expired)

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Restructure roles to be time constrained (### #392)	✅
Log the end of collegist status (### #482)	✅
Update role checks and methods to reflect new role names and logic (#392)	✅
Ensure expired roles can be retrieved (### #392)	✅

---

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
• Mastodon
• Reddit
• LinkedIn

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