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

Allow zeus to see activities in hidden courses even when not subscribed #5986

Merged
merged 1 commit into from
Dec 9, 2024

Conversation

jorg-vr
Copy link
Contributor

@jorg-vr jorg-vr commented Dec 9, 2024

  • Tests were added

@jorg-vr jorg-vr added the bug Something isn't working label Dec 9, 2024
@jorg-vr jorg-vr self-assigned this Dec 9, 2024
@jorg-vr jorg-vr requested a review from bmesuere as a code owner December 9, 2024 10:07
Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

Walkthrough

The changes in this pull request involve modifications to the visible_for_user? method in the Course class to allow users with a zeus? status to access courses, even if they are hidden. Additionally, a new test case has been added to the CoursesTest class to verify that users with the 'zeus' role can view activities in hidden courses. No other logic or control flow changes were made.

Changes

File Change Summary
app/models/course.rb Modified visible_for_user? method to include a condition for users with zeus? status.
test/system/courses_test.rb Added new test method test 'zeus should see activities in hidden courses' to verify access.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Course
    User->>Course: Request visibility
    Course-->>User: Check visibility conditions
    alt User is zeus?
        Course-->>User: Grant access to hidden course
    else Other conditions
        Course-->>User: Deny access
    end
Loading

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.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
test/system/courses_test.rb (1)

61-69: Test implementation looks good, but could be more comprehensive.

The test verifies the basic functionality, but consider enhancing it with additional assertions:

  1. Verify specific activity content is visible
  2. Test edge cases (e.g., multiple series/activities)
  3. Verify navigation through course structure

Consider expanding the test with additional scenarios:

 test 'zeus should see activities in hidden courses' do
   course = create :course, visibility: :hidden, series_count: 1, activities_per_series: 1
+  # Create multiple series to test comprehensive access
+  series = create :series, course: course
+  activity = create :exercise, series: series
 
   sign_in users(:zeus)
   visit(course_path(:en, course.id))
 
-  # assert activity table is visible
   assert_selector '.activity-table'
+  # Verify specific activity content
+  assert_selector '.activity-table', text: activity.name
+  # Verify series structure
+  assert_selector '.card.series', count: 2
+  # Verify navigation works
+  click_on activity.name
+  assert_current_path activity_path(:en, activity)
 end
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 77cce24 and 82afe03.

📒 Files selected for processing (2)
  • app/models/course.rb (1 hunks)
  • test/system/courses_test.rb (1 hunks)
🔇 Additional comments (1)
app/models/course.rb (1)

308-308: Implementation looks correct, verify broader system impact.

The change correctly implements the requirement by adding the zeus check while maintaining existing visibility rules.

Let's verify other parts of the system that might be affected:

✅ Verification successful

Implementation is correct and consistent with system-wide security model

The zeus check addition to the course visibility logic is consistent with the system-wide security model, as evidenced by:

  1. The change aligns with existing zeus-based access control patterns throughout the codebase:

    • Zeus users have system-wide access in various policies (e.g., JudgePolicy, UserPolicy, RepositoryPolicy)
    • Zeus check is consistently used as a top-level override for access control
  2. The implementation maintains the existing visibility rules while adding the zeus override:

    • Preserves all existing visibility checks (visible_for_all, visible_for_institution)
    • Zeus check is added as a final OR condition, consistent with other similar implementations
  3. The change is properly integrated with the course policy system:

    • CoursePolicy already handles zeus users appropriately in its scope resolution
    • Other course-related policies (SeriesPolicy, etc.) rely on this visibility check
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for other visibility-related code that might need adjustment
echo "Checking for related visibility checks..."
rg -A 3 "visible_for_user|visible_for_all|visible_for_institution" --type ruby

# Check for potential security implications in controllers
echo "Checking controller authorization..."
rg -A 3 "before_action.*:authorize" app/controllers/

Length of output: 12445


Script:

#!/bin/bash
# Let's check for any potential security-related code that might need the zeus check
echo "Checking for zeus-related security checks..."
rg -A 3 "zeus\?" --type ruby

# Let's also check for any course visibility related tests
echo "Checking course visibility tests..."
ast-grep --pattern 'test $_ do
  $$$
  visible_for_$$$
  $$$
end'

# Check for any other course access control methods
echo "Checking course access control methods..."
ast-grep --pattern 'def $_
  $$$
  visible_for_$$$
  $$$
end'

Length of output: 15491

@bmesuere bmesuere requested a review from Copilot December 9, 2024 10:21

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 2 out of 2 changed files in this pull request and generated no suggestions.

@jorg-vr jorg-vr merged commit 7909495 into main Dec 9, 2024
16 checks passed
@jorg-vr jorg-vr deleted the fix/zeus-access branch December 9, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants