Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-68049

Link-level LTI memberships service not working

    XMLWordPrintable

    Details

    • Testing Instructions:
      Hide

      Run your site with public access (use ngrok or similar). Better in a just created site than in a existing one that may have already other tools configured.

      To replicate the issue:

      1. Set up an LTI 2 connection to the saLTIre test tool:
        • As a system administrator, navigate to the Manage tools option for the External tool plugin (at /mod/lti/toolconfigure.php)
        • Enter https://lti.tools/saltire/tp in the Add tool box and click on the Add button
        • Click on the Tool Proxy button in the top navigation bar
        • Click on the Submit button
        • Click on the Yes button to activate the tool
      2. Add a link to the tool in a course:
        • Navigate to a course as a teacher
        • Turn editing on
        • Click on the Add an activity or resource link
        • Select External tool
        • Enter an activity name (e.g. Memberships test)
        • Select saLTIre tool provider from the list of preconfigured tools
        • Click on the Save and return to course
      3. Make a request to the link-level memberships service:
        • Click on the link added to the course
        • Select Membership v1 from the drop-down list of services on the top navigation bar
        • Click on the Read button
        • Verify that a message of "Sorry, an error occurred" is NOT displayed, but a dialog with the number of members retrieved is displayed.
        • Use the "Last service request" (Response tab) option on the View drop-down list to view the response received.
        • Verify the correct spelling of the "givenName" element and the inclusion of the "ext_user_username" element in the resulting json.
      Show
      Run your site with public access (use ngrok or similar). Better in a just created site than in a existing one that may have already other tools configured. To replicate the issue: Set up an LTI 2 connection to the saLTIre test tool: As a system administrator, navigate to the Manage tools option for the External tool plugin (at /mod/lti/toolconfigure.php) Enter https://lti.tools/saltire/tp in the Add tool box and click on the Add button Click on the Tool Proxy button in the top navigation bar Click on the Submit button Click on the Yes button to activate the tool Add a link to the tool in a course: Navigate to a course as a teacher Turn editing on Click on the Add an activity or resource link Select External tool Enter an activity name (e.g. Memberships test) Select saLTIre tool provider from the list of preconfigured tools Click on the Save and return to course Make a request to the link-level memberships service: Click on the link added to the course Select Membership v1 from the drop-down list of services on the top navigation bar Click on the Read button Verify that a message of "Sorry, an error occurred" is NOT displayed, but a dialog with the number of members retrieved is displayed. Use the "Last service request" (Response tab) option on the View drop-down list to view the response received. Verify the correct spelling of the "givenName" element and the inclusion of the "ext_user_username" element in the resulting json.
    • Workaround:
      Hide

      None.

      Show
      None.
    • Affected Branches:
      MOODLE_37_STABLE, MOODLE_38_STABLE, MOODLE_39_STABLE
    • Fixed Branches:
      MOODLE_37_STABLE, MOODLE_38_STABLE
    • Pull from Repository:
    • Pull 3.7 Branch:
    • Pull 3.8 Branch:
    • Pull Master Branch:

      Description

      The /mod/lti/services.php/links/{link_id}/memberships endpoint is returning a 404 error.

      The membership data has a misspelled element ("giveName") and omits the ext_user_username element when this is included in launch messages.

      Note that this only affects the old version of the Link-level Memberships service, not the new version which uses a query parameter to the Context-level Memberships service to request a link-level response.

        Attachments

          Activity

            People

            Assignee:
            svickers Stephen Vickers
            Reporter:
            svickers Stephen Vickers
            Peer reviewer:
            Peter Dias
            Integrator:
            Eloy Lafuente (stronk7)
            Tester:
            Janelle Barcega
            Participants:
            Component watchers:
            Adrian Greeve, Jake Dallimore, Mathew May, Mihail Geshoski, Peter Dias
            Votes:
            0 Vote for this issue
            Watchers:
            8 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Fix Release Date:
              11/May/20

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 3 hours, 30 minutes
                3h 30m