huginn_bigcommerce_product_agent 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2d3a13bdac789b3b1714c68e8794c30f0f15390c0161dd8a473d36f097f4422
-  data.tar.gz: ecc6fe4feb48b5bf7d8528951fd0bcccd41b095f9b1070f73e4d41b5b31908cd
+  metadata.gz: af097d968dbd6e4c5b16bd27be4b48a685625056f23e4863e749b8e2382ee06f
+  data.tar.gz: e441b45253fde8999a4480bf2f9dbd419cd228d21c3e05dad47d45d8f4dbbe08
 SHA512:
-  metadata.gz: db7b3003393f5b1c4e741a6be04b3bfb8bfd7be7aaf0cd006d7dd03112da997edb0efac33f2d5e41d5bc1f2d128a67c6be5c68b76b9be9b20bad4e7fbc397680
-  data.tar.gz: 1d18a0e667d3216a194816ded4f4c523dffe4eeda9d7a84186285f6a6e53ea4d14f2f8e28b2333b5de65b517e5e1bb2149c77cd7a53f659f8a65e352b266257a
+  metadata.gz: c8fc484fc9c277ce1deb6b1ec3baed84f74a607e12b2667eb4fcfc5c160511623364d9c8d962f3367f713fd1da6b430da128160a45a5f575badfd5efb01f6af6
+  data.tar.gz: 8546a2251a5a077eb00ad8cbbf9aa605b121ce251565121f5a36bdffa65099f1e67e26f217a7f64b0ada326410cfa271b459945fdadc02ac5f0e68cc8b46a1c5

data/lib/client/custom_field.rb

@@ -33,7 +33,17 @@ module BigcommerceProductAgent
               begin
                 client.delete(uri(product_id: product_id, custom_field_id: custom_field_id))
               rescue Faraday::Error::ClientError => e
-                  raise e, "\n#{e.message}\nFailed to delete custom_field with id = #{custom_field_id}\nfor product with id = #{product_id}\n", e.backtrace
+                  raise BigCommerceProductError.new(
+                    e.response[:status],
+                    'delete custom field',
+                    'Failed to delete custom field',
+                    product_id,
+                    {
+                      custom_field_id: custom_field_id,
+                      errors: JSON.parse(e.response[:body])['errors']
+                    },
+                    e
+                  )
               end
             end
 
@@ -46,8 +56,19 @@ module BigcommerceProductAgent
                         return create(product_id, payload)
                     end
                 rescue Faraday::Error::ClientError => e
-                    puts e.inspect
-                    raise e
+                  # include the field ID and name in the error here as _create_ requests have no ID
+                  raise BigCommerceProductError.new(
+                    e.response[:status],
+                    'upsert custom field',
+                    'Failed to delete custom field',
+                    product_id,
+                    {
+                      custom_field_id: payload['id'],
+                      field_name: payload[:name],
+                      errors: JSON.parse(e.response[:body])['errors']
+                    },
+                    e
+                  )
                 end
             end
         end

data/lib/client/meta_field.rb

@@ -39,8 +39,19 @@ module BigcommerceProductAgent
                   return create(product_id, meta_field)
                 end
               rescue Faraday::Error::ClientError => e
-                puts e.inspect
-                raise e
+                # include the field ID and name in the error here as _create_ requests have no ID
+                raise BigCommerceProductError.new(
+                  e.response[:status],
+                  'upsert meta field',
+                  'Failed to upsert meta field field',
+                  product_id,
+                  {
+                    meta_field_id: meta_field['id'],
+                    field_name: meta_field['key'],
+                    errors: JSON.parse(e.response[:body])['errors'],
+                  },
+                  e
+                )
               end
             end
 
@@ -48,7 +59,17 @@ module BigcommerceProductAgent
                 begin
                     client.delete(uri(product_id: product_id, meta_field_id: meta_field_id))
                 rescue Faraday::Error::ClientError => e
-                    raise e, "\n#{e.message}\nFailed to delete meta_field with id = #{meta_field_id}\nfor product with id = #{product_id}\n", e.backtrace
+                  raise BigCommerceProductError.new(
+                    e.response[:status],
+                    'delete meta field',
+                    'Failed to delete meta field',
+                    product_id,
+                    {
+                      meta_field_id: meta_field_id,
+                      errors: JSON.parse(e.response[:body])['errors'],
+                    },
+                    e
+                  )
                 end
             end
         end

data/lib/client/product.rb

