-
Notifications
You must be signed in to change notification settings - Fork 337
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
improvement: fetch missing dependency sources
- Loading branch information
1 parent
9a1575b
commit 7062b8c
Showing
5 changed files
with
202 additions
and
12 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
106 changes: 106 additions & 0 deletions
106
metals/src/main/scala/scala/meta/internal/metals/JarSourcesProvider.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,106 @@ | ||
| package scala.meta.internal.metals | ||
|
|
||
| import java.nio.file.Path | ||
|
|
||
| import scala.util.Success | ||
| import scala.util.Try | ||
| import scala.xml.XML | ||
|
|
||
| import scala.meta.internal.metals.MetalsEnrichments._ | ||
| import scala.meta.internal.semver.SemVer | ||
| import scala.meta.io.AbsolutePath | ||
|
|
||
| import coursierapi.Dependency | ||
| import coursierapi.Fetch | ||
|
|
||
| object JarSourcesProvider { | ||
|
|
||
| private val sbtRegex = "sbt-(.*)".r | ||
|
|
||
| def fetchSources(jars: Seq[String]): Seq[String] = { | ||
| def sourcesPath(jar: String) = s"${jar.stripSuffix(".jar")}-sources.jar" | ||
|
|
||
| val (haveSources, toDownload) = jars.partition { jar => | ||
| sourcesPath(jar).toAbsolutePathSafe.exists(_.exists) | ||
| } | ||
|
|
||
| val dependencies = toDownload.flatMap { jarPath => | ||
| val pomPath = s"${jarPath.stripSuffix(".jar")}.pom" | ||
| val dependency = | ||
| for { | ||
| pom <- pomPath.toAbsolutePathSafe | ||
| if pom.exists | ||
| dependency <- getDependency(pom) | ||
| } yield dependency | ||
|
|
||
| dependency.orElse { jarPath.toAbsolutePathSafe.flatMap(sbtFallback) } | ||
| }.distinct | ||
|
|
||
| val fetchedSources = | ||
| dependencies.flatMap { dep => | ||
| Try(fetchDependencySources(dep)).toEither match { | ||
| case Right(fetched) => fetched.map(_.toUri().toString()) | ||
| case Left(error) => | ||
| scribe.warn( | ||
| s"could not fetch dependency sources for $dep, error: $error" | ||
| ) | ||
| None | ||
| } | ||
| } | ||
| val existingSources = haveSources.map(sourcesPath) | ||
| fetchedSources ++ existingSources | ||
|
|
||
| } | ||
|
|
||
| private def sbtFallback(jar: AbsolutePath): Option[Dependency] = { | ||
| val filename = jar.filename.stripSuffix(".jar") | ||
| filename match { | ||
| case sbtRegex(versionStr) if Try().isSuccess => | ||
| Try(SemVer.Version.fromString(versionStr)) match { | ||
| case Success(version) if version.toString == versionStr => | ||
| Some(Dependency.of("org.scala-sbt", "sbt", versionStr)) | ||
| case _ => None | ||
| } | ||
| case _ => None | ||
| } | ||
| } | ||
|
|
||
| private def getDependency(pom: AbsolutePath) = { | ||
| val xml = XML.loadFile(pom.toFile) | ||
| val groupId = (xml \ "groupId").text | ||
| val version = (xml \ "version").text | ||
| val artifactId = (xml \ "artifactId").text | ||
| Option | ||
| .when(groupId.nonEmpty && version.nonEmpty && artifactId.nonEmpty) { | ||
| Dependency.of(groupId, artifactId, version) | ||
| } | ||
| .filterNot(dep => isSbtDap(dep) || isMetalsPlugin(dep)) | ||
| } | ||
|
|
||
| private def isSbtDap(dependency: Dependency) = { | ||
| dependency.getModule().getOrganization() == "ch.epfl.scala" && | ||
| dependency.getModule().getName() == "sbt-debug-adapter" && | ||
| dependency.getVersion() == BuildInfo.debugAdapterVersion | ||
| } | ||
|
|
||
| private def isMetalsPlugin(dependency: Dependency) = { | ||
| dependency.getModule().getOrganization() == "org.scalameta" && | ||
| dependency.getModule().getName() == "sbt-metals" && | ||
| dependency.getVersion() == BuildInfo.metalsVersion | ||
| } | ||
|
|
||
| private def fetchDependencySources( | ||
| dependency: Dependency | ||
| ): List[Path] = { | ||
| Fetch | ||
| .create() | ||
| .withDependencies(dependency) | ||
| .addClassifiers("sources") | ||
| .fetchResult() | ||
| .getFiles() | ||
| .asScala | ||
| .map(_.toPath()) | ||
| .toList | ||
| } | ||
|
|
||
| } |
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
19 changes: 19 additions & 0 deletions
19
tests/unit/src/test/scala/tests/JarSourcesProviderSuite.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,19 @@ | ||
| package tests | ||
|
|
||
| import scala.meta.internal.metals.JarSourcesProvider | ||
| import scala.meta.internal.metals.MetalsEnrichments._ | ||
|
|
||
| class JarSourcesProviderSuite extends BaseSuite { | ||
|
|
||
| test("download-deps") { | ||
| val downloadedSources = | ||
| JarSourcesProvider.fetchSources(Library.cats.map(_.toURI.toString())) | ||
| assert(downloadedSources.nonEmpty) | ||
| downloadedSources.foreach { pathStr => | ||
| val path = pathStr.toAbsolutePath | ||
| assert(path.exists) | ||
| assert(path.filename.endsWith("-sources.jar")) | ||
| } | ||
| } | ||
|
|
||
| } |