edx-ora2 icon indicating copy to clipboard operation
edx-ora2 copied to clipboard

feat: add ora filter for submission step rendering

Open BryanttV opened this issue 10 months ago • 2 comments

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:

  • https://github.com/openedx/openedx-filters/pull/158

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 avatar Apr 11 '24 02:04 BryanttV

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.

openedx-webhooks avatar Apr 11 '24 02:04 openedx-webhooks

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

BryanttV avatar Apr 12 '24 15:04 BryanttV

Hi @mariajgrimaldi, thanks for the review! I added some tests: https://github.com/openedx/edx-ora2/commit/f4156f2a26af1199406867223f00d86f6d331769

BryanttV avatar Apr 15 '24 18:04 BryanttV

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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%) :arrow_up:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Apr 17 '24 15:04 codecov[bot]

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

openedx-webhooks avatar Apr 18 '24 01:04 openedx-webhooks