@@ -11,7 +11,17 @@ module BigcommerceProductAgent
 
                     return response.body['data']
                 rescue Faraday::Error::ClientError => e
-                    raise e, "\n#{e.message}\nFailed to update product with payload = #{payload.to_json}\n", e.backtrace
+                  raise BigCommerceProductError.new(
+                    e.response[:status],
+                    'update product',
+                    'Failed to update product',
+                    id,
+                    {
+                      sku: payload[:sku],
+                      errors: JSON.parse(e.response[:body])['errors'],
+                    },
+                    e
+                  )
                 end
             end
 
@@ -23,7 +33,18 @@ module BigcommerceProductAgent
 
                   return response.body['data']
               rescue Faraday::Error::ClientError => e
-                  raise e, "\n#{e.message}\nFailed to update product batch with payload = #{payload.to_json}\n", e.backtrace
+                raise BigCommerceProductError.new(
+                  e.response[:status],
+                  'update product',
+                  'Failed to update product batch',
+                  {
+                    product_identifiers: payload.map { |p|
+                      { id: p[:id], sku: p[:sku] }
+                    },
+                    errors: JSON.parse(e.response[:body])['errors'],
+                  },
+                  e
+                )
               end
             end
 
@@ -40,7 +61,26 @@ module BigcommerceProductAgent
 
                     return response.body['data']
                 rescue Faraday::Error::ClientError => e
-                    raise e, "\n#{e.message}\nFailed to create product with payload = #{payload.to_json}\n", e.backtrace
+
+                  Rails.logger.info('RESPONSE OBJECT:  ------------------------------------------')
+                      Rails.logger.info(e.response.inspect)
+                  Rails.logger.info('------------------------------------------------------------')
+
+                  Rails.logger.info('RESPONSE METHODS:  -----------------------------------------')
+                      Rails.logger.info(e.response.methods)
+                  Rails.logger.info('------------------------------------------------------------')
+
+                  raise BigCommerceProductError.new(
+                    e.response[:status],
+                    'create product',
+                    'Failed to create product',
+                    nil,
+                    {
+                      sku: payload[:sku],
+                      errors: JSON.parse(e.response[:body])['errors'],
+                    },
+                    e
+                  )
                 end
             end
 
@@ -55,11 +95,30 @@ module BigcommerceProductAgent
 
             # When using sku:in you must specify the fields you want returned.
             def get_by_skus(skus, include = %w[custom_fields modifiers], include_fields = %w[sku])
-                products = index({
-                    'sku:in': skus.join(','),
-                    include: include.join(','),
-                    include_fields: include_fields.join(','),
-                })
+                products = []
+                skus.each do |sku|
+                    begin
+                        data = index({
+                            'sku': sku,
+                            include: include.join(','),
+                            include_fields: include_fields.join(','),
+                        })
+                        if not data.empty?
+                            products.push(data[0])
+                        end
+                    rescue Faraday::Error::ClientError => e
+                      raise BigCommerceProductError.new(
+                        e.response[:status],
+                        'get by sku',
+                        'Failed to get existing product data',
+                        sku,
+                        {
+                          related_skus: skus,
+                          errors: JSON.parse(e.response[:body])['errors'],
+                        }
+                      )
+                    end
+                end
 
                 return products
             end

data/lib/huginn_bigcommerce_product_agent.rb

@@ -12,4 +12,5 @@ Dir[File.join(__dir__, 'mapper', '*.rb')].each do |file|
     HuginnAgent.load file
 end
 
+HuginnAgent.load 'huginn_bigcommerce_product_agent/big_commerce_product_error'
 HuginnAgent.register 'huginn_bigcommerce_product_agent/bigcommerce_product_agent'

data/lib/huginn_bigcommerce_product_agent/big_commerce_product_error.rb

@@ -0,0 +1,13 @@
+class BigCommerceProductError < StandardError
+  attr_reader :status, :scope, :product_identifier, :data, :original_error
+
+  def initialize(status, scope, message, product_identifier, data, original_error)
+    @status = status
+    @scope = scope
+    @product_identifier = product_identifier
+    @data = data
+    @original_error = original_error
+
+    super(message)
+  end
+end

data/lib/huginn_bigcommerce_product_agent/bigcommerce_product_agent.rb

@@ -185,13 +185,12 @@ module Agents
         bc_products = @product_client.get_by_skus(raw_products.map { |r| r['sku'] })
 
         return bc_products
