Implement School sync to Salesforce

Author: fspeirs

app/jobs/salesforce/school_sync_job.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Salesforce
+  class SchoolSyncJob < SalesforceSyncJob
+    MODEL_CLASS = Salesforce::School
+
+    FIELD_MAPPINGS = {
+      editoruuid__c: :id,
+      name: :name,
+      editorreference__c: :reference,
+      addressline1__c: :address_line_1,
+      addressline2__c: :address_line_2,
+      editormunicipality__c: :municipality,
+      editoradministrativearea__c: :administrative_area,
+      postcode__c: :postal_code,
+      countrycode__c: :country_code,
+      verifiedat__c: :verified_at,
+      createdat__c: :created_at,
+      updatedat__c: :updated_at,
+      rejectedat__c: :rejected_at,
+      website__c: :website,
+      userorigin__c: :user_origin,
+      districtnamesupplied__c: :district_name,
+      ncesid__c: :district_nces_id,
+      schoolrollnumber__c: :school_roll_number
+    }.freeze
+
+    def perform(school_id:)
+      school = ::School.find(school_id)
+
+      sf_school = Salesforce::School.find_or_initialize_by(editoruuid__c: school_id)
+      sf_school.attributes = sf_school_attributes(school:)
+      sf_school.save!
+    end
+
+    private
+
+    def sf_school_attributes(school:)
+      mapped_attributes(school:).to_h do |sf_field, value|
+        value = 'for_education' if sf_field == :userorigin__c && value.nil?
+        value = truncate_value(sf_field:, value:) if value.is_a?(String)
+
+        [sf_field, value]
+      end
+    end
+
+    def mapped_attributes(school:)
+      FIELD_MAPPINGS.transform_values do |school_field|
+        school.send(school_field)
+      end
+    end
+  end
+end

app/models/salesforce/school.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Salesforce
+  class School < Salesforce::Base
+    self.table_name = 'salesforce.editor__c'
+    self.primary_key = :editoruuid__c
+  end
+end

app/models/school.rb

@@ -52,6 +52,8 @@ class School < ApplicationRecord
   # TODO: Remove the conditional once the feature flag is retired
   after_create :generate_code!, if: -> { FeatureFlags.immediate_school_onboarding? }
 
+  after_commit :do_salesforce_sync, on: %i[create update]
+
   def self.find_for_user!(user)
     school = Role.find_by(user_id: user.id)&.school || find_by(creator_id: user.id)
     raise ActiveRecord::RecordNotFound unless school
@@ -169,4 +171,11 @@ def format_uk_postal_code
     # ensures UK postcodes are always formatted correctly (as the inward code is always 3 chars long)
     self.postal_code = "#{cleaned_postal_code[0..-4]} #{cleaned_postal_code[-3..]}"
   end
+
+  def do_salesforce_sync
+    return unless ENV.fetch('SALESFORCE_ENABLED', 'true') == 'true'
+
+    Salesforce::SchoolSyncJob.perform_later(school_id: id)
+    Salesforce::ContactSyncJob.perform_later(school_id: id)
+  end
 end

lib/tasks/salesforce_sync.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+namespace :salesforce_sync do
+  desc 'Sync all Schools to Salesforce'
+  task school: :environment do
+    School.pluck(:id).each do |school_id|
+      Salesforce::SchoolSyncJob.perform_later(school_id:)
+    end
+  end
+end

spec/factories/salesforce/school.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory(:salesforce_school, class: 'Salesforce::School') do
+    editoruuid__c { SecureRandom.uuid }
+  end
+end

