Update documentation and make sure it's covered in AOT code generation.

Author: christophstrobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/DiskUse.java

@@ -19,23 +19,60 @@
 import org.springframework.util.StringUtils;
 
 /**
+ * Disk use indicates if the MongoDB server is allowed to write temporary files to disk during query/aggregation
+ * execution. MongoDB 6.0 server (and later) default for {@literal allowDiskUseByDefault} is {@literal true} on server
+ * side.
+ *
  * @author Christoph Strobl
+ * @since 5.0
  */
 public enum DiskUse {
 
-	DEFAULT, ALLOW, DENY;
+	/**
+	 * Go with the server default value and do not specify any override.
+	 */
+	DEFAULT,
+
+	/**
+	 * Override server default value and explicitly allow disk writes.
+	 */
+	ALLOW,
+
+	/**
+	 * Override server default value and explicitly deny disk writes.
+	 */
+	DENY;
 
+	/**
+	 * Obtain the {@link DiskUse} corresponding to the given Boolean flag. {@literal null} is considered {@link #DEFAULT},
+	 * {@literal true} as {@link #ALLOW}, {@literal false} as {@link #DENY}.
+	 *
+	 * @param value can be {@literal null}.
+	 * @return the {@link DiskUse} corresponding to the given value.
+	 */
 	public static DiskUse of(@Nullable Boolean value) {
 		return value != null ? (value ? ALLOW : DENY) : DEFAULT;
 	}
 
-	public static DiskUse of(String value) {
+	/**
+	 * Obtain the {@link DiskUse} referred to by the given value. Considers {@literal null} or empty Strings as
+	 * {@link #DEFAULT}, {@literal true} as {@link #ALLOW}, {@literal false} as {@link #DENY} and delegates other values
+	 * to {@link #valueOf(String)}.
+	 *
+	 * @param value can be {@literal null}.
+	 * @return the {@link DiskUse} corresponding to the given value.
+	 * @throws IllegalArgumentException if not matching {@link DiskUse} found.
+	 */
+	public static DiskUse of(@Nullable String value) {
+
 		if (!StringUtils.hasText(value)) {
 			return DEFAULT;
 		}
-		if (value.toLowerCase().equalsIgnoreCase("true")) {
-			return ALLOW;
-		}
-		return valueOf(value.toUpperCase());
+
+		return switch (value) {
+			case "true" -> ALLOW;
+			case "false" -> DENY;
+			default -> valueOf(value.toUpperCase());
+		};
 	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/Meta.java

@@ -69,10 +69,16 @@
 
 	/**
 	 * When set to {@literal true}, aggregation stages can write data to disk.
+	 * Valid arguments are:
+	 * <dl>
+	 *     <dt>""</dt><dd>DiskUse#DEFAULT</dd>
+	 *     <dt>true|allow</dt><dd>DiskUse#ALLOW</dd>
+	 *     <dt>false|deny</dt><dd>DiskUse#DENY</dd>
+	 * </dl>
 	 *
 	 * @return {@literal false} by default.
 	 * @since 3.0
-	 * @see Aggregation
+	 * @see org.springframework.data.mongodb.core.query.DiskUse
 	 */
 	String allowDiskUse() default "";
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/aot/QueryBlocks.java

@@ -26,6 +26,7 @@
 import org.springframework.data.mongodb.core.MongoOperations;
 import org.springframework.data.mongodb.core.annotation.Collation;
 import org.springframework.data.mongodb.core.query.BasicQuery;
+import org.springframework.data.mongodb.core.query.DiskUse;
 import org.springframework.data.mongodb.repository.Hint;
 import org.springframework.data.mongodb.repository.Meta;
 import org.springframework.data.mongodb.repository.query.MongoQueryExecution.PagedExecution;
@@ -292,6 +293,12 @@ CodeBlock build() {
 				if (StringUtils.hasText(comment)) {
 					builder.addStatement("$L.comment($S)", queryVariableName, comment);
 				}
+
+				String allowDiskUse = metaAnnotation.getString("allowDiskUse");
+				if (StringUtils.hasText(allowDiskUse)) {
+					DiskUse diskUse = DiskUse.of(allowDiskUse);
+					builder.addStatement("$L.diskUse($T.$L)", queryVariableName, DiskUse.class, diskUse.name());
+				}
 			}
 
 			MergedAnnotation<Collation> collationAnnotation = context.getAnnotation(Collation.class);

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/aot/MongoRepositoryContributorUnitTests.java

@@ -15,8 +15,8 @@
  */
 package org.springframework.data.mongodb.repository.aot;
 
-import static org.mockito.Mockito.*;
-import static org.springframework.data.mongodb.test.util.Assertions.*;
+import static org.mockito.Mockito.mock;
+import static org.springframework.data.mongodb.test.util.Assertions.assertThat;
 
 import example.aot.User;
 import example.aot.UserRepository;
@@ -25,7 +25,6 @@
 import java.nio.charset.StandardCharsets;
 
 import org.junit.jupiter.api.Test;
-
 import org.springframework.aot.generate.GeneratedFiles;
 import org.springframework.aot.test.generate.TestGenerationContext;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -42,8 +41,8 @@
  * Unit tests for the {@link UserRepository} fragment sources via {@link MongoRepositoryContributor}.
  *
  * @author Mark Paluch
+ * @author Christoph Strobl
  */
-
 @SpringJUnitConfig(classes = MongoRepositoryContributorUnitTests.MongoRepositoryContributorConfiguration.class)
 class MongoRepositoryContributorUnitTests {
 
@@ -63,7 +62,7 @@ MongoOperations mongoOperations() {
 
 	@Autowired TestGenerationContext generationContext;
 
-	@Test // GH-4970
+	@Test // GH-4970, GH-4667
 	void shouldConsiderMetaAnnotation() throws IOException {
 
 		InputStreamSource aotFragment = generationContext.getGeneratedFiles().getGeneratedFile(GeneratedFiles.Kind.SOURCE,
@@ -74,14 +73,15 @@ void shouldConsiderMetaAnnotation() throws IOException {
 		assertThat(content).contains("filterQuery.maxTimeMsec(555)");
 		assertThat(content).contains("filterQuery.cursorBatchSize(1234)");
 		assertThat(content).contains("filterQuery.comment(\"foo\")");
+		assertThat(content).contains("filterQuery.diskUse(DiskUse.DENY)");
 	}
 
 	interface MetaUserRepository extends CrudRepository<User, String> {
 
 		@Meta
 		User findAllByLastname(String lastname);
 
-		@Meta(cursorBatchSize = 1234, comment = "foo", maxExecutionTimeMs = 555)
+		@Meta(cursorBatchSize = 1234, comment = "foo", maxExecutionTimeMs = 555, allowDiskUse = "false")
 		User findWithMetaAllByLastname(String lastname);
 	}