-      rescue => e
+      rescue BigCommerceProductError => e
         create_event payload: {
-          status: 500,
-          scope: 'lookup_existing_products',
+          status: e.status,
+          scope: e.scope,
           message: e.message,
-          trace: e.backtrace.join('\n'),
-          raw_product: raw_products,
+          data: e.data,
         }
 
         raise e
@@ -206,14 +205,17 @@ module Agents
     def delete_inactive_product(bc_product)
       begin
         @product_client.delete(bc_product['id'])
+      rescue BigCommerceProductError => e
+        emit_error(e)
       rescue => e
-        create_event payload: {
-          status: 500,
-          scope: 'delete_inactive_product',
-          message: e.message,
-          trace: e.backtrace.join('\n'),
-          bc_product: bc_product,
-        }
+        emit_error(BigCommerceProductError.new(
+          500,
+          'delete inactive_product',
+          e.message,
+          bc_product['id'],
+          { sku: bc_product['sku'] },
+          e,
+        ))
       end
     end
 
@@ -224,18 +226,20 @@ module Agents
         custom_fields = map_custom_fields(raw_product, nil)
         bc_payload['custom_fields'] = custom_fields[:upsert]
         return @product_client.create(bc_payload, { include: 'custom_fields' })
+      rescue BigCommerceProductError => e
+        emit_error(e)
       rescue => e
-        create_event payload: {
-          status: 500,
-          scope: 'create_product',
-          message: e.message(),
-          trace: e.backtrace.join('\n'),
-          raw_product: raw_product,
-          product_data: bc_payload,
-        }
-
-        return nil
+        emit_error(BigCommerceProductError.new(
+          500,
+          'create_new_product',
+          e.message,
+          nil,
+          { sku: raw_product['sku'] },
+          e
+        ))
       end
+
+      return nil
     end
 
     # Generates an update payload for the provided product records
@@ -247,15 +251,17 @@ module Agents
         begin
           # Delete custom fields that are no longer used
           @custom_field_client.delete(bc_product['id'], field['id'])
+        rescue BigCommerceProductError => e
+          emit_error(e)
         rescue => e
-          create_event payload: {
-            status: 500,
-            scope: 'delete_custom_fields',
-            message: e.message(),
-            trace: e.backtrace.join('\n'),
-            product_id: bc_product['id'],
-            deletes: custom_fields[:delete]
-          }
+          emit_error(BigCommerceProductError.new(
+            500,
+            'delete_custom_fields',
+            e.message,
+            bc_product['id'],
+            { sku: bc_product['sku'], field_id: field['id'] },
+            e
+          ))
         end
       end
 
@@ -316,14 +322,17 @@ module Agents
             status: 200,
           }
         end
+      rescue BigCommerceProductError => e
+        emit_error(e)
       rescue => e
-        create_event payload: {
-          status: 500,
-          scope: 'upsert_products',
-          message: e.message,
-          trace: e.backtrace.join('\n'),
-          product_data: product_data,
-        }
+        emit_error(BigCommerceProductError.new(
+          500,
+          'upsert_products',
+          e.message,
+          nil,
+          { sku: product_data.map { |p| p['sku'] } },
+          e
+        ))
       end
     end
 
@@ -354,14 +363,17 @@ module Agents
         end
 
         return bc_payload
+      rescue BigCommerceProductError => e
+        emit_error(e)
       rescue => e
-        create_event payload: {
-          status: 500,
-          scope: 'map_product',
-          message: e.message(),
-          trace: e.backtrace.join('\n'),
-          product_payload: bc_payload,
-        }
+        emit_error(BigCommerceProductError.new(
+          500,
+          'map_product',
+          e.message,
+          bc_product['id'],
+          { sku: bc_product['sku'] },
+          e
+        ))
       end
 
       return nil
@@ -375,19 +387,20 @@ module Agents
 
       begin
         return get_mapper(:CustomFieldMapper).map(options['custom_fields_map'], raw_product, bc_payload, current_fields, options['meta_fields_namespace'])
+      rescue BigCommerceProductError => e
+        emit_error(e)
       rescue => e
-        create_event payload: {
-          status: 500,
-          scope: 'map_custom_fields',
-          message: e.message(),
-          trace: e.backtrace.join('\n'),
-          field_map: options['custom_fields_map'],
-          raw_product: raw_product,
-          product_payload: bc_payload,
-        }
-
-        return nil
+        emit_error(BigCommerceProductError.new(
+          500,
+          'map_custom_fields',
+          e.message,
+          bc_payload['id'],
+          { sku: bc_payload['sku'] },
+          e
+        ))
       end
