DPL-865 handle sprint client response

app/models/print_job.rb

@@ -103,32 +103,9 @@ def print_to_sprint
 
     merge_fields_list = label_array * number_of_copies
 
-    # assumes all labels use the same label template
-    SPrintClient.send_print_request(printer_name, label_template, merge_fields_list)
-
-    # TODO: DPL-865 [Limber] Handle sprint client response
-    #
-    # This print_to_sprint call fails silently if there is an error. Instead
-    # of returning success, the result of the send_print_request call should
-    # be used to check the response status and response body. Examples:
-    #
-    # The following response body is returned in a 200 response.
-    # {"errors":[{"message":"Variable 'printRequest' has an invalid value: Expected
-    #   type 'Int' but was
-    #   'Double'.","locations":[{"line":1,"column":16}],"extensions":{"classification":"
-    #   ValidationError"}}]}
-    #
-    # The following response body is returned in a 500 response.
-    # {"timestamp": "2023-08-02T14:46:30.160+00:00","status": 500,"error": "Internal
-    #   Server Error","path": "/graphql"}
-    #
-    # When sprint cannot log in to printer, the details are available in response body.
-    #
-    # A successful response has a job id in response body.
-    #
-    # Use errors.add to show proper feedback in the view.
-
-    true
+    response = SPrintClient.send_print_request(printer_name, label_template, merge_fields_list)
+
+    handle_sprint_response(response)
   end
 
   def number_of_copies=(number)
@@ -155,4 +132,71 @@ def get_label_template_by_service(print_service)
     templates_by_service = JSON.parse(label_templates_by_service)
     templates_by_service[print_service]
   end
+
+  # Handles the response from the SPrintClient and checks for success.
+  # If the response is successful and contains a job ID, it returns true.
+  # Otherwise, it adds an error message to the errors object and returns false.
+  #
+  # The print_to_sprint call fails silently if there is an error. Instead
+  # of returning success, the result of the send_print_request call should
+  # be used to check the response status and response body. Examples:
+  #
+  # The following response body is returned in a 200 response.
+  # {"errors":[{"message":"Variable 'printRequest' has an invalid value: Expected
+  #   type 'Int' but was
+  #   'Double'.","locations":[{"line":1,"column":16}],"extensions":{"classification":"
+  #   ValidationError"}}]}
+  #
+  # The following response body is returned in a 500 response.
+  # {"timestamp": "2023-08-02T14:46:30.160+00:00","status": 500,"error": "Internal
+  #   Server Error","path": "/graphql"}
+  #
+  # When sprint cannot log in to printer, the details are available in response body.
+  #
+  # A successful response has a job id in response body.
+  #
+  # Use errors.add to show proper feedback in the view.
+  #
+  # @param response [Net::HTTPResponse] The response object from the SPrintClient.
+  # @return [Boolean] True if the response is successful and contains a job ID, false otherwise.
+  def handle_sprint_response(response)
+    # Non-200 errors are treated as failures
+    # Ref: https://ruby-doc.org/stdlib-2.7.0/libdoc/net/http/rdoc/Net/HTTP.html#class-Net::HTTP-label-GET+with+Dynamic+Parameters
+    unless response.is_a?(Net::HTTPSuccess)
+      case response
+      when Net::HTTPUnprocessableEntity
+        errors.add(:sprint, 'Sprint could not understand the request. Please check the label data.')
+      when Net::HTTPInternalServerError
+        errors.add(:sprint, 'Internal server error at SPrint. Please try again later.')
+      else
+        errors.add(:sprint, 'Trouble connecting to SPrint. Please try again later.')
+      end
+      return false
+    end
+    if response.body.present? && response.body['jobId'].present?
+      true
+    else
+      errors.add(:sprint, extract_error_message(response))
+      false
+    end
+  end
+
+  def extract_error_message(response)
+    if response.body.present?
+      begin
+        response_body = JSON.parse(response.body)
+        if response_body['errors'].present?
+          messages =
+            response_body['errors'].map do |error|
+              extension = error['extensions'] ? " (#{error['extensions']['classification']})" : ''
+              "#{error['message']}#{extension}"
+            end
+          return messages.join(' - ')
+        end
+      rescue JSON::ParserError
+        return 'Failed to parse JSON response from SprintClient'
+      end
+    end
+    'Unknown error'
+  end
 end

spec/models/print_job_spec.rb

@@ -199,25 +199,157 @@
       }
     end
 
-    it 'will send a print request to SPrintClient' do
-      pj =
-        PrintJob.new(
-          printer_name: printer_sprint.name,
-          printer: printer_sprint,
-          label_templates_by_service: label_templates_by_service,
-          labels: [{ label: { barcode: '12345', test_attr: 'test' } }],
-          labels_sprint: labels_sprint,
-          number_of_copies: 1
-        )
+    let(:pj) do
+      PrintJob.new(
+        printer_name: printer_sprint.name,
+        printer: printer_sprint,
+        label_templates_by_service: label_templates_by_service,
+        labels: [{ label: { barcode: '12345', test_attr: 'test' } }],
+        labels_sprint: labels_sprint,
+        number_of_copies: 1
+      )
+    end
 
+    it 'will send a print request to SPrintClient' do
       allow(pj).to receive(:get_label_template_by_service).and_return(label_template_name_sprint)
