add refreshChannels parameter to /update API

See memo33/sc4pac-gui#14

CHANGELOG.md

@@ -7,8 +7,13 @@
 ### Fixed
 - an issue where building a channel with file names containing spaces failed
 
+### Changed
+- API upgrade to 2.1:
+  - `/update` accepts a new parameter `refreshChannels` to clear cached data ([#14][gui14]).
+
 
 [gui3]: https://github.com/memo33/sc4pac-gui/issues/3
+[gui14]: https://github.com/memo33/sc4pac-gui/issues/14
 
 
 ## [0.5.0] - 2024-12-14

api.md

@@ -1,4 +1,4 @@
-# API - version 2.0
+# API - version 2.1
 
 The API allows other programs to control *sc4pac* in a client-server fashion.
 
@@ -346,8 +346,10 @@ Opening a websocket at `/update` triggers the update process.
 This mirrors the interactive `sc4pac update` command of the CLI.
 The websocket sends a series of messages, some of which expect a specific response, such as a confirmation to continue.
 
-Pass the parameter `simtropolisCookie` to re-use an authenticated session.
-Otherwise, the environment variable will be used instead if available.
+Parameters:
+- `simtropolisCookie=<value>` to re-use an authenticated session.
+  Otherwise, the environment variable will be used instead if available.
+- `refreshChannels` to clear the cached channel contents files before updating.
 
 Example using Javascript in your web browser:
 ```javascript

src/main/scala/sc4pac/Constants.scala

@@ -41,6 +41,7 @@ object Constants {
   val fuzzySearchThreshold = 80  // 0..100
   val cacheTtl = 12.hours
   val channelContentsTtl = 30.minutes
+  val channelContentsTtlRefresh = 0.minutes
   val channelContentsTtlShort = 60.seconds
   val interactivePromptTimeout = java.time.Duration.ofSeconds(240)
   val urlConnectTimeout = java.time.Duration.ofSeconds(60)

src/main/scala/sc4pac/Sc4pac.scala

@@ -549,16 +549,17 @@ object Sc4pac {
   /** Limits parallel downloads to 2 (ST rejects too many connections). */
   private[sc4pac] def createThreadPool() = coursier.cache.internal.ThreadUtil.fixedThreadPool(size = 2)
 
-  def init(config: JD.Config): RIO[ProfileRoot & Logger, Sc4pac] = {
+  def init(config: JD.Config, refreshChannels: Boolean = false): RIO[ProfileRoot & Logger, Sc4pac] = {
     // val refreshLogger = coursier.cache.loggers.RefreshLogger.create(System.err)  // TODO System.err seems to cause less collisions between refreshing progress and ordinary log messages
     val coursierPool = createThreadPool()
+    val channelContentsTtl = if (refreshChannels) Constants.channelContentsTtlRefresh else Constants.channelContentsTtl  // 0 or 30 minutes
     for {
       cacheRoot <- config.cacheRootAbs
       logger    <- ZIO.service[Logger]
       cache     =  FileCache(location = (cacheRoot / "coursier").toIO, logger = logger, pool = coursierPool)
         .withTtl(Some(Constants.cacheTtl))  // 12 hours
         // .withCachePolicies(Seq(coursier.cache.CachePolicy.ForceDownload))  // TODO cache policy
-      repos     <- initializeRepositories(config.channels, cache, Constants.channelContentsTtl)  // 30 minutes
+      repos     <- initializeRepositories(config.channels, cache, channelContentsTtl)
       tempRoot  <- config.tempRootAbs
       profileRoot <- ZIO.service[ProfileRoot]
       context   = new ResolutionContext(repos, cache, logger, profileRoot.path)

src/main/scala/sc4pac/api/api.scala

@@ -224,7 +224,7 @@ class Api(options: sc4pac.cli.Commands.ServerOptions) {
               val cookies = Downloader.Cookies(req.url.queryParams.getAll("simtropolisCookie").headOption.orElse(Constants.simtropolisCookie))
               val cookieDesc = cookies.simtropolisCookie.map(c => s"with cookie: ${c.length} bytes").getOrElse("without cookie")
               for {
-                pac          <- Sc4pac.init(pluginsData.config)
+                pac          <- Sc4pac.init(pluginsData.config, refreshChannels = req.url.queryParams.getAll("refreshChannels").nonEmpty)
                 pluginsRoot  <- pluginsData.config.pluginsRootAbs
                 wsLogger     <- ZIO.service[WebSocketLogger]
                 _            <- ZIO.succeed(wsLogger.log(s"Updating... ($cookieDesc)"))