From 273a2fdb2235c43e21f9fb21df759fc9b4a3b81d Mon Sep 17 00:00:00 2001 From: jar Date: Sat, 31 Oct 2026 03:39:17 +0000 Subject: [PATCH 1/4] Use dedicated v2 search request helper instead of path inference Committed-By-Agent: goose Orbit-Session-Id: bf0045b8-bfc9-4e18-ae11-5f042ce9add7 --- ...1_owner_v2-search-limit-metadata.change.md | 6 +++ lib/stripe/stripe_service.rb | 22 ++++++----- test/stripe/stripe_service_test.rb | 37 ++++++++++++++++++- 3 files changed, 55 insertions(+), 10 deletions(-) create mode 100644 .hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md diff --git a/.hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md b/.hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md new file mode 100644 index 000000000..4dd6bdfcd --- /dev/null +++ b/.hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md @@ -0,0 +1,6 @@ +--- +title: Keep custom search limits in the request body and use dedicated v2 search helpers +semver_level: patch +--- + +Handwritten v2 search services should call `request_v2_search` instead of `request` to send `limit` in the initial URL query. Ordinary requests no longer infer search behavior from the path. diff --git a/lib/stripe/stripe_service.rb b/lib/stripe/stripe_service.rb index 17b2e045c..156c71da5 100644 --- a/lib/stripe/stripe_service.rb +++ b/lib/stripe/stripe_service.rb @@ -10,15 +10,6 @@ def initialize(requestor) def request(method:, path:, base_address:, params: {}, opts: {}) params = params.to_h if params.is_a?(RequestParams) - if method == :post && - path.split("?", 2).first.start_with?("/v2/") && - path.split("?", 2).first.end_with?("/search") && - (params.key?(:limit) || params.key?("limit")) - params = params.dup - limit = params.delete(:limit) || params.delete("limit") - separator = path.include?("?") ? "&" : "?" - path = "#{path}#{separator}limit=#{URI.encode_www_form_component(limit)}" - end @requestor.execute_request( method, path, @@ -29,6 +20,19 @@ def request(method:, path:, base_address:, params: {}, opts: {}) ) end + # V2 search uses POST but sends limit in the URL, not the JSON body. Only add + # it to the initial URL; page URLs already contain their pagination parameters. + # Delegate to the ordinary request path exactly once. + def request_v2_search(method:, path:, base_address:, params: {}, opts: {}) + params = params.to_h if params.is_a?(RequestParams) + params = params.dup + limit = params.delete(:limit) + string_limit = params.delete("limit") + limit ||= string_limit + path = "#{path}?limit=#{URI.encode_www_form_component(limit)}" if !limit.nil? && !path.include?("?") + request(method: method, path: path, base_address: base_address, params: params, opts: opts) + end + def request_stream(method:, path:, base_address:, params: {}, opts: {}, &read_body_chunk_block) @requestor.execute_request_stream( method, diff --git a/test/stripe/stripe_service_test.rb b/test/stripe/stripe_service_test.rb index 888e6766f..d8e2b8c76 100644 --- a/test/stripe/stripe_service_test.rb +++ b/test/stripe/stripe_service_test.rb @@ -84,12 +84,47 @@ class TestV2SearchParams < RequestParams has_entries(params: { query: "widgets" })) .returns([{ object: "v2.search_result", data: [] }, nil]) - service.request( + service.request_v2_search( method: :post, path: "/v2/widgets/search", base_address: :api, params: params ) + assert_equal 2, params.limit + assert_equal "widgets", params.query + end + end + + context "v2 search dispatch" do + [ + ["/v2/widgets/search", { limit: 2, query: "widgets" }, "/v2/widgets/search?limit=2", { query: "widgets" }], + ["/v2/widgets/search", { "limit" => 2, "query" => "widgets" }, "/v2/widgets/search?limit=2", { "query" => "widgets" }], + ["/v2/widgets/search?page=2&limit=2", { limit: 9, query: "widgets" }, "/v2/widgets/search?page=2&limit=2", { query: "widgets" }], + ["/v2/widgets/search?page=2", { limit: 9, query: "widgets" }, "/v2/widgets/search?page=2", { query: "widgets" }], + ["/v2/widgets/search", { query: "widgets" }, "/v2/widgets/search", { query: "widgets" }], + ].each_with_index do |(path, params, expected_path, body), index| + should "prepare and delegate search once for case #{index}" do + service = StripeService.new(nil) + original = params.dup + opts = { stripe_account: "acct_123" } + service.expects(:request).once.with(method: :post, path: expected_path, + base_address: :meter_events, params: body, opts: opts) + service.request_v2_search(method: :post, path: path, params: params, + base_address: :meter_events, opts: opts) + assert_equal original, params + end + end + + should "keep custom search limit in the body and preserve options and usage" do + requestor = APIRequestor.new("sk_test_123") + service = StripeService.new(requestor) + params = { limit: 2, query: "widgets" }.freeze + requestor.expects(:execute_request).once + .with(:post, "/v2/data/operations/search", :api, + has_entries(params: params, opts: has_entries(stripe_account: "acct_123"), + usage: ["stripe_client"])) + service.request(method: :post, path: "/v2/data/operations/search", base_address: :api, + params: params, opts: { stripe_account: "acct_123" }) end end From 8a95379a66b1a41240b33a5d457c87a97382992f Mon Sep 17 00:00:00 2001 From: jar Date: Sat, 31 Oct 2026 03:40:31 +0000 Subject: [PATCH 2/4] Link search fix changefile to its pull request Committed-By-Agent: goose Orbit-Session-Id: bf0045b8-bfc9-4e18-ae11-5f042ce9add7 --- .../changes/2026-10-31_owner_v2-search-limit-metadata.change.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md b/.hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md index 4dd6bdfcd..135c02b9a 100644 --- a/.hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md +++ b/.hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md @@ -1,6 +1,7 @@ --- title: Keep custom search limits in the request body and use dedicated v2 search helpers semver_level: patch +pr_url: https://github.com/stripe/stripe-ruby/pull/2015 --- Handwritten v2 search services should call `request_v2_search` instead of `request` to send `limit` in the initial URL query. Ordinary requests no longer infer search behavior from the path. From 788910c34bcda0414512a7cbbe32a83592038ec2 Mon Sep 17 00:00:00 2001 From: jar-stripe Date: Mon, 2 Nov 2026 08:41:15 -0800 Subject: [PATCH 3/4] Delete .hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md --- .../2026-10-31_owner_v2-search-limit-metadata.change.md | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 .hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md diff --git a/.hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md b/.hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md deleted file mode 100644 index 135c02b9a..000000000 --- a/.hark/changes/2026-10-31_owner_v2-search-limit-metadata.change.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Keep custom search limits in the request body and use dedicated v2 search helpers -semver_level: patch -pr_url: https://github.com/stripe/stripe-ruby/pull/2015 ---- - -Handwritten v2 search services should call `request_v2_search` instead of `request` to send `limit` in the initial URL query. Ordinary requests no longer infer search behavior from the path. From 1078fc706ac547b0d4045259a7d6b921f35f8a80 Mon Sep 17 00:00:00 2001 From: jar Date: Mon, 2 Nov 2026 17:31:19 +0000 Subject: [PATCH 4/4] Rebuild v2 search query from request params Committed-By-Agent: goose Orbit-Session-Id: bf0045b8-bfc9-4e18-ae11-5f042ce9add7 --- lib/stripe/stripe_service.rb | 8 ++++---- test/stripe/stripe_service_test.rb | 5 +++-- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/lib/stripe/stripe_service.rb b/lib/stripe/stripe_service.rb index 156c71da5..260eb7b76 100644 --- a/lib/stripe/stripe_service.rb +++ b/lib/stripe/stripe_service.rb @@ -20,16 +20,16 @@ def request(method:, path:, base_address:, params: {}, opts: {}) ) end - # V2 search uses POST but sends limit in the URL, not the JSON body. Only add - # it to the initial URL; page URLs already contain their pagination parameters. - # Delegate to the ordinary request path exactly once. + # V2 search uses POST but sends limit in the URL, not the JSON body. Rebuild + # the initial query from params; pagination uses the ordinary request path. def request_v2_search(method:, path:, base_address:, params: {}, opts: {}) params = params.to_h if params.is_a?(RequestParams) params = params.dup limit = params.delete(:limit) string_limit = params.delete("limit") limit ||= string_limit - path = "#{path}?limit=#{URI.encode_www_form_component(limit)}" if !limit.nil? && !path.include?("?") + path = path.split("?", 2).first + path = "#{path}?limit=#{URI.encode_www_form_component(limit)}" unless limit.nil? request(method: method, path: path, base_address: base_address, params: params, opts: opts) end diff --git a/test/stripe/stripe_service_test.rb b/test/stripe/stripe_service_test.rb index d8e2b8c76..3cc41c184 100644 --- a/test/stripe/stripe_service_test.rb +++ b/test/stripe/stripe_service_test.rb @@ -99,8 +99,9 @@ class TestV2SearchParams < RequestParams [ ["/v2/widgets/search", { limit: 2, query: "widgets" }, "/v2/widgets/search?limit=2", { query: "widgets" }], ["/v2/widgets/search", { "limit" => 2, "query" => "widgets" }, "/v2/widgets/search?limit=2", { "query" => "widgets" }], - ["/v2/widgets/search?page=2&limit=2", { limit: 9, query: "widgets" }, "/v2/widgets/search?page=2&limit=2", { query: "widgets" }], - ["/v2/widgets/search?page=2", { limit: 9, query: "widgets" }, "/v2/widgets/search?page=2", { query: "widgets" }], + ["/v2/widgets/search?page=2&limit=2", { limit: 9, query: "widgets" }, "/v2/widgets/search?limit=9", { query: "widgets" }], + ["/v2/widgets/search?page=2", { limit: 9, query: "widgets" }, "/v2/widgets/search?limit=9", { query: "widgets" }], + ["/v2/widgets/search?limit=2&unused=value", { query: "widgets" }, "/v2/widgets/search", { query: "widgets" }], ["/v2/widgets/search", { query: "widgets" }, "/v2/widgets/search", { query: "widgets" }], ].each_with_index do |(path, params, expected_path, body), index| should "prepare and delegate search once for case #{index}" do