Skip to content

api: Add a Supplier overload to Context #12935

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.

Sign up for GitHub

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

Merged
kannanjgithub merged 6 commits into from
Aug 12, 2026
Merged

api: Add a Supplier overload to Context #12935

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
275ad7d
api: Add a Supplier overload to Context
carl-mastrangelo Jul 27, 2026
55b44a9
Merge branch 'master' into contextsupplier
carl-mastrangelo Jul 28, 2026
f7faff8
must use
carl-mastrangelo Jul 30, 2026
6164702
Merge branch 'master' into contextsupplier
carl-mastrangelo Jul 30, 2026
afc76e4
Add experimental
carl-mastrangelo Jul 30, 2026
01063b3
Update ContextTest.java
kannanjgithub Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions api/src/context/java/io/grpc/Context.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Supplier;

Check failure on line 30 in api/src/context/java/io/grpc/Context.java

View workflow job for this annotation

GitHub Actions / tests (11) 

package java.util.function does not exist

Check failure on line 30 in api/src/context/java/io/grpc/Context.java

View workflow job for this annotation

GitHub Actions / tests (11) 

package java.util.function does not exist

Check failure on line 30 in api/src/context/java/io/grpc/Context.java

View workflow job for this annotation

GitHub Actions / tests (17) 

package java.util.function does not exist

Check failure on line 30 in api/src/context/java/io/grpc/Context.java

View workflow job for this annotation

GitHub Actions / tests (17) 

package java.util.function does not exist
import java.util.logging.Level;
import java.util.logging.Logger;

Expand Down Expand Up @@ -554,6 +555,22 @@
}
}

/**
* Immediately supply a value from a {@link Supplier} with this context as the
* {@link #current} context.
* @param supplier {@link Supplier} to use to produce the value.
* @return result of supplier.
*/
@CanIgnoreReturnValue

@ejona86 ejona86 Jul 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems a bit strange. Did we only ignore call() because of existing callers? Hey, look! @carl-mastrangelo reviewed #4430 😛

I guess people could be doing Callable<Void> if they wanted a Runnable that could throw exceptions. I don't think there's any point to ignoring a Supplier's return value though.

@ejona86 ejona86 Jul 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, Callable<Void> shouldn't even need @CanIgnoreReturnValue. So I guess we did it just because there were existing callers.

@carl-mastrangelo carl-mastrangelo Jul 30, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely don't like the name supply, but also can't really use an overload of call. I'm open to alternatives. invoke() ? callInContext() ? apply() ?

@carl-mastrangelo carl-mastrangelo Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also I sent out #12955 to update the context version

public <V> V supply(Supplier<V> supplier) {

Check failure on line 565 in api/src/context/java/io/grpc/Context.java

View workflow job for this annotation

GitHub Actions / tests (11) 

cannot find symbol

Check failure on line 565 in api/src/context/java/io/grpc/Context.java

View workflow job for this annotation

GitHub Actions / tests (11) 

cannot find symbol

Check failure on line 565 in api/src/context/java/io/grpc/Context.java

View workflow job for this annotation

GitHub Actions / tests (17) 

cannot find symbol

Check failure on line 565 in api/src/context/java/io/grpc/Context.java

View workflow job for this annotation

GitHub Actions / tests (17) 

cannot find symbol
Context previous = attach();
try {
return supplier.get();
} finally {
detach(previous);
}
}

/**
* Wrap a {@link Runnable} so that it executes with this context as the {@link #current} context.
*/
Expand Down
41 changes: 41 additions & 0 deletions api/src/test/java/io/grpc/ContextTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Supplier;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
Expand Down Expand Up @@ -553,6 +554,46 @@ public Object call() {
current.detach(Context.ROOT);
}

@Test
public void testSupply() throws Exception {

@kannanjgithub kannanjgithub Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This single test is testing multiple different behaviors. We can rewrite it into 3 different behavior driven tests each following the Given-When-Then structure for testing each behavior:

supply_executesSupplierUnderTargetContextAndRestoresPrevious
supply_whenContextIsAlreadyCurrent_executesAndMaintainsContext
supply_whenSupplierThrows_propagatesExceptionAndRestoresPreviousContext

@carl-mastrangelo carl-mastrangelo Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be better for the maintainers to take on that task. I wrote the test to match the existing style, and since I don't know your preferences, I think it would be better for you to adjust it the way you want.

Claude should be able to easily adjust and split these tests. How about we continue with the PR as is and the tests can be adjusted after?

Context base = Context.current().withValue(PET, "cat");
Context current = Context.current().withValue(PET, "fish");
current.attach();

final Object ret = new Object();
Supplier<Object> supplier = new Supplier<Object>() {
@Override
public Object get() {
runner.run();
return ret;
}
};

assertSame(ret, base.supply(supplier));
assertSame(base, observed);
assertSame(current, Context.current());

assertSame(ret, current.supply(supplier));
assertSame(current, observed);
assertSame(current, Context.current());

final TestError err = new TestError();
try {

@panchenko panchenko Jul 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TestError caught = assertThrows(TestError.class, ...

@carl-mastrangelo carl-mastrangelo Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you feel strongly I can, but I was keeping the style of the tests around it.

@panchenko panchenko Jul 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

assertThrows() was not available back then, worth using in new code

base.supply(new Supplier<Object>() {
@Override
public Object get() {
throw err;
}
});
fail("Excepted exception");
} catch (TestError ex) {
assertSame(err, ex);
}
assertSame(current, Context.current());

current.detach(Context.ROOT);
}

@Test
public void currentContextExecutor() {
QueuedExecutor queuedExecutor = new QueuedExecutor();
Expand Down
Loading