spec/jobs/salesforce/school_sync_job_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Salesforce::SchoolSyncJob do
+  subject(:perform_job) { described_class.perform_now(school_id: school.id) }
+
+  let(:school) { create(:school) }
+
+  context 'when the job has run' do
+    before { perform_job }
+
+    it 'syncs all FIELD_MAPPINGS to the correct school values' do
+      sf_school = Salesforce::School.find_by(editoruuid__c: school.id)
+      described_class::FIELD_MAPPINGS.each do |sf_field, school_field|
+        expected = Salesforce::School.type_for_attribute(sf_field).cast(school.send(school_field))
+        expect(sf_school.send(sf_field)).to eq(expected),
+                                            "Expected #{sf_field} to equal school.#{school_field}"
+      end
+    end
+
+    context 'when an address field is very long' do
+      let(:school) { create(:school, address_line_1: '❌' * 300) }
+
+      it 'truncates addressline1__c' do
+        sf_school = Salesforce::School.find_by(editoruuid__c: school.id)
+        expect(sf_school.addressline1__c).to end_with('…')
+        expect(sf_school.addressline1__c.length).to be < school.address_line_1.length
+      end
+    end
+
+    context 'when the school is verified' do
+      let(:school) { create(:verified_school) }
+
+      it 'syncs verifiedat__c' do
+        sf_school = Salesforce::School.find_by(editoruuid__c: school.id)
+        expect(sf_school.verifiedat__c).to eq(school.verified_at)
+      end
+    end
+
+    context 'when the school is rejected' do
+      let(:school) { create(:school, rejected_at: Time.current) }
+
+      it 'syncs rejectedat__c' do
+        sf_school = Salesforce::School.find_by(editoruuid__c: school.id)
+        expect(sf_school.rejectedat__c).to eq(school.rejected_at)
+      end
+    end
+  end
+
+  context 'when the Salesforce school fails to save' do
+    let(:sf_school) { instance_double(Salesforce::School) }
+
+    before do
+      allow(Salesforce::School).to receive(:find_or_initialize_by).with(editoruuid__c: school.id).and_return(sf_school)
+      allow(sf_school).to receive(:attributes=)
+      allow(sf_school).to receive(:save!).and_raise(ActiveRecord::RecordInvalid)
+    end
+
+    it 'raises an error' do
+      expect { perform_job }.to raise_error ActiveRecord::RecordInvalid
+    end
+  end
+
+  context 'when SALESFORCE_ENABLED is false' do
+    around do |example|
+      ClimateControl.modify(SALESFORCE_ENABLED: 'false') do
+        example.run
+      end
+    end
+
+    it 'discards the job without syncing' do
+      perform_job
+      expect(Salesforce::School.find_by(editoruuid__c: school.id)).to be_nil
+    end
+  end
+end

spec/models/school_spec.rb

@@ -632,6 +632,40 @@
     end
   end
 
+  describe 'salesforce sync' do
+    it 'enqueues Salesforce::SchoolSyncJob on create' do
+      expect { create(:school) }.to have_enqueued_job(Salesforce::SchoolSyncJob)
+    end
+
+    it 'enqueues Salesforce::ContactSyncJob on create' do
+      expect { create(:school) }.to have_enqueued_job(Salesforce::ContactSyncJob)
+    end
+
+    it 'enqueues Salesforce::SchoolSyncJob on update' do
+      school = create(:school)
+      expect { school.update!(name: 'Updated Name') }.to have_enqueued_job(Salesforce::SchoolSyncJob)
+    end
+
+    it 'enqueues Salesforce::ContactSyncJob on update' do
+      school = create(:school)
+      expect { school.update!(name: 'Updated Name') }.to have_enqueued_job(Salesforce::ContactSyncJob)
+    end
+
+    context 'when SALESFORCE_ENABLED is false' do
+      around do |example|
+        ClimateControl.modify(SALESFORCE_ENABLED: 'false') { example.run }
+      end
+
+      it 'does not enqueue Salesforce::SchoolSyncJob on create' do
+        expect { create(:school) }.not_to have_enqueued_job(Salesforce::SchoolSyncJob)
+      end
+
+      it 'does not enqueue Salesforce::ContactSyncJob on create' do
+        expect { create(:school) }.not_to have_enqueued_job(Salesforce::ContactSyncJob)
+      end
+    end
+  end
+
   describe '#reopen' do
     it 'sets rejected_at to nil' do
       school.reject