Fix C# paging helper naming collisions and long filenames by ArcturusZhang · Pull Request #12292 · microsoft/typespec

Dapeng Zhang (ArcturusZhang) · 2026-10-16T08:18:19Z

Summary

Nest operation-specific paging helpers inside their owning client and emit them together in <ClientName>.Collections.cs, following option 2 discussed in the issue. ClientProvider.CollectionResultProviders lazily creates and caches this partial declaration.
Simplify helper names to <OperationName>[Async]CollectionResult[OfT], without a redundant client-name prefix or original-name fallback. Resolve same-client normalized-name and sync/async collisions in input operation order: keep the first name unchanged, then append 2, 3, etc. For example, two operations normalized to GetAll produce GetAllCollectionResult and GetAllCollectionResult2.
Traverse nested helpers in library visitors and dependency analysis, preserving downstream customization and response models referenced only by helper bodies. Omit the implementation-only collections partial from public API stubs.
Disable duplicate compatibility-overload synthesis in the collections partial. Propagate client name and namespace updates to the collections partial and cached nested helpers while retaining visitor constructor customizations.
Document provider ownership and naming; add regression coverage for collisions, long operation names, nested member visitation, dependency retention, compatibility overloads, and cached identity updates; regenerate the checked-in sample output and update helper-name fixtures.

Generated SDK public APIs and paging iteration logic are unchanged. Internal helper names and qualified locations change with the nested layout.

Validation

C# emitter/generator build passed.
Core generator suite: 2,919 passed.
Client-model suite: 2,475 passed after the compatibility and identity fixes, using a temporary short Windows drive mapping to avoid existing fixture path limitations.
Regenerated local sample suite: 730 passed, rerun after the latest fixes; regeneration produced no additional checked-in output changes.
Full C# regeneration completed for the initial nested layout; the affected local sample was regenerated and rebuilt after subsequent changes. The full generated pageable Spector SDK was also built successfully for net8.0 with the initial nested layout and emitted five per-client collections files instead of per-operation files.
New compatibility and cached-identity regressions were observed failing before implementation and passing after the fixes.
Cop checks, repository-configured Oxlint, and root pnpm format passed after the latest changes.

Spector HTTP runtime integration tests were not run.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 268abd28-b2c0-4898-87f0-4ca429090c1f

pkg-pr-new · 2026-10-16T08:20:27Z

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/http-client-csharp@12292

commit: 280b02d

github-actions · 2026-10-16T08:22:14Z

No changes needing a change description found.

Document the collections partial declaration and let the output library reuse the client-owned provider. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 268abd28-b2c0-4898-87f0-4ca429090c1f

Drop redundant client prefixes and original-name fallback; document client-local numeric collision suffixes. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 268abd28-b2c0-4898-87f0-4ca429090c1f

…erty Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 268abd28-b2c0-4898-87f0-4ca429090c1f

Copilot

🟡 Changes recommended

Naming collisions and compatibility and identity propagation defects can produce uncompilable generated SDKs.

3 open issues

What changed in this PR

Addresses #12147 by nesting C# paging helpers inside their owning clients, reducing filename length and separating helper names across clients.

Changes:

Groups helpers into per-client .Collections.cs files with deterministic collision suffixes.
Extends visitor and dependency traversal to nested helpers and excludes collections partials from API stubs.
Adds regression coverage, updates fixtures, and regenerates sample output.

Paths below omit packages/http-client-csharp/generator/. Prefixes: Sample = TestProjects/Local/Sample-TypeSpec/src/Generated; Core = Microsoft.TypeSpec.Generator; ClientModel = Microsoft.TypeSpec.Generator.ClientModel.

