Return error_codes in SchoolEmailDomain response

Author: PetarSimonovic

app/controllers/api/school_email_domains_controller.rb

@@ -15,7 +15,7 @@ def create
       if result.success?
         render json: { domain: result[:school_email_domain].domain }, status: :created
       else
-        render json: { error: result[:error] }, status: :unprocessable_content
+        render json: { error: result[:error], error_code: result[:error_code] }, status: :unprocessable_content
       end
     end
 

lib/concepts/school_email_domain/operations/create.rb

@@ -14,15 +14,18 @@ def call(school:, domain:, token:)
       rescue ActiveRecord::RecordInvalid => e
         record = response[:school_email_domain] || e.record
         response[:error] = record.errors.full_messages.join(', ')
+        response[:error_code] = domain_error_code(record)
         response
       rescue ActiveRecord::RecordNotUnique
         record = response[:school_email_domain]
         record.errors.add(:domain, :taken)
         response[:error] = record.errors.full_messages.join(', ')
+        response[:error_code] = 'taken'
         response
       rescue StandardError => e
         Sentry.capture_exception(e) # Send unexpected/Profile errors to Sentry
         response[:error] = e.message
+        response[:error_code] = 'profile_sync_failed'
         response
       end
 
@@ -36,6 +39,10 @@ def update_profile(school, token)
         school_email_domains = school.school_email_domains.order(:created_at).pluck(:domain)
         ProfileApiClient.update_school_email_domains(token:, school_id: school.id, school_email_domains:)
       end
+
+      def domain_error_code(record)
+        record.errors.details[:domain].first.fetch(:error).to_s
+      end
     end
   end
 end

spec/concepts/school_email_domain/create_spec.rb

@@ -78,9 +78,9 @@
       expect(Sentry).not_to have_received(:capture_exception).with(kind_of(StandardError))
     end
 
-    it 'returns the error message in the operation response' do
+    it 'returns the error code in the operation response' do
       response = described_class.call(school:, domain:, token:)
-      expect(response[:error]).to include('')
+      expect(response[:error_code]).to eq(expected_error_code)
     end
 
     it 'does not attempt to update Profile' do
@@ -91,42 +91,42 @@
 
   context 'when domain is blank' do
     let(:domain) { '' }
-    let(:expected_error_message) { "Domain can't be blank" }
+    let(:expected_error_code) { 'blank' }
 
     it_behaves_like 'an invalid record'
   end
 
   context 'when domain is not an FQDN' do
     let(:domain) { 'edu' }
-    let(:expected_error_message) { 'Domain must be a fully qualified domain name' }
+    let(:expected_error_code) { 'invalid_host' }
 
     it_behaves_like 'an invalid record'
   end
 
   context 'when domain has an invalid URI' do
     let(:domain) { 'exa mple.com' }
-    let(:expected_error_message) { 'Domain must be a valid domain format' }
+    let(:expected_error_code) { 'invalid_uri' }
 
     it_behaves_like 'an invalid record'
   end
 
   context 'when domain has an invalid public suffix' do
     let(:domain) { 'co.uk' }
-    let(:expected_error_message) { 'Domain must be a registrable domain name' }
+    let(:expected_error_code) { 'invalid_public_suffix' }
 
     it_behaves_like 'an invalid record'
   end
 
   context 'when domain is a duplicate' do
     before { create(:school_email_domain, school:, domain:) }
 
-    let(:expected_error_message) { 'Domain has already been taken' }
+    let(:expected_error_code) { 'taken' }
 
     it_behaves_like 'an invalid record'
   end
 
   context 'when a concurrent request creates the same domain' do
-    let(:expected_error_message) { 'Domain has already been taken' }
+    let(:expected_error_code) { 'taken' }
     let(:school_email_domain) { SchoolEmailDomain.new(school:, domain:) }
 
     before do
@@ -171,9 +171,9 @@
       expect(described_class.call(school:, domain:, token:)).to be_failure
     end
 
-    it 'returns the error message in the operation response' do
+    it 'returns the error code in the operation response' do
       response = described_class.call(school:, domain:, token:)
-      expect(response[:error]).to eq('Unexpected response from Profile API (status code 500)')
+      expect(response[:error_code]).to eq('profile_sync_failed')
     end
   end
 end

spec/features/school_email_domain/creating_school_email_domains_spec.rb

@@ -43,9 +43,9 @@
         expect(response).to have_http_status(:unprocessable_content)
       end
 
-      it 'returns the error in the response body' do
+      it 'returns the error code in the response body' do
         data = JSON.parse(response.body, symbolize_names: true)
-        expect(data[:error]).to match(expected_error)
+        expect(data[:error_code]).to eq(expected_error_code)
       end
     end
 
@@ -117,7 +117,7 @@
     context 'when the domain cannot be processed' do
       context 'when the domain is blank' do
         let(:domain) { '' }
-        let(:expected_error) { /Domain can't be blank/ }
+        let(:expected_error_code) { 'blank' }
 
         it_behaves_like 'an unprocessable school email domain creation response'
 
@@ -130,7 +130,7 @@
 
       context 'when the domain is not an FQDN' do
         let(:domain) { 'edu' }
-        let(:expected_error) { /Domain must be a fully qualified domain name/ }
+        let(:expected_error_code) { 'invalid_host' }
 
         it_behaves_like 'an unprocessable school email domain creation response'
 
@@ -143,7 +143,7 @@
 
       context 'when the uri is invalid' do
         let(:domain) { 'exa mple.com' }
-        let(:expected_error) { /Domain must be a valid domain format/ }
+        let(:expected_error_code) { 'invalid_uri' }
 
         it_behaves_like 'an unprocessable school email domain creation response'
 
@@ -156,7 +156,7 @@
 
       context 'when the public suffix is invalid' do
         let(:domain) { 'co.uk' }
-        let(:expected_error) { /Domain must be a registrable domain name/ }
+        let(:expected_error_code) { 'invalid_public_suffix' }
 
         it_behaves_like 'an unprocessable school email domain creation response'
 
@@ -168,7 +168,7 @@
       end
 
       context 'when the domain is a duplicate' do
-        let(:expected_error) { /Domain has already been taken/ }
+        let(:expected_error_code) { 'taken' }
 
         before do
           create(:school_email_domain, school:, domain:)
@@ -190,7 +190,7 @@
           instance_double(Faraday::Response, status: 500, headers: {}, body: '')
         )
       end
-      let(:expected_error) { /Unexpected response from Profile API \(status code 500\)/ }
+      let(:expected_error_code) { 'profile_sync_failed' }
 
       before do
         allow(ProfileApiClient).to receive(:update_school_email_domains).and_raise(profile_error)