Pass scripting (host) environment independently from properties/configuration

This commit is contained in:
Ilya Chernikov
2018-07-15 22:23:49 +02:00
parent 91e6c0b77c
commit 8953bba47c
11 changed files with 49 additions and 43 deletions
@@ -208,14 +208,13 @@ fun loadDefinitionsFromTemplates(
) )
} }
template.annotations.firstIsInstanceOrNull<kotlin.script.experimental.annotations.KotlinScript>() != null -> { template.annotations.firstIsInstanceOrNull<kotlin.script.experimental.annotations.KotlinScript>() != null -> {
val hostEnvironment = ScriptingEnvironment(
ScriptingEnvironmentProperties.configurationDependencies to listOf(JvmDependency(classpath)),
ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass()
)
KotlinScriptDefinitionAdapterFromNewAPI( KotlinScriptDefinitionAdapterFromNewAPI(
ScriptDefinitionFromAnnotatedBaseClass( ScriptDefinitionFromAnnotatedBaseClass(KotlinType(template), hostEnvironment),
KotlinType(template), hostEnvironment
ScriptingEnvironment(
ScriptingEnvironmentProperties.configurationDependencies to listOf(JvmDependency(classpath)),
ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass()
)
)
) )
} }
else -> { else -> {
@@ -19,10 +19,10 @@ import kotlin.script.experimental.jvmhost.impl.KJVMCompilerImpl
import kotlin.script.experimental.misc.invoke import kotlin.script.experimental.misc.invoke
fun evalFile(scriptFile: File): ResultWithDiagnostics<EvaluationResult> { fun evalFile(scriptFile: File): ResultWithDiagnostics<EvaluationResult> {
val scriptCompiler = JvmScriptCompiler(KJVMCompilerImpl(), DummyCompiledJvmScriptCache())
val environment = ScriptingEnvironment( val environment = ScriptingEnvironment(
ScriptingEnvironmentProperties.getScriptingClass(JvmGetScriptingClass()) ScriptingEnvironmentProperties.getScriptingClass(JvmGetScriptingClass())
) )
val scriptCompiler = JvmScriptCompiler(KJVMCompilerImpl(environment), DummyCompiledJvmScriptCache())
val scriptDefinition = ScriptDefinitionFromAnnotatedBaseClass( val scriptDefinition = ScriptDefinitionFromAnnotatedBaseClass(
KotlinType(MyScriptWithMavenDeps::class), KotlinType(MyScriptWithMavenDeps::class),
environment environment
@@ -33,7 +33,6 @@ abstract class MyScriptWithMavenDeps {
object MyConfiguration : ArrayList<Pair<TypedKey<*>, Any?>>( object MyConfiguration : ArrayList<Pair<TypedKey<*>, Any?>>(
jvmJavaHomeParams + with(ScriptCompileConfigurationProperties) { jvmJavaHomeParams + with(ScriptCompileConfigurationProperties) {
listOf( listOf(
baseClass<MyScriptWithMavenDeps>(),
defaultImports(DependsOn::class.qualifiedName!!, Repository::class.qualifiedName!!), defaultImports(DependsOn::class.qualifiedName!!, Repository::class.qualifiedName!!),
dependencies( dependencies(
JvmDependency( JvmDependency(
@@ -18,16 +18,15 @@ import kotlin.script.experimental.misc.*
val myJvmConfigParams = jvmJavaHomeParams + with(ScriptCompileConfigurationProperties) { val myJvmConfigParams = jvmJavaHomeParams + with(ScriptCompileConfigurationProperties) {
listOf( listOf(
baseClass<MyScript>(),
dependencies(JvmDependency(scriptCompilationClasspathFromContext("scripting-jvm-simple-script" /* script library jar name */))) dependencies(JvmDependency(scriptCompilationClasspathFromContext("scripting-jvm-simple-script" /* script library jar name */)))
) )
} }
fun evalFile(scriptFile: File): ResultWithDiagnostics<EvaluationResult> { fun evalFile(scriptFile: File): ResultWithDiagnostics<EvaluationResult> {
val scriptCompiler = JvmScriptCompiler(KJVMCompilerImpl(), DummyCompiledJvmScriptCache())
val environment = ScriptingEnvironment( val environment = ScriptingEnvironment(
ScriptingEnvironmentProperties.getScriptingClass(JvmGetScriptingClass()) ScriptingEnvironmentProperties.getScriptingClass(JvmGetScriptingClass())
) )
val scriptCompiler = JvmScriptCompiler(KJVMCompilerImpl(environment), DummyCompiledJvmScriptCache())
val scriptDefinition = ScriptDefinitionFromAnnotatedBaseClass( val scriptDefinition = ScriptDefinitionFromAnnotatedBaseClass(
KotlinType(MyScript::class), KotlinType(MyScript::class),
environment environment
@@ -29,8 +29,3 @@ object ScriptDefinitionProperties {
val baseClass by typedKey<KotlinType>() // script base class val baseClass by typedKey<KotlinType>() // script base class
} }
fun ScriptDefinitionPropertiesBag.getScriptBaseClass(contextClass: KClass<*>): KClass<*> =
getScriptingClass(get(ScriptDefinitionProperties.baseClass), contextClass)
fun ScriptDefinitionPropertiesBag.getScriptBaseClass(context: Any): KClass<*> =
getScriptingClass(get(ScriptDefinitionProperties.baseClass), context::class)
@@ -15,7 +15,6 @@ import kotlin.script.experimental.annotations.KotlinScriptDefinition
import kotlin.script.experimental.annotations.KotlinScriptFileExtension import kotlin.script.experimental.annotations.KotlinScriptFileExtension
import kotlin.script.experimental.api.* import kotlin.script.experimental.api.*
import kotlin.script.experimental.util.TypedKey import kotlin.script.experimental.util.TypedKey
import kotlin.script.experimental.util.chainPropertyBags
private const val ERROR_MSG_PREFIX = "Unable to construct script definition: " private const val ERROR_MSG_PREFIX = "Unable to construct script definition: "
@@ -44,12 +43,12 @@ open class ScriptDefinitionFromAnnotatedBaseClass(
baseClass.findAnnotation<KotlinScriptDefinition>()?.definition.takeIf { it != this::class }?.let { it.instantiateScriptHandler() } baseClass.findAnnotation<KotlinScriptDefinition>()?.definition.takeIf { it != this::class }?.let { it.instantiateScriptHandler() }
override val properties = run { override val properties = run {
val baseProperties = chainPropertyBags(explicitDefinition?.properties, environment) val baseProperties = explicitDefinition?.properties
val propertiesData = arrayListOf<Pair<TypedKey<*>, Any?>>(ScriptDefinitionProperties.baseClass to baseClassType) val propertiesData = hashMapOf<TypedKey<*>, Any?>(ScriptDefinitionProperties.baseClass to baseClassType)
baseClass.findAnnotation<KotlinScriptFileExtension>()?.let { baseClass.findAnnotation<KotlinScriptFileExtension>()?.let {
propertiesData += ScriptDefinitionProperties.fileExtension to it.extension propertiesData[ScriptDefinitionProperties.fileExtension] = it.extension
} }
if (baseProperties.getOrNull(ScriptDefinitionProperties.name) == null) { if (baseProperties?.getOrNull(ScriptDefinitionProperties.name) == null) {
propertiesData += ScriptDefinitionProperties.name to mainAnnotation.name propertiesData += ScriptDefinitionProperties.name to mainAnnotation.name
} }
baseClass.annotations.filterIsInstance(KotlinScriptDefaultCompilationConfiguration::class.java).forEach { ann -> baseClass.annotations.filterIsInstance(KotlinScriptDefaultCompilationConfiguration::class.java).forEach { ann ->
@@ -61,10 +60,12 @@ open class ScriptDefinitionFromAnnotatedBaseClass(
params.forEach { param -> params.forEach { param ->
if (param !is Pair<*, *> || param.first !is TypedKey<*>) if (param !is Pair<*, *> || param.first !is TypedKey<*>)
throw IllegalArgumentException("$ILLEGAL_CONFIG_ANN_ARG: invalid parameter $param") throw IllegalArgumentException("$ILLEGAL_CONFIG_ANN_ARG: invalid parameter $param")
propertiesData.add(param as Pair<TypedKey<*>, Any?>) (param as Pair<TypedKey<*>, Any?>).let { (k, v) ->
propertiesData[k] = v
}
} }
} }
ScriptingEnvironment(baseProperties, propertiesData) ScriptingEnvironment.createOptimized(baseProperties, propertiesData)
} }
private fun <T : Any> KClass<T>.instantiateScriptHandler(): T { private fun <T : Any> KClass<T>.instantiateScriptHandler(): T {
@@ -42,6 +42,7 @@ open class ChainedPropertyBag private constructor(private val parent: ChainedPro
companion object { companion object {
fun createOptimized(parent: ChainedPropertyBag?, data: Map<TypedKey<*>, Any?>): ChainedPropertyBag = when { fun createOptimized(parent: ChainedPropertyBag?, data: Map<TypedKey<*>, Any?>): ChainedPropertyBag = when {
parent != null && data.isEmpty() -> parent parent != null && data.isEmpty() -> parent
parent != null && parent.data.isEmpty() -> createOptimized(parent.parent, data)
else -> ChainedPropertyBag(parent, data) else -> ChainedPropertyBag(parent, data)
} }
} }
@@ -70,7 +70,7 @@ class KJVMCompiledScript<out ScriptBase : Any>(
} }
} }
class KJVMCompilerImpl : KJVMCompilerProxy { class KJVMCompilerImpl(val hostEnvironment: ScriptingEnvironment) : KJVMCompilerProxy {
override fun compile( override fun compile(
script: ScriptSource, script: ScriptSource,
@@ -104,7 +104,7 @@ class KJVMCompilerImpl : KJVMCompilerProxy {
val kotlinCompilerConfiguration = org.jetbrains.kotlin.config.CompilerConfiguration().apply { val kotlinCompilerConfiguration = org.jetbrains.kotlin.config.CompilerConfiguration().apply {
add( add(
JVMConfigurationKeys.SCRIPT_DEFINITIONS, JVMConfigurationKeys.SCRIPT_DEFINITIONS,
BridgeScriptDefinition(scriptDefinition, scriptCompileConfiguration, ::updateClasspath) BridgeScriptDefinition(scriptDefinition, scriptCompileConfiguration, hostEnvironment, ::updateClasspath)
) )
put<MessageCollector>(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, messageCollector) put<MessageCollector>(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, messageCollector)
put(JVMConfigurationKeys.RETAIN_OUTPUT_IN_MEMORY, true) put(JVMConfigurationKeys.RETAIN_OUTPUT_IN_MEMORY, true)
@@ -238,17 +238,23 @@ class ScriptDiagnosticsMessageCollector : MessageCollector {
internal class BridgeScriptDefinition( internal class BridgeScriptDefinition(
scriptDefinition: ScriptDefinition, scriptDefinition: ScriptDefinition,
calculatedBcriptCompilerConfiguration: ScriptCompileConfiguration, calculatedScriptCompilerConfiguration: ScriptCompileConfiguration,
hostEnvironment: ScriptingEnvironment,
updateClasspath: (List<File>) -> Unit updateClasspath: (List<File>) -> Unit
) : KotlinScriptDefinition(calculatedBcriptCompilerConfiguration.getScriptBaseClass(BridgeScriptDefinition::class)) { ) : KotlinScriptDefinition(
hostEnvironment.getScriptingClass(
scriptDefinition.properties[ScriptDefinitionProperties.baseClass],
BridgeScriptDefinition::class
)
) {
override val acceptedAnnotations = run { override val acceptedAnnotations = run {
val cl = this::class.java.classLoader val cl = this::class.java.classLoader
calculatedBcriptCompilerConfiguration.getOrNull(ScriptCompileConfigurationProperties.refineConfigurationOnAnnotations) calculatedScriptCompilerConfiguration.getOrNull(ScriptCompileConfigurationProperties.refineConfigurationOnAnnotations)
?.map { (cl.loadClass(it.typeName) as Class<out Annotation>).kotlin } ?.map { (cl.loadClass(it.typeName) as Class<out Annotation>).kotlin }
?: emptyList() ?: emptyList()
} }
override val dependencyResolver: DependenciesResolver = override val dependencyResolver: DependenciesResolver =
BridgeDependenciesResolver(scriptDefinition, calculatedBcriptCompilerConfiguration, updateClasspath) BridgeDependenciesResolver(scriptDefinition, calculatedScriptCompilerConfiguration, updateClasspath)
} }
@@ -24,6 +24,8 @@ abstract class KotlinScriptDefinitionAdapterFromNewAPIBase : KotlinScriptDefinit
protected abstract val scriptDefinition: ScriptDefinition protected abstract val scriptDefinition: ScriptDefinition
protected abstract val hostEnvironment: ScriptingEnvironment
abstract val scriptFileExtensionWithDot: String abstract val scriptFileExtensionWithDot: String
open val baseClass: KClass<*> by lazy(LazyThreadSafetyMode.PUBLICATION) { open val baseClass: KClass<*> by lazy(LazyThreadSafetyMode.PUBLICATION) {
@@ -88,8 +90,8 @@ abstract class KotlinScriptDefinitionAdapterFromNewAPIBase : KotlinScriptDefinit
.orEmpty() .orEmpty()
private val scriptingClassGetter by lazy(LazyThreadSafetyMode.PUBLICATION) { private val scriptingClassGetter by lazy(LazyThreadSafetyMode.PUBLICATION) {
scriptDefinition.properties.getOrNull(ScriptingEnvironmentProperties.getScriptingClass) hostEnvironment.getOrNull(ScriptingEnvironmentProperties.getScriptingClass)
?: throw IllegalArgumentException("Expecting 'getScriptingClass' property in the scripting environment") ?: throw IllegalArgumentException("Expecting 'getScriptingClass' property in the scripting environment")
} }
private fun getScriptingClass(type: KotlinType) = private fun getScriptingClass(type: KotlinType) =
@@ -102,7 +104,8 @@ abstract class KotlinScriptDefinitionAdapterFromNewAPIBase : KotlinScriptDefinit
class KotlinScriptDefinitionAdapterFromNewAPI( class KotlinScriptDefinitionAdapterFromNewAPI(
override val scriptDefinition: ScriptDefinition override val scriptDefinition: ScriptDefinition,
override val hostEnvironment: ScriptingEnvironment
) : KotlinScriptDefinitionAdapterFromNewAPIBase() { ) : KotlinScriptDefinitionAdapterFromNewAPIBase() {
override val name: String get() = scriptDefinition.properties.getOrNull(ScriptDefinitionProperties.name) ?: super.name override val name: String get() = scriptDefinition.properties.getOrNull(ScriptDefinitionProperties.name) ?: super.name
@@ -34,19 +34,20 @@ class LazyScriptDefinitionFromDiscoveredClass internal constructor(
messageCollector: MessageCollector messageCollector: MessageCollector
) : this(loadAnnotationsFromClass(classBytes), className, classpath, messageCollector) ) : this(loadAnnotationsFromClass(classBytes), className, classpath, messageCollector)
override val hostEnvironment: ScriptingEnvironment by lazy(LazyThreadSafetyMode.PUBLICATION) {
ScriptingEnvironment(
ScriptingEnvironmentProperties.configurationDependencies to listOf(JvmDependency(classpath)),
ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass()
)
}
override val scriptDefinition: ScriptDefinition by lazy(LazyThreadSafetyMode.PUBLICATION) { override val scriptDefinition: ScriptDefinition by lazy(LazyThreadSafetyMode.PUBLICATION) {
messageCollector.report( messageCollector.report(
CompilerMessageSeverity.LOGGING, CompilerMessageSeverity.LOGGING,
"Configure scripting: loading script definition class $className using classpath $classpath\n. ${Thread.currentThread().stackTrace}" "Configure scripting: loading script definition class $className using classpath $classpath\n. ${Thread.currentThread().stackTrace}"
) )
try { try {
ScriptDefinitionFromAnnotatedBaseClass( ScriptDefinitionFromAnnotatedBaseClass(KotlinType(className), hostEnvironment)
KotlinType(className),
ScriptingEnvironment(
ScriptingEnvironmentProperties.configurationDependencies to listOf(JvmDependency(classpath)),
ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass()
)
)
} catch (ex: ClassNotFoundException) { } catch (ex: ClassNotFoundException) {
messageCollector.report(CompilerMessageSeverity.ERROR, "Cannot find script definition class $className") messageCollector.report(CompilerMessageSeverity.ERROR, "Cannot find script definition class $className")
InvalidScriptDefinition InvalidScriptDefinition
@@ -274,13 +274,15 @@ private fun loadScriptDefinition(
val cls = classLoader.loadClass(template) val cls = classLoader.loadClass(template)
val def = val def =
if (cls.annotations.firstIsInstanceOrNull<KotlinScript>() != null) { if (cls.annotations.firstIsInstanceOrNull<KotlinScript>() != null) {
val environment = ScriptingEnvironment(
ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass()
)
KotlinScriptDefinitionAdapterFromNewAPI( KotlinScriptDefinitionAdapterFromNewAPI(
ScriptDefinitionFromAnnotatedBaseClass( ScriptDefinitionFromAnnotatedBaseClass(
KotlinType(cls.kotlin), KotlinType(cls.kotlin),
ScriptingEnvironment( environment
ScriptingEnvironmentProperties.getScriptingClass to JvmGetScriptingClass() ),
) environment
)
) )
} else { } else {
KotlinScriptDefinitionFromAnnotatedTemplate(cls.kotlin, scriptResolverEnv) KotlinScriptDefinitionFromAnnotatedTemplate(cls.kotlin, scriptResolverEnv)