[SPARK-35800][SS] Improving GroupState testability by introducing TestGroupState #32938
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
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
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
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,173 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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 | ||
| * | ||
| * http://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.apache.spark.sql.streaming | ||
|
|
||
| import org.apache.spark.annotation.{Evolving, Experimental} | ||
| import org.apache.spark.api.java.Optional | ||
| import org.apache.spark.sql.execution.streaming.GroupStateImpl | ||
| import org.apache.spark.sql.execution.streaming.GroupStateImpl._ | ||
|
|
||
| /** | ||
| * :: Experimental :: | ||
| * | ||
| * The extended version of [[GroupState]] interface with extra getters of state machine fields | ||
| * to improve testability of the [[GroupState]] implementations | ||
| * which inherit from the extended interface. | ||
| * | ||
| * Scala example of using `TestGroupState`: | ||
| * {{{ | ||
| * // Please refer to ScalaDoc of `GroupState` for the Scala definition of `mappingFunction()` | ||
| * | ||
| * import org.apache.spark.api.java.Optional | ||
| * import org.apache.spark.sql.streaming.GroupStateTimeout | ||
| * import org.apache.spark.sql.streaming.TestGroupState | ||
| * // other imports | ||
| * | ||
| * // test class setups | ||
| * | ||
| * test("MapGroupsWithState state transition function") { | ||
| * // Creates the prevState input for the state transition function | ||
| * // with desired configs. The `create()` API would guarantee that | ||
| * // the generated instance has the same behavior as the one built by | ||
| * // engine with the same configs. | ||
| * val prevState = TestGroupState.create[Int]( | ||
| * optionalState = Optional.empty[Int], | ||
| * timeoutConf = NoTimeout, | ||
| * batchProcessingTimeMs = 1L, | ||
| * eventTimeWatermarkMs = Optional.of(1L), | ||
| * hasTimedOut = false) | ||
| * | ||
| * val key: String = ... | ||
| * val values: Iterator[Int] = ... | ||
| * | ||
| * // Asserts the prevState is in init state without updates. | ||
| * assert(!prevState.isUpdated) | ||
| * | ||
| * // Calls the state transition function with the test previous state | ||
| * // with desired configs. | ||
| * mappingFunction(key, values, prevState) | ||
| * | ||
| * // Asserts the test GroupState object has been updated but not removed | ||
| * // after calling the state transition function | ||
| * assert(prevState.isUpdated) | ||
| * assert(!prevState.isRemoved) | ||
| * } | ||
| * }}} | ||
| * | ||
| * Java example of using `TestGroupSate`: | ||
| * {{{ | ||
| * // Please refer to ScalaDoc of `GroupState` for the Java definition of `mappingFunction()` | ||
| * | ||
| * import org.apache.spark.api.java.Optional; | ||
| * import org.apache.spark.sql.streaming.GroupStateTimeout; | ||
| * import org.apache.spark.sql.streaming.TestGroupState; | ||
| * // other imports | ||
| * | ||
| * // test class setups | ||
| * | ||
| * // test `MapGroupsWithState` state transition function `mappingFunction()` | ||
| * public void testMappingFunctionWithTestGroupState() { | ||
| * // Creates the prevState input for the state transition function | ||
| * // with desired configs. The `create()` API would guarantee that | ||
| * // the generated instance has the same behavior as the one built by | ||
| * // engine with the same configs. | ||
| * TestGroupState<Int> prevState = TestGroupState.create( | ||
| * Optional.empty(), | ||
| * GroupStateTimeout.NoTimeout(), | ||
| * 1L, | ||
| * Optional.of(1L), | ||
| * false); | ||
| * | ||
| * String key = ...; | ||
| * Integer[] values = ...; | ||
| * | ||
| * // Asserts the prevState is in init state without updates. | ||
| * Assert.assertFalse(prevState.isUpdated()); | ||
| * | ||
| * // Calls the state transition function with the test previous state | ||
| * // with desired configs. | ||
| * mappingFunction.call(key, Arrays.asList(values).iterator(), prevState); | ||
| * | ||
| * // Asserts the test GroupState object has been updated but not removed | ||
| * // after calling the state transition function | ||
| * Assert.assertTrue(prevState.isUpdated()); | ||
| * Assert.assertFalse(prevState.isRemoved()); | ||
| * } | ||
| * }}} | ||
| * | ||
| * @tparam S User-defined type of the state to be stored for each group. Must be encodable into | ||
| * Spark SQL types (see `Encoder` for more details). | ||
| * @since 3.2.0 | ||
| */ | ||
|
There was a problem hiding this comment. Since the original GroupState API is still marked as experimental (I know it does make sense, but that's for a different discussion), lets be consistent and add the same annotations to this as well. similarly, also add and would be nice if you could add Java and Scala code snippets of how to use these traits. It's not entirely obvious how to use TestGroupState. See GroupState to find out how to add code snippets. This is how it looks later - https://spark.apache.org/docs/2.4.0/api/scala/index.html#org.apache.spark.sql.streaming.GroupState |
||
| @Experimental | ||
| @Evolving | ||
| trait TestGroupState[S] extends GroupState[S] { | ||
| /** Whether the state has been marked for removing */ | ||
| def isRemoved: Boolean | ||
|
|
||
| /** Whether the state has been updated but not removed */ | ||
| def isUpdated: Boolean | ||
|
|
||
| /** | ||
| * Returns the timestamp if `setTimeoutTimestamp()` is called. | ||
| * Or, returns batch processing time + the duration when | ||
| * `setTimeoutDuration()` is called. | ||
| * | ||
| * Otherwise, returns `Optional.empty` if not set. | ||
| */ | ||
| def getTimeoutTimestampMs: Optional[Long] | ||
| } | ||
|
|
||
| object TestGroupState { | ||
|
|
||
| /** | ||
| * Creates TestGroupState instances for general testing purposes. | ||
| * | ||
| * @param optionalState Optional value of the state. | ||
| * @param timeoutConf Type of timeout configured. Based on this, different operations | ||
| * will be supported. | ||
| * @param batchProcessingTimeMs Processing time of current batch, used to calculate timestamp | ||
| * for processing time timeouts. | ||
| * @param eventTimeWatermarkMs Optional value of event time watermark in ms. Set as | ||
| * `Optional.empty` if watermark is not present. | ||
| * Otherwise, event time watermark should be a positive long | ||
| * and the timestampMs set through `setTimeoutTimestamp()` | ||
| * cannot be less than `eventTimeWatermarkMs`. | ||
| * @param hasTimedOut Whether the key for which this state wrapped is being created is | ||
| * getting timed out or not. | ||
| * @return a [[TestGroupState]] instance built with the user specified configs. | ||
| */ | ||
| @throws[IllegalArgumentException]("if 'batchProcessingTimeMs' is less than 0") | ||
| @throws[IllegalArgumentException]("if 'eventTimeWatermarkMs' is present but less than 0") | ||
| @throws[UnsupportedOperationException]( | ||
| "if 'hasTimedOut' is true however there's no timeout configured") | ||
| def create[S]( | ||
| optionalState: Optional[S], | ||
| timeoutConf: GroupStateTimeout, | ||
| batchProcessingTimeMs: Long, | ||
| eventTimeWatermarkMs: Optional[Long], | ||
| hasTimedOut: Boolean): TestGroupState[S] = { | ||
| GroupStateImpl.createForStreaming[S]( | ||
| Option(optionalState.orNull), | ||
| batchProcessingTimeMs, | ||
| eventTimeWatermarkMs.orElse(NO_TIMESTAMP), | ||
| timeoutConf, | ||
| hasTimedOut, | ||
| eventTimeWatermarkMs.isPresent()) | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you need htis as well
::Experimental::See GroupState