-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: Extract listResources utility function for handling paginat…
…ion (#1923) This also fixes an issue where EventGroupsServiceTest was waiting for a real 30s deadline to pass. Also fixes the simulator issue of PR #1927: The MC and EDP simulators were only reading the first page of results from ListEventGroups. This means that in environments with more EventGroups, not all test EventGroups would be read. This is exacerbated by #1916, as the default page size is now smaller.
- Loading branch information
Showing
15 changed files
with
377 additions
and
198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
src/main/kotlin/org/wfanet/measurement/common/api/grpc/ListResources.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /* | ||
| * Copyright 2024 The Cross-Media Measurement Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.wfanet.measurement.common.api.grpc | ||
|
|
||
| import com.google.protobuf.Message | ||
| import io.grpc.kotlin.AbstractCoroutineStub | ||
| import kotlin.coroutines.coroutineContext | ||
| import kotlinx.coroutines.ExperimentalCoroutinesApi | ||
| import kotlinx.coroutines.ensureActive | ||
| import kotlinx.coroutines.flow.Flow | ||
| import kotlinx.coroutines.flow.asFlow | ||
| import kotlinx.coroutines.flow.flattenConcat | ||
| import kotlinx.coroutines.flow.flow | ||
| import kotlinx.coroutines.flow.map | ||
|
|
||
| /** A [List] of resources from a paginated List method. */ | ||
| data class ResourceList<T : Message>( | ||
| val resources: List<T>, | ||
| /** | ||
| * A token that can be sent on subsequent requests to retrieve the next page. If empty, there are | ||
| * no subsequent pages. | ||
| */ | ||
| val nextPageToken: String, | ||
| ) : List<T> by resources | ||
|
|
||
| /** | ||
| * Lists resources from a paginated List method on this stub. | ||
| * | ||
| * @param pageToken page token for initial request | ||
| * @param list function which calls the appropriate List method on the stub | ||
| */ | ||
| fun <T : Message, S : AbstractCoroutineStub<S>> S.listResources( | ||
| pageToken: String = "", | ||
| list: suspend S.(pageToken: String) -> ResourceList<T>, | ||
| ): Flow<ResourceList<T>> = | ||
| listResources(Int.MAX_VALUE, pageToken) { nextPageToken, _ -> list(nextPageToken) } | ||
|
|
||
| /** | ||
| * Lists resources from a paginated List method on this stub. | ||
| * | ||
| * @param limit maximum number of resources to emit | ||
| * @param pageToken page token for initial request | ||
| * @param list function which calls the appropriate List method on the stub, returning no more than | ||
| * the specified remaining number of resources | ||
| */ | ||
| fun <T : Message, S : AbstractCoroutineStub<S>> S.listResources( | ||
| limit: Int, | ||
| pageToken: String = "", | ||
| list: suspend S.(pageToken: String, remaining: Int) -> ResourceList<T>, | ||
| ): Flow<ResourceList<T>> { | ||
| require(limit > 0) { "limit must be positive" } | ||
| return flow { | ||
| var remaining: Int = limit | ||
| var nextPageToken = pageToken | ||
|
|
||
| while (true) { | ||
| coroutineContext.ensureActive() | ||
|
|
||
| val resourceList: ResourceList<T> = list(nextPageToken, remaining) | ||
| require(resourceList.size <= remaining) { | ||
| "List call must ensure that limit is not exceeded. " + | ||
| "Returned ${resourceList.size} items when only $remaining were remaining" | ||
| } | ||
| emit(resourceList) | ||
|
|
||
| remaining -= resourceList.size | ||
| nextPageToken = resourceList.nextPageToken | ||
| if (nextPageToken.isEmpty() || remaining == 0) { | ||
| break | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** @see [flattenConcat] */ | ||
| @ExperimentalCoroutinesApi // Overloads experimental `flattenConcat` function. | ||
| fun <T : Message> Flow<ResourceList<T>>.flattenConcat(): Flow<T> = | ||
| map { it.asFlow() }.flattenConcat() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.