[PDE-3241] accept dot notation by jazziining · Pull Request #18 · HiMamaInc/payrix

jazziining · 2026-05-16T03:53:26Z

Summary
Enhance the Payrix search query builder to support nested field paths using dot notation syntax

Changes

Added support for nested search fields using dot notation:

"merchant.entity.login.division"

Improve timeout to be 60 seconds

Testing
Current search query should continue to work, add the following code in bin/console

cad_options = {:region=>:ca, :api_key=>API_KEY}
start_date = Time.now - (8 * 24 * 60 * 60)
end_date = Time.now
filter = ::Payrix::Search.and(
  ::Payrix::Search.greater(:returned, start_date.strftime('%Y%m%d').to_i),
  ::Payrix::Search.less(:returned, end_date.strftime('%Y%m%d').to_i),
)
::Payrix::Txn.list(filter, cad_options).auto_paging_map(&:id)

Run bin/console, it should return a list of txn ids

New search query should work, add the following code in bin/console

cad_options = {:region=>:ca, :api_key=>API_KEY}
start_date = Time.now - (8 * 24 * 60 * 60)
end_date = Time.now
filter = ::Payrix::Search.and(
  ::Payrix::Search.equals('merchant.entity.login.division', DIVISION_ID),
  ::Payrix::Search.greater(:returned, start_date.strftime('%Y%m%d').to_i),
  ::Payrix::Search.less(:returned, end_date.strftime('%Y%m%d').to_i),
)
::Payrix::Txn.list(filter, cad_options).auto_paging_map(&:id)

Run bin/console, it should return a list of txn ids

jazziining · 2026-05-16T04:56:20Z


          connection.headers = headers
-          connection.options.timeout = timeout
+          connection.options.timeout = 60


We have been experiencing timeout issues with certain Payrix requests. When testing via curl, some requests can still fail even after ~120s. Payrix suggested that including the division ID may improve query performance, and initial testing shows response times improving to ~20s.

To improve reliability and accommodate slower queries, I am increasing the request timeout to 60s for now.

jazziining · 2026-05-16T05:01:14Z

+          parts
+            .map { |part| "[#{Payrix::Util.camel_case(part)}]" }
+            .join
+        end


The original implementation always wrapped the key with an [], which could lead to double-wrapping when the field was already partially formatted.

The goal of this change is to treat string inputs using dot notation (e.g. "merchant.entity.login.division") as a structured field path. These strings are parsed into an array of segments and then consistently formatted into the expected bracketed query structure.

This ensures:

Symbol inputs remain supported for simple fields

Dot notation strings are correctly parsed into nested fields

Do not unintentionally double-wrapped nested fields

Copilot

Pull request overview

Enhances the Payrix search query builder to support nested field paths via dot-notation (e.g., "merchant.entity.login.division") and adjusts HTTP request timeout behavior.

Changes:

Add dot-notation rendering for search fields in Payrix::RequestOptions::Search::Atom.
Update Faraday request timeout configuration to 60 seconds.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
lib/payrix/request_options/search/atom.rb	Adds dot-notation support by rendering nested field paths into bracketed query syntax.
lib/payrix/http/request.rb	Changes Faraday timeout configuration (currently hard-codes request timeout to 60s).

Comments suppressed due to low confidence (1)

lib/payrix/request_options/search/atom.rb:66

Dot-notation fields are split on '.', but there’s no validation that each segment is non-empty. Inputs like "merchant..division" or ".division" will produce empty path components (e.g., "[]") in the rendered query, which is very likely to generate invalid SEARCH filters. Consider tightening validate_field (only when the field is a dot-notation String) to reject strings with empty segments.

        def rendered_field(prefix)
          return Payrix::Util.camel_case(@field.to_s) unless @field.is_a?(String) && @field.include?('.')

          dot_field(prefix.empty?)
        end

        def dot_field(unprefixed)
          parts = @field.split('.').map { |part| Payrix::Util.camel_case(part) }

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+          connection.options.timeout = 60
          connection.options.open_timeout = timeout


Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

      end
    end

+    context 'when the field is dot notation with empty segments at the binning' do


+      end
+    end
+
+    context 'when the field is a dotted string and the prefix is a non empty string' do


pdmholden · 2026-05-19T18:19:28Z

      include Singleton

-      def send_http(method, base_url, endpoint, data = {}, headers = {}, timeout = 30)
+      def send_http(method, base_url, endpoint, data = {}, headers = {}, timeout = 60)


Wait, what?

Some queries are taking over 20 seconds, so I felt that 30 seconds might still lead to timeouts. That’s why I increased it to 60 seconds.

I'm not convinced we should do that, but I'll leave it to you.

I can reduce it to 30 seconds first and see how the query performs, then increase it again if we still encounter timeouts.

pdmholden · 2026-05-19T19:51:05Z

-            "#{field}[#{@operator}]=#{@value}"
+          if prefix.empty?
+            "#{formatted_field}[#{@operator}]=#{@value}"
+          elsif formatted_field.start_with?('[')


What's this branch for?

