SWAMPy

✎ CARVE FLESH

EDITING: canvas_outcomes_helper.rb

# frozen_string_literal: true

#
# Copyright (C) 2020 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

module CanvasOutcomesHelper
  MAX_RETRIES = 3
  THREAD_COUNT = 8
  class OSFetchError < StandardError; end

def get_outcome_alignments(context, outcome_ids, additional_params = nil)
    return if outcome_ids.blank? || context.blank? || !context.feature_enabled?(:outcome_service_results_to_canvas)

params = {
      context_uuid: context.uuid,
      external_outcome_id_list: outcome_ids
    }

domain, jwt = extract_domain_jwt(
      context.root_account,
      "lmgb_results.show",
      **params
    )
    return if domain.nil? || jwt.nil?

params = params.merge(additional_params) unless additional_params.nil?
    response = CanvasHttp.get(
      build_request_url(protocol, domain, "api/outcomes/list", params),
      {
        "Authorization" => jwt
      }
    )

if /^2/.match?(response.code.to_s)
      JSON.parse(response.body, symbolize_names: true)
    else
      raise "Error retrieving aligned assets from Outcomes Service: #{response.body}"
    end
  end

def get_lmgb_results(context, assignment_ids, assignment_type, outcome_ids, user_uuids = "")
    return if assignment_ids.blank? || assignment_type.blank? || outcome_ids.blank? || !context.feature_enabled?(:outcome_service_results_to_canvas)

params = {
      associated_asset_id_list: assignment_ids,
      associated_asset_type: assignment_type,
      external_outcome_id_list: outcome_ids,
    }
    params[:user_uuid_list] = user_uuids unless user_uuids.blank?

threaded_request(context, "lmgb_results.show", "api/authoritative_results", params)
  end

def threaded_request(context, scope, endpoint, params)
    responses = []
    mutex = Mutex.new
    batcher = OutcomesRequestBatcher.new(protocol, endpoint, context, scope, params)
    requests = batcher.requests

Array.new(THREAD_COUNT) do
      Thread.new(requests, responses) do |reqs, resp|
        while (r = mutex.synchronize { reqs.pop })
          response = get_request(context, r[:domain], r[:endpoint], r[:jwt], r[:params])
          mutex.synchronize { resp.concat(response) } unless response.nil?
        end
      end
    end.each(&:join)
    responses
  end

def get_request(context, domain, endpoint, jwt, params, per_page = 200)
    page_num = 1
    total_pages = 1
    all_results = []
    loop do
      results, total_pages = get_request_page(context, domain, endpoint, jwt, params, page_num, per_page).values_at(:results, :total_pages)
      all_results.concat(results)
      break if page_num >= total_pages

page_num += 1
    end
    all_results
  end

def get_request_page(context, domain, endpoint, jwt, params, page_num, per_page = 200)
    retry_count = 0
    pagination_params = {
      per_page:,
      page: page_num
    }
    params = params.merge(pagination_params)

begin
      response = CanvasHttp.get(
        build_request_url(protocol, domain, endpoint, params),
        {
          "Authorization" => jwt
        }
      )
    rescue
      retry_count += 1
      retry if retry_count < MAX_RETRIES
      raise OSFetchError, "Failed to fetch results for context #{context.id} #{params}"
    end

if /^2/.match?(response.code.to_s)
      per_page = response.header["Per-Page"].to_i
      total_pages = (response.header["Total"].to_f / per_page).ceil
      begin
        results = JSON.parse(response.body).deep_symbolize_keys[:results]
        results.each do |result|
          next if result[:attempts].nil?

result[:attempts].each do |attempt|
            # Initially metadata was a string, now it's a jsonb data type. When it was a string, canvas needed
            # to parse the result returned from outcome service
            next unless attempt[:metadata].is_a? String

attempt[:metadata] = JSON.parse(attempt[:metadata]) unless attempt[:metadata].nil?
            attempt[:metadata] = attempt[:metadata].deep_symbolize_keys unless attempt[:metadata].nil?
          end
        end
        { results:, total_pages: }
      rescue
        raise OSFetchError, "Error parsing JSON results from Outcomes Service: #{response.body}"
      end
    else
      raise OSFetchError, "Error retrieving results from Outcomes Service: #{response.body}"
    end
  end

