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

Fix plagiarism detection from evaluation #5957

Merged
merged 1 commit into from
Nov 25, 2024
Merged

Conversation

jorg-vr
Copy link
Contributor

@jorg-vr jorg-vr commented Nov 25, 2024

This pull request fixes the detect plagiarism button on the evaluations page.

The url being html encoded caused some parameters to not be passed properly to the backend

@jorg-vr jorg-vr added the bug Something isn't working label Nov 25, 2024
@jorg-vr jorg-vr self-assigned this Nov 25, 2024
@jorg-vr jorg-vr requested a review from bmesuere as a code owner November 25, 2024 09:02
Copy link
Contributor

coderabbitai bot commented Nov 25, 2024

Walkthrough

The changes involve a modification to the JavaScript initialization of the Dolos button in the exercises progress table's HTML template. The dodona.initDolosBtn function now uses the raw method to ensure that the output from series_exports_path is treated as HTML-safe, altering how the URL is rendered in the JavaScript context. There are no other changes to the logic or structure of the code.

Changes

File Path Change Summary
app/views/evaluations/_exercises_progress_table.html.erb Modified the dodona.initDolosBtn function to use raw for the output of series_exports_path.

Suggested reviewers

  • bmesuere

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 67204f9 and b19656c.

📒 Files selected for processing (1)
  • app/views/evaluations/_exercises_progress_table.html.erb (1 hunks)

@@ -50,7 +50,7 @@
</a>
<script>
dodona.ready.then(() =>{
dodona.initDolosBtn('dolos-btn-<%= meta[:exercise].id %>', "<%= series_exports_path(@evaluation.series, token: (@evaluation.series.access_token if @evaluation.series.hidden?), selected_ids: [meta[:exercise].id], evaluation: true) %>", "<%= meta[:exercise].programming_language&.renderer_name %>");
dodona.initDolosBtn('dolos-btn-<%= meta[:exercise].id %>', "<%= raw series_exports_path(@evaluation.series, token: (@evaluation.series.access_token if @evaluation.series.hidden?), selected_ids: [meta[:exercise].id], evaluation: true) %>", "<%= meta[:exercise].programming_language&.renderer_name %>");
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Similar URL encoding patterns found - needs consistent fixes

The search results reveal that there are similar patterns of URL encoding in the codebase that should be handled consistently:

  1. In submissions/index.html.erb:
dodona.initDolosBtn("dolos-btn", "<%= series_exports_path(@series, token: (@series.access_token if @series.hidden?), selected_ids: [@activity.id]) %>", ...)
  1. In visualizations/_punchcard.html.erb and _heatmap.html.erb:
dodona.initPunchcard('<%= raw punchcard_path(...) %>');
dodona.initHeatmap('<%= raw heatmap_path(...) %>');

The raw helper is already being used correctly in the visualization templates, but missing in the submissions view's Dolos button initialization, which likely suffers from the same double-encoding issue.

  • submissions/index.html.erb: Add raw helper to prevent double encoding of the URL parameters
🔗 Analysis chain

LGTM! The fix appropriately prevents URL double encoding.

The use of raw here is safe as all parameters are from trusted sources and properly escaped by Rails path helpers. This resolves the issue of URL parameters not being transmitted correctly to the backend.

Let's verify if there are other similar patterns that might need the same fix:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find similar patterns of JavaScript initialization with path helpers
# that might need the same fix to prevent double encoding

# Look for similar JavaScript initializations with path helpers
rg -g '*.erb' "dodona\.init.*Path.*\""

# Look for other potential URL encoding issues in JavaScript
ast-grep --pattern 'dodona.init$_($_, $_)'

Length of output: 84


Script:

#!/bin/bash
# Let's try a broader search to find similar patterns

# Look for all dodona.init calls in erb files
rg -g '*.erb' 'dodona\.init' -B 1 -A 1

# Look for series_exports_path usage
rg -g '*.erb' 'series_exports_path'

# Look for other potential raw usage with paths
rg -g '*.erb' 'raw.*_path'

Length of output: 13966

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