+
+      return nil
     end
 
     #  Manages meta field values for the provided product records.
@@ -398,15 +411,18 @@ module Agents
 
       begin
         current_fields = @meta_field_client.get_for_product(bc_payload['id'])
+      rescue BigCommerceProductError => e
+        emit_error(e)
+        return nil
       rescue => e
-        create_event payload: {
-          status: 500,
-          scope: 'update_meta_fields',
-          message: "Failed to lookup existing meta fields: #{e.message()}",
-          trace: e.backtrace.join('\n'),
-          product_id: bc_payload['id'],
-        }
-
+        emit_error(BigCommerceProductError.new(
+          500,
+          'get_meta_fields',
+          e.message,
+          bc_payload['id'],
+          { sku: bc_payload['sku'] },
+          e
+        ))
         return nil
       end
 
@@ -417,15 +433,17 @@ module Agents
         fields[:delete].each do |field|
             begin
               @meta_field_client.delete(bc_payload['id'], field['id'])
+            rescue BigCommerceProductError => e
+              emit_error(e)
             rescue => e
-              create_event payload: {
-                status: 500,
-                scope: 'update_meta_fields',
-                message: "Failed to delete meta field: #{e.message()}",
-                trace: e.backtrace.join('\n'),
-                product_id: bc_payload['id'],
-                field: field,
-              }
+              emit_error(BigCommerceProductError.new(
+                500,
+                'delete meta_fields',
+                e.message,
+                bc_payload['id'],
+                { sku: bc_payload['sku'] },
+                e
+              ))
             end
         end
 
@@ -433,33 +451,35 @@ module Agents
         fields[:upsert].each do |field|
           begin
             @meta_field_client.upsert(bc_payload['id'], field)
+          rescue BigCommerceProductError => e
+            emit_error(e)
           rescue => e
-            create_event payload: {
-              status: 500,
-              scope: 'update_meta_fields',
-              message: "Failed to update meta field: #{e.message()}",
-              trace: e.backtrace.join('\n'),
-              product_id: bc_payload['id'],
-              field: field,
-            }
+            emit_error(BigCommerceProductError.new(
+              500,
+              'upsert_meta_fields',
+              e.message,
+              bc_payload['id'],
+              { sku: bc_payload['sku'] },
+              e
+            ))
           end
         end
 
         return fields
+      rescue BigCommerceProductError => e
+        emit_error(e)
       rescue => e
-        create_event payload: {
-          status: 500,
-          scope: 'update_meta_fields',
-          message: "Failed to map meta field data: #{e.message()}",
-          trace: e.backtrace.join('\n'),
-          field_map: options['meta_fields_map'],
-          raw_product: raw_product,
-          bc_payload: bc_payload,
-          current_fields: current_fields,
-        }
-
-        return nil
+        emit_error(BigCommerceProductError.new(
+          500,
+          'map_meta_fields',
+          e.message,
+          bc_payload['id'],
+          { sku: bc_payload['sku'] },
+          e
+        ))
       end
+
+      return nil
     end
 
     private
@@ -482,5 +502,26 @@ module Agents
     def get_mapper(class_name)
         return ::BigcommerceProductAgent::Mapper.const_get(class_name.to_sym)
     end
+
+    #  Takes a BigCommerceProductError and emits the underlying data as an error payload
+    #  to assist with error reporting. It is recommended that these errors be consolidated
+    #  with a Digest Agent and reported as a summary.
+    def emit_error(error)
+
+      payload = {
+        status: error.status,
+        message: error.message,
+        scope: error.scope,
+        product_identifier: error.product_identifier,
+        data: error.data,
+      }
+
+      Rails.logger.debug({
+        error: payload,
+        trace: error.backtrace
+      })
+
+      create_event({ payload: payload })
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_bigcommerce_product_agent
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,7 @@ files:
 - lib/client/meta_field.rb
 - lib/client/product.rb
 - lib/huginn_bigcommerce_product_agent.rb
+- lib/huginn_bigcommerce_product_agent/big_commerce_product_error.rb
 - lib/huginn_bigcommerce_product_agent/bigcommerce_product_agent.rb
 - lib/mapper/custom_field_mapper.rb
 - lib/mapper/meta_field_mapper.rb