Skip to content

Commit

Permalink
binder: Set default idle timeout to 60 seconds, and enable "strict li…
Browse files Browse the repository at this point in the history
…fecycle management". (#9486)
  • Loading branch information
markb74 committed Nov 29, 2022
1 parent f082151 commit 241097c
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
22 changes: 22 additions & 0 deletions binder/src/main/java/io/grpc/binder/BinderChannelBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package io.grpc.binder;

import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;

import android.app.Application;
import android.content.ComponentName;
Expand Down Expand Up @@ -124,6 +125,7 @@ public static BinderChannelBuilder forTarget(String target) {
private SecurityPolicy securityPolicy;
private InboundParcelablePolicy inboundParcelablePolicy;
private BindServiceFlags bindServiceFlags;
private boolean strictLifecycleManagement;

private BinderChannelBuilder(
@Nullable AndroidComponentAddress directAddress,
Expand Down Expand Up @@ -164,6 +166,7 @@ public ClientTransportFactory buildClientTransportFactory() {
new BinderChannelTransportFactoryBuilder(),
null);
}
idleTimeout(60, TimeUnit.SECONDS);
}

@Override
Expand Down Expand Up @@ -224,6 +227,25 @@ public BinderChannelBuilder inboundParcelablePolicy(
return this;
}

/**
* Disables the channel idle timeout and prevents it from being enabled. This
* allows a centralized application method to configure the channel builder
* and return it, without worrying about another part of the application
* accidentally enabling the idle timeout.
*/
public BinderChannelBuilder strictLifecycleManagement() {
strictLifecycleManagement = true;
super.idleTimeout(1000, TimeUnit.DAYS); // >30 days disables timeouts entirely.
return this;
}

@Override
public BinderChannelBuilder idleTimeout(long value, TimeUnit unit) {
checkState(!strictLifecycleManagement, "Idle timeouts are not supported when strict lifecycle management is enabled");
super.idleTimeout(value, unit);
return this;
}

/** Creates new binder transports. */
private static final class TransportFactory implements ClientTransportFactory {
private final Context sourceContext;
Expand Down
44 changes: 44 additions & 0 deletions binder/src/test/java/io/grpc/binder/BinderChannelBuilderTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
* Copyright 2020 The gRPC 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 io.grpc.binder;

import static org.junit.Assert.fail;

import android.content.Context;
import androidx.test.core.app.ApplicationProvider;
import java.util.concurrent.TimeUnit;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;

@RunWith(RobolectricTestRunner.class)
public final class BinderChannelBuilderTest {
private final Context appContext = ApplicationProvider.getApplicationContext();
private final AndroidComponentAddress addr = AndroidComponentAddress.forContext(appContext);

@Test
public void strictLifecycleManagementForbidsIdleTimers() {
BinderChannelBuilder builder = BinderChannelBuilder.forAddress(addr, appContext);
builder.strictLifecycleManagement();
try {
builder.idleTimeout(10, TimeUnit.SECONDS);
fail();
} catch (IllegalStateException ise) {
// Expected.
}
}
}

0 comments on commit 241097c

Please sign in to comment.