Create UpdateSchoolEmailDomainsJob

Set up a job to update Profile's school email domains

Author: PetarSimonovic

app/jobs/update_school_email_domains_job.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class UpdateSchoolEmailDomainsJob < ApplicationJob
+  class ConcurrencyExceededForSchool < StandardError; end
+
+  include GoodJob::ActiveJobExtensions::Concurrency
+
+  # Serialize runs per school (eg user edits domains while batch or another job is updating Profile).
+  good_job_control_concurrency_with(
+    perform_limit: 1,
+    key: -> { "#{self.class.name}/#{concurrency_key_id}" }
+  )
+
+  retry_on StandardError, wait: :polynomially_longer, attempts: 3 do |_job, e|
+    Sentry.capture_exception(e)
+    raise e
+  end
+
+  # Don't retry...
+  rescue_from ConcurrencyExceededForSchool do |e|
+    Rails.logger.error "Only one job per school can be enqueued at a time: #{concurrency_key_id}"
+    Sentry.capture_exception(e)
+    raise e
+  end
+
+  queue_as :update_school_email_domains_job
+
+  def self.attempt_perform_later(school_id:, school_email_domains:, token:)
+    perform_later(school_id:, school_email_domains:, token:)
+  end
+
+  def perform(school_id:, school_email_domains:, token:)
+    ProfileApiClient.update_school_email_domains(token:, school_id:, school_email_domains:)
+  end
+
+  private
+
+  def concurrency_key_id
+    arguments.first&.with_indifferent_access&.dig(:school_id)
+  end
+end

spec/jobs/update_school_email_domains_job_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe UpdateSchoolEmailDomainsJob do
+  include ActiveJob::TestHelper
+
+  let(:token) { UserProfileMock::TOKEN }
+  let(:school) { create(:verified_school) }
+  let(:school_email_domains) { ['student.example.edu', 'mail.example.org'] }
+  let(:profile_api_base_url) { 'http://profile.com' }
+  let(:profile_api_key) { 'api-key' }
+  let(:update_school_email_domains_path) { "/api/v1/schools/#{school.id}" }
+  let(:update_school_email_domains_url) { "#{profile_api_base_url}#{update_school_email_domains_path}" }
+
+  around do |example|
+    ClimateControl.modify(
+      IDENTITY_URL: profile_api_base_url,
+      PROFILE_API_KEY: profile_api_key
+    ) do
+      example.run
+    end
+  end
+
+  before do
+    stub_request(:patch, update_school_email_domains_url)
+      .to_return(
+        status: 201,
+        body: {
+          id: school.id,
+          schoolCode: '99-12-34',
+          updatedAt: '2024-07-09T10:31:13.196Z',
+          createdAt: '2024-07-09T10:31:13.196Z',
+          discardedAt: nil,
+          studentEmailDomains: school_email_domains
+        }.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+  end
+
+  after do
+    GoodJob::Job.delete_all
+  end
+
+  describe 'GoodJob concurrency' do
+    it 'uses a per-school concurrency key' do
+      job = described_class.new
+      job.arguments = [{ school_id: school.id, school_email_domains:, token: }]
+
+      expect(job.good_job_concurrency_key).to eq("#{described_class.name}/#{school.id}")
+    end
+
+    it 'uses a different concurrency key for a different school' do
+      other_school = create(:verified_school)
+      job_a = described_class.new
+      job_a.arguments = [{ school_id: school.id, school_email_domains:, token: }]
+      job_b = described_class.new
+      job_b.arguments = [{ school_id: other_school.id, school_email_domains:, token: }]
+
+      expect(job_a.good_job_concurrency_key).not_to eq(job_b.good_job_concurrency_key)
+    end
+  end
+
+  it 'PATCHes student email domains to the Profile API' do
+    described_class.perform_now(token:, school_id: school.id, school_email_domains:)
+    expect(WebMock).to have_requested(:patch, update_school_email_domains_url).with(
+      body: { studentEmailDomains: school_email_domains }.to_json
+    )
+  end
+end