def outcome_has_authoritative_results?(outcome, context)
    assignments = Assignment.active.where(context:).quiz_lti

return false if assignments.blank?

assignment_ids = assignments.pluck(:id).join(",")
    assignment_type = "canvas.assignment.quizzes"
    params = {
      associated_asset_id_list: assignment_ids,
      associated_asset_type: assignment_type,
      external_outcome_id_list: outcome.id,
    }
    domain, jwt = extract_domain_jwt(
      context.root_account,
      "lmgb_results.show",
      **params
    )

return true if get_request_page(context, domain, "api/authoritative_results", jwt, params, 1, 1)[:results].count > 0

false
  end

def set_outcomes_alignment_js_env(artifact, context, props)
    context =
      case context
      when Group then context.context
      else context
      end
    # don't show for contexts without alignmments
    return if context.learning_outcome_links.empty?

# don't show for accounts without provisioned outcomes service
    artifact_type = artifact_type_lookup(artifact)
    domain, jwt = extract_domain_jwt(context.root_account, "outcome_alignment_sets.create")
    return if domain.nil? || jwt.nil?

host_url = "#{protocol}://#{domain}" if domain.present?

js_env(
      canvas_outcomes: {
        artifact_type:,
        artifact_id: artifact.id,
        context_uuid: context.uuid,
        host: host_url,
        jwt:,
        **props
      }
    )
  end

def extract_domain_jwt(account, scope, **props)
    settings = account.settings.dig(:provision, "outcomes") || {}
    domain = nil
    jwt = nil
    if settings.key?(:consumer_key) && settings.key?(:jwt_secret) && settings.key?(domain_key)
      consumer_key = settings[:consumer_key]
      jwt_secret = settings[:jwt_secret]
      domain = settings[domain_key]
      payload = {
        host: domain,
        consumer_key:,
        scope:,
        exp: 1.day.from_now.to_i,
        **props
      }
      jwt = JWT.encode(payload, jwt_secret, "HS512")
    end

[domain, jwt]
  end

def protocol
    ENV.fetch("OUTCOMES_SERVICE_PROTOCOL", Rails.env.production? ? "https" : "http")
  end

def domain_key
    # test_cluster? and test_cluster_name are true and not nil for nonprod environments,
    # like beta or test
    if ApplicationController.test_cluster?
      "#{ApplicationController.test_cluster_name}_domain".to_sym
    else
      :domain
    end
  end

def build_request_url(protocol, domain, endpoint, params)
    url = "#{protocol}://#{domain}/#{endpoint}"
    if params.present?
      url += "?" + params.to_query
    end
    url
  end

private

