27791313772

Committed 18 Jun 2026 09:46PM UTC coverage: 90.24% (+0.02%) from 90.221%

Build # 27791313772

Build Type

Pull #8007

github

Committed by

web-flow

Commit Message

Merge b8d4b3317 into f55405f2c

Pull Request Pull Request #8007: Support all annotation types in add_annotations API (#7999)

Coverage Stats

1071 of 2284 branches covered (46.89%)

Branch coverage included in aggregate %.

150 of 155 new or added lines in 9 files covered. (96.77%)

13 existing lines in 1 file now uncovered.

46498 of 50430 relevant lines covered (92.2%)

126.18 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.55

/app/controllers/api/groups_controller.rb

module Api
  # Allows for listing Markus groups for a particular assignment.
  # Uses Rails' RESTful routes (check 'rake routes' for the configured routes)
  class GroupsController < MainApiController
    # Define default fields to display for index and show methods
    DEFAULT_FIELDS = [:id, :group_name].freeze

    # The annotation types accepted by add_annotations (single-table-inheritance class names,
    # matching the values reported by the annotations endpoint), mapped to the fields that must
    # be present for each. Mirrors each subclass's model validations, enforced in add_annotations
    # because insert_all bypasses them.
    REQUIRED_ANNOTATION_FIELDS = {
      'TextAnnotation' => %i[line_start line_end column_start column_end],
      'ImageAnnotation' => %i[x1 y1 x2 y2],
      'PdfAnnotation' => %i[x1 y1 x2 y2 page],
      'HtmlAnnotation' => %i[start_node start_offset end_node end_offset]
    }.freeze

    # Create an assignment's group
    # Requires: assignment_id
    # Optional: filter, fields
    def create
      assignment = Assignment.find(params[:assignment_id])
      begin
        group = assignment.add_group_api(params[:new_group_name], params[:members])
        respond_to do |format|
          format.xml do
            render xml: group.to_xml(root: 'group', skip_types: 'true')
          end
          format.json { render json: group.to_json }
        end
      rescue StandardError => e
        render 'shared/http_status', locals: { code: '422', message:
          e.message }, status: :unprocessable_content
      end
    end

    # Returns an assignment's groups along with their attributes
    # Requires: assignment_id
    # Optional: filter, fields
    def index
      groups = get_collection(assignment.groups) || return

      group_data = include_memberships(groups)

      respond_to do |format|
        format.xml do
          render xml: group_data.to_xml(root: 'groups', skip_types: 'true')
        end
        format.json { render json: group_data }
      end
    end

    # Returns a single group along with its attributes
    # Requires: id
    # Optional: fields
    def show
      group_data = include_memberships(Group.where(id: record.id))

      # We found a grouping for that assignment
      respond_to do |format|
        format.xml do
          render xml: group_data.to_xml(root: 'groups', skip_types: 'true')
        end
        format.json { render json: group_data }
      end
    end

    # Include student_memberships and user info
    def include_memberships(groups)
      groups.joins(groupings: [:assignment, { student_memberships: [:role] }])
            .where('assessments.id': params[:assignment_id])
            .pluck_to_hash(*DEFAULT_FIELDS, :membership_status, :role_id)
            .group_by { |h| h.slice(*DEFAULT_FIELDS) }
            .map { |k, v| k.merge(members: v.map { |h| h.except(*DEFAULT_FIELDS) }) }
    end

    def add_members
      if self.grouping.nil?
        # The group doesn't have a grouping associated with that assignment
        render 'shared/http_status', locals: { code: '422', message:
          'The group is not involved with that assignment' }, status: :unprocessable_content
        return
      end

      students = current_course.students.joins(:user).where('users.user_name': params[:members])
      students.each do |student|
        set_membership_status = if grouping.student_memberships.empty?
                                  StudentMembership::STATUSES[:inviter]
                                else
                                  StudentMembership::STATUSES[:accepted]
                                end
        grouping.invite(student.user_name, set_membership_status, invoked_by_instructor: true)
        grouping.reload
      end

      render 'shared/http_status', locals: { code: '200', message:
        HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
    end

    # Update the group's marks for the given assignment.
    def update_marks
      result = self.grouping&.current_submission_used&.get_latest_result
      return page_not_found('No submission exists for that group') if result.nil?

      # We shouldn't be able to update marks if marking is already complete.
      if result.marking_state == Result::MARKING_STATES[:complete]
        render 'shared/http_status', locals: { code: '404', message:
          'Marking for that submission is already completed' }, status: :not_found
        return
      end
      matched_criteria = assignment.criteria.where(name: params.keys)
      if matched_criteria.empty?
        render 'shared/http_status', locals: { code: '404', message:
          'No criteria were found that match that request.' }, status: :not_found
        return
      end

      matched_criteria.each do |crit|
        mark_to_change = result.marks.find_or_initialize_by(criterion_id: crit.id)
        mark_to_change.mark = params[crit.name] == 'nil' ? nil : params[crit.name].to_f
        unless mark_to_change.save
          # Some error occurred (including invalid mark)
          render 'shared/http_status', locals: { code: '500', message:
            mark_to_change.errors.full_messages.first }, status: :internal_server_error
          return
        end
      end
      result.save
      render 'shared/http_status', locals: { code: '200', message:
        HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
    end

    def create_extra_marks
      result = self.grouping&.current_submission_used&.get_latest_result
      return page_not_found('No submission exists for that group') if result.nil?

      begin
        ExtraMark.create!(result_id: result.id, extra_mark: params[:extra_marks],
                          description: params[:description], unit: ExtraMark::POINTS)
      rescue ActiveRecord::RecordInvalid => e
        # Some error occurred
        render 'shared/http_status', locals: { code: '500', message:
            e.message }, status: :internal_server_error
        return
      end
      render 'shared/http_status', locals: { code: '200', message:
          'Extra mark created successfully' }, status: :ok
    end

    def remove_extra_marks
      result = self.grouping&.current_submission_used&.get_latest_result
      return page_not_found('No submission exists for that group') if result.nil?
      extra_mark = ExtraMark.find_by(result_id: result.id,
                                     description: params[:description],
                                     extra_mark: params[:extra_marks])
      if extra_mark.nil?
        render 'shared/http_status', locals: { code: '404', message:
            'No such Extra Mark exist for that result' }, status: :not_found
        return
      end
      begin
        extra_mark.destroy
      rescue ActiveRecord::RecordNotDestroyed => e
        # Some other error occurred
        render 'shared/http_status', locals: { code: '500', message:
            e.message }, status: :internal_server_error
        return
      end
      # Successfully deleted the Extra Mark; render success
      render 'shared/http_status', locals: { code: '200', message:
          'Extra mark removed successfully' }, status: :ok
    end

    def annotations
      if record # this is a member route
        grouping_relation = assignment.groupings.where(group_id: record.id)
      else # this is a collection route
        grouping_relation = assignment.groupings
      end

      pluck_keys = ['annotations.type as type',
                    'annotation_texts.content as content',
                    'submission_files.filename as filename',
                    'submission_files.path as path',
                    'annotations.page as page',
                    'group_id',
                    'annotation_categories.annotation_category_name as category',
                    'annotations.creator_id as creator_id',
                    'annotation_texts.creator_id as content_creator_id',
                    'annotations.line_end as line_end',
                    'annotations.line_start as line_start',
                    'annotations.column_start as column_start',
                    'annotations.column_end as column_end',
                    'annotations.x1 as x1',
                    'annotations.y1 as y1',
                    'annotations.x2 as x2',
                    'annotations.y2 as y2']

      annotations = grouping_relation.left_joins(current_submission_used:
                                              [{ submission_files:
                                                 [{ annotations:
                                                    [{ annotation_text: :annotation_category }] }] }])
                                     .where(assessment_id: params[:assignment_id])
                                     .where.not('annotations.id': nil)
                                     .pluck_to_hash(*pluck_keys)
      respond_to do |format|
        format.xml do
          render xml: annotations.to_xml(root: 'annotations', skip_types: 'true')
        end
        format.json do
          render json: annotations.to_json
        end
      end
    end

    def test_results
      return render_no_grouping_error unless grouping

      # Use the existing Assignment#summary_test_results method filtered for this specific group
      # This ensures format consistency with the UI download (summary_test_result_json)
      group_name = grouping.group.group_name
      results = assignment.summary_test_results([group_name])

      return render_no_grouping_error if results.blank?

      # Group by test_group name to match the summary_test_result_json format
      results_by_test_group = results.group_by(&:name)

      respond_to do |format|
        format.xml { render xml: results_by_test_group.to_xml(root: 'test_results', skip_types: 'true') }
        format.json { render json: results_by_test_group }
      end
    end

    def render_no_grouping_error
      render 'shared/http_status',
             locals: { code: '404', message: 'No test results found for this group' },
             status: :not_found
    end

    def add_annotations
      result = self.grouping&.current_result
      return page_not_found('No submission exists for that group') if result.nil?

      force_complete = params.fetch(:force_complete, false)
      # We shouldn't be able to update annotations if marking is already complete, unless forced.
      if result.marking_state == Result::MARKING_STATES[:complete] && !force_complete
        return page_not_found('Marking for that submission is already completed')
      end

      annots = annotations_params
      submission_files = result.submission.submission_files.index_by(&:filename)

      # Validation pass: insert_all bypasses model validations, so guard the input here
      # before writing anything to the database. The annotation type is derived from the
      # file; a caller-supplied type is optional but must agree with it.
      annots.each do |annot_params|
        submission_file = submission_files[annot_params[:filename]]
        if submission_file.nil?
          return add_annotations_error("Submission file not found: #{annot_params[:filename]}")
        end

        expected_type = submission_file.annotation_type

        requested = annot_params[:type].presence
        if requested
          unless REQUIRED_ANNOTATION_FIELDS.key?(requested)
            return add_annotations_error("Invalid annotation type: #{requested}")
          end
          if requested != expected_type
            return add_annotations_error(
              "Annotation type '#{requested}' does not match the type of file '#{annot_params[:filename]}'"
            )
          end
        end

        missing = REQUIRED_ANNOTATION_FIELDS[expected_type].select { |field| annot_params[field].blank? }
        next if missing.empty?

        return add_annotations_error(
          "Missing required fields for #{expected_type}: #{missing.join(', ')}"
        )
      end

      annotation_texts = []
      annotations = []
      count = result.submission.annotations.count + 1
      annotation_category = nil
      annots.each_with_index do |annot_params, i|
        if annot_params[:annotation_category_name].nil?
          annotation_category_id = nil
        else
          name = annot_params[:annotation_category_name]
          if annotation_category.nil? || annotation_category.annotation_category_name != name
            annotation_category = assignment.annotation_categories.find_or_create_by(
              annotation_category_name: name
            )
          end
          annotation_category_id = annotation_category.id
        end

        submission_file = submission_files[annot_params[:filename]]
        annotation_texts << {
          content: annot_params[:content],
          annotation_category_id: annotation_category_id,
          creator_id: current_role.id,
          last_editor_id: current_role.id
        }
        annotations << {
          type: submission_file.annotation_type,
          line_start: annot_params[:line_start],
          line_end: annot_params[:line_end],
          column_start: annot_params[:column_start],
          column_end: annot_params[:column_end],
          x1: annot_params[:x1],
          y1: annot_params[:y1],
          x2: annot_params[:x2],
          y2: annot_params[:y2],
          page: annot_params[:page],
          start_node: annot_params[:start_node],
          start_offset: annot_params[:start_offset],
          end_node: annot_params[:end_node],
          end_offset: annot_params[:end_offset],
          annotation_text_id: nil,
          submission_file_id: submission_file.id,
          creator_id: current_role.id,
          creator_type: current_role.type,
          is_remark: !result.remark_request_submitted_at.nil?,
          annotation_number: count + i,
          result_id: result.id
        }
      end
      imported = AnnotationText.insert_all! annotation_texts
      imported.rows.zip(annotations) do |t, a|
        a[:annotation_text_id] = t[0]
      end
      Annotation.insert_all! annotations
      render 'shared/http_status', locals: { code: '200', message:
        HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
    end

    # Return key:value pairs of group_name:group_id
    def group_ids_by_name
      reversed = assignment.groups.pluck(:group_name, :id).to_h
      respond_to do |format|
        format.xml do
          render xml: reversed.to_xml(root: 'groups', skip_types: 'true')
        end
        format.json do
          render json: reversed.to_json
        end
      end
    end

    # Allow user to set marking state to complete
    def update_marking_state
      if has_missing_params?([:marking_state])
        # incomplete/invalid HTTP params
        render 'shared/http_status', locals: { code: '422', message:
            HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
        return
      end
      result = self.grouping&.current_submission_used&.get_latest_result
      return page_not_found('No submission exists for that group') if result.nil?
      result.marking_state = params[:marking_state]
      if result.save
        render 'shared/http_status', locals: { code: '200', message:
            HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
      else
        render 'shared/http_status', locals: { code: '500', message:
            result.errors.full_messages.first }, status: :internal_server_error
      end
    end

    def add_tag
      grouping = self.grouping
      tag = self.assignment.tags.find_by(id: params[:tag_id])
      if tag.nil? || grouping.nil?
        raise 'tag or group not found'
      else
        grouping.tags << tag
        render 'shared/http_status', locals: { code: '200', message:
          HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
      end
    rescue StandardError
      render 'shared/http_status', locals: { code: '404', message: I18n.t('tags.not_found') }, status: :not_found
    end

    def remove_tag
      grouping = self.grouping
      tag = grouping.tags.find_by(id: params[:tag_id])
      if tag.nil? || grouping.nil?
        raise 'tag or grouping not found'
      else
        grouping.tags.destroy(tag)
        render 'shared/http_status', locals: { code: '200', message:
          HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
      end
    rescue StandardError
      render 'shared/http_status', locals: { code: '404', message: I18n.t('tags.not_found') }, status: :not_found
    end

    def extension
      grouping = Grouping.find_by(group_id: params[:id], assignment: params[:assignment_id])
      case request.method
      when 'DELETE'
        if grouping.extension.present?
          grouping.extension.destroy!
          # Successfully deleted the extension; render success
          render 'shared/http_status', locals: { code: '200', message:
            HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
        else
          # cannot delete a non existent extension; render failure
          render 'shared/http_status', locals: { code: '422', message:
            HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
        end
      when 'POST'
        if grouping.extension.nil?
          extension_values = extension_params
          extension_values[:time_delta] = time_delta_params if extension_values[:time_delta].present?
          grouping.create_extension!(extension_values)
          # Successfully created the extension record; render success
          render 'shared/http_status', locals: { code: '201', message:
            HttpStatusHelper::ERROR_CODE['message']['201'] }, status: :created
        else
          # cannot create extension as it already exists; render failure
          render 'shared/http_status', locals: { code: '422', message:
            HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
        end
      when 'PATCH'
        if grouping.extension.present?
          extension_values = extension_params
          extension_values[:time_delta] = time_delta_params if extension_values[:time_delta].present?
          grouping.extension.update!(extension_values)
          # Successfully updated the extension record; render success
          render 'shared/http_status', locals: { code: '200', message:
            HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
        else
          # cannot update extension as it does not exists; render failure
          render 'shared/http_status', locals: { code: '422', message:
            HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
        end
      end
    rescue ActiveRecord::RecordInvalid => e
      render 'shared/http_status', locals: { code: '422', message: e.to_s }, status: :unprocessable_content
    end

    def collect_submission
      @grouping = Grouping.find_by(group_id: params[:id], assignment: params[:assignment_id])
      unless @grouping.current_submission_used.nil?
        released = @grouping.current_submission_used.results.exists?(released_to_students: true)
        if released
          render 'shared/http_status', locals: { code: '422', message:
            HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
          return
        end
      end

      @revision_identifier = params[:revision_identifier]
      apply_late_penalty = if params[:apply_late_penalty].nil?
                             false
                           else
                             params[:apply_late_penalty]
                           end
      retain_existing_grading = if params[:retain_existing_grading].nil?
                                  false
                                else
                                  params[:retain_existing_grading]
                                end
      SubmissionsJob.perform_now([@grouping],
                                 revision_identifier: @revision_identifier,
                                 collect_current: params[:collect_current],
                                 apply_late_penalty: apply_late_penalty,
                                 retain_existing_grading: retain_existing_grading)

      render 'shared/http_status', locals: { code: '201', message:
        HttpStatusHelper::ERROR_CODE['message']['201'] }, status: :created
    end

    def add_test_run
      m_logger = MarkusLogger.instance
      # Validate test results against contract schema
      validation = TestResultsContract.new.call(params[:test_results].as_json)

      if validation.failure?
        return render json: { errors: validation.errors.to_hash }, status: :unprocessable_content
      end

      # Verify grouping exists and is authorized (grouping helper method handles this)
      if grouping.nil?
        return render json: { errors: 'Group not found for this assignment' }, status: :not_found
      end

      # Verify submission exists before attempting to create test run
      submission = grouping.current_submission_used
      if submission.nil?
        return render json: { errors: 'No submission exists for this grouping' }, status: :unprocessable_content
      end

      begin
        ActiveRecord::Base.transaction do
          test_run = TestRun.create!(
            status: :in_progress,
            role: current_role,
            grouping: grouping,
            submission: submission
          )

          test_run.update_results!(JSON.parse(params[:test_results].to_json))
          render json: { status: 'success', test_run_id: test_run.id }, status: :created
        end
      rescue ActiveRecord::RecordInvalid => e
        render json: { errors: e.record.errors.full_messages }, status: :unprocessable_content
      rescue StandardError => e
        m_logger.log("Test results processing failed: #{e.message}\n#{e.backtrace.join("\n")}")
        render json: { errors: 'Failed to process test results' }, status: :internal_server_error
      end
    end

    def overall_comment
      result = grouping&.current_result
      return page_not_found('No submission exists for that group') if result.nil?

      case request.method
      when 'GET'
        respond_to do |format|
          format.xml do
            render xml: { overall_comment: result.overall_comment }.to_xml(root: 'result', skip_types: 'true')
          end
          format.json { render json: { overall_comment: result.overall_comment } }
        end
      when 'PATCH'
        if has_missing_params?([:overall_comment])
          render 'shared/http_status', locals: { code: '422', message:
              HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
          return
        end
        if result.update(overall_comment: params[:overall_comment])
          head :ok
        else
          render 'shared/http_status',
                 locals: { code: '422', message: result.errors.full_messages.first },
                 status: :unprocessable_content
        end
      end
    end

    private

    def assignment
      return @assignment if defined?(@assignment)

      @assignment = Assignment.find_by(id: params[:assignment_id])
    end

    def grouping
      @grouping ||= record.grouping_for_assignment(assignment.id)
    end

    def annotations_params
      params.permit(annotations: [
        :annotation_category_name,
        :content,
        :filename,
        :type,
        :line_start,
        :line_end,
        :column_start,
        :column_end,
        :x1,
        :y1,
        :x2,
        :y2,
        :page,
        :start_node,
        :start_offset,
        :end_node,
        :end_offset
      ])[:annotations] || []
    end

    def add_annotations_error(message)
      render 'shared/http_status',
             locals: { code: '422', message: message },
             status: :unprocessable_content
    end

    def time_delta_params
      params = extension_params[:time_delta]
      Extension::PARTS.sum { |part| params[part].to_i.public_send(part) }
    end

    def extension_params
      params.require(:extension).permit({ time_delta: [:weeks, :days, :hours, :minutes] }, :apply_penalty, :note)
    end
  end
end

MarkUsProject / Markus / 27791313772

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous