Adding better UI details on age of data cache

Author: Ivo Salmre

CloudbedsApp/CloudbedsSessionState.cs

@@ -48,6 +48,24 @@ public  bool IsDataAvailableForDailyOperationsReport()
         return reservationsManager.IsDataCached();
     }
 
+
+    /// <summary>
+    /// The time the cache was last updated
+    /// </summary>
+    public DateTime? ReservationsWithRooms_CacheLastUpdatedTimeUtc
+    {
+        get
+        {
+            var resCache = _reservationWithRoomsManager;
+            if (resCache == null)
+            {
+                return null;
+            }
+
+            return resCache.CacheLastUpdatedTimeUtc;
+        }
+    }
+
     /// <summary>
     /// Genrate the daily operations report
     /// </summary>
@@ -419,11 +437,19 @@ public CloudbedsGuestManager EnsureGuestManager()
         return guestManager;
     }
 
+    /// <summary>
+    /// Clear a cache...
+    /// </summary>
+    public void ReservationsWithRooms_ClearCache()
+    {
+        _reservationWithRoomsManager = null;
+    }
+
     /// <summary>
     /// Creates a reservation manager object if necessary
     /// </summary>
     /// <returns></returns>
-    public  CloudbedsReservationWithRoomsManager EnsureReservationWithRoomsManager()
+    public CloudbedsReservationWithRoomsManager EnsureReservationWithRoomsManager()
     {
         var reservationManager = _reservationWithRoomsManager;
         if (reservationManager != null)

CloudbedsApp/CloudbedsSingletons.cs

@@ -51,6 +51,36 @@ public static ICollection<CloudbedsSessionState> ListOfCBSessions
         }
     }
 
+
+    /// <summary>
+    /// Clear a cache
+    /// </summary>
+    public static void ReservationsWithRooms_ClearCache()
+    {
+        var session = s_selectedCBSessionState;
+        if(session != null) 
+        {
+            session.ReservationsWithRooms_ClearCache();
+        }
+    }
+
+    /// <summary>
+    /// The time the cache was last updated
+    /// </summary>
+    public static DateTime? ReservationsWithRooms_CacheLastUpdatedTimeUtc
+    {
+        get
+        {
+            var session = s_selectedCBSessionState;
+            if(session == null)
+            {
+                return null;
+            }
+
+            return session.ReservationsWithRooms_CacheLastUpdatedTimeUtc;
+        }
+    }
+
     /// <summary>
     /// Genrate the daily operations report
     /// </summary>

CloudbedsDataManagers/CloudbedsReservationWithRoomsManager.cs

@@ -13,7 +13,6 @@ partial class CloudbedsReservationWithRoomsManager
     private readonly TaskStatusLogs _statusLog;
     const int NumberDaysFutureReservations = 120;
 
-
     /// <summary>
     /// If true - we will save the data locally after re-querying it
     /// </summary>
@@ -134,63 +133,6 @@ public void EnsureCachedData_Async()
     object _syncLockForCacheQuery = new object();
 
 
-    /*
-    /// <summary>
-    /// Store the cached data in a local file system file
-    /// </summary>
-    public void PersistToLocalStorage()
-    {
-        var persister = new Persistence_Save(this);
-
-        string pathXml = AppSettings.LocalFileSystemPath_CachedReservationsList;
-
-        var xmlWriter = System.Xml.XmlWriter.Create(pathXml);
-
-        using(xmlWriter)
-        {
-            persister.SaveAsXml(xmlWriter);
-            xmlWriter.Close();
-        }
-    }
-    */
-
-    /*
-    /// <summary>
-    /// Load from XML file
-    /// </summary>
-    /// <returns></returns>
-    public bool DepersistFromLocalStorageIfExists()
-    {
-        var statusLogs = CloudbedsSingletons.StatusLogs;
-
-        statusLogs.AddStatusHeader("Attempt load from local cache: Reservations list");
-
-        string pathXml = AppSettings.LocalFileSystemPath_CachedReservationsList;
-        //Not fatal... just note if no file exists
-        if(!System.IO.File.Exists(pathXml))
-        {
-            statusLogs.AddStatus("0128-1013: Skipping. No local reservations cache file exists at: " + pathXml);
-            return false;
-        }
-
-        var xmlDoc = new System.Xml.XmlDocument();
-        xmlDoc.Load(pathXml);
-        var loadResults = Persistence_Load.LoadFromXml(xmlDoc);
-        if(loadResults != null)
-        {
-            _cachedData = loadResults;
-            statusLogs.AddStatus("Successfully loaded reservation list from local cache");
-        }
-        else
-        {
-            CloudbedsSingletons.StatusLogs.AddError("0205-540: Internal error. No results returned from XML Guests cache load");
-            return false;
-        }
-
-
-        return true;
-    }
-    */
     /// <summary>
     /// TRUE: The data has already been querued
     /// </summary>
@@ -233,25 +175,6 @@ public void EnsureCachedData()
         }//end: Lock
     }
 
