-
Notifications
You must be signed in to change notification settings - Fork 326
/
BuildTargets.scala
591 lines (527 loc) Β· 18.1 KB
/
BuildTargets.scala
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
package scala.meta.internal.metals
import java.lang.{Iterable => JIterable}
import java.net.URLClassLoader
import java.nio.file.Path
import java.{util => ju}
import scala.annotation.tailrec
import scala.collection.mutable
import scala.concurrent.ExecutionContext
import scala.concurrent.Future
import scala.util.control.NonFatal
import scala.meta.internal.io.PathIO
import scala.meta.internal.metals.MetalsEnrichments._
import scala.meta.internal.mtags.Symbol
import scala.meta.io.AbsolutePath
import ch.epfl.scala.bsp4j.BuildTarget
import ch.epfl.scala.bsp4j.BuildTargetIdentifier
import ch.epfl.scala.bsp4j.InverseSourcesParams
import ch.epfl.scala.bsp4j.TextDocumentIdentifier
/**
* In-memory cache for looking up build server metadata.
*/
final class BuildTargets() {
private var workspace = PathIO.workingDirectory
def setWorkspaceDirectory(newWorkspace: AbsolutePath): Unit = {
workspace = newWorkspace
}
private var tables: Option[Tables] = None
private val dataLock = new Object
private var data: BuildTargets.DataSeq =
BuildTargets.DataSeq((new TargetData) :: Nil)
def allWritableData = data.list
val buildTargetsOrder: BuildTargetIdentifier => Int = {
(t: BuildTargetIdentifier) =>
var score = 1
val isSupportedScalaVersion = scalaTarget(t).exists(t =>
ScalaVersions.isSupportedAtReleaseMomentScalaVersion(
t.scalaVersion
)
)
if (isSupportedScalaVersion) score <<= 2
val usesJavac = javaTarget(t).nonEmpty
val isJVM = scalaTarget(t).exists(_.scalac.isJVM)
if (usesJavac) score <<= 1
else if (isJVM) score <<= 1
// note(@tgodzik) once the support for Scala 3 is on par with Scala 2 this can be removed
val isScala2 = scalaTarget(t).exists(info =>
!ScalaVersions.isScala3Version(info.scalaVersion)
)
if (isScala2) score <<= 1
val isScala213Version =
scalaTarget(t).exists(info => info.scalaBinaryVersion == "2.13")
if (isScala213Version) score <<= 1
score
}
def setTables(newTables: Tables): Unit = {
tables = Some(newTables)
}
def sourceItems: Iterable[AbsolutePath] =
data.iterable.flatMap(_.sourceItemsToBuildTarget.keys)
def sourceItemsToBuildTargets
: Iterator[(AbsolutePath, JIterable[BuildTargetIdentifier])] =
data.fromIterators(_.sourceItemsToBuildTarget.iterator)
private def allBuildTargetIdsInternal
: Iterator[(TargetData, BuildTargetIdentifier)] =
data.fromIterators(d => d.allBuildTargetIds.iterator.map((d, _)))
def mappedTo(path: AbsolutePath): Option[TargetData.MappedSource] =
data.fromOptions(_.actualSources.get(path))
def allBuildTargetIds: Seq[BuildTargetIdentifier] =
allBuildTargetIdsInternal.map(_._2).toVector
def allTargetRoots: Iterator[AbsolutePath] =
data.fromIterators(_.allTargetRoots)
def all: Iterator[BuildTarget] =
data.fromIterators(_.all)
def allScala: Iterator[ScalaTarget] =
data.fromIterators(_.allScala)
def allJava: Iterator[JavaTarget] =
data.fromIterators(_.allJava)
def info(id: BuildTargetIdentifier): Option[BuildTarget] =
data.fromOptions(_.info(id))
def targetData(id: BuildTargetIdentifier): Option[TargetData] =
data.fromOptions(data0 => if (data0.info(id).isEmpty) None else Some(data0))
def scalaTarget(id: BuildTargetIdentifier): Option[ScalaTarget] =
data.fromOptions(_.scalaTarget(id))
def javaTarget(id: BuildTargetIdentifier): Option[JavaTarget] =
data.fromOptions(_.javaTarget(id))
def targetJarClasspath(
id: BuildTargetIdentifier
): Option[List[AbsolutePath]] =
data.fromOptions(_.targetJarClasspath(id))
def targetClasspath(
id: BuildTargetIdentifier
): Option[List[String]] =
data.fromOptions(_.targetClasspath(id))
def targetClassDirectories(
id: BuildTargetIdentifier
): List[String] =
data.fromIterators(_.targetClassDirectories(id).iterator).toList
def allWorkspaceJars: Iterator[AbsolutePath] = {
val isVisited = new ju.HashSet[AbsolutePath]
data.fromIterators(_.allWorkspaceJars).filter { p =>
isVisited.add(p)
}
}
def onCreate(source: AbsolutePath): Unit = {
for {
buildTargetIds <- sourceBuildTargets(source)
buildTargetId <- buildTargetIds
targetData <- targetData(buildTargetId)
} {
targetData.onCreate(source)
}
}
def allSourceJars: Iterator[AbsolutePath] =
data.fromIterators(_.inverseDependencySources.keysIterator)
def buildTargetSources(
id: BuildTargetIdentifier
): Iterable[AbsolutePath] =
data
.fromOptions(_.buildTargetSources.get(id))
.map(_.asScala)
.getOrElse(Nil)
def buildTargetTransitiveSources(
id: BuildTargetIdentifier
): Iterator[AbsolutePath] = {
for {
dependency <- buildTargetTransitiveDependencies(id).iterator
sources <- data.fromOptions(_.buildTargetSources.get(dependency)).iterator
source <- sources.asScala.iterator
} yield source
}
def buildTargetTransitiveDependencies(
id: BuildTargetIdentifier
): Iterable[BuildTargetIdentifier] = {
val isVisited = mutable.Set.empty[BuildTargetIdentifier]
val toVisit = new java.util.ArrayDeque[BuildTargetIdentifier]
toVisit.add(id)
while (!toVisit.isEmpty) {
val next = toVisit.pop()
if (!isVisited(next)) {
isVisited.add(next)
for {
info <- info(next).iterator
dependency <- info.getDependencies.asScala.iterator
} {
toVisit.add(dependency)
}
}
}
isVisited
}
def targetRoots(
buildTarget: BuildTargetIdentifier
): List[AbsolutePath] = {
val javaRoot = javaTargetRoot(buildTarget).toList
val scalaRoot = scalaTargetRoot(buildTarget).toList
(javaRoot ++ scalaRoot).distinct
}
def javaTargetRoot(
buildTarget: BuildTargetIdentifier
): Option[AbsolutePath] =
data.fromOptions(_.javaTargetRoot(buildTarget))
def scalaTargetRoot(
buildTarget: BuildTargetIdentifier
): Option[AbsolutePath] =
data.fromOptions(_.scalaTargetRoot(buildTarget))
def workspaceDirectory(
buildTarget: BuildTargetIdentifier
): Option[AbsolutePath] =
buildServerOf(buildTarget).map(_.workspaceDirectory)
def canCompile(id: BuildTargetIdentifier): Boolean = {
targetData(id).exists { data =>
data.buildTargetInfo
.get(id)
.map[Boolean](_.getCapabilities().getCanCompile())
.getOrElse(true)
}
}
/**
* Returns the first build target containing this source file.
*/
def inverseSources(
source: AbsolutePath
): Option[BuildTargetIdentifier] = {
val buildTargets = sourceBuildTargets(source)
val orSbtBuildTarget =
buildTargets.getOrElse(sbtBuildScalaTarget(source).toIterable)
if (orSbtBuildTarget.isEmpty) {
tables
.flatMap(_.dependencySources.getBuildTarget(source))
.orElse(inferBuildTarget(source))
} else {
Some(orSbtBuildTarget.maxBy(buildTargetsOrder))
}
}
def inverseSourcesBsp(
source: AbsolutePath
)(implicit ec: ExecutionContext): Future[Option[BuildTargetIdentifier]] = {
inverseSources(source) match {
case None =>
val identifier = new TextDocumentIdentifier(
source.toTextDocumentIdentifier.getUri()
)
val params = new InverseSourcesParams(identifier)
val connections =
data.fromIterators(_.targetToConnection.values.toIterator).distinct
val queries = connections.map { connection =>
connection
.buildTargetInverseSources(params)
.map(_.getTargets.asScala.toList)
}
Future.sequence(queries).map { results =>
val target = results.flatten.maxByOption(buildTargetsOrder)
for {
tgt <- target
data <- targetData(tgt)
} data.addSourceItem(source, tgt)
target
}
case some =>
Future.successful(some)
}
}
def scalaVersion(source: AbsolutePath): Option[String] = {
for {
id <- inverseSources(source)
target <- scalaTarget(id)
} yield target.scalaVersion
}
/**
* Resolves sbt auto imports if a file belongs to a Sbt build target.
*/
def sbtAutoImports(path: AbsolutePath): Option[Seq[String]] =
for {
targetId <- inverseSources(path)
target <- scalaTarget(targetId)
imports <- target.autoImports
} yield imports
/**
* Tries to guess what build target this readonly file belongs to from the symbols it defines.
*
* By default, we rely on carefully recording what build target produced what
* files in the `.metals/readonly/` directory. This approach has the problem
* that navigation failed to work in `readonly/` sources if
*
* - a new metals feature forgot to record the build target
* - a user removes `.metals/metals.h2.db`
*
* When encountering an unknown `readonly/` file we do the following steps to
* infer what build target it belongs to:
*
* - check if file is in `.metals/readonly/dependencies/${source-jar-name}`
* - find the build targets that have a sourceDependency with that name
*
* Otherwise if it's a jar file we find a build target it belongs to.
*
* This approach is not glamorous but it seems to work reasonably well.
*/
def inferBuildTarget(
source: AbsolutePath
): Option[BuildTargetIdentifier] = {
if (source.isJarFileSystem) {
for {
jarName <- source.jarPath.map(_.filename)
sourceJarFile <- sourceJarFile(jarName)
buildTargetId <- inverseDependencySource(sourceJarFile).headOption
} yield buildTargetId
} else {
val readonly = workspace.resolve(Directories.readonly)
source.toRelativeInside(readonly) match {
case Some(rel) =>
val names = rel.toNIO.iterator().asScala.toList.map(_.filename)
names match {
case Directories.dependenciesName :: jarName :: _ =>
// match build target by source jar name
sourceJarFile(jarName)
.flatMap(inverseDependencySource(_).headOption)
case _ => None
}
case None =>
// else it can be a source file inside a jar
val fromJar = jarPath(source)
.flatMap { jar =>
allBuildTargetIdsInternal.find { case (_, id) =>
targetJarClasspath(id).exists(_.contains(jar))
}
}
fromJar.map { case (data0, id) =>
data0.addSourceItem(source, id)
id
}
}
}
}
def findByDisplayName(name: String): Option[BuildTarget] = {
data
.fromIterators(_.buildTargetInfo.valuesIterator)
.find(_.getDisplayName() == name)
}
private def jarPath(source: AbsolutePath): Option[AbsolutePath] = {
source.jarPath.map { sourceJarPath =>
sourceJarPath.parent.resolve(
source.filename.replace("-sources.jar", ".jar")
)
}
}
/**
* Returns meta build target for `*.sbt` or `*.scala` files.
* It selects build target by directory of its connection
* because `*.sbt` and `*.scala` aren't included in `sourceFiles` set
*/
def sbtBuildScalaTarget(
file: AbsolutePath
): Option[BuildTargetIdentifier] = {
val targetMetaBuildDir =
if (file.isSbt) file.parent.resolve("project") else file.parent
data
.fromIterators(_.buildTargetInfo.valuesIterator)
.find { target =>
val isMetaBuild = target.isSbtBuild
if (isMetaBuild) {
workspaceDirectory(target.getId)
.map(_ == targetMetaBuildDir)
.getOrElse(false)
} else {
false
}
}
.map(_.getId())
}
case class InferredBuildTarget(
jar: AbsolutePath,
symbol: String,
id: BuildTargetIdentifier,
)
def inferBuildTarget(
toplevels: Iterable[Symbol]
): Option[InferredBuildTarget] = {
val classloader = new URLClassLoader(
allWorkspaceJars.map(_.toNIO.toUri().toURL()).toArray,
null,
)
lazy val classpaths: Seq[(BuildTargetIdentifier, Iterator[AbsolutePath])] =
allBuildTargetIdsInternal.toVector.map { case (data, id) =>
id -> data
.targetClasspath(id)
.map(_.toAbsoluteClasspath)
.getOrElse(Iterator.empty)
}
try {
toplevels.foldLeft(Option.empty[InferredBuildTarget]) {
case (Some(x), _) => Some(x)
case (None, toplevel) =>
val classfile = toplevel.owner.value + toplevel.displayName + ".class"
val resource = classloader
.findResource(classfile)
.toURI()
.toString()
.replaceFirst("!/.*", "")
.stripPrefix("jar:")
val path = resource.toAbsolutePath
classpaths.collectFirst {
case (id, classpath) if classpath.contains(path) =>
InferredBuildTarget(path, toplevel.value, id)
}
}
} catch {
case NonFatal(_) =>
None
} finally {
classloader.close()
}
}
def sourceBuildTargets(
sourceItem: AbsolutePath
): Option[Iterable[BuildTargetIdentifier]] =
data.fromOptions(_.sourceBuildTargets(sourceItem))
def inverseSourceItem(source: AbsolutePath): Option[AbsolutePath] =
sourceItems.find(item => source.toNIO.startsWith(item.toNIO))
def originalInverseSourceItem(source: AbsolutePath): Option[AbsolutePath] =
data
.fromIterators(_.originalSourceItems.asScala.iterator)
.find(item => source.toNIO.startsWith(item.dealias.toNIO))
def isInverseDependency(
query: BuildTargetIdentifier,
roots: List[BuildTargetIdentifier],
): Boolean = {
BuildTargets.isInverseDependency(
query,
roots,
id => data.fromOptions(_.inverseDependencies.get(id)),
)
}
def inverseDependencyLeaves(
target: BuildTargetIdentifier
): collection.Set[BuildTargetIdentifier] = {
computeInverseDependencies(target).leaves
}
def allInverseDependencies(
target: BuildTargetIdentifier
): collection.Set[BuildTargetIdentifier] = {
computeInverseDependencies(target).visited
}
private def computeInverseDependencies(
target: BuildTargetIdentifier
): BuildTargets.InverseDependencies = {
BuildTargets.inverseDependencies(
List(target),
id => data.fromOptions(_.inverseDependencies.get(id)),
)
}
def sourceJarFile(sourceJarName: String): Option[AbsolutePath] =
data.fromOptions(_.sourceJarNameToJarFile.get(sourceJarName))
def inverseDependencySource(
sourceJar: AbsolutePath
): collection.Set[BuildTargetIdentifier] = {
data
.fromOptions(_.inverseDependencySources.get(sourceJar))
.getOrElse(Set.empty)
}
def sourceRoots: Iterable[AbsolutePath] = {
data.iterable.flatMap(_.isSourceRoot.asScala)
}
def isInsideSourceRoot(path: AbsolutePath): Boolean = {
data.iterator.exists(_.isSourceRoot.contains(path)) &&
data.fromIterators(_.isSourceRoot.asScala.iterator).exists { root =>
path.toNIO.startsWith(root.toNIO)
}
}
def isSourceFile(source: AbsolutePath): Boolean =
data.iterator.exists(_.isSourceFile(source))
def checkIfGeneratedSource(source: Path): Boolean =
data.iterator.exists(_.checkIfGeneratedSource(source))
def checkIfGeneratedDir(path: AbsolutePath): Boolean =
data.iterator.exists(_.checkIfGeneratedDir(path))
def buildServerOf(
id: BuildTargetIdentifier
): Option[BuildServerConnection] =
data.fromOptions(_.targetToConnection.get(id))
def addData(data: TargetData): Unit =
dataLock.synchronized {
this.data = BuildTargets.DataSeq(data :: this.data.list)
}
}
object BuildTargets {
def isInverseDependency(
query: BuildTargetIdentifier,
roots: List[BuildTargetIdentifier],
inverseDeps: BuildTargetIdentifier => Option[
collection.Seq[BuildTargetIdentifier]
],
): Boolean = {
val isVisited = mutable.Set.empty[BuildTargetIdentifier]
@tailrec
def loop(toVisit: List[BuildTargetIdentifier]): Boolean =
toVisit match {
case Nil => false
case head :: tail =>
if (head == query) true
else if (isVisited(head)) false
else {
isVisited += head
inverseDeps(head) match {
case Some(next) =>
loop(next.toList ++ tail)
case None =>
loop(tail)
}
}
}
loop(roots)
}
/**
* Given an acyclic graph and a root target, returns the leaf nodes that depend on the root target.
*
* For example, returns `[D, E, C]` given the following graph with root A: {{{
* A
* ^ ^
* | |
* B C
* ^ ^
* | |
* D E
* }}}
*/
def inverseDependencies(
root: List[BuildTargetIdentifier],
inverseDeps: BuildTargetIdentifier => Option[
collection.Seq[BuildTargetIdentifier]
],
): InverseDependencies = {
val isVisited = mutable.Set.empty[BuildTargetIdentifier]
val leaves = mutable.Set.empty[BuildTargetIdentifier]
def loop(toVisit: List[BuildTargetIdentifier]): Unit =
toVisit match {
case Nil => ()
case head :: tail =>
if (!isVisited(head)) {
isVisited += head
inverseDeps(head) match {
case Some(next) =>
loop(next.toList)
case None =>
// Only add leaves of the tree to the result to minimize the number
// of targets that we compile. If `B` depends on `A`, it's faster
// in Bloop to compile only `B` than `A+B`.
leaves += head
}
}
loop(tail)
}
loop(root)
InverseDependencies(isVisited, leaves)
}
case class InverseDependencies(
visited: collection.Set[BuildTargetIdentifier],
leaves: collection.Set[BuildTargetIdentifier],
)
final case class DataSeq(list: List[TargetData]) {
def iterator: Iterator[TargetData] = list.iterator
def writableDataIterator: Iterator[TargetData] = list.iterator
def iterable: Iterable[TargetData] = list.toIterable
def fromIterators[T](f: TargetData => Iterator[T]): Iterator[T] =
iterator.flatMap(f)
def fromOptions[T](f: TargetData => Option[T]): Option[T] =
fromIterators(f(_).iterator).find(_ => true)
}
}