From ce6cedaf4be53d52f2e558055b91e515b92e4c83 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Fri, 19 Jul 2019 13:15:45 -0400
Subject: add background fetch for mod compatibility list (#651)

---
 src/SMAPI.Web/Framework/Caching/BaseCacheRepository.cs       |  6 +++---
 src/SMAPI.Web/Framework/Caching/Wiki/CachedWikiMetadata.cs   |  2 +-
 src/SMAPI.Web/Framework/Caching/Wiki/IWikiCacheRepository.cs |  4 ++--
 .../Framework/ConfigModels/BackgroundServicesConfig.cs       | 12 ++++++++++++
 .../Framework/ConfigModels/ModCompatibilityListConfig.cs     |  6 +++---
 5 files changed, 21 insertions(+), 9 deletions(-)
 create mode 100644 src/SMAPI.Web/Framework/ConfigModels/BackgroundServicesConfig.cs

(limited to 'src/SMAPI.Web/Framework')

diff --git a/src/SMAPI.Web/Framework/Caching/BaseCacheRepository.cs b/src/SMAPI.Web/Framework/Caching/BaseCacheRepository.cs
index 904455c5..f5354b93 100644
--- a/src/SMAPI.Web/Framework/Caching/BaseCacheRepository.cs
+++ b/src/SMAPI.Web/Framework/Caching/BaseCacheRepository.cs
@@ -10,10 +10,10 @@ namespace StardewModdingAPI.Web.Framework.Caching
         *********/
         /// <summary>Whether cached data is stale.</summary>
         /// <param name="lastUpdated">The date when the data was updated.</param>
-        /// <param name="cacheMinutes">The age in minutes before data is considered stale.</param>
-        public bool IsStale(DateTimeOffset lastUpdated, int cacheMinutes)
+        /// <param name="staleMinutes">The age in minutes before data is considered stale.</param>
+        public bool IsStale(DateTimeOffset lastUpdated, int staleMinutes)
         {
-            return lastUpdated < DateTimeOffset.UtcNow.AddMinutes(-cacheMinutes);
+            return lastUpdated < DateTimeOffset.UtcNow.AddMinutes(-staleMinutes);
         }
     }
 }
diff --git a/src/SMAPI.Web/Framework/Caching/Wiki/CachedWikiMetadata.cs b/src/SMAPI.Web/Framework/Caching/Wiki/CachedWikiMetadata.cs
index de1ea9db..4d6b4b10 100644
--- a/src/SMAPI.Web/Framework/Caching/Wiki/CachedWikiMetadata.cs
+++ b/src/SMAPI.Web/Framework/Caching/Wiki/CachedWikiMetadata.cs
@@ -37,7 +37,7 @@ namespace StardewModdingAPI.Web.Framework.Caching.Wiki
         {
             this.StableVersion = stableVersion;
             this.BetaVersion = betaVersion;
-            this.LastUpdated = DateTimeOffset.UtcNow;;
+            this.LastUpdated = DateTimeOffset.UtcNow;
         }
     }
 }
diff --git a/src/SMAPI.Web/Framework/Caching/Wiki/IWikiCacheRepository.cs b/src/SMAPI.Web/Framework/Caching/Wiki/IWikiCacheRepository.cs
index d319db69..6031123d 100644
--- a/src/SMAPI.Web/Framework/Caching/Wiki/IWikiCacheRepository.cs
+++ b/src/SMAPI.Web/Framework/Caching/Wiki/IWikiCacheRepository.cs
@@ -17,8 +17,8 @@ namespace StardewModdingAPI.Web.Framework.Caching.Wiki
 
         /// <summary>Whether cached data is stale.</summary>
         /// <param name="lastUpdated">The date when the data was updated.</param>
-        /// <param name="cacheMinutes">The age in minutes before data is considered stale.</param>
-        bool IsStale(DateTimeOffset lastUpdated, int cacheMinutes);
+        /// <param name="staleMinutes">The age in minutes before data is considered stale.</param>
+        bool IsStale(DateTimeOffset lastUpdated, int staleMinutes);
 
         /// <summary>Get the cached wiki mods.</summary>
         /// <param name="filter">A filter to apply, if any.</param>
diff --git a/src/SMAPI.Web/Framework/ConfigModels/BackgroundServicesConfig.cs b/src/SMAPI.Web/Framework/ConfigModels/BackgroundServicesConfig.cs
new file mode 100644
index 00000000..de871c9a
--- /dev/null
+++ b/src/SMAPI.Web/Framework/ConfigModels/BackgroundServicesConfig.cs
@@ -0,0 +1,12 @@
+namespace StardewModdingAPI.Web.Framework.ConfigModels
+{
+    /// <summary>The config settings for background services.</summary>
+    internal class BackgroundServicesConfig
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>Whether to enable background update services.</summary>
+        public bool Enabled { get; set; }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/ConfigModels/ModCompatibilityListConfig.cs b/src/SMAPI.Web/Framework/ConfigModels/ModCompatibilityListConfig.cs
index d9ac9f02..24b540cd 100644
--- a/src/SMAPI.Web/Framework/ConfigModels/ModCompatibilityListConfig.cs
+++ b/src/SMAPI.Web/Framework/ConfigModels/ModCompatibilityListConfig.cs
@@ -1,12 +1,12 @@
 namespace StardewModdingAPI.Web.Framework.ConfigModels
 {
-    /// <summary>The config settings for mod compatibility list.</summary>
+    /// <summary>The config settings for the mod compatibility list.</summary>
     internal class ModCompatibilityListConfig
     {
         /*********
         ** Accessors
         *********/
-        /// <summary>The number of minutes data from the wiki should be cached before refetching it.</summary>
-        public int CacheMinutes { get; set; }
+        /// <summary>The number of minutes before which wiki data should be considered old.</summary>
+        public int StaleMinutes { get; set; }
     }
 }
-- 
cgit