forked from spring-projects/spring-data-mongodb
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
spring-projectsGH-3726: Add support for $sampleRate aggregation opera…
…tion Closes spring-projects#3726
- Loading branch information
1 parent
45971b2
commit 4621303
Showing
3 changed files
with
129 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
.../src/main/java/org/springframework/data/mongodb/core/aggregation/SampleRateOperation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
/* | ||
* Copyright 2017-2021 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package org.springframework.data.mongodb.core.aggregation; | ||
|
||
import org.bson.Document; | ||
import org.springframework.util.Assert; | ||
|
||
/** | ||
* Encapsulates the {@code $sampleRate}-operation. | ||
* <p> | ||
* We recommend using the static factory method {@link Aggregation#sampleRate(double)} instead of creating instances of this | ||
* class directly. | ||
* | ||
* @author James McNee | ||
* @see <a href="https://docs.mongodb.com/manual/reference/operator/aggregation/sampleRate/">MongoDB Aggregation Framework: | ||
* $sampleRate</a> | ||
* @since 3.2.4 | ||
*/ | ||
public class SampleRateOperation implements AggregationOperation { | ||
|
||
private final double sampleRate; | ||
|
||
/** | ||
* @param sampleRate sample rate to determine number of documents to be randomly selected from the input. | ||
*/ | ||
public SampleRateOperation(double sampleRate) { | ||
Assert.isTrue(sampleRate >= 0, "Sample rate must be greater than zero!"); | ||
Assert.isTrue(sampleRate <= 1, "Sample rate must not be greater than one!"); | ||
this.sampleRate = sampleRate; | ||
} | ||
|
||
/* | ||
(non-Javadoc) | ||
* @see org.springframework.data.mongodb.core.aggregation.BucketOperationSupport#toDocument(org.springframework.data.mongodb.core.aggregation.AggregationOperationContext) | ||
*/ | ||
@Override | ||
public Document toDocument(AggregationOperationContext context) { | ||
return new Document(getOperator(), this.sampleRate); | ||
} | ||
|
||
/* | ||
* (non-Javadoc) | ||
* @see org.springframework.data.mongodb.core.aggregation.AggregationOperation#getOperator() | ||
*/ | ||
@Override | ||
public String getOperator() { | ||
return "$sampleRate"; | ||
} | ||
} |
54 changes: 54 additions & 0 deletions
54
.../java/org/springframework/data/mongodb/core/aggregation/SampleRateOperationUnitTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
/* | ||
* Copyright 2017-2021 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package org.springframework.data.mongodb.core.aggregation; | ||
|
||
import org.bson.Document; | ||
import org.junit.jupiter.api.Test; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; | ||
|
||
/** | ||
* Unit tests for {@link SampleRateOperation}. | ||
* | ||
* @author James McNee | ||
*/ | ||
public class SampleRateOperationUnitTests { | ||
|
||
private static final String OPERATION = "$sampleRate"; | ||
|
||
@Test // GH-3726 | ||
public void shouldRejectSampleNegativeSampleRate() { | ||
assertThatIllegalArgumentException().isThrownBy(() -> new SampleRateOperation(-1.0)); | ||
} | ||
|
||
@Test // GH-3726 | ||
public void shouldRejectSampleRateGreaterThan1() { | ||
assertThatIllegalArgumentException().isThrownBy(() -> new SampleRateOperation(1.1)); | ||
} | ||
|
||
@Test // GH-3726 | ||
public void rendersSampleRateOperation() { | ||
double sampleRate = 0.34; | ||
|
||
SampleRateOperation sampleOperation = Aggregation.sampleRate(sampleRate); | ||
|
||
Document sampleOperationDocument = sampleOperation.toDocument(Aggregation.DEFAULT_CONTEXT); | ||
|
||
assertThat(sampleOperationDocument.get(OPERATION)).isNotNull(); | ||
assertThat(sampleOperationDocument.get(OPERATION)).isEqualTo(sampleRate); | ||
} | ||
} |