Refactor the scripts

Author: mahozad

scripts/check-for-updates.main.kts

@@ -1,31 +1,25 @@
 #!/usr/bin/env kotlin
 
 @file:JvmName("ReleaseUpdateChecker")
-@file:CompilerOptions("-jvm-target", "11")
+@file:CompilerOptions("-jvm-target", "17")
 @file:Repository("https://repo.maven.apache.org/maven2")
-@file:Repository("https://jcenter.bintray.com")
-@file:Repository("https://jitpack.io")
 @file:DependsOn("com.rometools:rome:2.1.0")
 
-// NOTE: See https://youtrack.jetbrains.com/issue/KT-42101
-// NOTE that currently, IntelliJ code features break when importing external scripts.
-@file:Import("retry.main.kts")
+@file:Import("retry.kts")
 
 import com.rometools.rome.io.SyndFeedInput
 import com.rometools.rome.io.XmlReader
 import java.net.URI
 import java.time.LocalDateTime
 import java.time.format.DateTimeFormatter
-import kotlin.io.path.Path
-import kotlin.io.path.appendText
-import kotlin.io.path.readText
+import kotlin.io.path.*
 
 val datesPattern = DateTimeFormatter.ofPattern("EEE LLL dd HH:mm:ss z yyyy")
 val feedUrl = URI("https://developer.android.com/feeds/androidx-release-notes.xml").toURL()
-val reader = tryTo("initialize the feed reader") { XmlReader(feedUrl) }
-val file = Path("last-rss-update.txt")
+val reader = tryTo("initialize the feed reader") { XmlReader(feedUrl.openStream()) }
+val file = Path("last-rss-update.txt").takeIf { it.exists() }
 val feed = SyndFeedInput().build(reader)
-val ours = file.readText().trimEnd().parseAsLocalDateTime()
+val ours = file?.readText()?.trimEnd().parseAsLocalDateTime()
 val ourDate = ours.toLocalDate().toString()
 val theirs = feed.publishedDate.toString().parseAsLocalDateTime()
 val theirDate = theirs.toLocalDate().toString()
@@ -45,11 +39,14 @@ println("Their RSS publish date: $theirs")
 // To set output for a job step
 // see https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#setting-an-output-parameter
 // and https://stackoverflow.com/a/59201610
-val stepsOutputFile = Path(System.getenv("GITHUB_OUTPUT"))
+val stepsOutputFile = (System.getenv("GITHUB_OUTPUT") ?: "output.txt")
+    .let(::Path)
+    .also { if (it.notExists()) it.createFile() }
 val lineFeed: String = System.lineSeparator()
 stepsOutputFile.appendText("result=$freshness$lineFeed")
 stepsOutputFile.appendText("dateTag=$dateTag$lineFeed")
 
-fun String.parseAsLocalDateTime() =
-    runCatching { LocalDateTime.parse(this, datesPattern) }
-    .getOrDefault(LocalDateTime.of(1, 1, 1, 1, 1))
+fun String?.parseAsLocalDateTime() = this
+    ?.runCatching { LocalDateTime.parse(this, datesPattern) }
+    ?.getOrNull()
+    ?: LocalDateTime.of(1, 1, 1, 1, 1)

scripts/create-new-release-notes.main.kts

@@ -1,12 +1,12 @@
 #!/usr/bin/env kotlin
 
 @file:JvmName("ReleaseNotesGenerator")
-@file:CompilerOptions("-jvm-target", "11")
+@file:CompilerOptions("-jvm-target", "17")
 @file:Repository("https://repo.maven.apache.org/maven2")
-@file:Repository("https://jcenter.bintray.com")
-@file:Repository("https://jitpack.io")
 @file:DependsOn("com.rometools:rome:2.1.0")
-@file:DependsOn("org.jsoup:jsoup:1.18.3")
+@file:DependsOn("org.jsoup:jsoup:1.21.1")
+
+@file:Import("retry.kts")
 
 import com.rometools.rome.io.SyndFeedInput
 import com.rometools.rome.io.XmlReader
@@ -17,16 +17,17 @@ import java.net.URI
 import kotlin.io.path.Path
 import kotlin.io.path.bufferedWriter
 import kotlin.io.path.writeText
-import kotlin.time.Duration.Companion.seconds
+
+typealias LinkString = String
+typealias LinkDocument = Pair<LinkString, Document>
 
 val resultFile = Path("release-notes.html")
-val waitTime = 10.seconds
 val feedUrl = URI("https://developer.android.com/feeds/androidx-release-notes.xml").toURL()
 val writer = resultFile.bufferedWriter()
 val reader = tryTo("initialize the feed reader") {
     // NOTE: Use this to test for a complicated release notes
     // XmlReader(File("test-feed-result.xml"))
-    XmlReader(feedUrl)
+    XmlReader(feedUrl.openStream())
 }
 val feed = SyndFeedInput().build(reader)
 val latestRelease = feed.entries.first()
@@ -40,9 +41,9 @@ Jsoup
     .parse(latestReleaseItems)
     .select("a")
     .asSequence()
-    .map(::toLink)
-    .map(::toDocument)
-    .map(::toReleaseNote)
+    .map(Element::toLink)
+    .map(LinkString::toLinkDocument)
+    .map(LinkDocument::toReleaseNote)
     .forEach(writer::write)
     .also { writer.close() }
     .also { reader.close() }