def artifact_type_lookup(artifact)
    case artifact.class.to_s
    when "WikiPage"
      "canvas.page"
    else
      raise "Unsupported artifact type: #{artifact.class}"
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 login/	DIR	—	2023-09-24 03:36
📁 messages/	DIR	—	2023-09-24 03:36
📄 account_notification_helper.rb	RB	2.7 KB	2023-09-24 03:36	EDIT
📄 accounts_helper.rb	RB	2.1 KB	2023-09-24 03:36	EDIT
📄 alignments_helper.rb	RB	2.1 KB	2023-09-24 03:36	EDIT
📄 application_helper.rb	RB	47 KB	2023-09-24 03:39	EDIT
📄 assessment_request_helper.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 assignments_helper.rb	RB	4.4 KB	2023-09-24 03:36	EDIT
📄 attachment_helper.rb	RB	6.3 KB	2023-09-24 03:39	EDIT
📄 avatar_helper.rb	RB	4.6 KB	2023-09-24 03:36	EDIT
📄 broken_link_helper.rb	RB	2.5 KB	2023-09-24 03:36	EDIT
📄 calendar_conferences_helper.rb	RB	3.4 KB	2023-09-24 03:36	EDIT
📄 calendar_events_helper.rb	RB	1.6 KB	2023-09-24 03:36	EDIT
📄 calendars_helper.rb	RB	1.2 KB	2023-09-24 03:36	EDIT
📄 canvadocs_helper.rb	RB	1.7 KB	2023-09-24 03:36	EDIT
📄 canvas_outcomes_helper.rb	RB	7.6 KB	2023-09-24 03:39	EDIT
📄 collaborations_helper.rb	RB	2 KB	2023-09-24 03:36	EDIT
📄 communication_channels_helper.rb	RB	1.9 KB	2023-09-24 03:36	EDIT
📄 content_export_api_helper.rb	RB	3.1 KB	2023-09-24 03:36	EDIT
📄 content_imports_helper.rb	RB	1.2 KB	2023-09-24 03:36	EDIT
📄 context_external_tools_helper.rb	RB	2.3 KB	2023-09-24 03:36	EDIT
📄 context_modules_helper.rb	RB	6.5 KB	2023-09-24 03:36	EDIT
📄 conversations_helper.rb	RB	12.6 KB	2023-09-24 03:36	EDIT
📄 courses_helper.rb	RB	6.9 KB	2023-09-24 03:39	EDIT
📄 custom_color_helper.rb	RB	1.3 KB	2023-09-24 03:36	EDIT
📄 custom_sidebar_links_helper.rb	RB	2.2 KB	2023-09-24 03:36	EDIT
📄 cyoe_helper.rb	RB	3.7 KB	2023-09-24 03:36	EDIT
📄 dashboard_helper.rb	RB	6.2 KB	2023-09-24 03:36	EDIT
📄 datadog_rum_helper.rb	RB	2.8 KB	2023-09-24 03:36	EDIT
📄 default_due_time_helper.rb	RB	2.4 KB	2023-09-24 03:36	EDIT
📄 discussion_topics_helper.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 eportfolios_helper.rb	RB	1.5 KB	2023-09-24 03:36	EDIT
📄 files_helper.rb	RB	2.3 KB	2023-09-24 03:39	EDIT
📄 full_story_helper.rb	RB	1.5 KB	2023-09-24 03:36	EDIT
📄 global_navigation_helper.rb	RB	1.2 KB	2023-09-24 03:36	EDIT
📄 gradebooks_helper.rb	RB	6.2 KB	2023-09-24 03:36	EDIT
📄 grading_periods_helper.rb	RB	912 B	2023-09-24 03:36	EDIT
📄 groups_helper.rb	RB	925 B	2023-09-24 03:36	EDIT
📄 hmac_helper.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 kaltura_helper.rb	RB	1.2 KB	2023-09-24 03:36	EDIT
📄 legal_information_helper.rb	RB	1 KB	2023-09-24 03:36	EDIT
📄 new_quizzes_features_helper.rb	RB	2.4 KB	2023-09-24 03:39	EDIT
📄 observer_enrollments_helper.rb	RB	2.4 KB	2023-09-24 03:36	EDIT
📄 outcome_result_resolver_helper.rb	RB	1.5 KB	2023-09-24 03:36	EDIT
📄 outcomes_features_helper.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 outcomes_request_batcher.rb	RB	3.6 KB	2023-09-24 03:36	EDIT
📄 outcomes_service_alignments_helper.rb	RB	3.6 KB	2023-09-24 03:39	EDIT
📄 outcomes_service_authoritative_results_helper.rb	RB	9.2 KB	2023-09-24 03:36	EDIT
📄 quizzes_helper.rb	RB	21.1 KB	2023-09-24 03:36	EDIT
📄 rollup_score_aggregator_helper.rb	RB	3.8 KB	2023-09-24 03:39	EDIT
📄 rrule_helper.rb	RB	14 KB	2023-09-24 03:39	EDIT
📄 search_helper.rb	RB	15.5 KB	2023-09-24 03:36	EDIT
📄 section_tab_helper.rb	RB	6.7 KB	2023-09-24 03:36	EDIT
📄 self_enrollments_helper.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 sis_import_helper.rb	RB	955 B	2023-09-24 03:36	EDIT
📄 stream_items_helper.rb	RB	7.2 KB	2023-09-24 03:36	EDIT
📄 submission_comments_helper.rb	RB	918 B	2023-09-24 03:36	EDIT
📄 submittable_helper.rb	RB	2.8 KB	2023-09-24 03:39	EDIT
📄 syllabus_helper.rb	RB	966 B	2023-09-24 03:36	EDIT
📄 user_notes_helper.rb	RB	1.2 KB	2023-09-24 03:36	EDIT
📄 web_zip_export_helper.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 will_paginate_helper.rb	RB	1.7 KB	2023-09-24 03:36	EDIT