Skip to content

Do not set AggregationOptions.allowDiskUse by default #4666

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.

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>org.springframework.data</groupId>
<artifactId>spring-data-mongodb-parent</artifactId>
<version>4.3.0-SNAPSHOT</version>
<version>4.3.0-GH-4664-SNAPSHOT</version>
<packaging>pom</packaging>

<name>Spring Data MongoDB</name>
Expand Down
2 changes: 1 addition & 1 deletion spring-data-mongodb-benchmarks/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-mongodb-parent</artifactId>
<version>4.3.0-SNAPSHOT</version>
<version>4.3.0-GH-4664-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion spring-data-mongodb-distribution/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<parent>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-mongodb-parent</artifactId>
<version>4.3.0-SNAPSHOT</version>
<version>4.3.0-GH-4664-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion spring-data-mongodb/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<parent>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-mongodb-parent</artifactId>
<version>4.3.0-SNAPSHOT</version>
<version>4.3.0-GH-4664-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2191,8 +2191,11 @@ protected <O> AggregationResults<O> doAggregate(Aggregation aggregation, String
.getCollation());

AggregateIterable<Document> aggregateIterable = delegate.prepare(collection).aggregate(pipeline, Document.class) //
.collation(collation.map(Collation::toMongoCollation).orElse(null)) //
.allowDiskUse(options.isAllowDiskUse());
.collation(collation.map(Collation::toMongoCollation).orElse(null));

if (options.isAllowDiskUseSet()) {
aggregateIterable = aggregateIterable.allowDiskUse(options.isAllowDiskUse());
}