so the dot notation field will be formatted to something like [merchant][entity][login][division][equals] when it formatted to something start with [ then we do not want to add an outter [].

pdmholden

Question: why do we need to accept dot notation?

I think we should bump the version number to 1.2.0. This is not a breaking change, but it is more than a patch. We need to resume updating the version number, which we haven't done in three years.

pdmholden · 2026-05-19T20:32:09Z

      include Singleton

-      def send_http(method, base_url, endpoint, data = {}, headers = {}, timeout = 30)
+      def send_http(method, base_url, endpoint, data = {}, headers = {}, timeout = 60)


I'm not convinced we should do that, but I'll leave it to you.

jazziining · 2026-05-19T20:47:22Z

Question: why do we need to accept dot notation?

I think we should bump the version number to 1.2.0. This is not a breaking change, but it is more than a patch. We need to resume updating the version number, which we haven't done in three years.

Our current implementation only accepts a single field for filtering, represented as a symbol or string:

::Payrix::Search.less(:returned, end_date.strftime('%Y%m%d').to_i)

Here, :returned is the field and end_date is the value we’re matching against.

The division id filter is different because it’s a nested field:

merchant[entity][login][division][equals]=p1_div_

Since this is not a single symbol or string, we would need to support either dot notation like:
'merchant.entity.login.division'
or bracket notation like:
'[merchant][entity][login][division]'.
That would allow us to do something like:
::Payrix::Search.equals('merchant.entity.login.division', DIVISION_ID),

Also, I agree with the version suggestion

pdmholden

Can you update the version.rb? 🙏

pdmholden

Everything works according to the test plan. I regret to acknowledge that the 60s timeout may be necessary for the US server. 😭

For the record, I tested with production for both :ca and :us regions.

pdmholden · 2026-05-19T22:20:32Z

      include Singleton

-      def send_http(method, base_url, endpoint, data = {}, headers = {}, timeout = 30)
+      def send_http(method, base_url, endpoint, data = {}, headers = {}, timeout = 60)


I do not approve of this. LOL.

pdmholden · 2026-05-19T22:25:22Z


 module Payrix
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'


Oh, maybe this should be 1.1.0. I don't know why I thought it should be 1.2.0. 🤦

Sorry, I wasn't thinking either. 🙏 ♻️

jazziining added 2 commits May 14, 2026 00:51

update atom to allow dot notation tyle of search

f85db58

delete idea file

15b431c

jazziining self-assigned this May 16, 2026

jazziining added the enhancement New feature or request label May 16, 2026

increase timeout to 60

7f737b2

jazziining force-pushed the PDE-3241/accept-dot-notation branch from b490dd7 to 7f737b2 Compare May 16, 2026 04:51

jazziining commented May 16, 2026

View reviewed changes

Stop tracking .idea

e00c74c

jazziining requested a review from Copilot May 17, 2026 07:33

Copilot started reviewing on behalf of jazziining May 17, 2026 07:34 View session

Copilot AI reviewed May 17, 2026

View reviewed changes

Comment thread lib/payrix/http/request.rb Outdated

Comment on lines 19 to 20

connection.options.timeout = 60

connection.options.open_timeout = timeout

Comment thread lib/payrix/request_options/search/atom.rb

jazziining added 4 commits May 17, 2026 22:51

add spec

5e4d80a

Stop tracking .idea

5ce0f1f

add validation for dot notation

cf16645

Stop tracking .idea

22b4f17

jazziining requested a review from Copilot May 18, 2026 03:55

Copilot started reviewing on behalf of jazziining May 18, 2026 03:56 View session

jazziining requested a review from pdmholden May 18, 2026 03:57

jazziining marked this pull request as ready for review May 18, 2026 03:57

Copilot AI reviewed May 18, 2026

View reviewed changes

jazziining added 5 commits May 18, 2026 00:04

fix typos

5a148b1

Stop tracking .idea

a27bc70

Update changelog

73e1fcf

Stop tracking .idea

b8bb76b

update readme

e45b8a7

pdmholden reviewed May 19, 2026

View reviewed changes

change timeout back to 30s

61e2cc8

jazziining force-pushed the PDE-3241/accept-dot-notation branch from 6cf0770 to 61e2cc8 Compare May 19, 2026 21:22

pdmholden reviewed May 19, 2026

View reviewed changes

change timeout back to 60s

7b3ba67

pdmholden reviewed May 19, 2026

View reviewed changes

update the version number

74f7ac1

jazziining force-pushed the PDE-3241/accept-dot-notation branch from f591f02 to 74f7ac1 Compare May 19, 2026 22:29

pdmholden approved these changes May 19, 2026

View reviewed changes

jazziining merged commit c6285fd into main May 20, 2026
5 checks passed

		connection.options.timeout = 60
		connection.options.open_timeout = timeout

Conversation

jazziining commented May 16, 2026 • edited by pdmholden Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pdmholden left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jazziining commented May 19, 2026

Uh oh!

pdmholden left a comment

Choose a reason for hiding this comment

Uh oh!

pdmholden left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jazziining commented May 16, 2026 •

edited by pdmholden

Loading

pdmholden left a comment •

edited

Loading