Cache the item emitted by a Uni instead of the Uni itself #16608

gwenneg · 2021-04-18T00:18:07Z

gwenneg · 2021-04-18T00:20:30Z

extensions/cache/deployment/src/test/java/io/quarkus/cache/test/runtime/UniValueTest.java

+/**
+ * Tests the {@link CacheResult} annotation on methods returning {@link Uni}.
+ */
+public class UniValueTest {


Here's the log output for this test:

[INFO] Running io.quarkus.cache.test.runtime.UniValueTest 2021-04-18 02:17:52,879 INFO [io.quarkus] (main) Quarkus 999-SNAPSHOT on JVM started in 0.486s. Listening on: http://localhost:8081 2021-04-18 02:17:52,879 INFO [io.quarkus] (main) Profile test activated. 2021-04-18 02:17:52,880 INFO [io.quarkus] (main) Installed features: [cache, cdi, mutiny, smallrye-context-propagation] 2021-04-18 02:17:53,156 DEBUG [io.qua.cac.run.CacheResultInterceptor] (main) Loading entry with key [key] from cache [test-cache] 2021-04-18 02:17:53,160 DEBUG [io.qua.cac.run.CacheResultInterceptor] (main) Adding UncomputedUniValue entry with key [key] into cache [test-cache] 2021-04-18 02:17:53,166 DEBUG [io.qua.cac.run.CacheResultInterceptor] (main) Loading entry with key [key] from cache [test-cache] 2021-04-18 02:17:53,169 DEBUG [io.qua.cac.run.caf.CaffeineCache] (main) Replacing Uni value entry with key [key] into cache [test-cache] 2021-04-18 02:17:53,169 DEBUG [io.qua.cac.run.caf.CaffeineCache] (main) Replacing Uni value entry with key [key] into cache [test-cache] 2021-04-18 02:17:53,170 DEBUG [io.qua.cac.run.CacheResultInterceptor] (main) Loading entry with key [key] from cache [test-cache] 2021-04-18 02:17:53,170 DEBUG [io.qua.cac.run.CacheResultInterceptor] (main) Loading entry with key [another-key] from cache [test-cache] 2021-04-18 02:17:53,170 DEBUG [io.qua.cac.run.CacheResultInterceptor] (main) Adding UncomputedUniValue entry with key [another-key] into cache [test-cache] 2021-04-18 02:17:53,170 DEBUG [io.qua.cac.run.caf.CaffeineCache] (main) Replacing Uni value entry with key [another-key] into cache [test-cache] 2021-04-18 02:17:53,215 INFO [io.quarkus] (main) Quarkus stopped in 0.044s [INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.723 s - in io.quarkus.cache.test.runtime.UniValueTest

quarkus-bot · 2021-04-18T00:32:16Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `311d99d`

Status	Name	Step	Test failures	Logs	Raw logs
✖	Initial JDK 11 Build	`Build`	⚠️ Check →	Logs	Raw logs
🚫	Devtools Tests - JDK ${{ matrix.java.name }}
🚫	Devtools Tests - JDK 11 Windows
🚫	Gradle Tests - JDK 11 ${{ matrix.os.family }}
🚫	JVM Tests - JDK ${{ matrix.java.name }}
🚫	JVM Tests - JDK 11 Windows
🚫	Maven Tests - JDK ${{ matrix.java.name }}
🚫	Maven Tests - JDK 11 Windows
🚫	MicroProfile TCKs Tests
🚫	Native Tests - ${{ matrix.category }}
🚫	Native Tests - Windows - ${{ matrix.category }}

cescoffier · 2021-04-18T07:37:16Z

extensions/cache/deployment/src/test/java/io/quarkus/cache/test/runtime/UniValueTest.java

+        @CacheResult(cacheName = "test-cache")
+        public Uni<String> cachedMethod(String key) {
+            invocations++;
+            return Uni.createFrom().item(() -> new String());


Can you also check that the number of subscriptions is equal to the number of invocations?

return Uni.createFrom().item(() -> { subscriptions++; return "" + subscriptions; }

Thanks for the review @cescoffier.

I added the subcriptions check. The number of subscriptions is not always equal to the number of invocations though. Step 2 uses a cached Uni so it does not increment the invocations counter, but the subscriptions counter is still incremented when the Uni is resolved.

Oh, I see! You cache the Uni and resubscribe to it every time (well Quarkus does).
That's actually interesting, but I'm not sure it's what the user would expect.

Imagine:

@GET public Uni<String> callMyRemoteService() { return webClient.send().map(r -> r.bodyAsString()); }

Basically, it calls a remote service.

If you cache the result, what would/should happen?

the response is cached - the users will get the same response, avoiding calls to the remote service

the uni is cached - to every time there is a request, there is another subscription calling the remote service

I would have said 1, but it looks like 2 has been implemented. Can you confirm?

2 happens until one of the subscribers gets the reponse, which will be cached because of the callback at CacheResultInterceptor:116. From there, 1 will happen for all subsequent calls to the cached method. I don't think we can lower the number of remote service calls, but maybe I missed something.

There is one detail that could be changed though: the Uni returned by the cached method does not have to be cached until a response is received. UnresolvedUniValue could act as a placeholder in the cache and be replaced by the reponse when it's available. In the meantime, CacheResultInterceptor.intercept would simply return the method invocation result followed by the CacheResultInterceptor:116 callback.

Now that I wrote it down, that placeholder idea sounds more elegant to me than wrapping and then caching the Uni. 😄

If you want, I can add a commit to this PR to show you what I have in mind exactly.

I pushed the changes in 2daae56.

UnresolvedUniValue no longer contains the Uni but is still cached as a placeholder until the emitted item is available.

The number of subscriptions is now equal to the number of invocations.

If that version is OK with you, I'll push one more commit to make UnresolvedUniValue static instead of creating a new instance for each unresolved Uni.

extensions/cache/runtime/src/main/java/io/quarkus/cache/runtime/CacheResultInterceptor.java

extensions/cache/runtime/pom.xml

quarkus-bot · 2021-04-18T17:39:18Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `0af0bf3`

Status	Name	Step	Test failures	Logs	Raw logs
✖	MicroProfile TCKs Tests	`Verify resteasy-reative dependencies`	⚠️ Check →	Logs	Raw logs

quarkus-bot · 2021-04-18T18:15:13Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `0af0bf3`

Status	Name	Step	Test failures	Logs	Raw logs
✖	MicroProfile TCKs Tests	`Verify resteasy-reative dependencies`	⚠️ Check →	Logs	Raw logs

quarkus-bot · 2021-04-18T23:34:25Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `85ac88b`

Status	Name	Step	Test failures	Logs	Raw logs
✖	MicroProfile TCKs Tests	`Verify resteasy-reative dependencies`	⚠️ Check →	Logs	Raw logs

quarkus-bot · 2021-04-19T09:49:25Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `35d60d7`

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Initial JDK 11 Build	`Reclaim Disk Space`	⚠️ Check →	Logs	Raw logs
⌛	CI Sanity Check	`Build`	⚠️ Check →	Logs	Raw logs
🚫	Devtools Tests - JDK ${{ matrix.java.name }}
🚫	Devtools Tests - JDK 11 Windows
🚫	Gradle Tests - JDK 11 ${{ matrix.os.family }}
🚫	JVM Tests - JDK ${{ matrix.java.name }}
🚫	JVM Tests - JDK 11 Windows
🚫	Maven Tests - JDK ${{ matrix.java.name }}
🚫	Maven Tests - JDK 11 Windows
🚫	MicroProfile TCKs Tests
🚫	Native Tests - ${{ matrix.category }}
🚫	Native Tests - Windows - ${{ matrix.category }}

quarkus-bot · 2021-04-19T09:56:45Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `62a28b8`

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Initial JDK 11 Build	`Build`	⚠️ Check →	Logs	Raw logs
🚫	Devtools Tests - JDK ${{ matrix.java.name }}
🚫	Devtools Tests - JDK 11 Windows
🚫	Gradle Tests - JDK 11 ${{ matrix.os.family }}
🚫	JVM Tests - JDK ${{ matrix.java.name }}
🚫	JVM Tests - JDK 11 Windows
🚫	Maven Tests - JDK ${{ matrix.java.name }}
🚫	Maven Tests - JDK 11 Windows
🚫	MicroProfile TCKs Tests
🚫	Native Tests - ${{ matrix.category }}
🚫	Native Tests - Windows - ${{ matrix.category }}

gwenneg · 2021-04-19T12:55:54Z

I pushed the static UnresolvedUniValue instance (it made the code simpler) and squashed the commits. This is ready for a merge.

gwenneg · 2021-04-20T20:02:14Z

Thank you all for your help with this!

quarkus-bot bot added the area/cache label Apr 18, 2021

gwenneg commented Apr 18, 2021

View reviewed changes

gwenneg force-pushed the issue-16607-cache-emitted-uni-item branch from 311d99d to 2a577df Compare April 18, 2021 00:37

cescoffier requested changes Apr 18, 2021

View reviewed changes

gwenneg force-pushed the issue-16607-cache-emitted-uni-item branch from 2a577df to 0af0bf3 Compare April 18, 2021 17:06

geoand reviewed Apr 18, 2021

View reviewed changes

extensions/cache/runtime/pom.xml Show resolved Hide resolved

gwenneg force-pushed the issue-16607-cache-emitted-uni-item branch from 0af0bf3 to 85ac88b Compare April 18, 2021 23:00

gwenneg force-pushed the issue-16607-cache-emitted-uni-item branch from 35d60d7 to 62a28b8 Compare April 19, 2021 09:48

gwenneg force-pushed the issue-16607-cache-emitted-uni-item branch from 62a28b8 to 2daae56 Compare April 19, 2021 09:55

cescoffier approved these changes Apr 19, 2021

View reviewed changes

gwenneg force-pushed the issue-16607-cache-emitted-uni-item branch from 2daae56 to 015a3c6 Compare April 19, 2021 12:01

Cache the item emitted by a Uni instead of the Uni itself

7662427

gwenneg force-pushed the issue-16607-cache-emitted-uni-item branch from 015a3c6 to 7662427 Compare April 19, 2021 12:19

quarkusio deleted a comment from quarkus-bot bot Apr 19, 2021

gsmet merged commit 6978921 into quarkusio:main Apr 20, 2021

quarkus-bot bot added this to the 2.0 - main milestone Apr 20, 2021

gwenneg deleted the issue-16607-cache-emitted-uni-item branch April 20, 2021 20:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cache the item emitted by a Uni instead of the Uni itself #16608

Cache the item emitted by a Uni instead of the Uni itself #16608

gwenneg commented Apr 18, 2021

gwenneg Apr 18, 2021

quarkus-bot bot commented Apr 18, 2021 •

edited

Loading

Failing Jobs - Building `311d99d`

cescoffier Apr 18, 2021

gwenneg Apr 18, 2021 •

edited

Loading

cescoffier Apr 19, 2021

gwenneg Apr 19, 2021

gwenneg Apr 19, 2021 •

edited

Loading

cescoffier Apr 19, 2021

gwenneg Apr 19, 2021 •

edited

Loading

gwenneg Apr 19, 2021

quarkus-bot bot commented Apr 18, 2021 •

edited

Loading

Failing Jobs - Building `0af0bf3`

quarkus-bot bot commented Apr 18, 2021 •

edited

Loading

Failing Jobs - Building `0af0bf3`

quarkus-bot bot commented Apr 18, 2021 •

edited

Loading

Failing Jobs - Building `85ac88b`

quarkus-bot bot commented Apr 19, 2021 •

edited

Loading

Failing Jobs - Building `35d60d7`

quarkus-bot bot commented Apr 19, 2021 •

edited

Loading

Failing Jobs - Building `62a28b8`

gwenneg commented Apr 19, 2021 •

edited

Loading

gwenneg commented Apr 20, 2021

Cache the item emitted by a Uni instead of the Uni itself #16608

Cache the item emitted by a Uni instead of the Uni itself #16608

Conversation

gwenneg commented Apr 18, 2021

gwenneg Apr 18, 2021

Choose a reason for hiding this comment

quarkus-bot bot commented Apr 18, 2021 • edited Loading

Failing Jobs - Building 311d99d

cescoffier Apr 18, 2021

Choose a reason for hiding this comment

gwenneg Apr 18, 2021 • edited Loading

Choose a reason for hiding this comment

cescoffier Apr 19, 2021

Choose a reason for hiding this comment

gwenneg Apr 19, 2021

Choose a reason for hiding this comment

gwenneg Apr 19, 2021 • edited Loading

Choose a reason for hiding this comment

cescoffier Apr 19, 2021

Choose a reason for hiding this comment

gwenneg Apr 19, 2021 • edited Loading

Choose a reason for hiding this comment

gwenneg Apr 19, 2021

Choose a reason for hiding this comment

quarkus-bot bot commented Apr 18, 2021 • edited Loading

Failing Jobs - Building 0af0bf3

quarkus-bot bot commented Apr 18, 2021 • edited Loading

Failing Jobs - Building 0af0bf3

quarkus-bot bot commented Apr 18, 2021 • edited Loading

Failing Jobs - Building 85ac88b

quarkus-bot bot commented Apr 19, 2021 • edited Loading

Failing Jobs - Building 35d60d7

quarkus-bot bot commented Apr 19, 2021 • edited Loading

Failing Jobs - Building 62a28b8

gwenneg commented Apr 19, 2021 • edited Loading

gwenneg commented Apr 20, 2021

quarkus-bot bot commented Apr 18, 2021 •

edited

Loading

Failing Jobs - Building `311d99d`

gwenneg Apr 18, 2021 •

edited

Loading

gwenneg Apr 19, 2021 •

edited

Loading

gwenneg Apr 19, 2021 •

edited

Loading

quarkus-bot bot commented Apr 18, 2021 •

edited

Loading

Failing Jobs - Building `0af0bf3`

quarkus-bot bot commented Apr 18, 2021 •

edited

Loading

Failing Jobs - Building `0af0bf3`

quarkus-bot bot commented Apr 18, 2021 •

edited

Loading

Failing Jobs - Building `85ac88b`

quarkus-bot bot commented Apr 19, 2021 •

edited

Loading

Failing Jobs - Building `35d60d7`

quarkus-bot bot commented Apr 19, 2021 •

edited

Loading

Failing Jobs - Building `62a28b8`

gwenneg commented Apr 19, 2021 •

edited

Loading