From fdcfc23a538ac984e05df2ffd8d11b33c9e252ec Mon Sep 17 00:00:00 2001
From: Georgios Andrianakis <geoand@gmail.com>
Date: Tue, 30 Nov 2021 11:42:25 +0200
Subject: [PATCH] Add @CheckReturnValue to Hibernate Reactive Panache methods

Resolves: #21796
---
 .../PanacheHibernateResourceProcessor.java    | 23 +++++++++++
 .../runtime/pom.xml                           |  4 ++
 .../reactive/panache/PanacheEntityBase.java   | 37 ++++++++++++++++++
 .../reactive/panache/PanacheQuery.java        |  9 +++++
 .../panache/PanacheRepositoryBase.java        | 38 +++++++++++++++++++
 5 files changed, 111 insertions(+)

diff --git a/extensions/panache/hibernate-reactive-panache/deployment/src/main/java/io/quarkus/hibernate/reactive/panache/deployment/PanacheHibernateResourceProcessor.java b/extensions/panache/hibernate-reactive-panache/deployment/src/main/java/io/quarkus/hibernate/reactive/panache/deployment/PanacheHibernateResourceProcessor.java
index 5e77edd5fa9ad..7c46556b0a1bb 100644
--- a/extensions/panache/hibernate-reactive-panache/deployment/src/main/java/io/quarkus/hibernate/reactive/panache/deployment/PanacheHibernateResourceProcessor.java
+++ b/extensions/panache/hibernate-reactive-panache/deployment/src/main/java/io/quarkus/hibernate/reactive/panache/deployment/PanacheHibernateResourceProcessor.java
@@ -13,6 +13,9 @@
 import org.jboss.jandex.AnnotationInstance;
 import org.jboss.jandex.ClassInfo;
 import org.jboss.jandex.DotName;
+import org.jboss.jandex.MethodInfo;
+import org.objectweb.asm.MethodVisitor;
+import org.objectweb.asm.Type;
 
 import io.quarkus.arc.deployment.UnremovableBeanBuildItem;
 import io.quarkus.arc.deployment.ValidationPhaseBuildItem;
@@ -35,6 +38,8 @@
 import io.quarkus.panache.common.deployment.PanacheJpaEntityOperationsEnhancer;
 import io.quarkus.panache.common.deployment.PanacheMethodCustomizer;
 import io.quarkus.panache.common.deployment.PanacheMethodCustomizerBuildItem;
