feat: unload partitions when not publishing for better performance #1286
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| /* | ||
| * Copyright 2020 Google LLC | ||
| * | ||
| * 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.pubsublite.internal.wire; | ||
|
|
||
| import com.google.api.core.AbstractApiService; | ||
| import com.google.api.core.ApiFuture; | ||
| import com.google.cloud.pubsublite.Message; | ||
| import com.google.cloud.pubsublite.MessageMetadata; | ||
| import com.google.cloud.pubsublite.internal.AlarmFactory; | ||
| import com.google.cloud.pubsublite.internal.Publisher; | ||
| import java.io.IOException; | ||
| import java.util.Optional; | ||
| import java.util.concurrent.Future; | ||
| import java.util.function.Supplier; | ||
| import javax.annotation.concurrent.GuardedBy; | ||
|
|
||
| /** A publisher which tears down connections when inactive. */ | ||
| class UnloadingPublisher extends AbstractApiService implements Publisher<MessageMetadata> { | ||
| private final Supplier<Publisher<MessageMetadata>> supplier; | ||
| private final Future<?> alarmFuture; | ||
|
|
||
| @GuardedBy("this") | ||
| private Optional<Publisher<MessageMetadata>> publisher = Optional.empty(); | ||
|
|
||
| @GuardedBy("this") | ||
| private boolean sawPublish = false; | ||
|
|
||
| UnloadingPublisher(Supplier<Publisher<MessageMetadata>> supplier, AlarmFactory unloadAlarm) { | ||
| this.supplier = supplier; | ||
| this.alarmFuture = unloadAlarm.newAlarm(this::onUnloadAlarm); | ||
| } | ||
|
|
||
| @Override | ||
| protected void doStart() { | ||
| notifyStarted(); | ||
| } | ||
|
|
||
| @Override | ||
| protected synchronized void doStop() { | ||
| alarmFuture.cancel(false); | ||
| if (!publisher.isPresent()) { | ||
| notifyStopped(); | ||
| return; | ||
| } | ||
| publisher | ||
| .get() | ||
| .addListener( | ||
| new Listener() { | ||
| @Override | ||
| public void terminated(State from) { | ||
| notifyStopped(); | ||
| } | ||
| }, | ||
| SystemExecutors.getFuturesExecutor()); | ||
| publisher.get().stopAsync(); | ||
| } | ||
|
|
||
| @Override | ||
| public synchronized ApiFuture<MessageMetadata> publish(Message message) { | ||
| sawPublish = true; | ||
| return getPublisher().publish(message); | ||
| } | ||
|
|
||
| private synchronized Publisher<MessageMetadata> getPublisher() { | ||
| if (!publisher.isPresent()) { | ||
| publisher = Optional.of(supplier.get()); | ||
| publisher | ||
| .get() | ||
| .addListener( | ||
| new Listener() { | ||
| @Override | ||
| public void failed(State from, Throwable failure) { | ||
| notifyFailed(failure); | ||
| } | ||
| }, | ||
| SystemExecutors.getFuturesExecutor()); | ||
| publisher.get().startAsync().awaitRunning(); | ||
| } | ||
| return publisher.get(); | ||
| } | ||
|
|
||
| @Override | ||
| public synchronized void cancelOutstandingPublishes() { | ||
| if (publisher.isPresent()) { | ||
| publisher.get().cancelOutstandingPublishes(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public synchronized void flush() throws IOException { | ||
| if (publisher.isPresent()) { | ||
| publisher.get().flush(); | ||
| } | ||
| } | ||
|
|
||
| private synchronized void onUnloadAlarm() { | ||
| if (publisher.isPresent() && !sawPublish) { | ||
| publisher.get().stopAsync().awaitTerminated(); | ||
|
There was a problem hiding this comment. Similar to the above, waiting here may block publish() due to the lock held. |
||
| publisher = Optional.empty(); | ||
| } | ||
| sawPublish = false; | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| /* | ||
| * Copyright 2020 Google LLC | ||
| * | ||
| * 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.pubsublite.internal.wire; | ||
|
|
||
| import static com.google.cloud.pubsublite.internal.testing.RetryingConnectionHelpers.whenFailed; | ||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.doReturn; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import com.google.api.core.ApiFuture; | ||
| import com.google.api.core.SettableApiFuture; | ||
| import com.google.cloud.pubsublite.Message; | ||
| import com.google.cloud.pubsublite.MessageMetadata; | ||
| import com.google.cloud.pubsublite.internal.AlarmFactory; | ||
| import com.google.cloud.pubsublite.internal.Publisher; | ||
| import com.google.cloud.pubsublite.internal.testing.FakeApiService; | ||
| import com.google.protobuf.ByteString; | ||
| import java.util.Objects; | ||
| import java.util.concurrent.Future; | ||
| import java.util.function.Supplier; | ||
| import org.junit.Before; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
| import org.mockito.Mock; | ||
| import org.mockito.Spy; | ||
| import org.mockito.junit.MockitoJUnit; | ||
| import org.mockito.junit.MockitoRule; | ||
| import org.mockito.quality.Strictness; | ||
|
|
||
| @RunWith(JUnit4.class) | ||
| public class UnloadingPublisherTest { | ||
| private static final Message MESSAGE = | ||
| Message.builder().setData(ByteString.copyFromUtf8("abc")).build(); | ||
|
|
||
| @Rule public MockitoRule mockito = MockitoJUnit.rule().strictness(Strictness.STRICT_STUBS); | ||
|
|
||
| @Mock private Supplier<Publisher<MessageMetadata>> supplier; | ||
|
|
||
| abstract static class FakePublisher extends FakeApiService | ||
| implements Publisher<MessageMetadata> {}; | ||
|
|
||
| @Spy private FakePublisher underlying1; | ||
| @Spy private FakePublisher underlying2; | ||
|
|
||
| @Mock private AlarmFactory alarmFactory; | ||
| private Runnable onAlarm; | ||
|
|
||
| private UnloadingPublisher publisher; | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| when(alarmFactory.newAlarm(any())) | ||
| .thenAnswer( | ||
| args -> { | ||
| onAlarm = args.getArgument(0); | ||
| return SettableApiFuture.create(); | ||
| }); | ||
| publisher = new UnloadingPublisher(supplier, alarmFactory); | ||
| Objects.requireNonNull(onAlarm); | ||
| publisher.startAsync().awaitRunning(); | ||
| } | ||
|
|
||
| @Test | ||
| public void loadOnPublish() { | ||
| doReturn(underlying1).when(supplier).get(); | ||
| SettableApiFuture<MessageMetadata> future = SettableApiFuture.create(); | ||
| doReturn(future).when(underlying1).publish(MESSAGE); | ||
|
|
||
| assertThat(publisher.publish(MESSAGE)).isSameInstanceAs(future); | ||
| } | ||
|
|
||
| @Test | ||
| public void underlyingFailureFails() throws Exception { | ||
| doReturn(underlying1).when(supplier).get(); | ||
| doReturn(SettableApiFuture.create()).when(underlying1).publish(MESSAGE); | ||
| ApiFuture<?> unused = publisher.publish(MESSAGE); | ||
|
|
||
| Future<Void> failed = whenFailed(publisher); | ||
| underlying1.fail(new IllegalStateException("bad")); | ||
| failed.get(); | ||
| } | ||
|
|
||
| @Test | ||
| public void twoAlarmsWithoutPublishShutsDown() throws Exception { | ||
| doReturn(underlying1).when(supplier).get(); | ||
| doReturn(SettableApiFuture.create()).when(underlying1).publish(MESSAGE); | ||
| ApiFuture<?> future1 = publisher.publish(MESSAGE); | ||
|
|
||
| onAlarm.run(); | ||
|
|
||
| assertThat(underlying1.isRunning()).isTrue(); | ||
|
|
||
| ApiFuture<?> future2 = publisher.publish(MESSAGE); | ||
| onAlarm.run(); | ||
| assertThat(underlying1.isRunning()).isTrue(); | ||
|
|
||
| onAlarm.run(); | ||
| assertThat(underlying1.isRunning()).isFalse(); | ||
| } | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it ok to block the publish() call here, while the stream is connecting?
In Go, I allowed the wire publisher to accept messages while it is starting up. The messages just get queued until the stream is connected.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this issue already exists- so I'm okay with blocking here. We should as a refactor fix this eventually.