spree_vpago 2.3.2 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40b1b2417da2209fc3545dc75fb99354e9fd009adc565d3c4d920b59f18c4655
-  data.tar.gz: dbb1754379d9378dcbfb9fb1d225b7c73628475ae1155e1ad5b198df1e323535
+  metadata.gz: 4e73bfb9e0eac7606f41017d8ca6c90e9853296a588f4fccd305331ec4c0c6bc
+  data.tar.gz: d8180f240e40c47b8983c460892079d2d954638a486855deda122e7971c90bed
 SHA512:
-  metadata.gz: 007761d54598f02ee411f16962eec6ad167eb5eb4623f11f27c8e278e05b2fbc023f71ef4ed3e8eb723870692d83d25155f3fffd85d9fd7880057a9fa1ba2791
-  data.tar.gz: a5ddf6866c3905d6b12224388e9a1b91ad3b19dbdd7fa6dfd936b23227081d8910820795678fac206a7384066e479ae851a23f75dd035abd62abcf47d9e25446
+  metadata.gz: 34e2bd88bce6cb6a090d57fe8e6ea7c9ade90f813d834c998a66a697a96b881700ac084b78dd1074a9ec62d63a87d77942f421a25d9f6c046272526a6a407231
+  data.tar.gz: 231f3bdd5f51c7dd42b78dd1e93b45937031e32abf49383388f4c62c57de4668d2b64dd9bb89fa6f81d325a25db760c7daaa296b2dc5d69c64ee94b9b3badebf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spree_vpago (2.3.2)
+    spree_vpago (2.3.4)
       faraday
       google-cloud-firestore
       spree_api (>= 4.5)

data/app/controllers/spree/vpago_payments_controller.rb

@@ -17,7 +17,7 @@ module Spree
 
       @order = @payment.order
 
-      Rails.logger.info("[Vpago][#{@payment.number}] Showing checkout page for order #{@order.number}")
+      VpagoLogger.log(label: 'Spree::VpagoPaymentsController#checkout', data: vpago_log_context)
     end
 
     # GET
@@ -27,7 +27,7 @@ module Spree
 
       @order = @payment.order
 
-      Rails.logger.info("[Vpago][#{@payment.number}] Showing processing page for order #{@order.number}")
+      VpagoLogger.log(label: 'Spree::VpagoPaymentsController#processing', data: vpago_log_context)
     end
 
     # GET
@@ -38,7 +38,7 @@ module Spree
       @order = @payment.order
       raise CanCan::AccessDenied unless @order.completed?
 
-      Rails.logger.info("[Vpago][#{@payment.number}] Showing success page for order #{@order.number}")
+      VpagoLogger.log(label: 'Spree::VpagoPaymentsController#success', data: vpago_log_context)
     end
 
     # GET
@@ -49,20 +49,21 @@ module Spree
       return render json: { status: :success }, status: :ok if @payment.completed?
       return render json: { status: :failed }, status: :ok if @payment.failed?
 
-      if @payment.payment_method.support_check_transaction_api?
-        Rails.logger.info("[Vpago][#{@payment.number}] Checking transaction for payment #{@payment.number}")
-        checker = @payment.payment_method.check_transaction(@payment)
-        Rails.logger.info("[Vpago][#{@payment.number}] Check transaction result for payment #{@payment.number} with success: #{checker.success?}, failed: #{checker.try(:failed?)}")
-
-        if checker.success?
-          render json: { status: :success }, status: :ok
-        elsif checker.try(:failed?) == true
-          render json: { status: :failed }, status: :ok
-        else
-          render json: { status: :pending }, status: :ok
-        end
+      unless @payment.payment_method.support_check_transaction_api?
+        VpagoLogger.log(label: 'Spree::VpagoPaymentsController#check_transaction unsupported', data: vpago_log_context)
+        return render json: { status: :pending }, status: :ok
+      end
+
+      checker = VpagoLogger.log(
+        label: 'Spree::VpagoPaymentsController#check_transaction',
+        data: vpago_log_context
+      ) { @payment.payment_method.check_transaction(@payment) }
+
+      if checker.success?
+        render json: { status: :success }, status: :ok
+      elsif checker.try(:failed?) == true
+        render json: { status: :failed }, status: :ok
       else
-        Rails.logger.info("[Vpago][#{@payment.number}] Payment method does not support check transaction API")
         render json: { status: :pending }, status: :ok
       end
     end
@@ -75,30 +76,35 @@ module Spree
       @payment = Vpago::PaymentFinder.new(return_params).find_and_verify
 
       if @payment.nil?
-        Rails.logger.error("[Vpago] Payment not found for params: #{return_params}")
+        VpagoLogger.error(
+          label: 'Spree::VpagoPaymentsController#process_payment payment_not_found',
+          data: vpago_log_context(params: return_params)
+        )
         return render_not_found
       end
 
