spree_vpago 2.1.7 → 2.1.9.pre.add.pre.payment.pre.processor.pre.job.pre.logging

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9b031369bbd969fecf293dac288e729fc3fe46b316d533e5878307aaf62fc64
-  data.tar.gz: 0a7aa630380c6c3020852ff420f26565d01f286b3ab8bd1d9e2d4ac62f611f02
+  metadata.gz: '08625418c07e62cfb023d294ccbb6347eef32d80185a062e998c2ff60f40384c'
+  data.tar.gz: 7cb7085798844c5e0f1c988c4d003f8b98c37a484b0cc21b2136b18168be2b17
 SHA512:
-  metadata.gz: f2ec517322a3284bca70a17a68487c85adaff686346f45c35a77cf763d83a8477611549bc146e10d3b0040b92f093096a763b81c53b2efe3d74031ebc67f05b1
-  data.tar.gz: 5f2b0fbfc08abaf632ef7543b8434fe155442d29dbe4c78db996e62f7e7505a73b4c08480c20aef6c72b7c272c6dd770704a866d50898087e5a9658066b430c0
+  metadata.gz: db274532d60f50158835effe14fb965fbe038a717314a24cdb3ac7596c90b32d01aa3a44780596233891f27c56d5cec75a97a0cbaefec8db26cde761b8d11050
+  data.tar.gz: 2385401f1b371a5d4ad19b33c02dce9f2f3b1a0cd92b1366b23887b6e3d6ff225f285e29e5143bf3eae69cf7ae6e1fcaa854eb6a732c5cff13a5c04a21f350ce

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spree_vpago (2.1.7)
+    spree_vpago (2.1.9.pre.add.pre.payment.pre.processor.pre.job.pre.logging)
       faraday
       google-cloud-firestore
       spree_api (>= 4.5)
@@ -128,7 +128,7 @@ GEM
       babel-source (>= 4.0, < 6)
       execjs (~> 2.0)
     base64 (0.3.0)
-    bcrypt (3.1.20)
+    bcrypt (3.1.21)
     bigdecimal (3.1.8)
     bootstrap (4.6.2.1)
       autoprefixer-rails (>= 9.1.0)
@@ -188,7 +188,7 @@ GEM
     faraday-http-cache (2.5.0)
       faraday (>= 0.8)
     faraday-net_http (3.0.2)
-    faraday-retry (2.3.2)
+    faraday-retry (2.4.0)
       faraday (~> 2.0)
     ffaker (2.21.0)
     ffi (1.15.5)
@@ -234,7 +234,7 @@ GEM
       google-cloud-core (~> 1.7)
       google-cloud-firestore-v1 (~> 2.0)
       rbtree (~> 0.4.2)
-    google-cloud-firestore-v1 (2.2.1)
+    google-cloud-firestore-v1 (2.3.0)
       gapic-common (~> 1.2)
       google-cloud-errors (~> 1.0)
       google-cloud-location (~> 1.0)
@@ -242,7 +242,7 @@ GEM
       gapic-common (~> 1.2)
       google-cloud-errors (~> 1.0)
     google-logging-utils (0.2.0)
-    google-protobuf (4.33.2)
+    google-protobuf (4.33.4)
       bigdecimal
       rake (>= 13)
     googleapis-common-protos (1.9.0)
@@ -251,7 +251,7 @@ GEM
       grpc (~> 1.41)
     googleapis-common-protos-types (1.22.0)
       google-protobuf (~> 4.26)
-    googleauth (1.16.0)
+    googleauth (1.16.1)
       faraday (>= 1.0, < 3.a)
       google-cloud-env (~> 2.2)
       google-logging-utils (~> 0.1)

data/app/controllers/spree/vpago_payments_controller.rb

@@ -44,14 +44,15 @@ module Spree
       return render_not_found unless @payment.present?
 
       unless @payment.order.paid?
-        Vpago::PaymentProcessorJob.perform_later(
-          payment_number: @payment.number
-        )
+        enqueued_at = Time.now.to_f
+        log_enqueue_start(@payment, enqueued_at, return_params)
+
+        Vpago::PaymentProcessorJob.perform_later(payment_number: @payment.number, enqueued_at: enqueued_at)
       end
 
       render json: { status: :ok }, status: :ok
     rescue StandardError => e
