SWAMPy

✎ CARVE FLESH

EDITING: job_info_spec.rb

# frozen_string_literal: true

#
# Copyright (C) 2015 - 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/>.

require "spec_helper"
require "active_support/time_with_zone"

module CanvasErrors
  describe JobInfo do
    let(:job) do
      double(
        id: 42,
        source: "controller:discussion_topics_api,action:add_entry," \
                "hostname:app010001063068-vpc.us-east-1.canvas.insops.net," \
                "pid:8949,context_id:c5ec694d-1c0d-4744-a97a-cae44c477837",
        attempts: 1,
        strand: "thing",
        priority: 1,
        handler: "Something",
        run_at: Time.zone.now,
        max_attempts: 1,
        tag: "TAG",
        current_shard: double(id: 1)
      )
    end

let(:worker) { double(name: "workername") }

let(:info) { described_class.new(job, worker) }

describe "#to_h" do
      subject(:hash) { info.to_h }

it "tags all exceptions as 'BackgroundJob'" do
        expect(hash[:tags][:process_type]).to eq("BackgroundJob")
      end

it "includes the tag from the job if there is one" do
        expect(hash[:tags][:job_tag]).to eq("TAG")
      end

it "grabs some common attrs from jobs into extras" do
        expect(hash[:extra][:attempts]).to eq(1)
        expect(hash[:extra][:strand]).to eq("thing")
      end

it "includes the worker name" do
        expect(hash[:extra][:worker_name]).to eq("workername")
      end

it "includes the job id in the extras hash" do
        expect(hash[:extra][:id]).to eq(42)
      end

it "includes the source, which has the request context id" do
        expect(hash[:extra][:source])
          .to match(/c5ec694d-1c0d-4744-a97a-cae44c477837/)
      end
    end

describe "edge cases" do
      it "tolerates a nil worker" do
        job_info = described_class.new(job, nil)
        hash = job_info.to_h
        expect(hash[:tags][:job_tag]).to eq("TAG")
        expect(hash[:extra][:worker_name]).to be_nil
      end
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 job_info_spec.rb	RB	2.5 KB	2023-09-24 03:36	EDIT