-      Rails.logger.info("[Vpago][#{@payment.number}] Payment found: #{@payment&.number}, order: #{@payment&.order&.number}")
+      VpagoLogger.log(label: 'Spree::VpagoPaymentsController#process_payment payment_found', data: vpago_log_context)
 
       # for ABA reviewing mode, we can disable pushback from bank, and only process it from our app UI instead.
       # This will give ABA team to know that we don't rely on just pushback and have fallback to process payment.
       if @payment.payment_method.type_payway_v2? && @payment.payment_method.reviewing_mode? && request_from_external_server?
-        Rails.logger.info("[Vpago][#{@payment.number}] Received payment notification from bank in reviewing mode, skipping processing")
+        VpagoLogger.log(label: 'Spree::VpagoPaymentsController#process_payment skipped_reviewing_mode', data: vpago_log_context)
         return render json: { status: :ok }, status: :ok
       end
 
       unless @payment.order.paid?
-        Rails.logger.info("[Vpago][#{@payment.number}] Enqueuing payment processor job for payment #{@payment.number}")
-        Vpago::PaymentProcessorJob.perform_later(
-          payment_number: @payment.number
-        )
+        VpagoLogger.log(
+          label: 'Spree::VpagoPaymentsController#process_payment enqueue_payment_processor_job',
+          data: vpago_log_context
+        ) { Vpago::PaymentProcessorJob.perform_later(payment_number: @payment.number) }
       end
 
-      Rails.logger.info("[Vpago][#{@payment.number}] Successfully enqueued payment processor job for payment #{@payment.number}")
       render json: { status: :ok }, status: :ok
     rescue StandardError => e
-      Rails.logger.error("[Vpago][#{@payment&.number}] Failed to enqueue payment processor job: #{e.message}")
+      VpagoLogger.error(
+        label: 'Spree::VpagoPaymentsController#process_payment failed',
+        data: vpago_log_context(error_class: e.class.name, error_message: e.message, backtrace: e.backtrace&.first(5))
+      )
       render json: { status: :internal_server_error, message: 'Failed to enqueue payment processor job' }, status: :internal_server_error
     end
 
@@ -107,14 +113,28 @@ module Spree
       return render json: { status: { code: '000001', message: 'success' }, data: nil }, status: :ok if request.method != 'POST'
 
       @payment = Spree::Payment.find_by(number: params.dig(:data, :external_ref_id))
-      return render_not_found unless @payment
 
-      Vpago::PaymentProcessorJob.perform_later(payment_number: @payment.number) unless @payment.order.paid?
-      Rails.logger.info("[Vpago][#{@payment.number}] Successfully enqueued payment processor job for payment #{@payment.number}")
+      if @payment.nil?
+        VpagoLogger.error(
+          label: 'Spree::VpagoPaymentsController#true_money_process_payment payment_not_found',
+          data: vpago_log_context(external_ref_id: params.dig(:data, :external_ref_id))
+        )
+        return render_not_found
+      end
+
+      unless @payment.order.paid?
+        VpagoLogger.log(
+          label: 'Spree::VpagoPaymentsController#true_money_process_payment enqueue_payment_processor_job',
+          data: vpago_log_context
+        ) { Vpago::PaymentProcessorJob.perform_later(payment_number: @payment.number) }
+      end
 
       render json: { status: { code: '000001', message: 'success' }, data: nil }, status: :ok
     rescue StandardError => e
-      Rails.logger.error("[Vpago][#{@payment&.number}] Failed to enqueue payment processor job: #{e.message}")
+      VpagoLogger.error(
+        label: 'Spree::VpagoPaymentsController#true_money_process_payment failed',
+        data: vpago_log_context(error_class: e.class.name, error_message: e.message, backtrace: e.backtrace&.first(5))
+      )
       render json: { status: :internal_server_error, message: 'Failed to enqueue payment processor job' }, status: :internal_server_error
     end
 
@@ -144,5 +164,17 @@ module Spree
     def request_from_external_server?
       params[:internal_client].blank? || params[:internal_client] == 'false'
     end
+
+    def vpago_log_context(extra = {})
+      {
+        timestamp: Time.current.utc.iso8601(3),
+        remote_ip: request.remote_ip,
+        payment_number: @payment&.number,
+        order_number: @payment&.order&.number,
+        payment_method_type: @payment&.payment_method&.type,
+        payment_method_name: @payment&.payment_method&.name,
+        request_id: request.request_id
+      }.merge(extra)
+    end
   end
 end

data/app/jobs/vpago/payment_processor_job.rb

@@ -5,7 +5,22 @@ module Vpago
 
     def perform(options)
       payment = Spree::Payment.find_by!(number: options[:payment_number])