-      Rails.logger.error("Failed to enqueued payment processor job: #{params} #{e.message}")
+      log_enqueue_error(e)
       render json: { status: :internal_server_error, message: 'Failed to enqueue payment processor job' }, status: :internal_server_error
     end
 
@@ -62,14 +63,21 @@ module Spree
       @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?
+      unless @payment.order.paid?
+        enqueued_at = Time.now.to_f
+        log_enqueue_start(@payment, enqueued_at)
+
+        Vpago::PaymentProcessorJob.perform_later(payment_number: @payment.number, enqueued_at: enqueued_at)
+      end
 
       render json: { status: { code: '000001', message: 'success' }, data: nil }, status: :ok
     rescue StandardError => e
-      Rails.logger.error("Payment error: #{e.message}")
+      log_enqueue_error(e)
       render json: { status: :internal_server_error, message: 'Failed to enqueue payment processor job' }, status: :internal_server_error
     end
 
+    private
+
     def sanitize_return_params
       sanitized_params = params.permit!.to_h
 
@@ -92,5 +100,41 @@ module Spree
         format.json { render json: { status: :unauthorized }, status: :unauthorized }
       end
     end
+
+    def log_enqueue_start(payment, enqueued_at, return_params = {})
+      Rails.logger.info(
+        {
+          event: 'vpago.payment_processor_job.enqueue',
+          payment_number: payment.number,
+          order_number: payment.order&.number,
+          request_id: request.request_id,
+          payment_method_type: payment.payment_method&.type,
+          payment_method_name: payment.payment_method&.name,
+          gateway: detect_payway_gateway_version(payment.payment_method),
+          tran_id: (return_params[:tran_id] || return_params['tran_id']),
+          enqueued_at: enqueued_at
+        }
+      )
+    end
+
+    def log_enqueue_error(error)
+      Rails.logger.error(
+        {
+          event: 'vpago.payment_processor_job.enqueue.error',
+          request_id: request.request_id,
+          payment_number: @payment&.number,
+          error_class: error.class.name,
+          error_message: error.message
+        }
+      )
+    end
+
+    def detect_payway_gateway_version(payment_method)
+      return nil unless payment_method
+      return 'payway_v2' if payment_method.type_payway_v2?
+      return 'payway_v1' if payment_method.type_payway?
+
+      nil
+    end
   end
 end

data/app/controllers/spree/webhook/payways_controller.rb

@@ -4,7 +4,7 @@ module Spree
       skip_before_action :verify_authenticity_token, only: %i[return v2_return continue v2_continue]
 
       # match via: [:get, :post]
-      # {"response"=>"{\"tran_id\":\"PE13LXT1\",\"status\":0"}"}
+      # {"response"=>"{\"tran_id\":\"PE13LXT1\",\"status\":0}"}
       def v2_return
         handler_service = v2_request_updater_service
 
@@ -48,9 +48,11 @@ module Spree
         request_updater.call
 
         order = payment.order
-        order = order.reload
+        order.reload
 
-        if order.paid? || payment.pending?
+        ok = order.paid? || payment.pending?
+
+        if ok
           render plain: :success
         else
           render plain: :failed, status: 400

data/app/jobs/vpago/payment_processor_job.rb

@@ -1,11 +1,54 @@
 # Put :payment_processing at a higher priority in your project: config/sidekiq.yml
+require 'vpago/timing_helper'
+
 module Vpago
   class PaymentProcessorJob < ::ApplicationUniqueJob
     queue_as :payment_processing
 
     def perform(options)
+      started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+      enqueued_at = options[:enqueued_at]
+      queue_wait_ms = if enqueued_at
+                        ((Time.now.to_f - enqueued_at.to_f) * 1000.0).round(1)
+                      end
+
+      Rails.logger.info(
+        {
+          event: 'vpago.payment_processor_job.start',
+          payment_number: options[:payment_number],
+          queue: self.class.queue_name,
+          queue_wait_ms: queue_wait_ms
+        }
+      )
+
       payment = Spree::Payment.find_by!(number: options[:payment_number])
       Vpago::PaymentProcessor.new(payment: payment).call
