fix: correctly codegen paginators for types which require fully-qualified names #1249
Conversation
This comment has been minimized.
This comment has been minimized.
| * @param initialRequest A [ListFlowsRequest] to start pagination | ||
| * @return A [kotlinx.coroutines.flow.Flow] that can collect [ListFlowsResponse] | ||
| */ | ||
| public fun TestClient.listFlowsPaginated(initialRequest: ListFlowsRequest = ListFlowsRequest { }): kotlinx.coroutines.flow.Flow<ListFlowsResponse> = |
There was a problem hiding this comment.
question: These will only be fully qualified kotlinx.coroutines.flow.Flow when there's an import collision, right?
There was a problem hiding this comment.
Yes, although typically kotlinx.coroutines.flow.Flow will be referenced first in our codegen and so a conflicting symbol like com.foo.Flow would actually be the one which gets the fully-qualified name in code. This test case shows it the other way around because the very first paginator is the one which has the collision and the model shape is referenced before kotlinx.coroutines.flow.Flow.
| @@ -263,6 +263,130 @@ class PaginatorGeneratorTest { | |||
| actual.shouldContainOnlyOnceWithDiff(expectedImports) | |||
| } | |||
|
|
|||
| @Test | |||
| fun testRenderPaginatorWithItemRequiringFqName() { | |||
There was a problem hiding this comment.
Suggestion: Fq -> FullyQualified
There was a problem hiding this comment.
How about just Full instead?
@Test
fun testRenderPaginatorWithItemRequiringFullName() {
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Affected ArtifactsNo artifacts changed size |
Issue #
(none)
Description of changes
The codegen for paginators does not correctly handle the case of item types whose names collide with other types. Specifically, the function signature for the items paginator is formed without taking into account existing imports. This was discovered in a test model in which the pagination items were of type
Flowwhich caused a paginator like this:This PR improves the logic which forms item descriptors in paginator generators and will fully qualify type names which collide with existing imports, leading to this:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.