-    /*
-    /// <summary>
-    /// Try to persist the data locally
-    /// </summary>
-    private void TryPersistToLocalStorage()
-    {
-        
-        try
-        {
-            PersistToLocalStorage();
-        }
-        catch(Exception ex)
-        {
-            CloudbedsSingletons.StatusLogs.AddError("0205-422: Error persisting Reservations data locally: " + ex.Message);
-        }
-        
-    }
-    */
-
     /// <summary>
     /// Get the latest data in the cache
     /// </summary>
@@ -265,14 +188,6 @@ public void ForceRefreshOfCachedData()
 
         //Store the cached results
         _cachedData = new CachedData(queriedItems, queryTime);
-
-        /*
-        //Save to to local storage...
-        if (this.LocalPersistDataAfterQuery)
-        {
-            TryPersistToLocalStorage();
-        }
-        */
     }
 
     /// <summary>

UI/AppPages/appPageOperationalReport.xaml

@@ -17,7 +17,12 @@
         <Button Background="#2020ff"  Foreground="#ffffff" Padding="2" HorizontalAlignment="Left" Width="170" Click="ButtonQueryForData_Click" Name="btnRunQuery">Query server for data</Button>
     </StackPanel>
 
-    <StackPanel Orientation="Horizontal">
+    <StackPanel Orientation="Vertical" Margin="0 10 0 10" Name="spLocalCacheInfo">
+        <TextBlock x:Name="txtCacheAge">Fill me: Cache age goes here...</TextBlock>
+        <Button Background="#ff2020"  Foreground="#ffffff" Padding="2" HorizontalAlignment="Left" Width="170" Click="btnClearCache_Click" Name="btnClearCache">Clear Cache</Button>
+    </StackPanel>
+
+    <StackPanel Orientation="Horizontal" x:Name="spGenerateCSVsOptions">
         <Button Click="ButtonGenerateOperationalReportCsv_Click" Width="180" Margin="0 0 10 0" Padding="2" Background="#7070ff"  Foreground="#ffffff" BorderThickness="0" HorizontalAlignment="Left">
             <TextBlock>Save Daily Summary CSV...</TextBlock>
         </Button>

UI/AppPages/appPageOperationalReport.xaml.cs

@@ -34,6 +34,28 @@ public appPageOperationalReport()
 
         }
 
+
+        /// <summary>
+        /// Gives us information about the age of the data cache
+        /// </summary>
+        private void UpdateCacheAgeText()
+        {
+            var cacheAgeUtc = CloudbedsSingletons.ReservationsWithRooms_CacheLastUpdatedTimeUtc;
+            if(cacheAgeUtc == null)
+            {
+                txtCacheAge.Text = "No data in local cache ...";
+                return;
+            }
+
+
+            var localTime= cacheAgeUtc.Value.ToLocalTime();
+            txtCacheAge.Text = "Cache updated: " + localTime.ToString();
+        }
+
+
+        /// <summary>
+        /// Update UI visibility and contents
+        /// </summary>
         private void ResetUiBasedOnDataAvailability()
         {
             //If we have the data cached, then generate the report...
@@ -43,15 +65,22 @@ private void ResetUiBasedOnDataAvailability()
 
                 //Hide the query data UI
                 spQueryForDataIfNeeded.Visibility = Visibility.Collapsed;
+                //Show the CSV options
+                spGenerateCSVsOptions.Visibility = Visibility.Visible;
+                spLocalCacheInfo.Visibility = Visibility.Visible;
+
             }
             else
             {
                 spContent.Children.Clear(); //Hide any list data
                 //Show the query data UI
                 spQueryForDataIfNeeded.Visibility = Visibility.Visible;
 
+                spGenerateCSVsOptions.Visibility = Visibility.Collapsed;
+                spLocalCacheInfo.Visibility = Visibility.Collapsed;
             }
 
+            UpdateCacheAgeText();
         }
 
 
@@ -108,9 +137,12 @@ private void ButtonGenerateOperationalReportCsv_Click(object sender, RoutedEvent
             csvReport.GenerateCSVFile(fileOutputTo);
         }
 
-//        const string QueryButtonText_ready = "Query server for data";
-//        const string QueryButtonText_queryUnderway = "(Query underway...)";
 
+        /// <summary>
+        /// Query for data (or use data from cache) and fill in the grid
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void ButtonQueryForData_Click(object sender, RoutedEventArgs e)
         {
             //Since this may run a while, show the wait cursor
@@ -127,6 +159,8 @@ private void ButtonQueryForData_Click(object sender, RoutedEventArgs e)
 
             this.Cursor = null;  //revert to default
 
+            //Update the UI
+            ResetUiBasedOnDataAvailability();
         }
 
         /// <summary>
@@ -159,5 +193,17 @@ private void ButtonGenerateOperationalReportWithReservationDetailsCsv_Click(obje
             csvReport.GenerateCSVFile(fileOutputTo);
 
         }
+
+
+        /// <summary>
+        /// Clear a local data cache
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
+        private void btnClearCache_Click(object sender, RoutedEventArgs e)
+        {
+            CloudbedsSingletons.ReservationsWithRooms_ClearCache();
+            ResetUiBasedOnDataAvailability();
+        }
     }
 }