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

feat: add ora filter for submission step rendering #2204

Merged
merged 4 commits into from
Apr 18, 2024

Conversation

BryanttV
Copy link
Contributor

@BryanttV BryanttV commented Apr 11, 2024

Description

This PR triggers the ORA submission view filter. This filter changes the default template by a custom template with a warning message notifying the student that the Turnitin plagiarism check is enabled.

Dependencies

This PR needs the new ORA submission view filter:

Supporting Information

These changes are based on those proposed in the following ADR

How to Test

Using Tutor:

  1. Install this xblock with changes in this branch in the LMS/CMS services.

  2. Install openedx-filters in the LMS/CMS services with these changes.

  3. Install platform-plugin-turnitin in the LMS/CMS services with the changes in the ora filter branch.

  4. Add the Open edX Filters configuration to your environment and restart the services. You can use this inline plugin:

    name: filters-settings
    version: 0.1.0
    patches:
      openedx-common-settings: |
        OPEN_EDX_FILTERS_CONFIG = {
          "org.openedx.learning.ora.submission_view.render.started.v1": {
            "fail_silently": False,
            "pipeline": [
              "platform_plugin_turnitin.extensions.filters.ORASubmissionViewTurnitinWarning",
            ]
          },
        }
  5. In a unit of the course create a new ora assessment.

  6. In the LMS, in the submission step (1. Your Response), you'll see:

    image

@BryanttV BryanttV requested a review from a team as a code owner April 11, 2024 02:53
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 11, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @BryanttV! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@BryanttV BryanttV force-pushed the bav/ora-submission-view-filter branch 5 times, most recently from 8a2b120 to f2fdee2 Compare April 11, 2024 20:56
@BryanttV BryanttV requested a review from mariajgrimaldi April 11, 2024 21:03
@itsjeyd itsjeyd removed the request for review from a team April 12, 2024 13:50
@BryanttV
Copy link
Contributor Author

Hi @pomegranited, this PR is part of the implementation of the ADR for lightweight extension points, could you take a look at it? Thanks!

Copy link
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

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

This looks good! Although we're missing some tests, could we add some? Thanks!

@BryanttV BryanttV force-pushed the bav/ora-submission-view-filter branch from 3f8408a to 6ba12da Compare April 15, 2024 15:27
@BryanttV
Copy link
Contributor Author

Hi @mariajgrimaldi, thanks for the review! I added some tests: f4156f2

Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍 Works great, thank you @BryanttV !

Could you merge latest master to get test passing again, and I'll merge :)

  • I tested this using the PR description, both with and without the added filters to ensure no errors.
  • I read through the code
  • I checked for accessibility issues by navigating with my keyboard.
  • Includes documentation
  • User-facing strings are extracted for translation N/A

@BryanttV BryanttV force-pushed the bav/ora-submission-view-filter branch 2 times, most recently from 5ca3093 to 345869a Compare April 17, 2024 15:01
Copy link

codecov bot commented Apr 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.05%. Comparing base (00934e2) to head (8ced069).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2204   +/-   ##
=======================================
  Coverage   95.04%   95.05%           
=======================================
  Files         191      191           
  Lines       21045    21083   +38     
  Branches     1902     1903    +1     
=======================================
+ Hits        20002    20040   +38     
  Misses        779      779           
  Partials      264      264           
Flag Coverage Δ
unittests 95.05% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@BryanttV BryanttV force-pushed the bav/ora-submission-view-filter branch from 345869a to 8ced069 Compare April 17, 2024 15:09
@pomegranited pomegranited merged commit d8eeddf into openedx:master Apr 18, 2024
11 checks passed
@openedx-webhooks
Copy link

@BryanttV 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants