-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
KotlinBuildScriptDependenciesResolver.kt
234 lines (187 loc) · 7.79 KB
/
KotlinBuildScriptDependenciesResolver.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/*
* Copyright 2016 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
*
* 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.gradle.kotlin.dsl.resolver
import org.gradle.kotlin.dsl.concurrent.EventLoop
import org.gradle.kotlin.dsl.concurrent.future
import org.gradle.kotlin.dsl.tooling.models.EditorPosition
import org.gradle.kotlin.dsl.tooling.models.EditorReport
import org.gradle.kotlin.dsl.tooling.models.EditorReportSeverity
import org.gradle.kotlin.dsl.tooling.models.KotlinBuildScriptModel
import org.gradle.tooling.BuildException
import com.google.common.annotations.VisibleForTesting
import java.io.File
import java.net.URI
import kotlin.script.dependencies.KotlinScriptExternalDependencies
import kotlin.script.dependencies.ScriptContents
import kotlin.script.dependencies.ScriptContents.Position
import kotlin.script.dependencies.ScriptDependenciesResolver
import kotlin.script.dependencies.ScriptDependenciesResolver.ReportSeverity
internal
typealias Environment = Map<String, Any?>
private
typealias Report = (ReportSeverity, String, Position?) -> Unit
private
fun Report.warning(message: String, position: Position? = null) =
invoke(ReportSeverity.WARNING, message, position)
private
fun Report.error(message: String, position: Position? = null) =
invoke(ReportSeverity.ERROR, message, position)
private
fun Report.fatal(message: String, position: Position? = null) =
invoke(ReportSeverity.FATAL, message, position)
private
fun Report.editorReport(editorReport: EditorReport) = editorReport.run {
invoke(severity.toIdeSeverity(), message, position?.toIdePosition())
}
private
fun EditorReportSeverity.toIdeSeverity(): ReportSeverity =
when (this) {
EditorReportSeverity.WARNING -> ReportSeverity.WARNING
EditorReportSeverity.ERROR -> ReportSeverity.ERROR
}
private
fun EditorPosition.toIdePosition(): Position =
Position(if (line == 0) 0 else line - 1, column)
class KotlinBuildScriptDependenciesResolver @VisibleForTesting constructor(
private
val logger: ResolverEventLogger
) : ScriptDependenciesResolver {
@Suppress("unused")
constructor() : this(DefaultResolverEventLogger)
override fun resolve(
script: ScriptContents,
environment: Map<String, Any?>?,
/**
* Shows a message in the IDE.
*
* To report whole file errors (e.g. failure to query for dependencies), one can just pass a
* null position so the error/warning will be shown in the top panel of the editor
*
* Also there is a FATAL Severity - in this case the highlighting of the file will be
* switched off (may be it is useful for some errors).
*/
report: (ReportSeverity, String, Position?) -> Unit,
previousDependencies: KotlinScriptExternalDependencies?
) = future {
val cid = newCorrelationId()
try {
log(ResolutionRequest(cid, script.file, environment, previousDependencies))
assembleDependenciesFrom(
cid,
script.file,
environment!!,
report,
previousDependencies
)
} catch (e: BuildException) {
log(ResolutionFailure(cid, script.file, e))
if (previousDependencies == null) report.fatal(EditorMessages.buildConfigurationFailed)
else report.warning(EditorMessages.buildConfigurationFailedUsingPrevious)
previousDependencies
} catch (e: Exception) {
log(ResolutionFailure(cid, script.file, e))
if (previousDependencies == null) report.fatal(EditorMessages.failure)
else report.error(EditorMessages.failureUsingPrevious)
previousDependencies
}
}
private
suspend fun assembleDependenciesFrom(
cid: String,
scriptFile: File?,
environment: Environment,
report: Report,
previousDependencies: KotlinScriptExternalDependencies?
): KotlinScriptExternalDependencies? {
val request = scriptModelRequestFrom(scriptFile, environment, cid)
log(SubmittedModelRequest(cid, scriptFile, request))
val response = DefaultKotlinBuildScriptModelRepository.scriptModelFor(request)
if (response == null) {
log(RequestCancelled(cid, scriptFile, request))
return null
}
log(ReceivedModelResponse(cid, scriptFile, response))
response.editorReports.forEach { editorReport ->
report.editorReport(editorReport)
}
return when {
response.exceptions.isEmpty() ->
dependenciesFrom(request, response).also {
log(ResolvedDependencies(cid, scriptFile, it))
}
previousDependencies != null && previousDependencies.classpath.count() > response.classPath.size ->
previousDependencies.also {
log(ResolvedToPreviousWithErrors(cid, scriptFile, previousDependencies, response.exceptions))
}
else ->
dependenciesFrom(request, response).also {
log(ResolvedDependenciesWithErrors(cid, scriptFile, it, response.exceptions))
}
}
}
private
fun log(event: ResolverEvent) = logger.log(event)
private
fun scriptModelRequestFrom(
scriptFile: File?,
environment: Environment,
correlationId: String
): KotlinBuildScriptModelRequest {
@Suppress("unchecked_cast")
fun stringList(key: String) =
(environment[key] as? List<String>) ?: emptyList()
fun path(key: String) =
(environment[key] as? String)?.let(::File)
val projectDir = environment["projectRoot"] as File
return KotlinBuildScriptModelRequest(
projectDir = projectDir,
scriptFile = scriptFile,
gradleInstallation = gradleInstallationFrom(environment),
gradleUserHome = path("gradleUserHome"),
javaHome = path("gradleJavaHome"),
options = stringList("gradleOptions"),
jvmOptions = stringList("gradleJvmOptions"),
correlationId = correlationId
)
}
private
fun gradleInstallationFrom(environment: Environment): GradleInstallation =
(environment["gradleHome"] as? File)?.let(GradleInstallation::Local)
?: (environment["gradleUri"] as? URI)?.let(GradleInstallation::Remote)
?: (environment["gradleVersion"] as? String)?.let(GradleInstallation::Version)
?: GradleInstallation.Wrapper
private
fun dependenciesFrom(request: KotlinBuildScriptModelRequest, response: KotlinBuildScriptModel) =
KotlinBuildScriptDependencies(
response.classPath,
response.sourcePath,
response.implicitImports,
request.javaHome?.path
)
}
internal
class KotlinBuildScriptDependencies(
override val classpath: Iterable<File>,
override val sources: Iterable<File>,
override val imports: Iterable<String>,
override val javaHome: String? = null
) : KotlinScriptExternalDependencies
/**
* Handles all incoming [KotlinBuildScriptModelRequest]s via a single [EventLoop] to avoid spawning
* multiple competing Gradle daemons.
*/
private
object DefaultKotlinBuildScriptModelRepository : KotlinBuildScriptModelRepository()