forked from apache/spark
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[SPARK-49031] Implement validation for the TransformWithStateExec ope…
…rator using OperatorStateMetadataV2 ### What changes were proposed in this pull request? Implementing validation for the TransformWithStateExec operator, so that it can't restart with a different TimeMode and OutputMode, or invalid State Variable transformations. ### Why are the changes needed? If there is an invalid change to the query after a restart, we want the query to fail. ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? Unit tests ### Was this patch authored or co-authored using generative AI tooling? No Closes apache#47508 from ericm-db/validation. Authored-by: Eric Marnadi <eric.marnadi@databricks.com> Signed-off-by: Jungtaek Lim <kabhwan.opensource@gmail.com>
- Loading branch information
1 parent
acb2fec
commit 40d94b6
Showing
8 changed files
with
553 additions
and
18 deletions.
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
149 changes: 149 additions & 0 deletions
149
...main/scala/org/apache/spark/sql/execution/streaming/TransformWithStateVariableUtils.scala
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,149 @@ | ||
| /* | ||
| * 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.execution.streaming | ||
|
|
||
| import org.json4s.DefaultFormats | ||
| import org.json4s.JsonAST._ | ||
| import org.json4s.JsonDSL._ | ||
| import org.json4s.jackson.JsonMethods | ||
| import org.json4s.jackson.JsonMethods.{compact, render} | ||
|
|
||
| import org.apache.spark.internal.Logging | ||
| import org.apache.spark.sql.execution.streaming.StateVariableType.StateVariableType | ||
| import org.apache.spark.sql.execution.streaming.state.StateStoreErrors | ||
|
|
||
| /** | ||
| * This file contains utility classes and functions for managing state variables in | ||
| * the operatorProperties field of the OperatorStateMetadata for TransformWithState. | ||
| * We use these utils to read and write state variable information for validation purposes. | ||
| */ | ||
| object TransformWithStateVariableUtils { | ||
| def getValueState(stateName: String, ttlEnabled: Boolean): TransformWithStateVariableInfo = { | ||
| TransformWithStateVariableInfo(stateName, StateVariableType.ValueState, ttlEnabled) | ||
| } | ||
|
|
||
| def getListState(stateName: String, ttlEnabled: Boolean): TransformWithStateVariableInfo = { | ||
| TransformWithStateVariableInfo(stateName, StateVariableType.ListState, ttlEnabled) | ||
| } | ||
|
|
||
| def getMapState(stateName: String, ttlEnabled: Boolean): TransformWithStateVariableInfo = { | ||
| TransformWithStateVariableInfo(stateName, StateVariableType.MapState, ttlEnabled) | ||
| } | ||
| } | ||
|
|
||
| // Enum of possible State Variable types | ||
| object StateVariableType extends Enumeration { | ||
| type StateVariableType = Value | ||
| val ValueState, ListState, MapState = Value | ||
| } | ||
|
|
||
| case class TransformWithStateVariableInfo( | ||
| stateName: String, | ||
| stateVariableType: StateVariableType, | ||
| ttlEnabled: Boolean) { | ||
| def jsonValue: JValue = { | ||
| ("stateName" -> JString(stateName)) ~ | ||
| ("stateVariableType" -> JString(stateVariableType.toString)) ~ | ||
| ("ttlEnabled" -> JBool(ttlEnabled)) | ||
| } | ||
|
|
||
| def json: String = { | ||
| compact(render(jsonValue)) | ||
| } | ||
| } | ||
|
|
||
| object TransformWithStateVariableInfo { | ||
|
|
||
| def fromJson(json: String): TransformWithStateVariableInfo = { | ||
| implicit val formats: DefaultFormats.type = DefaultFormats | ||
| val parsed = JsonMethods.parse(json).extract[Map[String, Any]] | ||
| fromMap(parsed) | ||
| } | ||
|
|
||
| def fromMap(map: Map[String, Any]): TransformWithStateVariableInfo = { | ||
| val stateName = map("stateName").asInstanceOf[String] | ||
| val stateVariableType = StateVariableType.withName( | ||
| map("stateVariableType").asInstanceOf[String]) | ||
| val ttlEnabled = map("ttlEnabled").asInstanceOf[Boolean] | ||
| TransformWithStateVariableInfo(stateName, stateVariableType, ttlEnabled) | ||
| } | ||
| } | ||
|
|
||
| case class TransformWithStateOperatorProperties( | ||
| timeMode: String, | ||
| outputMode: String, | ||
| stateVariables: List[TransformWithStateVariableInfo]) { | ||
|
|
||
| def json: String = { | ||
| val stateVariablesJson = stateVariables.map(_.jsonValue) | ||
| val json = | ||
| ("timeMode" -> timeMode) ~ | ||
| ("outputMode" -> outputMode) ~ | ||
| ("stateVariables" -> stateVariablesJson) | ||
| compact(render(json)) | ||
| } | ||
| } | ||
|
|
||
| object TransformWithStateOperatorProperties extends Logging { | ||
| def fromJson(json: String): TransformWithStateOperatorProperties = { | ||
| implicit val formats: DefaultFormats.type = DefaultFormats | ||
| val jsonMap = JsonMethods.parse(json).extract[Map[String, Any]] | ||
| TransformWithStateOperatorProperties( | ||
| jsonMap("timeMode").asInstanceOf[String], | ||
| jsonMap("outputMode").asInstanceOf[String], | ||
| jsonMap("stateVariables").asInstanceOf[List[Map[String, Any]]].map { stateVarMap => | ||
| TransformWithStateVariableInfo.fromMap(stateVarMap) | ||
| } | ||
| ) | ||
| } | ||
|
|
||
| // This function is to confirm that the operator properties and state variables have | ||
| // only changed in an acceptable way after query restart. If the properties have changed | ||
| // in an unacceptable way, this function will throw an exception. | ||
| def validateOperatorProperties( | ||
| oldOperatorProperties: TransformWithStateOperatorProperties, | ||
| newOperatorProperties: TransformWithStateOperatorProperties): Unit = { | ||
| if (oldOperatorProperties.timeMode != newOperatorProperties.timeMode) { | ||
| throw StateStoreErrors.invalidConfigChangedAfterRestart( | ||
| "timeMode", oldOperatorProperties.timeMode, newOperatorProperties.timeMode) | ||
| } | ||
|
|
||
| if (oldOperatorProperties.outputMode != newOperatorProperties.outputMode) { | ||
| throw StateStoreErrors.invalidConfigChangedAfterRestart( | ||
| "outputMode", oldOperatorProperties.outputMode, newOperatorProperties.outputMode) | ||
| } | ||
|
|
||
| val oldStateVariableInfos = oldOperatorProperties.stateVariables | ||
| val newStateVariableInfos = newOperatorProperties.stateVariables.map { stateVarInfo => | ||
| stateVarInfo.stateName -> stateVarInfo | ||
| }.toMap | ||
| oldStateVariableInfos.foreach { oldInfo => | ||
| val newInfo = newStateVariableInfos.get(oldInfo.stateName) | ||
| newInfo match { | ||
| case Some(stateVarInfo) => | ||
| if (oldInfo.stateVariableType != stateVarInfo.stateVariableType) { | ||
| throw StateStoreErrors.invalidVariableTypeChange( | ||
| stateVarInfo.stateName, | ||
| oldInfo.stateVariableType.toString, | ||
| stateVarInfo.stateVariableType.toString | ||
| ) | ||
| } | ||
| case None => | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.