if (options.getCursorBatchSize() != null) {
aggregateIterable = aggregateIterable.batchSize(options.getCursorBatchSize());
Expand Down Expand Up @@ -2255,8 +2258,11 @@ protected <O> Stream<O> aggregateStream(Aggregation aggregation, String collecti

CollectionPreparerDelegate delegate = CollectionPreparerDelegate.of(options);

AggregateIterable<Document> cursor = delegate.prepare(collection).aggregate(pipeline, Document.class) //
.allowDiskUse(options.isAllowDiskUse());
AggregateIterable<Document> cursor = delegate.prepare(collection).aggregate(pipeline, Document.class);

if (options.isAllowDiskUseSet()) {
cursor = cursor.allowDiskUse(options.isAllowDiskUse());
}

if (options.getCursorBatchSize() != null) {
cursor = cursor.batchSize(options.getCursorBatchSize());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1027,8 +1027,11 @@ private <O> Flux<O> aggregateAndMap(MongoCollection<Document> collection, List<D
@Nullable Class<?> inputType) {

ReactiveCollectionPreparerDelegate collectionPreparer = ReactiveCollectionPreparerDelegate.of(options);
AggregatePublisher<Document> cursor = collectionPreparer.prepare(collection).aggregate(pipeline, Document.class)
.allowDiskUse(options.isAllowDiskUse());
AggregatePublisher<Document> cursor = collectionPreparer.prepare(collection).aggregate(pipeline, Document.class);

if (options.isAllowDiskUseSet()) {
cursor = cursor.allowDiskUse(options.isAllowDiskUse());
}

if (options.getCursorBatchSize() != null) {
cursor = cursor.batchSize(options.getCursorBatchSize());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public class AggregationOptions implements ReadConcernAware, ReadPreferenceAware
private static final String MAX_TIME = "maxTimeMS";
private static final String HINT = "hint";

private final boolean allowDiskUse;
private final Optional<Boolean> allowDiskUse;
private final boolean explain;
private final Optional<Document> cursor;
private final Optional<Collation> collation;
Expand Down Expand Up @@ -123,10 +123,10 @@ public AggregationOptions(boolean allowDiskUse, boolean explain, @Nullable Docum
* @param hint can be {@literal null}, used to provide an index that would be forcibly used by query optimizer.
* @since 3.1
*/
private AggregationOptions(boolean allowDiskUse, boolean explain, @Nullable Document cursor,
private AggregationOptions(@Nullable Boolean allowDiskUse, boolean explain, @Nullable Document cursor,
@Nullable Collation collation, @Nullable String comment, @Nullable Object hint) {

this.allowDiskUse = allowDiskUse;
this.allowDiskUse = Optional.ofNullable(allowDiskUse);
this.explain = explain;
this.cursor = Optional.ofNullable(cursor);
this.collation = Optional.ofNullable(collation);
Expand Down Expand Up @@ -159,7 +159,7 @@ public static AggregationOptions fromDocument(Document document) {

Assert.notNull(document, "Document must not be null");

boolean allowDiskUse = document.getBoolean(ALLOW_DISK_USE, false);
Boolean allowDiskUse = document.get(ALLOW_DISK_USE, Boolean.class);
boolean explain = document.getBoolean(EXPLAIN, false);
Document cursor = document.get(CURSOR, Document.class);
Collation collation = document.containsKey(COLLATION) ? Collation.from(document.get(COLLATION, Document.class))
Expand All @@ -185,13 +185,23 @@ public static Builder builder() {
}

/**
* Enables writing to temporary files. When set to true, aggregation stages can write data to the _tmp subdirectory in
* the dbPath directory.
* Enables writing to temporary files. When set to {@literal true}, aggregation stages can write data to the
* {@code _tmp} subdirectory in the {@code dbPath} directory.
*
* @return {@literal true} if enabled.
* @return {@literal true} if enabled; {@literal false} otherwise (or if not set).
*/
public boolean isAllowDiskUse() {
return allowDiskUse;
return allowDiskUse.orElse(false);
}

/**
* Return whether {@link #isAllowDiskUse} is configured.
*
* @return {@literal true} if is {@code allowDiskUse} is configured, {@literal false} otherwise.
* @since 4.2.5
*/
public boolean isAllowDiskUseSet() {
return allowDiskUse.isPresent();
}

/**
Expand Down Expand Up @@ -335,8 +345,8 @@ Document applyAndReturnPotentiallyChangedCommand(Document command) {

Document result = new Document(command);

if (allowDiskUse && !result.containsKey(ALLOW_DISK_USE)) {
result.put(ALLOW_DISK_USE, allowDiskUse);
if (isAllowDiskUseSet() && !result.containsKey(ALLOW_DISK_USE)) {
result.put(ALLOW_DISK_USE, isAllowDiskUse());
}

if (explain && !result.containsKey(EXPLAIN)) {
Expand Down Expand Up @@ -370,7 +380,9 @@ Document applyAndReturnPotentiallyChangedCommand(Document command) {
public Document toDocument() {

Document document = new Document();
document.put(ALLOW_DISK_USE, allowDiskUse);
if (isAllowDiskUseSet()) {
document.put(ALLOW_DISK_USE, isAllowDiskUse());
}
document.put(EXPLAIN, explain);

cursor.ifPresent(val -> document.put(CURSOR, val));
Expand Down Expand Up @@ -410,7 +422,7 @@ static Document createCursor(int cursorBatchSize) {
*/
public static class Builder {

private boolean allowDiskUse;
private Boolean allowDiskUse;
private boolean explain;
private @Nullable Document cursor;
private @Nullable Collation collation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,22 @@ void shouldInitializeFromDocument() {
assertThat(aggregationOptions.getHintObject()).contains(dummyHint);
}

@Test // GH-4664
void omitsAllowDiskUseByDefault() {

aggregationOptions = AggregationOptions.fromDocument(new Document());

assertThat(aggregationOptions.isAllowDiskUse()).isFalse();
assertThat(aggregationOptions.isAllowDiskUseSet()).isFalse();

assertThat(aggregationOptions.toDocument()).doesNotContainKey("allowDiskUse");

Document empty = new Document();
aggregationOptions.applyAndReturnPotentiallyChangedCommand(empty);

assertThat(empty).doesNotContainKey("allowDiskUse");
}

@Test // DATAMONGO-960, DATAMONGO-2153, DATAMONGO-1836
void aggregationOptionsToString() {

Expand Down