Implement Role sync to Salesforce

Author: fspeirs

app/jobs/salesforce/role_sync_job.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Salesforce
+  class RoleSyncJob < SalesforceSyncJob
+    MODEL_CLASS = Salesforce::Role
+
+    FIELD_MAPPINGS = {
+      affiliation_id__c: :id,
+      contact__r__pi_accounts_unique_id__c: :user_id,
+      editor__r__editoruuid__c: :school_id,
+      roletype__c: :role,
+      createdat__c: :created_at,
+      updatedat__c: :updated_at
+    }.freeze
+
+    def perform(role_id:)
+      role = ::Role.find(role_id)
+
+      return if role.student?
+
+      sf_role = Salesforce::Role.find_or_initialize_by(affiliation_id__c: role_id)
+      sf_role.attributes = sf_role_attributes(role:)
+      sf_role.save!
+    end
+
+    private
+
+    def sf_role_attributes(role:)
+      mapped_attributes(role:).to_h do |sf_field, value|
+        value = truncate_value(sf_field:, value:) if value.is_a?(String)
+
+        [sf_field, value]
+      end
+    end
+
+    def mapped_attributes(role:)
+      FIELD_MAPPINGS.transform_values do |role_field|
+        role.send(role_field)
+      end
+    end
+  end
+end

app/models/role.rb

@@ -16,6 +16,8 @@ class Role < ApplicationRecord
     }
   )
 
+  after_commit :do_salesforce_sync, on: %i[create update]
+
   private
 
   def students_cannot_have_additional_roles
@@ -38,4 +40,10 @@ def users_can_only_have_roles_in_one_school
 
     errors.add(:base, 'Cannot create role as this user already has a role in a different school')
   end
+
+  def do_salesforce_sync
+    return unless ENV.fetch('SALESFORCE_ENABLED', 'true') == 'true'
+
+    Salesforce::RoleSyncJob.perform_later(role_id: id)
+  end
 end

app/models/salesforce/role.rb

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

lib/tasks/salesforce_sync.rake

@@ -7,4 +7,11 @@ namespace :salesforce_sync do
       Salesforce::SchoolSyncJob.perform_later(school_id:)
     end
   end
+
+  desc 'Sync all Roles to Salesforce'
+  task role: :environment do
+    Role.pluck(:id).each do |role_id|
+      Salesforce::RoleSyncJob.perform_later(role_id:)
+    end
+  end
 end

spec/factories/salesforce/role.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory(:salesforce_role, class: 'Salesforce::Role') do
+    sequence(:affiliation_id__c)
+  end
+end

spec/jobs/salesforce/role_sync_job_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Salesforce::RoleSyncJob do
+  subject(:perform_job) { described_class.perform_now(role_id: role.id) }
+
+  let(:role) { create(:role) }
+
+  context 'when the job has run' do
+    before { perform_job }
+
+    it 'syncs all FIELD_MAPPINGS to the correct role values' do
+      sf_role = Salesforce::Role.find_by(affiliation_id__c: role.id)
+      described_class::FIELD_MAPPINGS.each do |sf_field, role_field|
+        expected = Salesforce::Role.type_for_attribute(sf_field).cast(role.send(role_field))
+        expect(sf_role.send(sf_field)).to eq(expected),
+                                          "Expected #{sf_field} to equal role.#{role_field}"
+      end
+    end
+  end
+
+  context 'when the Salesforce role fails to save' do
+    let(:sf_role) { instance_double(Salesforce::Role) }
+
+    before do
+      allow(Salesforce::Role).to receive(:find_or_initialize_by).with(affiliation_id__c: role.id).and_return(sf_role)
+      allow(sf_role).to receive(:attributes=)
+      allow(sf_role).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 the role is a student role' do
+    let(:role) { create(:student_role) }
+
+    it 'does not create a Salesforce role record' do
+      perform_job
+      expect(Salesforce::Role.find_by(affiliation_id__c: role.id)).to be_nil
+    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::Role.find_by(affiliation_id__c: role.id)).to be_nil
+    end
+  end
+end

spec/models/role_spec.rb

@@ -165,4 +165,25 @@
       end
     end
   end
+
+  describe 'salesforce sync' do
+    it 'enqueues a Salesforce::RoleSyncJob on create' do
+      expect { create(:role) }.to have_enqueued_job(Salesforce::RoleSyncJob)
+    end
+
+    it 'enqueues a Salesforce::RoleSyncJob on update' do
+      role = create(:role)
+      expect { role.update!(role: 'teacher') }.to have_enqueued_job(Salesforce::RoleSyncJob)
+    end
+
+    context 'when SALESFORCE_ENABLED is false' do
+      around do |example|
+        ClimateControl.modify(SALESFORCE_ENABLED: 'false') { example.run }
+      end
+
+      it 'does not enqueue Salesforce::RoleSyncJob on create' do
+        expect { create(:role) }.not_to have_enqueued_job(Salesforce::RoleSyncJob)
+      end
+    end
+  end
 end