[Next Major] prevent autopagination from mutating (#2899)

--------- Co-authored-by: jar-stripe <[email protected]>
stripe · Feb 5, 2025 · 559e1fe · 559e1fe
1 parent 7a40fcf
commit 559e1fe
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/src/Stripe.net/Services/_base/Service.cs b/src/Stripe.net/Services/_base/Service.cs
@@ -167,7 +167,7 @@ internal IEnumerable<T> V1ListRequestAutoPagingSync<T>(
                 options,
                 requestOptions);
 
-            options = options ?? new ListOptions();
+            options = ((ListOptions)options?.Clone()) ?? new ListOptions();
             bool iterateBackward = false;
 
             // Backward iterating activates if we have an `EndingBefore`
@@ -360,7 +360,7 @@ internal async IAsyncEnumerable<T> V1ListRequestAutoPagingAsync<T>(
                 requestOptions,
                 cancellationToken).ConfigureAwait(false);
 
-            options = options ?? new ListOptions();
+            options = ((ListOptions)options?.Clone()) ?? new ListOptions();
             bool iterateBackward = false;
 
             // Backward iterating activates if we have an `EndingBefore`
@@ -450,7 +450,7 @@ private IEnumerable<T> SearchRequestAutoPagingSync<T>(
                 options,
                 requestOptions);
 
-            options = options ?? new SearchOptions();
+            options = ((SearchOptions)options?.Clone()) ?? new SearchOptions();
 
             while (true)
             {
@@ -500,7 +500,7 @@ internal async IAsyncEnumerable<T> SearchRequestAutoPagingAsync<T>(
                 requestOptions,
                 cancellationToken).ConfigureAwait(false);
 
-            options = options ?? new SearchOptions();
+            options = ((SearchOptions)options?.Clone()) ?? new SearchOptions();
 
             while (true)
             {

diff --git a/src/StripeTests/Services/AutoPagingTest.cs b/src/StripeTests/Services/AutoPagingTest.cs
@@ -193,6 +193,9 @@ public void ListAutoPaging_StartingAfter()
             Assert.Equal("pm_126", models[1].Id);
             Assert.Equal("pm_127", models[2].Id);
 
+            // Should not mutate its argument
+            Assert.Equal("pm_124", options.StartingAfter);
+
             // Check invocations
             this.MockHttpClientFixture.MockHandler.Protected()
                 .Verify(
@@ -247,6 +250,9 @@ public void ListAutoPaging_EndingBefore()
             };
             var models = service.ListAutoPaging(options).ToList();
 
+            // Should not mutate its argument
+            Assert.Equal("pm_127", options.EndingBefore);
+
             // Check results
             Assert.Equal(5, models.Count);
             Assert.Equal("pm_126", models[0].Id);

diff --git a/src/StripeTests/Services/_base/ServiceTest.cs b/src/StripeTests/Services/_base/ServiceTest.cs
@@ -60,14 +60,17 @@ public void SearchAuto_ReturnsAllPages()
                 "?page=page2&query=my+query");
 
             var service = new TestService(this.StripeClient);
+            var options = new SearchOptions() { Query = "my query" };
 
             HashSet<string> ids = new HashSet<string>();
-            foreach (var testEntity in service.SearchAutoPaging(new SearchOptions() { Query = "my query" }))
+            foreach (var testEntity in service.SearchAutoPaging(options))
             {
                 Assert.NotNull(testEntity);
                 ids.Add(testEntity.Id);
             }
 
+            Assert.Null(options.Page);
+
             Assert.Equal(4, ids.Count);
             Assert.Equal(4, ids.Count);
         }
@@ -91,13 +94,16 @@ public async Task SearchAutoAsync_ReturnsAllPages()
 
             var service = new TestService(this.StripeClient);
 
+            var options = new SearchOptions() { Query = "my query" };
             HashSet<string> ids = new HashSet<string>();
-            await foreach (var testEntity in service.SearchAutoPagingAsync(new SearchOptions() { Query = "my query" }))
+            await foreach (var testEntity in service.SearchAutoPagingAsync(options))
             {
                 Assert.NotNull(testEntity);
                 ids.Add(testEntity.Id);
             }
 
+            Assert.Null(options.Page);
+
             Assert.Equal(4, ids.Count);
         }