-      allow(SPrintClient).to receive(:send_print_request).and_return('a response')
+      response = Net::HTTPSuccess.new(1.0, '200', 'OK')
+      response.instance_variable_set(:@read, true)
+      response.instance_variable_set(
+        :@body,
+        { data: { print: { jobId: 'psd-2:68b27056-11cf-41ff-9b22-bdf6121a95be' } } }.to_json
+      )
+      allow(SPrintClient).to receive(:send_print_request).and_return(response)
       expect(SPrintClient).to receive(:send_print_request).with(
         printer_sprint.name,
         label_template_name_sprint,
         labels_sprint.values
       )
       expect(pj.print_to_sprint).to eq(true)
     end
+
+    it 'will not execute if the SPrintClient is down' do
+      response = Net::HTTPBadGateway.new(1.0, '502', nil)
+      response.instance_variable_set(:@read, true)
+      allow(SPrintClient).to receive(:send_print_request).and_return(response)
+      expect(pj.execute).to be false
+      expect(pj.errors.full_messages[0]).to eq('Sprint Trouble connecting to SPrint. Please try again later.')
+    end
+
+    it 'will not execute if the SPrintClient returns unprocessable entity' do
+      response = Net::HTTPUnprocessableEntity.new(1.0, '422', nil)
+      response.instance_variable_set(:@read, true)
+      allow(SPrintClient).to receive(:send_print_request).and_return(response)
+      expect(pj.execute).to be false
+      expect(pj.errors.full_messages[0]).to eq(
+        'Sprint Sprint could not understand the request. Please check the label data.'
+      )
+    end
+
+    it 'will not execute if the SPrintClient returns unprocessable entity' do
+      response = Net::HTTPInternalServerError.new(1.0, '500', nil)
+      response.instance_variable_set(:@read, true)
+      allow(SPrintClient).to receive(:send_print_request).and_return(response)
+      expect(pj.execute).to be false
+      expect(pj.errors.full_messages[0]).to eq('Sprint Internal server error at SPrint. Please try again later.')
+    end
+
+    it 'will not execute if the SPrintClient sends a valid error with code 200' do
+      response = Net::HTTPSuccess.new(1.0, '200', nil)
+      response.instance_variable_set(:@read, true)
+      response.instance_variable_set(
+        :@body,
+        {
+          errors: [
+            {
+              message: "Variable 'printRequest' has an invalid value: Expected type 'Int' but was 'Double'.",
+              locations: [{ line: 1, column: 16 }],
+              extensions: {
+                classification: 'ValidationError'
+              }
+            }
+          ]
+        }.to_json
+      )
+      allow(SPrintClient).to receive(:send_print_request).and_return(response)
+      expect(pj.execute).to be false
+      expect(pj.errors.full_messages[0]).to eq(
+        "Sprint Variable 'printRequest' has an invalid value: Expected type 'Int' but was 'Double'. (ValidationError)"
+      )
+    end
+
+    it 'will not execute if the SPrintClient sends an invalid error with code 200' do
+      response = Net::HTTPSuccess.new(1.0, '200', nil)
+      response.instance_variable_set(:@read, true)
+      response.instance_variable_set(
+        :@body,
+        {
+          errors: [
+            {
+              message: 'Failed to parse JSON response from SprintClient',
+              locations: [{ line: 1, column: 16 }],
+              extensions: {
+                classification: 'ValidationError'
+              }
+            }
+          ]
+        }.to_json
+      )
+      allow(SPrintClient).to receive(:send_print_request).and_return(response)
+      expect(pj.execute).to be false
+      expect(pj.errors.full_messages[0]).to eq(
+        'Sprint Failed to parse JSON response from SprintClient (ValidationError)'
+      )
+    end
+  end
+
+  describe '#extract_error_message' do
+    let(:print_job) { PrintJob.new }
+
+    it 'returns the error message with extensions' do
+      response =
+        instance_double(
+          'Net::HTTPResponse',
+          body: {
+            errors: [
+              {
+                message: "Variable 'printRequest' has an invalid value: Expected type 'Int' but was 'Double'.",
+                extensions: {
+                  classification: 'ValidationError'
+                }
+              }
+            ]
+          }.to_json
+        )
+
+      expect(print_job.send(:extract_error_message, response)).to eq(
+        "Variable 'printRequest' has an invalid value: Expected type 'Int' but was 'Double'. (ValidationError)"
+      )
+    end
+
+    it 'returns the error message without extensions' do
+      response =
+        instance_double(
+          'Net::HTTPResponse',
+          body: {
+            errors: [{ message: "Variable 'printRequest' has an invalid value: Expected type 'Int' but was 'Double'." }]
+          }.to_json
+        )
+
+      expect(print_job.send(:extract_error_message, response)).to eq(
+        "Variable 'printRequest' has an invalid value: Expected type 'Int' but was 'Double'."
+      )
+    end
+
+    it 'returns unknown error if response body is empty' do
+      response = instance_double('Net::HTTPResponse', body: nil)
+
+      expect(print_job.send(:extract_error_message, response)).to eq('Unknown error')
+    end
+
+    it 'returns failed to parse JSON response if JSON parsing fails' do
+      response = instance_double('Net::HTTPResponse', body: 'invalid_json')
+
+      expect(print_job.send(:extract_error_message, response)).to eq('Failed to parse JSON response from SprintClient')
+    end
   end
 end