@@ -51,44 +52,16 @@ Jsoup
 val text = Jsoup.parse(resultFile).wholeText()
 Path("release-notes.txt").writeText(text)
 
-// TODO: Duplicate; use the retry.main.kts script.
-//  See other scripts for example usage.
-//  NOTE that currently, IntelliJ code features break when importing external scripts.
-/**
- * Try [forAtMost] times to run the block without exception.
- *
- * We could also make subsequent runs wait
- * for an [exponential delay](https://en.wikipedia.org/wiki/Exponential_backoff).
- * See [this article](https://dzone.com/articles/understanding-retry-pattern-with-exponential-back).
- *
- * I wrote this function myself.
- * It is interesting that [this solution](https://stackoverflow.com/a/46890009)
- * proposed by Roman Elizarov is very similar to mine.
- */
-fun <T> tryTo(
-    description: String,
-    forAtMost: Int = 5,
-    block: () -> T
-): T {
-    repeat(forAtMost) {
-        runCatching(block).onSuccess { return it }
-        println("Failed to $description.")
-        println("Trying again in $waitTime\n")
-        Thread.sleep(waitTime.inWholeMilliseconds)
-    }
-    error("All attempts to $description failed.")
-}
-
-fun toLink(element: Element) = element.attr("href")
+fun Element.toLink() = this.attr("href")
 
 // FIXME: Use plain Jsoup.connect()... and remove Pair creation (to)
 //  See https://github.com/jhy/jsoup/issues/1686 for the reason.
-fun toDocument(link: String) = tryTo("get $link") {
-    link to Jsoup.connect(link).get()
+fun LinkString.toLinkDocument() = tryTo("get $this") {
+    this to Jsoup.connect(this).get()
 }
 
-fun toReleaseNote(pair: Pair<String, Document>): String {
-    val (link, document) = pair
+fun LinkDocument.toReleaseNote(): String {
+    val (link, document) = this
     val id = link.substringAfter("#")
     val name = document.extractName(id)
     val version = document.extractVersion(id)

scripts/mouse.main.kts

@@ -1,3 +1,5 @@
+#!/usr/bin/env kotlin
+
 import kotlin.io.path.Path
 import kotlin.io.path.writeText
 import kotlin.math.roundToInt

scripts/retry.main.kts renamed to scripts/retry.kts

@@ -1,14 +1,12 @@
-#!/usr/bin/env kotlin
-
-@file:JvmName("Retry")
-@file:CompilerOptions("-jvm-target", "11")
-
 import kotlin.time.Duration.Companion.seconds
 
+// Updates to this file are not reflected to user scripts
+// See https://youtrack.jetbrains.com/issue/KT-42101
+
 val waitTime = 10.seconds
 
 /**
- * Try [forAtMost] times to run the block without exception.
+ * Try for [maxTries] times to run the block without exception.
  *
  * We could also make subsequent runs wait
  * for an [exponential delay](https://en.wikipedia.org/wiki/Exponential_backoff).
@@ -18,16 +16,18 @@ val waitTime = 10.seconds
  * It is interesting that [this solution](https://stackoverflow.com/a/46890009)
  * proposed by Roman Elizarov is very similar to mine.
  */
+@Suppress("unused")
 fun <T> tryTo(
     description: String,
-    forAtMost: Int = 5,
+    maxTries: Int = 5,
     block: () -> T
 ): T {
-    repeat(forAtMost) {
+    for (i in 1..maxTries) {
         runCatching(block).onSuccess { return it }
         println("Failed to $description.")
+        if (i == maxTries) break
         println("Trying again in $waitTime\n")
         Thread.sleep(waitTime.inWholeMilliseconds)
     }
-    error("All attempts to $description failed.")
+    error("All $maxTries attempts to $description failed.")
 }

scripts/set-rss-last-update.main.kts

@@ -1,15 +1,11 @@
 #!/usr/bin/env kotlin
 
 @file:JvmName("TimestampUpdater")
-@file:CompilerOptions("-jvm-target", "11")
+@file:CompilerOptions("-jvm-target", "17")
 @file:Repository("https://repo.maven.apache.org/maven2")
-@file:Repository("https://jcenter.bintray.com")
-@file:Repository("https://jitpack.io")
 @file:DependsOn("com.rometools:rome:2.1.0")
 
-// NOTE: See https://youtrack.jetbrains.com/issue/KT-42101
-// NOTE that currently, IntelliJ code features break when importing external scripts.
-@file:Import("retry.main.kts")
+@file:Import("retry.kts")
 
 import com.rometools.rome.io.SyndFeedInput
 import com.rometools.rome.io.XmlReader
@@ -18,7 +14,7 @@ import kotlin.io.path.Path
 import kotlin.io.path.writeText
 
 val feedUrl = URI("https://developer.android.com/feeds/androidx-release-notes.xml").toURL()
-val reader = tryTo("initialize the feed reader") { XmlReader(feedUrl) }
+val reader = tryTo("initialize the feed reader") { XmlReader(feedUrl.openStream()) }
 val feed = SyndFeedInput().build(reader)
 val date = feed.publishedDate.toString()
 Path("last-rss-update.txt").writeText("$date\n")