-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add AsyncPage implementation and docs. Add related tests #974
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
82 changes: 82 additions & 0 deletions
82
gcloud-java-core/src/main/java/com/google/cloud/AsyncPageImpl.java
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,82 @@ | ||
/* | ||
* Copyright 2016 Google Inc. All Rights Reserved. | ||
* | ||
* 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 com.google.cloud; | ||
|
||
import com.google.common.base.Throwables; | ||
import com.google.common.util.concurrent.Uninterruptibles; | ||
|
||
import java.io.Serializable; | ||
import java.util.concurrent.ExecutionException; | ||
import java.util.concurrent.Future; | ||
|
||
/** | ||
* Base implementation for asynchronously consuming Google Cloud paginated results. | ||
* | ||
* @param <T> the value type that the page holds | ||
*/ | ||
public class AsyncPageImpl<T> extends PageImpl<T> implements AsyncPage<T> { | ||
|
||
private static final long serialVersionUID = -6009473188630364906L; | ||
|
||
private final NextPageFetcher<T> asyncPageFetcher; | ||
|
||
/** | ||
* Interface for asynchronously fetching the next page of results from the service. | ||
* | ||
* @param <T> the value type that the page holds | ||
*/ | ||
public interface NextPageFetcher<T> extends Serializable { | ||
Future<AsyncPage<T>> nextPage(); | ||
} | ||
|
||
private static class SyncNextPageFetcher<T> implements PageImpl.NextPageFetcher<T> { | ||
|
||
private static final long serialVersionUID = -4124568632363525351L; | ||
|
||
private NextPageFetcher<T> asyncPageFetcher; | ||
|
||
private SyncNextPageFetcher(NextPageFetcher<T> asyncPageFetcher) { | ||
this.asyncPageFetcher = asyncPageFetcher; | ||
} | ||
|
||
@Override | ||
public Page<T> nextPage() { | ||
try { | ||
return asyncPageFetcher != null | ||
? Uninterruptibles.getUninterruptibly(asyncPageFetcher.nextPage()) : null; | ||
} catch (ExecutionException ex) { | ||
throw Throwables.propagate(ex.getCause()); | ||
} | ||
} | ||
} | ||
|
||
/** | ||
* Creates an {@code AsyncPageImpl} object. | ||
*/ | ||
public AsyncPageImpl(NextPageFetcher<T> asyncPageFetcher, String cursor, Iterable<T> results) { | ||
super(new SyncNextPageFetcher<T>(asyncPageFetcher), cursor, results); | ||
this.asyncPageFetcher = asyncPageFetcher; | ||
} | ||
|
||
@Override | ||
public Future<AsyncPage<T>> nextPageAsync() { | ||
if (nextPageCursor() == null || asyncPageFetcher == null) { | ||
return null; | ||
} | ||
return asyncPageFetcher.nextPage(); | ||
} | ||
} |
128 changes: 128 additions & 0 deletions
128
gcloud-java-core/src/test/java/com/google/cloud/AsyncPageImplTest.java
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,128 @@ | ||
/* | ||
* Copyright 2016 Google Inc. All Rights Reserved. | ||
* | ||
* 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 com.google.cloud; | ||
|
||
import static org.junit.Assert.assertEquals; | ||
|
||
import com.google.common.collect.ImmutableList; | ||
import com.google.common.util.concurrent.Futures; | ||
|
||
import org.junit.Test; | ||
|
||
import java.util.concurrent.ExecutionException; | ||
import java.util.concurrent.Future; | ||
|
||
public class AsyncPageImplTest { | ||
|
||
private static final ImmutableList<String> VALUES1 = ImmutableList.of("1", "2"); | ||
private static final ImmutableList<String> VALUES2 = ImmutableList.of("3", "4"); | ||
private static final ImmutableList<String> VALUES3 = ImmutableList.of("5", "6"); | ||
private static final ImmutableList<String> ALL_VALUES = ImmutableList.<String>builder() | ||
.addAll(VALUES1) | ||
.addAll(VALUES2) | ||
.addAll(VALUES3) | ||
.build(); | ||
private static final ImmutableList<String> SOME_VALUES = ImmutableList.<String>builder() | ||
.addAll(VALUES2) | ||
.addAll(VALUES3) | ||
.build(); | ||
|
||
@Test | ||
public void testPage() { | ||
final AsyncPageImpl<String> nextResult = new AsyncPageImpl<>(null, "c", VALUES2); | ||
AsyncPageImpl.NextPageFetcher<String> fetcher = new AsyncPageImpl.NextPageFetcher<String>() { | ||
private static final long serialVersionUID = 4703765400378593176L; | ||
|
||
@Override | ||
public Future<AsyncPage<String>> nextPage() { | ||
return Futures.<AsyncPage<String>>immediateFuture(nextResult); | ||
} | ||
}; | ||
AsyncPageImpl<String> result = new AsyncPageImpl<>(fetcher, "c", VALUES1); | ||
assertEquals(nextResult, result.nextPage()); | ||
assertEquals("c", result.nextPageCursor()); | ||
assertEquals(VALUES1, result.values()); | ||
} | ||
|
||
@Test | ||
public void testPageAsync() throws ExecutionException, InterruptedException { | ||
final AsyncPageImpl<String> nextResult = new AsyncPageImpl<>(null, "c", VALUES2); | ||
AsyncPageImpl.NextPageFetcher<String> fetcher = new AsyncPageImpl.NextPageFetcher<String>() { | ||
private static final long serialVersionUID = 4703765400378593176L; | ||
|
||
@Override | ||
public Future<AsyncPage<String>> nextPage() { | ||
return Futures.<AsyncPage<String>>immediateFuture(nextResult); | ||
} | ||
}; | ||
AsyncPageImpl<String> result = new AsyncPageImpl<>(fetcher, "c", VALUES1); | ||
assertEquals(nextResult, result.nextPageAsync().get()); | ||
assertEquals("c", result.nextPageCursor()); | ||
assertEquals(VALUES1, result.values()); | ||
} | ||
|
||
@Test | ||
public void testIterateAll() { | ||
final AsyncPageImpl<String> nextResult2 = new AsyncPageImpl<>(null, "c3", VALUES3); | ||
AsyncPageImpl.NextPageFetcher<String> fetcher2 = new AsyncPageImpl.NextPageFetcher<String>() { | ||
private static final long serialVersionUID = -9203621430631884026L; | ||
|
||
@Override | ||
public Future<AsyncPage<String>> nextPage() { | ||
return Futures.<AsyncPage<String>>immediateFuture(nextResult2); | ||
} | ||
}; | ||
final AsyncPageImpl<String> nextResult1 = new AsyncPageImpl<>(fetcher2, "c2", VALUES2); | ||
AsyncPageImpl.NextPageFetcher<String> fetcher1 = new AsyncPageImpl.NextPageFetcher<String>() { | ||
private static final long serialVersionUID = -9203621430631884026L; | ||
|
||
@Override | ||
public Future<AsyncPage<String>> nextPage() { | ||
return Futures.<AsyncPage<String>>immediateFuture(nextResult1); | ||
} | ||
}; | ||
AsyncPageImpl<String> result = new AsyncPageImpl<>(fetcher1, "c1", VALUES1); | ||
assertEquals(ALL_VALUES, ImmutableList.copyOf(result.iterateAll())); | ||
} | ||
|
||
@Test | ||
public void testAsyncPageAndIterateAll() throws ExecutionException, InterruptedException { | ||
final AsyncPageImpl<String> nextResult2 = new AsyncPageImpl<>(null, "c3", VALUES3); | ||
AsyncPageImpl.NextPageFetcher<String> fetcher2 = new AsyncPageImpl.NextPageFetcher<String>() { | ||
private static final long serialVersionUID = -9203621430631884026L; | ||
|
||
@Override | ||
public Future<AsyncPage<String>> nextPage() { | ||
return Futures.<AsyncPage<String>>immediateFuture(nextResult2); | ||
} | ||
}; | ||
final AsyncPageImpl<String> nextResult1 = new AsyncPageImpl<>(fetcher2, "c2", VALUES2); | ||
AsyncPageImpl.NextPageFetcher<String> fetcher1 = new AsyncPageImpl.NextPageFetcher<String>() { | ||
private static final long serialVersionUID = -9203621430631884026L; | ||
|
||
@Override | ||
public Future<AsyncPage<String>> nextPage() { | ||
return Futures.<AsyncPage<String>>immediateFuture(nextResult1); | ||
} | ||
}; | ||
AsyncPageImpl<String> result = new AsyncPageImpl<>(fetcher1, "c1", VALUES1); | ||
assertEquals(nextResult1, result.nextPageAsync().get()); | ||
assertEquals("c1", result.nextPageCursor()); | ||
assertEquals(VALUES1, result.values()); | ||
assertEquals(SOME_VALUES, ImmutableList.copyOf(result.nextPageAsync().get().iterateAll())); | ||
} | ||
} |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
Sorry, something went wrong.