-
-
Notifications
You must be signed in to change notification settings - Fork 14
/
OmnidocBuild.scala
383 lines (336 loc) · 14.2 KB
/
OmnidocBuild.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
import sbt.{ Def, _ }
import io.Using
import sbt.librarymanagement.{ DependencyResolution, GetClassifiersConfiguration, GetClassifiersModule, UpdateConfiguration }
import sbt.librarymanagement.ivy._
import sbt.Artifact.SourceClassifier
import sbt.Keys._
import interplay.PlayBuildBase.autoImport._
import interplay._
import sbtrelease.ReleasePlugin.autoImport._
object OmnidocBuild {
val playOrganisation = "com.typesafe.play"
val scalaTestPlusPlayOrganisation = "org.scalatestplus.play"
val playOrganisations = Seq(playOrganisation, scalaTestPlusPlayOrganisation)
val snapshotVersionLabel = "2.8.x"
val playVersion = sys.props.getOrElse("play.version", "2.8.0")
val scalaTestPlusPlayVersion = sys.props.getOrElse("scalatestplus-play.version", "5.0.0")
val playJsonVersion = sys.props.getOrElse("play-json.version", "2.8.1")
val playSlickVersion = sys.props.getOrElse("play-slick.version", "5.0.0")
val maybeTwirlVersion = sys.props.get("twirl.version")
// List Play artifacts so that they can be added as dependencies
// and later Omnidoc will read the javadoc artifact.
//
// Of course there are dependencies between these projects and
// we would need to list them all here, but it is better if we
// do so that we won't need to worry about the dependency tree.
val playProjects = Seq(
"play-streams",
"play-joda-forms",
"play",
"play-server",
"play-netty-server",
"play-akka-http-server",
"play-akka-http2-support",
"play-jdbc-api",
"play-jdbc",
"play-jdbc-evolutions",
"play-java-jdbc",
"play-java-jpa",
"play-test",
"play-specs2",
"play-java",
"play-java-forms",
"play-guice",
"play-logback",
"play-ws",
"play-ahc-ws",
"play-openid",
"filters-helpers",
"play-cache",
"play-ehcache",
"play-caffeine-cache",
"play-jcache"
)
val excludeArtifacts = Seq(
"build-link",
"play-exceptions",
"play-netty-utils"
)
val playModules = Seq(
scalaTestPlusPlayOrganisation %% "scalatestplus-play" % scalaTestPlusPlayVersion,
playOrganisation %% "play-functional" % playJsonVersion,
playOrganisation %% "play-json" % playJsonVersion,
playOrganisation %% "play-slick" % playSlickVersion,
playOrganisation %% "play-slick-evolutions" % playSlickVersion
)
val maybeTwirlModule = maybeTwirlVersion.map { twirlVersion =>
playOrganisation %% "twirl-api" % twirlVersion
}.toSeq
val externalModules = playModules ++ maybeTwirlModule
val nameFilter = excludeArtifacts.foldLeft(new SimpleFilter(!_.contains("-standalone")): NameFilter)(_ - _)
val organizationFilter = playOrganisations.map(new ExactFilter(_): NameFilter).reduce(_ | _)
val playModuleFilter = moduleFilter(organization = organizationFilter, name = nameFilter)
val Omnidoc = config("omnidoc").hide
val PlaydocClassifier = "playdoc"
val extractedSources = TaskKey[Seq[Extracted]]("extractedSources")
val sourceUrls = TaskKey[Map[String, String]]("sourceUrls")
val javadoc = TaskKey[File]("javadoc")
val scaladoc = TaskKey[File]("scaladoc")
val extractedPlaydoc = TaskKey[File]("playdoc")
//Duplicate of sbt'd updateClassifiers for 'playdoc' specific use")
val updatePlaydocClassifiers = TaskKey[(sbt.librarymanagement.UpdateReport, sbt.librarymanagement.UpdateReport)] ("updatePlaydocClassifiers")
lazy val omnidoc = project
.in(file("."))
.enablePlugins(PlayLibrary, PlayReleaseBase)
.settings(omnidocSettings)
def omnidocSettings: Seq[Setting[_]] =
projectSettings ++
dependencySettings ++
releaseSettings ++
inConfig(Omnidoc) {
updateSettings ++
extractSettings ++
compilerReporterSettings ++
scaladocSettings ++
javadocSettings ++
packageSettings
}
def projectSettings: Seq[Setting[_]] = Seq(
name := "play-omnidoc",
version := playVersion,
playBuildRepoName in ThisBuild := "omnidoc",
crossScalaVersions := Seq(ScalaVersions.scala212, ScalaVersions.scala213),
resolvers ++= Seq(Resolver.bintrayRepo("akka", "snapshots"), Resolver.sonatypeRepo("releases"))
)
def dependencySettings: Seq[Setting[_]] = Seq(
ivyConfigurations += Omnidoc,
libraryDependencies ++= playProjects map (playOrganisation %% _ % playVersion % Omnidoc.name),
libraryDependencies ++= externalModules map (_ % Omnidoc.name),
libraryDependencies += playOrganisation %% "play-docs" % playVersion,
libraryDependencies ++= {
CrossVersion.partialVersion(scalaVersion.value) match {
case Some((2, 10)) => Seq(
compilerPlugin("org.scalamacros" % "paradise" % "2.1.1" cross CrossVersion.full)
)
case _ => Nil
}
},
libraryDependencies ++= Seq(
compilerPlugin("com.github.ghik" %% "silencer-plugin" % "1.4.2"),
"com.github.ghik" %% "silencer-lib" % "1.4.2" % Omnidoc.name
)
)
def releaseSettings: Seq[Setting[_]] = Seq(
releaseTagName := playVersion,
releaseProcess := {
import ReleaseTransformations._
// Since the version comes externally, we don't set or update it here.
Seq[ReleaseStep](
checkSnapshotDependencies,
tagRelease,
publishArtifacts,
releaseStepCommand("sonatypeBundleRelease"),
pushChanges
)
}
)
def updateSettings: Seq[Setting[_]] = Seq(
transitiveClassifiers := Seq(SourceClassifier, PlaydocClassifier),
updatePlaydocClassifiers := updatePlaydocClassifiersTask.value
)
def extractSettings: Seq[Setting[_]] = Seq(
target := crossTarget.value / "omnidoc",
target in sources := target.value / "sources",
extractedSources := extractSources.value,
sources := extractedSources.value.map(_.dir),
sourceUrls := getSourceUrls(extractedSources.value),
dependencyClasspath := Classpaths.managedJars(configuration.value, classpathTypes.value, update.value),
target in extractedPlaydoc := target.value / "playdoc",
extractedPlaydoc := extractPlaydocs.value
)
def scaladocSettings: Seq[Setting[_]] = Defaults.docTaskSettings(scaladoc) ++ Seq(
sources in scaladoc := {
val s = sources.value
// Exclude a Play JSON file from the Scaladoc build because
// it includes a macro from a third party library and we don't
// want to deal with bringing extra libraries into Omnidoc.
((s ** "*.scala") --- (s ** "JsMacroImpl.scala")).get
},
target in scaladoc := target.value / "scaladoc",
scalacOptions in scaladoc := scaladocOptions.value,
scaladoc := rewriteSourceUrls(scaladoc.value, sourceUrls.value, "/src/main/scala", ".scala")
)
def javadocSettings: Seq[Setting[_]] = Defaults.docTaskSettings(javadoc) ++ Seq(
sources in javadoc := (sources.value ** "*.java").get,
target in javadoc := target.value / "javadoc",
javacOptions in javadoc := javadocOptions.value
)
private val compilerReporter = taskKey[xsbti.Reporter]("Experimental hook to listen (or send) compilation failure messages.")
def compilerReporterSettings = Seq(
compilerReporter in compile := {
new sbt.internal.server.LanguageServerReporter(
maxErrors.value,
streams.value.log,
foldMappers(sourcePositionMappers.value)
)
},
)
private def foldMappers[A](mappers: Seq[A => Option[A]]): A => A =
mappers.foldRight(idFun[A]) { (mapper, acc) =>
p: A => mapper(p).getOrElse(acc(p))
}
def packageSettings: Seq[Setting[_]] = Seq(
mappings in (Compile, packageBin) ++= {
def mapped(dir: File, path: String) = dir.allPaths pair Path.rebase(dir, path)
mapped(extractedPlaydoc.value, "play/docs/content") ++
mapped(scaladoc.value, "play/docs/content/api/scala") ++
mapped(javadoc.value, "play/docs/content/api/java")
}
)
/**
* Custom update classifiers task that only resolves classifiers for Play modules.
* Also redirects warnings to debug for any artifacts that can't be found.
*/
private def updatePlaydocClassifiersTask: Def.Initialize[Task[(UpdateReport, UpdateReport)]] = Def.task {
val filteredConfig: UpdateConfiguration = updateConfiguration.value
.withMetadataDirectory(dependencyCacheDirectory.value)
.withArtifactFilter(updateConfiguration.value.artifactFilter.map(af => af.withInverted(!af.inverted)))
val unfilteredConfig: UpdateConfiguration = updateConfiguration.value
.withMetadataDirectory(dependencyCacheDirectory.value)
def updateClassifiersTask0(updateConfig: UpdateConfiguration): UpdateReport = {
val s = streams.value
val is = ivySbt.value
val lm = IvyDependencyResolution(is.configuration)
val classifiersModule = {
val playModules = update.value.configuration(Omnidoc).toVector.flatMap(_.allModules.filter(playModuleFilter))
GetClassifiersModule(projectID.value, None, playModules, Vector(Omnidoc), transitiveClassifiers.value.toVector)
}
val srcTypes = sourceArtifactTypes.value
val docTypes = docArtifactTypes.value
val uwConfig = (unresolvedWarningConfiguration in update).value
lm.updateClassifiers(
GetClassifiersConfiguration(classifiersModule, Vector.empty, updateConfig, srcTypes.toVector, docTypes.toVector),
uwConfig,
Vector.empty,
s.log
) match {
case Left(_) => ???
case Right(ur) => ur
}
}
// Current Impl of Ivy Resolvers in sbt or the underlying Ivy client don't support
// the combination of `playdoc` classifiers with `sources` and `docs` so we
// run two passes with differentcomplementary) filter.
(updateClassifiersTask0(filteredConfig), updateClassifiersTask0(unfilteredConfig))
} tag(Tags.Update, Tags.Network)
/**
* Redirect logging above a certain level to debug.
*/
def quietLogger(underlying: Logger, minimumLevel: Level.Value = Level.Info): Logger = new Logger {
def log(level: Level.Value, message: => String): Unit = {
if (level.id > minimumLevel.id) underlying.log(Level.Debug, s"[$level] $message")
else underlying.log(level, message)
}
def success(message: => String): Unit = underlying.success(message)
def trace(t: => Throwable): Unit = underlying.trace(t)
}
def extractSources = Def.task {
val log = streams.value.log
val targetDir = (target in sources).value
val dependencies = (updatePlaydocClassifiers.value._1 filter artifactFilter(classifier = SourceClassifier)).toSeq
log.info("Extracting sources...")
IO.delete(targetDir)
dependencies map { case (conf, module, artifact, file) =>
val name = s"${module.organization}-${module.name}-${module.revision}"
val dir = targetDir / name
log.debug(s"Extracting $name")
IO.unzip(file, dir, -"META-INF*")
val sourceUrl = extractSourceUrl(file)
if (sourceUrl.isEmpty) log.warn(s"Source url not found for ${module.name}")
Extracted(dir, sourceUrl)
}
}
def extractPlaydocs = Def.task {
val log = streams.value.log
val targetDir = (target in extractedPlaydoc).value
val dependencies = updatePlaydocClassifiers.value._2 matching artifactFilter(classifier = PlaydocClassifier)
log.info("Extracting playdocs...")
IO.delete(targetDir)
dependencies foreach { case file =>
log.debug(s"Extracting $file")
IO.unzip(file, targetDir, -"META-INF*")
}
targetDir
}
def scaladocOptions = Def.task {
val sourcepath = (target in sources).value.getAbsolutePath
val docSourceUrl = sourceUrlMarker("€{FILE_PATH}")
Seq(
"-sourcepath", sourcepath,
"-doc-source-url", docSourceUrl
)
}
def javadocOptions = Def.task {
val label = "Play " + (if (isSnapshot.value) snapshotVersionLabel else version.value)
Seq(
"-windowtitle", label,
// Adding a user agent when we run `javadoc` is necessary to create link docs
// with Akka (at least, maybe play too) because doc.akka.io is served by Cloudflare
// which blocks requests without a User-Agent header.
"-J-Dhttp.agent=Play-Unidoc-Javadoc",
"-link",
"https://docs.oracle.com/javase/8/docs/api/",
"-link",
"https://doc.akka.io/japi/akka/2.6/",
"-link",
"https://doc.akka.io/japi/akka-http/current/",
"-notimestamp",
"-subpackages", "play",
"-exclude", "play.api:play.core",
"-Xdoclint:none",
"-noqualifier",
"java.lang",
"-encoding",
"UTF-8",
"-source",
"8",
)
}
// Source linking
case class Extracted(dir: File, url: Option[String])
val SourceUrlKey = "Omnidoc-Source-URL"
val NoSourceUrl = "javascript:;"
// first part of path is the extracted directory name, which is used as the source url mapping key
val SourceUrlRegex = sourceUrlMarker("/([^/\\s]*)(/\\S*)").r
def extractSourceUrl(sourceJar: File): Option[String] = {
Using.jarFile(verify = false)(sourceJar) { jar =>
try {
Option(jar.getManifest.getMainAttributes.getValue(SourceUrlKey))
} catch {
case e: java.io.IOException =>
// JDK jar APIs refuse to attribute jar files in their exceptions
// And vegemite seems to have a corrupt jar
throw new java.io.IOException(s"Error reading manifest attributes from $sourceJar", e)
}
}
}
def sourceUrlMarker(path: String): String = s"http://%SOURCE;${path}%"
def getSourceUrls(extracted: Seq[Extracted]): Map[String, String] = {
(extracted flatMap { source => source.url map source.dir.name.-> }).toMap
}
def rewriteSourceUrls(baseDir: File, sourceUrls: Map[String, String], prefix: String, suffix: String): File = {
val files = baseDir.allPaths.filter(!_.isDirectory).get
files foreach { file =>
val contents = IO.read(file)
val newContents = SourceUrlRegex.replaceAllIn(contents, matched => {
val key = matched.group(1)
val path = matched.group(2)
sourceUrls.get(key).fold(NoSourceUrl)(_ + prefix + path + suffix)
})
if (newContents != contents) {
IO.write(file, newContents)
}
}
baseDir
}
}