🌐 AI搜索 & 代理 主页
Skip to content

Commit d8dd636

Browse files
xavdid-stripexavdid-stripe
authored
Fix stripe-context not being included in subsequent list requests (stripe#1660)
* fix stripe-context getting dropped from subsequent requests * rename _replace_options and centralize keys
1 parent 4117aaa commit d8dd636

File tree

6 files changed

+153
-15
lines changed

6 files changed

+153
-15
lines changed

‎stripe/_api_requestor.py‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,11 @@
4242
StripeStreamResponse,
4343
StripeStreamResponseAsync,
4444
)
45-
from stripe._request_options import RequestOptions, merge_options
45+
from stripe._request_options import (
46+
PERSISTENT_OPTIONS_KEYS,
47+
RequestOptions,
48+
merge_options,
49+
)
4650
from stripe._requestor_options import (
4751
RequestorOptions,
4852
_GlobalRequestorOptions,
@@ -121,12 +125,15 @@ def _get_http_client(self) -> HTTPClient:
121125
return stripe.default_http_client
122126
return client
123127

124-
def _replace_options(
128+
def _new_requestor_with_options(
125129
self, options: Optional[RequestOptions]
126130
) -> "_APIRequestor":
131+
"""
132+
Returns a new _APIRequestor instance with the same HTTP client but a (potentially) updated set of options. Useful for ensuring the original isn't modified, but any options the original had are still used.
133+
"""
127134
options = options or {}
128135
new_options = self._options.to_dict()
129-
for key in ["api_key", "stripe_account", "stripe_version"]:
136+
for key in PERSISTENT_OPTIONS_KEYS:
130137
if key in options and options[key] is not None:
131138
new_options[key] = options[key]
132139
return _APIRequestor(
@@ -165,7 +172,9 @@ def _global_instance(cls):
165172
def _global_with_options(
166173
**params: Unpack[RequestOptions],
167174
) -> "_APIRequestor":
168-
return _APIRequestor._global_instance()._replace_options(params)
175+
return _APIRequestor._global_instance()._new_requestor_with_options(
176+
params
177+
)
169178

170179
@classmethod
171180
def _format_app_info(cls, info):
@@ -187,7 +196,7 @@ def request(
187196
usage: Optional[List[str]] = None,
188197
) -> "StripeObject":
189198
api_mode = get_api_mode(url)
190-
requestor = self._replace_options(options)
199+
requestor = self._new_requestor_with_options(options)
191200
rbody, rcode, rheaders = requestor.request_raw(
192201
method.lower(),
193202
url,
@@ -221,7 +230,7 @@ async def request_async(
221230
usage: Optional[List[str]] = None,
222231
) -> "StripeObject":
223232
api_mode = get_api_mode(url)
224-
requestor = self._replace_options(options)
233+
requestor = self._new_requestor_with_options(options)
225234
rbody, rcode, rheaders = await requestor.request_raw_async(
226235
method.lower(),
227236
url,

‎stripe/_error_object.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def refresh_from(
3939
values=values,
4040
partial=partial,
4141
last_response=last_response,
42-
requestor=self._requestor._replace_options(
42+
requestor=self._requestor._new_requestor_with_options(
4343
{
4444
"api_key": api_key,
4545
"stripe_version": stripe_version,
@@ -102,7 +102,7 @@ def refresh_from(
102102
values=values,
103103
partial=partial,
104104
last_response=last_response,
105-
requestor=self._requestor._replace_options(
105+
requestor=self._requestor._new_requestor_with_options(
106106
{
107107
"api_key": api_key,
108108
"stripe_version": stripe_version,

‎stripe/_request_options.py‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,18 @@ def merge_options(
5454
}
5555

5656

57+
PERSISTENT_OPTIONS_KEYS = {
58+
"api_key",
59+
"stripe_version",
60+
"stripe_account",
61+
"stripe_context",
62+
}
63+
"""
64+
These are the keys in RequestOptions that should persist across requests made
65+
by the same requestor.
66+
"""
67+
68+
5769
def extract_options_from_dict(
5870
d: Optional[Mapping[str, Any]],
5971
) -> Tuple[RequestOptions, Dict[str, Any]]:

‎stripe/_stripe_object.py‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@
2727
StripeStreamResponseAsync,
2828
)
2929
from stripe._encode import _encode_datetime # pyright: ignore
30-
from stripe._request_options import extract_options_from_dict
30+
from stripe._request_options import (
31+
PERSISTENT_OPTIONS_KEYS,
32+
extract_options_from_dict,
33+
)
3134
from stripe._api_mode import ApiMode
3235
from stripe._base_address import BaseAddress
3336

@@ -152,8 +155,10 @@ def update( # pyright: ignore
152155
if not TYPE_CHECKING:
153156

154157
def __setattr__(self, k, v):
155-
if k in {"api_key", "stripe_account", "stripe_version"}:
156-
self._requestor = self._requestor._replace_options({k: v})
158+
if k in PERSISTENT_OPTIONS_KEYS:
159+
self._requestor = self._requestor._new_requestor_with_options(
160+
{k: v}
161+
)
157162
return None
158163

159164
if k[0] == "_" or k in self.__dict__:
@@ -303,7 +308,7 @@ def refresh_from(
303308
values=values,
304309
partial=partial,
305310
last_response=last_response,
306-
requestor=self._requestor._replace_options( # pyright: ignore[reportPrivateUsage]
311+
requestor=self._requestor._new_requestor_with_options( # pyright: ignore[reportPrivateUsage]
307312
{
308313
"api_key": api_key,
309314
"stripe_version": stripe_version,

‎tests/api_resources/test_list_object.py‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import stripe
66
from stripe._util import convert_to_stripe_object
77
from stripe._stripe_object import StripeObject
8+
from tests.http_client_mock import HTTPClientMock
89

910

1011
class TestListObject(object):
@@ -522,6 +523,115 @@ def test_forwards_api_key_to_nested_resources(self, http_client_mock):
522523

523524
# assert seen == ["prod_001", "prod_002"]
524525

526+
def test_iter_with_stripe_account(self, http_client_mock: HTTPClientMock):
527+
http_client_mock.stub_request(
528+
"get",
529+
path="/v1/customers",
530+
rbody='{"object": "list", "data": [{"id": "cus_001", "object": "customer"}], "url": "/v1/customers", "has_more": true}',
531+
)
532+
http_client_mock.stub_request(
533+
"get",
534+
path="/v1/customers",
535+
query_string="starting_after=cus_001",
536+
rbody='{"object": "list", "data": [{"id": "cus_002", "object": "customer"}], "url": "/v1/customers", "has_more": false}',
537+
)
538+
539+
cu_list = stripe.Customer.list(
540+
api_key="org_key_abc",
541+
stripe_account="ctx_123",
542+
)
543+
544+
customers = [item.id for item in cu_list.auto_paging_iter()]
545+
assert customers == ["cus_001", "cus_002"]
546+
547+
http_client_mock.assert_requested(
548+
"get",
549+
path="/v1/customers",
550+
api_key="org_key_abc",
551+
stripe_account="ctx_123",
552+
)
553+
http_client_mock.assert_requested(
554+
"get",
555+
path="/v1/customers",
556+
query_string="starting_after=cus_001",
557+
api_key="org_key_abc",
558+
stripe_account="ctx_123",
559+
)
560+
561+
def test_iter_with_stripe_context(self, http_client_mock: HTTPClientMock):
562+
http_client_mock.stub_request(
563+
"get",
564+
path="/v1/customers",
565+
rbody='{"object": "list", "data": [{"id": "cus_001", "object": "customer"}], "url": "/v1/customers", "has_more": true}',
566+
)
567+
http_client_mock.stub_request(
568+
"get",
569+
path="/v1/customers",
570+
query_string="starting_after=cus_001",
571+
rbody='{"object": "list", "data": [{"id": "cus_002", "object": "customer"}], "url": "/v1/customers", "has_more": false}',
572+
)
573+
574+
cu_list = stripe.Customer.list(
575+
api_key="org_key_abc",
576+
stripe_context="ctx_123",
577+
)
578+
579+
customers = [item.id for item in cu_list.auto_paging_iter()]
580+
assert customers == ["cus_001", "cus_002"]
581+
582+
http_client_mock.assert_requested(
583+
"get",
584+
path="/v1/customers",
585+
api_key="org_key_abc",
586+
stripe_context="ctx_123",
587+
)
588+
http_client_mock.assert_requested(
589+
"get",
590+
path="/v1/customers",
591+
query_string="starting_after=cus_001",
592+
api_key="org_key_abc",
593+
stripe_context="ctx_123",
594+
)
595+
596+
def test_iter_with_stripe_context_client(
597+
self, http_client_mock: HTTPClientMock
598+
):
599+
http_client_mock.stub_request(
600+
"get",
601+
path="/v1/customers",
602+
rbody='{"object": "list", "data": [{"id": "cus_001", "object": "customer"}], "url": "/v1/customers", "has_more": true}',
603+
)
604+
http_client_mock.stub_request(
605+
"get",
606+
path="/v1/customers",
607+
query_string="starting_after=cus_001",
608+
rbody='{"object": "list", "data": [{"id": "cus_002", "object": "customer"}], "url": "/v1/customers", "has_more": false}',
609+
)
610+
611+
client = stripe.StripeClient(
612+
"org_key_abc", http_client=http_client_mock.get_mock_http_client()
613+
)
614+
cu_list = client.v1.customers.list(
615+
options={"stripe_context": "ctx_123"}
616+
)
617+
618+
customers = [item.id for item in cu_list.auto_paging_iter()]
619+
assert customers == ["cus_001", "cus_002"]
620+
621+
http_client_mock.assert_requested(
622+
"get",
623+
path="/v1/customers",
624+
api_key="org_key_abc",
625+
stripe_context="ctx_123",
626+
)
627+
http_client_mock.assert_requested(
628+
"get",
629+
path="/v1/customers",
630+
query_string="starting_after=cus_001",
631+
api_key="org_key_abc",
632+
stripe_context="ctx_123",
633+
)
634+
525635

526636
class TestAutoPagingAsync:
527637
@staticmethod

‎tests/test_api_requestor.py‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,9 @@ def test_prefers_headers_api_version(self, requestor, http_client_mock):
572572

573573
def test_uses_instance_key(self, requestor, http_client_mock):
574574
key = "fookey"
575-
requestor = requestor._replace_options(RequestOptions(api_key=key))
575+
requestor = requestor._new_requestor_with_options(
576+
RequestOptions(api_key=key)
577+
)
576578

577579
http_client_mock.stub_request(
578580
"get", path=self.v1_path, rbody="{}", rcode=200
@@ -585,7 +587,7 @@ def test_uses_instance_key(self, requestor, http_client_mock):
585587

586588
def test_uses_instance_account(self, requestor, http_client_mock):
587589
account = "acct_foo"
588-
requestor = requestor._replace_options(
590+
requestor = requestor._new_requestor_with_options(
589591
RequestOptions(stripe_account=account)
590592
)
591593

@@ -610,7 +612,7 @@ def test_removes_None_account(
610612
in the generated fetch_related_object doesn't actually send the null header
611613
"""
612614
account = None
613-
requestor = requestor._replace_options(
615+
requestor = requestor._new_requestor_with_options(
614616
RequestOptions(stripe_account=account)
615617
)
616618

0 commit comments

Comments
 (0)