+import io.smallrye.mutiny.Multi;
+import io.smallrye.mutiny.Uni;
 
 public final class PanacheHibernateResourceProcessor {
 
@@ -49,6 +54,8 @@ public final class PanacheHibernateResourceProcessor {
     protected static final String META_INF_PANACHE_ARCHIVE_MARKER = "META-INF/panache-archive.marker";
 
     private static final DotName DOTNAME_TRANSIENT = DotName.createSimple(Transient.class.getName());
+    private static final DotName DOTNAME_UNI = DotName.createSimple(Uni.class.getName());
+    private static final DotName DOTNAME_MULTI = DotName.createSimple(Multi.class.getName());
 
     @BuildStep
     FeatureBuildItem featureBuildItem() {
@@ -137,4 +144,20 @@ ValidationPhaseBuildItem.ValidationErrorBuildItem validate(ValidationPhaseBuildI
         }
         return null;
     }
+
+    private static final String CHECK_RETURN_VALUE_BINARY_NAME = "io/smallrye/common/annotation/CheckReturnValue";
+    private static final String CHECK_RETURN_VALUE_SIGNATURE = "L" + CHECK_RETURN_VALUE_BINARY_NAME + ";";
+
+    @BuildStep
+    PanacheMethodCustomizerBuildItem mutinyReturnTypes() {
+        return new PanacheMethodCustomizerBuildItem(new PanacheMethodCustomizer() {
+            @Override
+            public void customize(Type entityClassSignature, MethodInfo method, MethodVisitor mv) {
+                DotName returnType = method.returnType().name();
+                if (returnType.equals(DOTNAME_UNI) || returnType.equals(DOTNAME_MULTI)) {
+                    mv.visitAnnotation(CHECK_RETURN_VALUE_SIGNATURE, true);
+                }
+            }
+        });
+    }
 }
diff --git a/extensions/panache/hibernate-reactive-panache/runtime/pom.xml b/extensions/panache/hibernate-reactive-panache/runtime/pom.xml
index 8fe252fd5da64..eda49d612646f 100644
--- a/extensions/panache/hibernate-reactive-panache/runtime/pom.xml
+++ b/extensions/panache/hibernate-reactive-panache/runtime/pom.xml
@@ -28,6 +28,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-arc</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.smallrye.common</groupId>
+            <artifactId>smallrye-common-annotation</artifactId>
+        </dependency>
         <dependency>
             <groupId>jakarta.json.bind</groupId>
             <artifactId>jakarta.json.bind-api</artifactId>
diff --git a/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheEntityBase.java b/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheEntityBase.java
index 26df0ce5cdfb8..2398340c9e210 100644
--- a/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheEntityBase.java
+++ b/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheEntityBase.java
@@ -17,6 +17,7 @@
 import io.quarkus.panache.common.Parameters;
 import io.quarkus.panache.common.Sort;
 import io.quarkus.panache.common.impl.GenerateBridge;
+import io.smallrye.common.annotation.CheckReturnValue;
 import io.smallrye.mutiny.Multi;
 import io.smallrye.mutiny.Uni;
 
@@ -52,6 +53,7 @@ public static Uni<Mutiny.Session> getSession() {
      * @see #persist(Stream)
      * @see #persist(Object, Object...)
      */
+    @CheckReturnValue
     public <T extends PanacheEntityBase> Uni<T> persist() {
         return INSTANCE.persist(this).map(v -> (T) this);
     }
@@ -67,6 +69,7 @@ public <T extends PanacheEntityBase> Uni<T> persist() {
      * @see #persist(Stream)
      * @see #persist(Object, Object...)
      */
+    @CheckReturnValue
     public <T extends PanacheEntityBase> Uni<T> persistAndFlush() {
         return INSTANCE.persist(this)
                 .flatMap(v -> INSTANCE.flush())
@@ -84,6 +87,7 @@ public <T extends PanacheEntityBase> Uni<T> persistAndFlush() {
      * @see #delete(String, Parameters)
      * @see #deleteAll()
      */
+    @CheckReturnValue
     public Uni<Void> delete() {
         return INSTANCE.delete(this);
     }
@@ -107,6 +111,7 @@ public boolean isPersistent() {
      * 
      * @return
      */
+    @CheckReturnValue
     public Uni<Void> flush() {
         return INSTANCE.flush();
     }
@@ -131,6 +136,7 @@ public static <T extends PanacheEntityBase> Uni<T> findById(Object id) {
      * @param lockModeType the locking strategy to be used when retrieving the entity.
      * @return the entity found, or <code>null</code> if not found.
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Uni<T> findById(Object id, LockModeType lockModeType) {
         throw INSTANCE.implementationInjectionMissing();
@@ -281,6 +287,7 @@ public static <T extends PanacheEntityBase> PanacheQuery<T> findAll(Sort sort) {
      * @see #find(String, Object...)
      * @see #stream(String, Object...)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -300,6 +307,7 @@ public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Obje
      * @see #find(String, Sort, Object...)
      * @see #stream(String, Sort, Object...)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Sort sort, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -318,6 +326,7 @@ public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Sort
      * @see #find(String, Map)
      * @see #stream(String, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -337,6 +346,7 @@ public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Map<
      * @see #find(String, Sort, Map)
      * @see #stream(String, Sort, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Sort sort, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -355,6 +365,7 @@ public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Sort
      * @see #find(String, Parameters)
      * @see #stream(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -374,6 +385,7 @@ public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Para
      * @see #find(String, Sort, Parameters)
      * @see #stream(String, Sort, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Sort sort, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -388,6 +400,7 @@ public static <T extends PanacheEntityBase> Uni<List<T>> list(String query, Sort
      * @see #findAll()
      * @see #streamAll()
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Uni<List<T>> listAll() {
         throw INSTANCE.implementationInjectionMissing();
@@ -403,6 +416,7 @@ public static <T extends PanacheEntityBase> Uni<List<T>> listAll() {
      * @see #findAll(Sort)
      * @see #streamAll(Sort)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Uni<List<T>> listAll(Sort sort) {
         throw INSTANCE.implementationInjectionMissing();
@@ -423,6 +437,7 @@ public static <T extends PanacheEntityBase> Uni<List<T>> listAll(Sort sort) {
      * @see #find(String, Object...)
      * @see #list(String, Object...)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Multi<T> stream(String query, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -444,6 +459,7 @@ public static <T extends PanacheEntityBase> Multi<T> stream(String query, Object
      * @see #find(String, Sort, Object...)
      * @see #list(String, Sort, Object...)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Multi<T> stream(String query, Sort sort, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -464,6 +480,7 @@ public static <T extends PanacheEntityBase> Multi<T> stream(String query, Sort s
      * @see #find(String, Map)
      * @see #list(String, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Multi<T> stream(String query, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -485,6 +502,7 @@ public static <T extends PanacheEntityBase> Multi<T> stream(String query, Map<St
      * @see #find(String, Sort, Map)
      * @see #list(String, Sort, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Multi<T> stream(String query, Sort sort, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -505,6 +523,7 @@ public static <T extends PanacheEntityBase> Multi<T> stream(String query, Sort s
      * @see #find(String, Parameters)
      * @see #list(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Multi<T> stream(String query, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -526,6 +545,7 @@ public static <T extends PanacheEntityBase> Multi<T> stream(String query, Parame
      * @see #find(String, Sort, Parameters)
      * @see #list(String, Sort, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Multi<T> stream(String query, Sort sort, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -542,6 +562,7 @@ public static <T extends PanacheEntityBase> Multi<T> stream(String query, Sort s
      * @see #findAll()
      * @see #listAll()
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Multi<T> streamAll() {
         throw INSTANCE.implementationInjectionMissing();
@@ -559,6 +580,7 @@ public static <T extends PanacheEntityBase> Multi<T> streamAll() {
      * @see #findAll(Sort)
      * @see #listAll(Sort)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static <T extends PanacheEntityBase> Multi<T> streamAll(Sort sort) {
         throw INSTANCE.implementationInjectionMissing();
@@ -572,6 +594,7 @@ public static <T extends PanacheEntityBase> Multi<T> streamAll(Sort sort) {
      * @see #count(String, Map)
      * @see #count(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Long> count() {
         throw INSTANCE.implementationInjectionMissing();
@@ -587,6 +610,7 @@ public static Uni<Long> count() {
      * @see #count(String, Map)
      * @see #count(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Long> count(String query, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -602,6 +626,7 @@ public static Uni<Long> count(String query, Object... params) {
      * @see #count(String, Object...)
      * @see #count(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Long> count(String query, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -617,6 +642,7 @@ public static Uni<Long> count(String query, Map<String, Object> params) {
      * @see #count(String, Object...)
      * @see #count(String, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Long> count(String query, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -633,6 +659,7 @@ public static Uni<Long> count(String query, Parameters params) {
      * @see #delete(String, Map)
      * @see #delete(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Long> deleteAll() {
         throw INSTANCE.implementationInjectionMissing();
@@ -644,6 +671,7 @@ public static Uni<Long> deleteAll() {
      * @param id the ID of the entity to delete.
      * @return false if the entity was not deleted (not found).
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Boolean> deleteById(Object id) {
         throw INSTANCE.implementationInjectionMissing();
@@ -662,6 +690,7 @@ public static Uni<Boolean> deleteById(Object id) {
      * @see #delete(String, Map)
      * @see #delete(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Long> delete(String query, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -680,6 +709,7 @@ public static Uni<Long> delete(String query, Object... params) {
      * @see #delete(String, Object...)
      * @see #delete(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Long> delete(String query, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -698,6 +728,7 @@ public static Uni<Long> delete(String query, Map<String, Object> params) {
      * @see #delete(String, Object...)
      * @see #delete(String, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Long> delete(String query, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -712,6 +743,7 @@ public static Uni<Long> delete(String query, Parameters params) {
      * @see #persist(Stream)
      * @see #persist(Object,Object...)
      */
+    @CheckReturnValue
     @GenerateBridge(callSuperMethod = true)
     public static Uni<Void> persist(Iterable<?> entities) {
         return INSTANCE.persist(entities);
@@ -726,6 +758,7 @@ public static Uni<Void> persist(Iterable<?> entities) {
      * @see #persist(Iterable)
      * @see #persist(Object,Object...)
      */
+    @CheckReturnValue
     @GenerateBridge(callSuperMethod = true)
     public static Uni<Void> persist(Stream<?> entities) {
         return INSTANCE.persist(entities);
@@ -740,6 +773,7 @@ public static Uni<Void> persist(Stream<?> entities) {
      * @see #persist(Stream)
      * @see #persist(Iterable)
      */
+    @CheckReturnValue
     @GenerateBridge(callSuperMethod = true)
     public static Uni<Void> persist(Object firstEntity, Object... entities) {
         return INSTANCE.persist(firstEntity, entities);
@@ -754,6 +788,7 @@ public static Uni<Void> persist(Object firstEntity, Object... entities) {
      * @see #update(String, Map)
      * @see #update(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Integer> update(String query, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -769,6 +804,7 @@ public static Uni<Integer> update(String query, Object... params) {
      * @see #update(String, Parameters)
      * 
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Integer> update(String query, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -783,6 +819,7 @@ public static Uni<Integer> update(String query, Map<String, Object> params) {
      * @see #update(String, Object...)
      * @see #update(String, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public static Uni<Integer> update(String query, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
diff --git a/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheQuery.java b/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheQuery.java
index 2d8048e6ea540..e383a6b17e822 100644
--- a/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheQuery.java
+++ b/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheQuery.java
@@ -13,6 +13,7 @@
 
 import io.quarkus.panache.common.Page;
 import io.quarkus.panache.common.Parameters;
+import io.smallrye.common.annotation.CheckReturnValue;
 import io.smallrye.mutiny.Multi;
 import io.smallrye.mutiny.Uni;
 
@@ -97,6 +98,7 @@ public interface PanacheQuery<Entity> {
      * @see #firstPage()
      * @see #count()
      */
+    @CheckReturnValue
     public <T extends Entity> Uni<PanacheQuery<T>> lastPage();
 
     /**
@@ -108,6 +110,7 @@ public interface PanacheQuery<Entity> {
      * @see #hasPreviousPage()
      * @see #count()
      */
+    @CheckReturnValue
     public Uni<Boolean> hasNextPage();
 
     /**
@@ -126,6 +129,7 @@ public interface PanacheQuery<Entity> {
      * @return the total number of pages to be read using the current page size.
      * @throws UnsupportedOperationException if a page hasn't been set or if a range is already set
      */
+    @CheckReturnValue
     public Uni<Integer> pageCount();
 
     /**
@@ -221,6 +225,7 @@ public interface PanacheQuery<Entity> {
      * 
      * @return the total number of entities this query operates on, cached.
      */
+    @CheckReturnValue
     public Uni<Long> count();
 
     /**
@@ -231,6 +236,7 @@ public interface PanacheQuery<Entity> {
      * @see #page(Page)
      * @see #page()
      */
+    @CheckReturnValue
     public <T extends Entity> Uni<List<T>> list();
 
     /**
@@ -241,6 +247,7 @@ public interface PanacheQuery<Entity> {
      * @see #page(Page)
      * @see #page()
      */
+    @CheckReturnValue
     public <T extends Entity> Multi<T> stream();
 
     /**
@@ -250,6 +257,7 @@ public interface PanacheQuery<Entity> {
      * @return the first result of the current page index, or null if there are no results.
      * @see #singleResult()
      */
+    @CheckReturnValue
     public <T extends Entity> Uni<T> firstResult();
 
     /**
@@ -260,5 +268,6 @@ public interface PanacheQuery<Entity> {
      * @throws NonUniqueResultException if there are more than one result
      * @see #firstResult()
      */
+    @CheckReturnValue
     public <T extends Entity> Uni<T> singleResult();
 }
diff --git a/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheRepositoryBase.java b/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheRepositoryBase.java
index 16a63243cba8a..ab2e3e5bc4fae 100644
--- a/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheRepositoryBase.java
+++ b/extensions/panache/hibernate-reactive-panache/runtime/src/main/java/io/quarkus/hibernate/reactive/panache/PanacheRepositoryBase.java
@@ -13,6 +13,7 @@
 import io.quarkus.panache.common.Parameters;
 import io.quarkus.panache.common.Sort;
 import io.quarkus.panache.common.impl.GenerateBridge;
+import io.smallrye.common.annotation.CheckReturnValue;
 import io.smallrye.mutiny.Multi;
 import io.smallrye.mutiny.Uni;
 
@@ -49,6 +50,7 @@ public default Uni<Mutiny.Session> getSession() {
      * @see #persist(Stream)
      * @see #persist(Object, Object...)
      */
+    @CheckReturnValue
     public default Uni<Entity> persist(Entity entity) {
         return INSTANCE.persist(entity).map(v -> entity);
     }
@@ -64,6 +66,7 @@ public default Uni<Entity> persist(Entity entity) {
      * @see #persist(Stream)
      * @see #persist(Object, Object...)
      */
+    @CheckReturnValue
     public default Uni<Entity> persistAndFlush(Entity entity) {
         return INSTANCE.persist(entity)
                 .flatMap(v -> INSTANCE.flush())
@@ -81,6 +84,7 @@ public default Uni<Entity> persistAndFlush(Entity entity) {
      * @see #delete(String, Parameters)
      * @see #deleteAll()
      */
+    @CheckReturnValue
     public default Uni<Void> delete(Entity entity) {
         return INSTANCE.delete(entity);
     }
@@ -102,6 +106,7 @@ public default boolean isPersistent(Entity entity) {
      * 
      * @return
      */
+    @CheckReturnValue
     public default Uni<Void> flush() {
         return INSTANCE.flush();
     }
@@ -114,6 +119,7 @@ public default Uni<Void> flush() {
      * @param id the ID of the entity to find.
      * @return the entity found, or <code>null</code> if not found.
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Entity> findById(Id id) {
         throw INSTANCE.implementationInjectionMissing();
@@ -126,6 +132,7 @@ public default Uni<Entity> findById(Id id) {
      * @param lockModeType the locking strategy to be used when retrieving the entity.
      * @return the entity found, or <code>null</code> if not found.
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Entity> findById(Id id, LockModeType lockModeType) {
         throw INSTANCE.implementationInjectionMissing();
@@ -276,6 +283,7 @@ public default PanacheQuery<Entity> findAll(Sort sort) {
      * @see #find(String, Object...)
      * @see #stream(String, Object...)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<List<Entity>> list(String query, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -295,6 +303,7 @@ public default Uni<List<Entity>> list(String query, Object... params) {
      * @see #find(String, Sort, Object...)
      * @see #stream(String, Sort, Object...)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<List<Entity>> list(String query, Sort sort, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -313,6 +322,7 @@ public default Uni<List<Entity>> list(String query, Sort sort, Object... params)
      * @see #find(String, Map)
      * @see #stream(String, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<List<Entity>> list(String query, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -332,6 +342,7 @@ public default Uni<List<Entity>> list(String query, Map<String, Object> params)
      * @see #find(String, Sort, Map)
      * @see #stream(String, Sort, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<List<Entity>> list(String query, Sort sort, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -350,6 +361,7 @@ public default Uni<List<Entity>> list(String query, Sort sort, Map<String, Objec
      * @see #find(String, Parameters)
      * @see #stream(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<List<Entity>> list(String query, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -369,6 +381,7 @@ public default Uni<List<Entity>> list(String query, Parameters params) {
      * @see #find(String, Sort, Parameters)
      * @see #stream(String, Sort, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<List<Entity>> list(String query, Sort sort, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -383,6 +396,7 @@ public default Uni<List<Entity>> list(String query, Sort sort, Parameters params
      * @see #findAll()
      * @see #streamAll()
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<List<Entity>> listAll() {
         throw INSTANCE.implementationInjectionMissing();
@@ -398,6 +412,7 @@ public default Uni<List<Entity>> listAll() {
      * @see #findAll(Sort)
      * @see #streamAll(Sort)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<List<Entity>> listAll(Sort sort) {
         throw INSTANCE.implementationInjectionMissing();
@@ -418,6 +433,7 @@ public default Uni<List<Entity>> listAll(Sort sort) {
      * @see #find(String, Object...)
      * @see #list(String, Object...)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Multi<Entity> stream(String query, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -439,6 +455,7 @@ public default Multi<Entity> stream(String query, Object... params) {
      * @see #find(String, Sort, Object...)
      * @see #list(String, Sort, Object...)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Multi<Entity> stream(String query, Sort sort, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -459,6 +476,7 @@ public default Multi<Entity> stream(String query, Sort sort, Object... params) {
      * @see #find(String, Map)
      * @see #list(String, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Multi<Entity> stream(String query, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -480,6 +498,7 @@ public default Multi<Entity> stream(String query, Map<String, Object> params) {
      * @see #find(String, Sort, Map)
      * @see #list(String, Sort, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Multi<Entity> stream(String query, Sort sort, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -500,6 +519,7 @@ public default Multi<Entity> stream(String query, Sort sort, Map<String, Object>
      * @see #find(String, Parameters)
      * @see #list(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Multi<Entity> stream(String query, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -521,6 +541,7 @@ public default Multi<Entity> stream(String query, Parameters params) {
      * @see #find(String, Sort, Parameters)
      * @see #list(String, Sort, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Multi<Entity> stream(String query, Sort sort, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -537,6 +558,7 @@ public default Multi<Entity> stream(String query, Sort sort, Parameters params)
      * @see #findAll()
      * @see #listAll()
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Multi<Entity> streamAll(Sort sort) {
         throw INSTANCE.implementationInjectionMissing();
@@ -553,6 +575,7 @@ public default Multi<Entity> streamAll(Sort sort) {
      * @see #findAll(Sort)
      * @see #listAll(Sort)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Multi<Entity> streamAll() {
         throw INSTANCE.implementationInjectionMissing();
@@ -566,6 +589,7 @@ public default Multi<Entity> streamAll() {
      * @see #count(String, Map)
      * @see #count(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Long> count() {
         throw INSTANCE.implementationInjectionMissing();
@@ -581,6 +605,7 @@ public default Uni<Long> count() {
      * @see #count(String, Map)
      * @see #count(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Long> count(String query, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -596,6 +621,7 @@ public default Uni<Long> count(String query, Object... params) {
      * @see #count(String, Object...)
      * @see #count(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Long> count(String query, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -611,6 +637,7 @@ public default Uni<Long> count(String query, Map<String, Object> params) {
      * @see #count(String, Object...)
      * @see #count(String, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Long> count(String query, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -627,6 +654,7 @@ public default Uni<Long> count(String query, Parameters params) {
      * @see #delete(String, Map)
      * @see #delete(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Long> deleteAll() {
         throw INSTANCE.implementationInjectionMissing();
@@ -638,6 +666,7 @@ public default Uni<Long> deleteAll() {
      * @param id the ID of the entity to delete.
      * @return false if the entity was not deleted (not found).
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Boolean> deleteById(Id id) {
         throw INSTANCE.implementationInjectionMissing();
@@ -656,6 +685,7 @@ public default Uni<Boolean> deleteById(Id id) {
      * @see #delete(String, Map)
      * @see #delete(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Long> delete(String query, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -674,6 +704,7 @@ public default Uni<Long> delete(String query, Object... params) {
      * @see #delete(String, Object...)
      * @see #delete(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Long> delete(String query, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -692,6 +723,7 @@ public default Uni<Long> delete(String query, Map<String, Object> params) {
      * @see #delete(String, Object...)
      * @see #delete(String, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Long> delete(String query, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -706,6 +738,7 @@ public default Uni<Long> delete(String query, Parameters params) {
      * @see #persist(Stream)
      * @see #persist(Object,Object...)
      */
+    @CheckReturnValue
     public default Uni<Void> persist(Iterable<Entity> entities) {
         return INSTANCE.persist(entities);
     }
@@ -719,6 +752,7 @@ public default Uni<Void> persist(Iterable<Entity> entities) {
      * @see #persist(Iterable)
      * @see #persist(Object,Object...)
      */
+    @CheckReturnValue
     public default Uni<Void> persist(Stream<Entity> entities) {
         return INSTANCE.persist(entities);
     }
@@ -732,6 +766,7 @@ public default Uni<Void> persist(Stream<Entity> entities) {
      * @see #persist(Stream)
      * @see #persist(Iterable)
      */
+    @CheckReturnValue
     public default Uni<Void> persist(Entity firstEntity, @SuppressWarnings("unchecked") Entity... entities) {
         return INSTANCE.persist(firstEntity, entities);
     }
@@ -745,6 +780,7 @@ public default Uni<Void> persist(Entity firstEntity, @SuppressWarnings("unchecke
      * @see #update(String, Map)
      * @see #update(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Integer> update(String query, Object... params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -759,6 +795,7 @@ public default Uni<Integer> update(String query, Object... params) {
      * @see #update(String, Object...)
      * @see #update(String, Parameters)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Integer> update(String query, Map<String, Object> params) {
         throw INSTANCE.implementationInjectionMissing();
@@ -773,6 +810,7 @@ public default Uni<Integer> update(String query, Map<String, Object> params) {
      * @see #update(String, Object...)
      * @see #update(String, Map)
      */
+    @CheckReturnValue
     @GenerateBridge
     public default Uni<Integer> update(String query, Parameters params) {
         throw INSTANCE.implementationInjectionMissing();