carloea2 commented on code in PR #5141: URL: https://github.com/apache/texera/pull/5141#discussion_r3313258990
########## common/workflow-operator/src/main/scala/org/apache/texera/amber/operator/udf/python/PythonUdfUiParameterInjector.scala: ########## @@ -0,0 +1,197 @@ +/* + * 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.texera.amber.operator.udf.python + +import org.apache.texera.amber.core.tuple.{Attribute, AttributeType} +import org.apache.texera.amber.pybuilder.PythonTemplateBuilder +import org.apache.texera.amber.pybuilder.PythonTemplateBuilder.PythonTemplateBuilderStringContext + +import scala.util.matching.Regex + +/** + * Injects the reserved UI-parameter hook into user-written Python UDF code. + * + * Operator descriptors should call this after loading saved [[UiUDFParameter]] values and before sending Python source + * to runtime execution. The injected hook returns decoded parameter names and values that Python runtime support reads + * before the user's `open()` method runs. + */ +object PythonUdfUiParameterInjector { + + private val InjectedUiParametersHookMethodName = "_texera_injected_ui_parameters" + private val InjectedUiParametersHookMethodHeader = + s"def $InjectedUiParametersHookMethodName(self) -> Dict[str, Any]:" + private val UnsupportedUiParameterTypes = Set(AttributeType.BINARY, AttributeType.LARGE_BINARY) + + // Keep supported user-facing UDF class names in sync with the frontend parser. + private val SupportedPythonUdfClassHeaderRegex: Regex = + """(?m)^([ \t]*)class\s+(ProcessTupleOperator|ProcessBatchOperator|ProcessTableOperator|GenerateOperator)\s*\([^)]*\)\s*:\s*(?:#.*)?$""".r + + private def validate(uiParameters: List[UiUDFParameter]): Unit = { + val attributes = uiParameters.map(parameterAttribute) + attributes.foreach(validateSupportedType) + + attributes + .groupBy(_.getName) + .collectFirst { + case (parameterName, matchingAttributes) if matchingAttributes.size > 1 => parameterName + } + .foreach { duplicateName => + throw new RuntimeException(s"UiParameter name '$duplicateName' is declared more than once.") + } + } + + private def parameterAttribute(parameter: UiUDFParameter): Attribute = + Option(parameter).flatMap(parameter => Option(parameter.attribute)).getOrElse { + throw new RuntimeException("UiParameter attribute is required.") + } + + private def validateSupportedType(attribute: Attribute): Unit = { + if (UnsupportedUiParameterTypes.contains(attribute.getType)) { + throw new RuntimeException( + s"UiParameter type '${attribute.getType.name()}' is not supported. " + + "Use string, integer, long, double, boolean, or timestamp instead." + ) + } + } + + private def buildInjectedParameterEntry(parameter: UiUDFParameter): PythonTemplateBuilder = { + pyb"${parameter.attribute.getName}: ${parameter.value}" + } + + private def buildInjectedParametersMap( + uiParameters: List[UiUDFParameter] + ): PythonTemplateBuilder = { + val entries = uiParameters.map(buildInjectedParameterEntry) + entries.reduceOption((acc, entry) => acc + pyb", " + entry).getOrElse(pyb"") + } + + private def buildInjectedHookMethod(uiParameters: List[UiUDFParameter]): String = { + val injectedParametersMap = buildInjectedParametersMap(uiParameters) + + (pyb"""|@overrides + |$InjectedUiParametersHookMethodHeader + | return {""" + + injectedParametersMap + + pyb"""} + |""").encode + } + + private def indentBlock(block: String, indent: String): String = { + block + .split("\n", -1) + .map { line => + if (line.nonEmpty) indent + line else line + } + .mkString("\n") + } + + private def lineEndIndex(text: String, from: Int): Int = { + val lineEnd = text.indexOf('\n', from) + if (lineEnd < 0) text.length else lineEnd + } + + private def detectClassBlockEnd(code: String, classHeaderStart: Int, classIndent: String): Int = { + val classLineEnd = lineEndIndex(code, classHeaderStart) + var lineStart = if (classLineEnd < code.length) classLineEnd + 1 else code.length + + while (lineStart < code.length) { + val lineEnd = lineEndIndex(code, lineStart) + val line = code.substring(lineStart, lineEnd) + + val trimmed = line.trim + val isBlank = trimmed.isEmpty + + val currentIndentLen = line.segmentLength(ch => ch == ' ' || ch == '\t') + val classIndentLen = classIndent.length + + if (!isBlank && currentIndentLen <= classIndentLen) { + return lineStart + } + + lineStart = if (lineEnd < code.length) lineEnd + 1 else code.length + } + + code.length + } + + private def containsReservedHook(classBlock: String): Boolean = { + val hookRegex = + ("""(?m)^[ \t]+def\s+""" + Regex.quote(InjectedUiParametersHookMethodName) + """\s*\(""").r + hookRegex.findFirstIn(classBlock).isDefined + } + + private def injectHookIntoUserClass(encodedUserCode: String, hookMethod: String): String = { + val classHeaderMatch = + SupportedPythonUdfClassHeaderRegex.findFirstMatchIn(encodedUserCode).getOrElse { + return encodedUserCode Review Comment: Got it, I will update it -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