File	Description
Sample/SampleTypeSpecClient.cs	Uses nested paging helpers.
Sample/SampleTypeSpecClient.Collections.cs	Groups client paging helpers.
Sample/ExperimentalSamples.cs	Uses nested paging helpers.
Sample/ExperimentalSamples.Collections.cs	Groups experimental paging helpers.
Sample/CollectionResults/SampleTypeSpecClientGetWithStringNextLinkCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithStringNextLinkCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithStringNextLinkAsyncCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithStringNextLinkAsyncCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithPagingCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithPagingCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithPagingAsyncCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithPagingAsyncCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithNextLinkCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithNextLinkCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithNextLinkAsyncCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithNextLinkAsyncCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenHeaderResponseCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenHeaderResponseCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenHeaderResponseAsyncCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenHeaderResponseAsyncCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenAsyncCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenAsyncCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/ExperimentalSamplesGetAllCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/ExperimentalSamplesGetAllCollectionResult.cs	Removed; helper moved into client.
Sample/CollectionResults/ExperimentalSamplesGetAllAsyncCollectionResultOfT.cs	Removed; helper moved into client.
Sample/CollectionResults/ExperimentalSamplesGetAllAsyncCollectionResult.cs	Removed; helper moved into client.
Core/test/ReferenceMap/ProviderReferenceMapAnalyzerTests.cs	Tests nested-helper dependency retention.
Core/test/OutputLibraryVisitorTests.cs	Tests nested member visitation.
Core/src/ReferenceMap/ProviderReferenceMapAnalyzer.BodyReferences.cs	Includes nested providers in dependency analysis.
Core/src/LibraryVisitor.cs	Recursively visits nested members.
ClientModel/test/Providers/TestData/ScmMethodProviderCollectionTests/OptionsBagOverride_PagingMethodExpandsBagForCollectionResult(Protocol).cs	Updates qualified helper reference.
ClientModel/test/Providers/TestData/ScmMethodProviderCollectionTests/OptionsBagOverride_PagingMethodExpandsBagForCollectionResult(Convenience).cs	Updates qualified helper reference.
ClientModel/test/Providers/ScmMethodProviderCollectionTests.cs	Finds helpers in nested providers.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NormalizedDateTimeReinjectedParameterFiltersNextLinkArguments.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NextLinkInHeaderOfTAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NextLinkInHeaderOfT.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NextLinkInHeaderAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NextLinkInHeader.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NextLinkInBodyOfTAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NextLinkInBodyOfT.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NextLinkInBodyAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NextLinkInBody.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NestedNextLinkInBodyOfTAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NestedNextLinkInBodyOfT.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NestedNextLinkInBodyAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/NestedNextLinkInBody.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/InheritedNextLinkInBodyOfTAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/InheritedNextLinkInBodyOfT.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/InheritedNextLinkInBodyAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/NextLinkTests/InheritedNextLinkInBody.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ListPageableTests/NoNextLinkOrContinuationTokenOfTAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ListPageableTests/NoNextLinkOrContinuationTokenOfT.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ListPageableTests/NoNextLinkOrContinuationTokenAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ListPageableTests/NoNextLinkOrContinuationToken.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/NestedContinuationTokenInBodyOfTAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/NestedContinuationTokenInBodyOfT.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/NestedContinuationTokenInBodyAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/NestedContinuationTokenInBody.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/ContinuationTokenInHeaderOfTAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/ContinuationTokenInHeaderOfT.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/ContinuationTokenInHeaderAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/ContinuationTokenInHeader.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/ContinuationTokenInBodyOfTAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/ContinuationTokenInBodyOfT.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/ContinuationTokenInBodyAsync.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/TestData/ContinuationTokenTests/ContinuationTokenInBody.cs	Updates helper-name baseline.
ClientModel/test/Providers/CollectionResultDefinitions/NextLinkTests.cs	Uses nested helper names and lookups.
ClientModel/test/Providers/CollectionResultDefinitions/ListPageableTests.cs	Uses nested helper names and lookups.
ClientModel/test/Providers/CollectionResultDefinitions/ContinuationTokenTests.cs	Uses nested helper names and lookups.
ClientModel/test/Providers/CollectionResultDefinitions/CollectionResultDefinitionTests.cs	Tests ownership, collisions, and bounded filenames.
ClientModel/test/Providers/ClientProviders/TestData/ClientProviderCustomizationTests/SuppressedPagingProtocolMethodKeepsPagingHelpers/TestClient.cs	References nested helper from custom code.
ClientModel/test/Providers/ClientProviders/ClientProviderTests.cs	Updates paging-helper assertions.
ClientModel/test/Providers/ClientProviders/ClientProviderCustomizationTests.cs	Checks retained nested helpers.
ClientModel/src/ScmOutputLibrary.cs	Registers per-client collections partials.
ClientModel/src/Providers/CollectionResultDefinition.cs	Adds nesting and local name disambiguation.
ClientModel/src/Providers/ClientProvider.cs	Lazily caches collections provider.
ClientModel/src/Providers/ClientCollectionsProvider.cs	Defines partial containing paging helpers.
Microsoft.TypeSpec.Generator.ClientModel.StubLibrary/src/StubLibraryVisitor.cs	Excludes collections partials from stubs.
docs/architecture.md	Documents helper ownership and naming.

