Merge pull request #4 from manfredbjorlin/feature-MaxAgeOnList

Feature max age on list

Author: robinhultman

Src/LookupUtility/LookupUtilityService.cs

@@ -20,9 +20,9 @@ public LookupUtilityService(ILookupRepository lookupRepository)
             _lookupRepository = lookupRepository;
         }
 
-        public string GetValue(string list, string key, string defaultValue)
+        public string GetValue(string list, string key, string defaultValue, TimeSpan maxAge = default(TimeSpan))
         {
-            var dict = GetList(list);
+            var dict = GetList(list, maxAge);
             string val;
             if (!dict.TryGetValue(key, out val))
             {
@@ -32,9 +32,9 @@ public string GetValue(string list, string key, string defaultValue)
             return val;
         }
 
-        public string GetValue(string list, string key, bool throwIfNotExists = false, bool allowDefaults = false)
+        public string GetValue(string list, string key, bool throwIfNotExists = false, bool allowDefaults = false, TimeSpan maxAge = default(TimeSpan))
         {
-            var dict = GetList(list);
+            var dict = GetList(list, maxAge);
             string val;
             if (!dict.TryGetValue(key, out val))
             {
@@ -54,13 +54,13 @@ public string GetValue(string list, string key, bool throwIfNotExists = false, b
             return val;
         }
 
-        private Dictionary<string, string> GetList(string list)
+        private Dictionary<string, string> GetList(string list, TimeSpan maxAge = default(TimeSpan))
         {
             var dict = new Dictionary<string, string>();
 
             if (!_lookupValues.TryGetValue(list, out dict))
             {
-                dict = _lookupRepository.LoadList(list);
+                dict = _lookupRepository.LoadList(list, maxAge);
 
                 if (dict == null)
                 {

Src/LookupUtility/Repository/ILookupRepository.cs

@@ -8,6 +8,6 @@ namespace BizTalkComponents.Utilities.LookupUtility.Repository
 {
     public interface ILookupRepository
     {
-        Dictionary<string, string> LoadList(string list);
+        Dictionary<string, string> LoadList(string list, TimeSpan maxAge = default(TimeSpan));
     }
 }

Src/LookupUtility/Repository/LookupRepositoryMock.cs

@@ -8,8 +8,10 @@ namespace BizTalkComponents.Utilities.LookupUtility.Repository
 {
     public class LookupRepositoryMock : ILookupRepository
     {
-        public Dictionary<string, string> LoadList(string list)
+        public Dictionary<string, string> LoadList(string list, TimeSpan maxAge = default(TimeSpan))
         {
+            if (maxAge != default(TimeSpan) && maxAge > new TimeSpan(1, 0, 0)) 
+                throw new ArgumentException("List too old");
             return new Dictionary<string, string>() { { "MockKey", "MockValue" } };
         }
     }

Src/LookupUtility/Repository/SharepointLookupRepository.cs

@@ -10,15 +10,22 @@ namespace BizTalkComponents.Utilities.LookupUtility.Repository
 {
     public class SharepointLookupRepository : ILookupRepository
     {
-        public Dictionary<string, string> LoadList(string list)
+        Microsoft.SharePoint.Client.List spList;
+        ClientContext clientContext;
+
+        public SharepointLookupRepository()
         {
             var site = ConfigurationManager.AppSettings["SharePointSite"];
+            clientContext = new ClientContext(site);
 
-            ClientContext clientContext = new ClientContext(site);
-            Web oWebsite = clientContext.Web;
-            ListCollection collList = oWebsite.Lists;
+        }
 
-            var spList = collList.GetByTitle(list);
+        public Dictionary<string, string> LoadList(string list, TimeSpan maxAge = default(TimeSpan))
+        {
+            SetList(list);
+
+            if (maxAge != default(TimeSpan) && maxAge < GetAgeOfList(list))
+                spList.RefreshLoad();
 
             var q = new CamlQuery();
             ListItemCollection collListItem = spList.GetItems(q);
@@ -44,5 +51,17 @@ public Dictionary<string, string> LoadList(string list)
 
             return dictionary;
         }
+
+        private void SetList(string list)
+        {
+            Web oWebsite = clientContext.Web;
+            ListCollection collList = oWebsite.Lists;
+            spList = collList.GetByTitle(list);
+        }
+
+        private TimeSpan GetAgeOfList(string list)
+        {
+            return DateTime.Now.Subtract(spList.LastItemModifiedDate);
+        }
     }
 }

Src/LookupUtility/Repository/SqlLookupRepository.cs

@@ -10,7 +10,7 @@ namespace BizTalkComponents.Utilities.LookupUtility.Repository
 {
     public class SqlLookupRepository : ILookupRepository
     {
-        public Dictionary<string, string> LoadList(string list)
+        public Dictionary<string, string> LoadList(string list, TimeSpan maxAge = default(TimeSpan))
         {
             string query = string.Format("SELECT [Key], Value FROM {0}", list);
 

Test/UnitTest/LookupUtilityTest.cs

@@ -16,27 +16,26 @@ public class LookupUtilityTest
         [ClassInitialize]
         public static void Init(TestContext context)
         {
-            
             mock = new Mock<ILookupRepository>();
             util = new LookupUtilityService(mock.Object);
             var dictionary = new Dictionary<string, string>();
             dictionary.Add("ConfigKey", "ConfigValue");
             dictionary.Add("default", "DefaultValue");
-            mock.Setup(s => s.LoadList(list)).Returns(dictionary);
+            mock.Setup(s => s.LoadList(list, default(TimeSpan))).Returns(dictionary);
         }
 
         [TestMethod]
         public void TestHappyPath()
-            {
+        {
             Assert.AreEqual("ConfigValue", util.GetValue(list, "ConfigKey"));
-            mock.Verify(util => util.LoadList(list), Times.Once);
+            mock.Verify(_util => _util.LoadList(list, default(TimeSpan)), Times.Once);
         }
 
         [TestMethod]
         public void TestCache()
         {
             util.GetValue(list, "ConfigKey");
-            mock.Verify(util => util.LoadList(list), Times.Once);
+            mock.Verify(_util => _util.LoadList(list, default(TimeSpan)), Times.Once);
         }
 
         [TestMethod]
@@ -76,5 +75,12 @@ public void TestNonExistingList()
         {
             util.GetValue("NonExistingList", "ConfigKey");
         }
+
+        [TestMethod]
+        public void TestAgeListOK()
+        {
+            var ts = new TimeSpan(0, 30, 0);
+            util.GetValue(list, "ConfigKey", maxAge: ts);
+        }
     }
 }

packages/repositories.config

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<repositories>
+  <repository path="..\Src\LookupUtility\packages.config" />
+  <repository path="..\Test\UnitTest\packages.config" />
+</repositories>