-      Vpago::PaymentProcessor.new(payment: payment).call
+
+      VpagoLogger.log(
+        label: 'Vpago::PaymentProcessorJob#perform',
+        data: {
+          payment_number: payment.number,
+          order_number: payment.order.number,
+          payment_method_type: payment.payment_method.type,
+          payment_method_name: payment.payment_method.name
+        }
+      ) { Vpago::PaymentProcessor.new(payment: payment).call }
+    rescue StandardError => e
+      VpagoLogger.error(
+        label: 'Vpago::PaymentProcessorJob#perform failed',
+        data: { payment_number: options[:payment_number], error_class: e.class.name, error_message: e.message, backtrace: e.backtrace&.first(5) }
+      )
+      raise
     end
   end
 end

data/app/services/vpago/payment_processable.rb

@@ -24,17 +24,18 @@ module Vpago
       :unable_to_complete_order
     end
 
-    # example.
-    # Started Vpago::PaymentProcessor#process_payment! for payment_number: PX81YZX with args: {}
-    # Completed Vpago::PaymentProcessor#process_payment! for payment_number: PX81YZX in 2000ms
-    def log_process(method, *args)
-      start_time = Time.now
-      Rails.logger.error("Started #{self.class}##{method} for payment_number: #{@payment.number} with args: #{args}")
-
-      yield
-
-      duration_ms = (Time.now - start_time) * 1000
-      Rails.logger.error("Completed #{self.class}##{method} for payment_number: #{@payment.number} in #{duration_ms}ms")
+    def log_process(method, *args, &)
+      VpagoLogger.log(
+        label: "#{self.class.name}##{method}",
+        data: {
+          payment_number: @payment.number,
+          order_number: @payment.order.number,
+          payment_method_type: @payment.payment_method.type,
+          payment_method_name: @payment.payment_method.name,
+          args: args
+        },
+        &
+      )
     end
 
     def user_informer

data/lib/spree_vpago/version.rb

@@ -1,7 +1,7 @@
 module SpreeVpago
   module_function
 
-  VERSION = '2.3.2'.freeze
+  VERSION = '2.3.4'.freeze
 
   def version
     Gem::Version.new VERSION

data/lib/vpago_logger.rb

@@ -0,0 +1,59 @@
+# lib/vpago_logger.rb
+module VpagoLogger
+  def self.log(label:, data: nil)
+    message = { label: label, data: safe_serialize(data) }
+    start_time = Time.current
+    Rails.logger.info(message.to_json)
+
+    return unless block_given?
+
+    # Capture the block's return value and return it to preserve existing behavior for callers expecting that value.
+    block_result = yield
+
+    message[:start_time] = start_time.iso8601(3)
+    message[:duration_ms] = (Time.current - start_time) * 1000
+    message[:result] = safe_serialize(block_result)
+    Rails.logger.info(message.to_json)
+    block_result
+  end
+
+  def self.error(label:, data: nil)
+    message = {
+      label: label,
+      data: safe_serialize(data)
+    }
+
+    Rails.logger.error(message.to_json)
+  end
+
+  # Safely serializes objects for JSON logging.
+  #
+  # @param obj [Object] The object to serialize
+  # @param depth [Integer] Internal parameter tracking recursion depth (max: 50)
+  # @return [Object] A JSON-safe representation of the input object
+  def self.safe_serialize(obj, depth: 0)
+    return '[Max Depth Exceeded]' if depth > 50
+
+    if obj.is_a?(Hash)
+      obj.each_with_object({}) do |(k, v), memo|
+        memo[safe_serialize(k, depth: depth + 1)] = safe_serialize(v, depth: depth + 1)
+      end
+    elsif obj.is_a?(Array)
+      obj.map { |item| safe_serialize(item, depth: depth + 1) }
+    elsif obj.is_a?(Date)
+      obj.iso8601
+    elsif obj.is_a?(Time) || obj.is_a?(DateTime) || obj.is_a?(ActiveSupport::TimeWithZone)
+      obj.iso8601(3)
+    elsif obj.is_a?(ActiveJob::Base)
+      {
+        job_class: obj.class.name,
+        job_id: obj.job_id,
+        arguments: safe_serialize(obj.arguments, depth: depth + 1)
+      }
+    elsif obj.respond_to?(:id)
+      { class: obj.class.name, id: obj.id }
+    else
+      obj.to_s
+    end
+  end
+end

data/node_modules/.yarn-integrity

@@ -1,5 +1,5 @@
 {
-  "systemParams": "linux-x64-115",
+  "systemParams": "linux-x64-127",
   "modulesFolders": [
     "node_modules"
   ],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_vpago
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.4
 platform: ruby
 authors:
 - You
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-07 00:00:00.000000000 Z
+date: 2026-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -421,6 +421,7 @@ files:
 - lib/vpago/wing_sdk/payment_retriever.rb
 - lib/vpago/wing_sdk/transaction_status_checker.rb
 - lib/vpago/wing_sdk/transaction_status_response.rb
+- lib/vpago_logger.rb
 - node_modules/.yarn-integrity
 - package-lock.json
 - package.json