_{Review effort: Balanced}

+
+        protected override string BuildRelativeFilePath() => Path.Combine("src", "Generated", $"{Name}.Collections.cs");
+
+        protected override TypeSignatureModifiers BuildDeclarationModifiers() => Client.DeclarationModifiers;


+        /// <summary>
+        /// Gets the partial client declaration containing this client's nested paging helpers.
+        /// </summary>
+        public ClientCollectionsProvider CollectionResultProviders => _collectionResultProviders ??= new ClientCollectionsProvider(this);


+            var operations = Client.InputClient.Methods.OfType<InputPagingServiceMethod>().Select(m => m.Operation).Distinct().ToArray();
+            var name = GetName(Operation, IsAsync);


Avoid duplicate compatibility overloads in the collections partial and propagate client identity updates to cached nested paging helpers while preserving constructor customizations. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 268abd28-b2c0-4898-87f0-4ca429090c1f

fix(http-client-csharp): nest paging helpers in client collections files

d2c8829

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 268abd28-b2c0-4898-87f0-4ca429090c1f

microsoft-github-policy-service Bot added the emitter:client:csharp Issue for the C# client emitter: @typespec/http-client-csharp label Oct 16, 2026

Dapeng Zhang (ArcturusZhang) and others added 3 commits October 19, 2026 12:00

refactor(http-client-csharp): rename collection result providers prop…

197437d

…erty Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 268abd28-b2c0-4898-87f0-4ca429090c1f

Dapeng Zhang (ArcturusZhang) marked this pull request as ready for review October 19, 2026 08:21

Dapeng Zhang (ArcturusZhang) requested review from JoshLove-msft, Jorge Rangel (jorgerangel-msft), Jose Arriaga Maldonado (joseharriaga) and m-nash as code owners October 19, 2026 08:21

Copilot AI balanced review requested due to automatic review settings October 19, 2026 08:21

Copilot started reviewing on behalf of Dapeng Zhang (ArcturusZhang) October 19, 2026 08:22

View session

Copilot AI reviewed Oct 19, 2026

View reviewed changes

Copilot AI balanced review requested due to automatic review settings October 19, 2026 08:52

Copilot started reviewing on behalf of Dapeng Zhang (ArcturusZhang) October 19, 2026 08:53

View session

Navigation Menu

Repository navigation

Fix C# paging helper naming collisions and long filenames - #12292

Fix C# paging helper naming collisions and long filenames#12292
Dapeng Zhang (ArcturusZhang) wants to merge 5 commits into
microsoft:mainfrom
ArcturusZhang:arcturuszhang-issue-12147-fix

Dapeng Zhang (ArcturusZhang) commented Oct 16, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Oct 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 16, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		protected override string BuildRelativeFilePath() => Path.Combine("src", "Generated", $"{Name}.Collections.cs");

		protected override TypeSignatureModifiers BuildDeclarationModifiers() => Client.DeclarationModifiers;

		var operations = Client.InputClient.Methods.OfType<InputPagingServiceMethod>().Select(m => m.Operation).Distinct().ToArray();
		var name = GetName(Operation, IsAsync);

Conversation

Dapeng Zhang (ArcturusZhang) commented Oct 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Validation

Uh oh!

pkg-pr-new Bot commented Oct 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 16, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Dapeng Zhang (ArcturusZhang) commented Oct 16, 2026 •

edited

Loading

pkg-pr-new Bot commented Oct 16, 2026 •

edited

Loading