+
+      runtime_ms = Vpago::TimingHelper.elapsed_ms(started_at)
+      Rails.logger.info(
+        {
+          event: 'vpago.payment_processor_job.finish',
+          payment_number: options[:payment_number],
+          queue: self.class.queue_name,
+          queue_wait_ms: queue_wait_ms,
+          runtime_ms: runtime_ms
+        }
+      )
+    rescue StandardError => e
+      runtime_ms = Vpago::TimingHelper.elapsed_ms(started_at)
+      Rails.logger.error(
+        {
+          event: 'vpago.payment_processor_job.error',
+          payment_number: options[:payment_number],
+          queue: self.class.queue_name,
+          queue_wait_ms: queue_wait_ms,
+          runtime_ms: runtime_ms,
+          error_class: e.class.name,
+          error_message: e.message
+        }
+      )
+      raise
     end
   end
 end

data/app/lib/vpago/timing_helper.rb

@@ -0,0 +1,21 @@
+module Vpago
+  module TimingHelper
+    # Measures elapsed time in milliseconds from a given start timestamp.
+    #
+    # @param started_at [Float] timestamp from Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    # @return [Float] elapsed time in milliseconds, rounded to 1 decimal place
+    def self.elapsed_ms(started_at)
+      ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000.0).round(1)
+    end
+
+    # Yields to a block and measures its execution time in milliseconds.
+    #
+    # @yield the block to measure
+    # @return [Float] elapsed time in milliseconds, rounded to 1 decimal place
+    def self.measure_ms
+      started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      yield
+      elapsed_ms(started_at)
+    end
+  end
+end

data/app/models/spree/payment_method/cash_on.rb

@@ -0,0 +1,15 @@
+module Spree
+  class PaymentMethod::CashOn < ::Spree::PaymentMethod
+    def payment_source_class
+      Spree::VpagoPaymentSource
+    end
+
+    def source_required?
+      true
+    end
+
+    def auto_capture?
+      true
+    end
+  end
+end

data/app/models/vpago/order_decorator.rb

@@ -15,10 +15,13 @@ module Vpago
 
     # override
     def process_payments!
-      super if insufficient_processed_payment?
+      super
 
       # Prevent from reaching :complete state if payment is insufficient
-      errors.add(:base, Spree.t(:insufficient_payment_amount_to_cover_the_total)) if insufficient_processed_payment?
+      return unless insufficient_processed_payment?
+
+      errors.add(:base, Spree.t(:insufficient_payment_amount_to_cover_the_total))
+      false
     end
 
     def insufficient_processed_payment?

data/app/models/vpago/payment_method_decorator.rb

@@ -8,6 +8,7 @@ module Vpago
     TYPE_TRUE_MONEY = 'Spree::Gateway::TrueMoney'.freeze
     TYPE_VATTANAC = 'Spree::Gateway::Vattanac'.freeze
     TYPE_VATTANAC_MINI_APP = 'Spree::Gateway::VattanacMiniApp'.freeze
+    TYPE_CASH_ON = 'Spree::PaymentMethod::CashOn'.freeze
 
     def self.prepended(base)
       base.preference :icon_name, :string, default: 'cheque'
@@ -23,7 +24,8 @@ module Vpago
           Spree::PaymentMethod::TYPE_ACLEDA_MOBILE,
           Spree::PaymentMethod::TYPE_VATTANAC,
           Spree::PaymentMethod::TYPE_VATTANAC_MINI_APP,
-          Spree::PaymentMethod::TYPE_TRUE_MONEY
+          Spree::PaymentMethod::TYPE_TRUE_MONEY,
+          Spree::PaymentMethod::TYPE_CASH_ON
         ]
       end
     end
@@ -101,6 +103,10 @@ module Vpago
       type == Spree::PaymentMethod::TYPE_TRUE_MONEY
     end
 
+    def type_cash_on?
+      type == Spree::PaymentMethod::TYPE_CASH_ON
+    end
+
     def type_check?
       type == 'Spree::PaymentMethod::Check'
     end

data/lib/spree_vpago/engine.rb

@@ -24,7 +24,8 @@ module SpreeVpago
         Spree::Gateway::AcledaMobile,
         Spree::Gateway::Vattanac,
         Spree::Gateway::VattanacMiniApp,
-        Spree::Gateway::TrueMoney
+        Spree::Gateway::TrueMoney,
+        Spree::PaymentMethod::CashOn
       )
     end
 

data/lib/spree_vpago/version.rb

@@ -1,7 +1,7 @@
 module SpreeVpago
   module_function
 
-  VERSION = '2.1.7'.freeze
+  VERSION = '2.1.9-add-payment-processor-job-logging'.freeze
 
   def version
     Gem::Version.new VERSION

data/lib/vpago/payway_v2/base.rb

@@ -143,6 +143,7 @@ module Vpago
         result += return_deeplink if return_deeplink.present?
         result += return_params if return_params.present?
         result += payout if payout.present?
+        result += skip_success_page.to_s if skip_success_page.present?
 
         log_hash_data = "Hash data: #{result}"
         Rails.logger.info(log_hash_data)
@@ -154,6 +155,10 @@ module Vpago
         payload = { order_number: @payment.order.number, order_id: @payment.order.id }
         JWT.encode(payload, @payment.order.token, 'HS256')
       end
+
+      def skip_success_page
+        1
+      end
     end
   end
 end

data/lib/vpago/payway_v2/checkout.rb

@@ -14,6 +14,7 @@ module Vpago
           return_url: return_url,
           continue_success_url: continue_success_url,
           return_params: return_params,
+          skip_success_page: skip_success_page,
           hash: hash_hmac
         }
 

data/lib/vpago/payway_v2/transaction_status.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'vpago/timing_helper'
 
 module Vpago
   module PaywayV2
@@ -35,6 +36,8 @@ module Vpago
       end
 
       def check_remote_status
+        started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
         conn = Faraday::Connection.new do |faraday|
           faraday.request :url_encoded
         end
@@ -46,7 +49,33 @@ module Vpago
           hash: checker_hmac
         }
 
-        conn.post(check_transaction_url, data)
+        response = conn.post(check_transaction_url, data)
+
+        runtime_ms = Vpago::TimingHelper.elapsed_ms(started_at)
+        Rails.logger.info(
+          {
+            event: 'vpago.payway.check_transaction',
+            version: 'v2',
+            payment_number: transaction_id,
+            http_status: response.status,
+            runtime_ms: runtime_ms
+          }
+        )
+
+        response
+      rescue StandardError => e
+        runtime_ms = Vpago::TimingHelper.elapsed_ms(started_at)
+        Rails.logger.error(
+          {
+            event: 'vpago.payway.check_transaction.error',
+            version: 'v2',
+            payment_number: transaction_id,
+            runtime_ms: runtime_ms,
+            error_class: e.class.name,
+            error_message: e.message
+          }
+        )
+        raise
       end
 
       def payout_total

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_vpago
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.1.9.pre.add.pre.payment.pre.processor.pre.job.pre.logging
 platform: ruby
 authors:
 - You
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-11 00:00:00.000000000 Z
+date: 2026-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -188,6 +188,7 @@ files:
 - app/jobs/vpago/payment_capturer_job.rb
 - app/jobs/vpago/payment_processor_job.rb
 - app/jobs/vpago/payment_voider_job.rb
+- app/lib/vpago/timing_helper.rb
 - app/models/.gitkeep
 - app/models/concerns/vpago/payoutable.rb
 - app/models/spree/gateway/acleda.rb
@@ -198,6 +199,7 @@ files:
 - app/models/spree/gateway/vattanac.rb
 - app/models/spree/gateway/vattanac_mini_app.rb
 - app/models/spree/gateway/wing_sdk.rb
+- app/models/spree/payment_method/cash_on.rb
 - app/models/spree/payout.rb
 - app/models/spree/payout_profile.rb
 - app/models/spree/payout_profile_product.rb
@@ -438,9 +440,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
 - none
 rubygems_version: 3.4.1