From 8a71f7fdf0672e425c98fd04391568e0373663ac Mon Sep 17 00:00:00 2001
From: Jon Atkins <github@jonatkins.com>
Date: Mon, 24 Jun 2013 16:15:44 +0100
Subject: [PATCH] map status improvements, reporting status of cache. basic
 'error/out of date/up to date' message, and tool tip with tile counts for
 #394

---
 code/map_data.js         | 14 ++++++++++++++
 code/request_handling.js | 24 ++++++++++++++++++++----
 2 files changed, 34 insertions(+), 4 deletions(-)

diff --git a/code/map_data.js b/code/map_data.js
index 199b9427..32c277f8 100644
--- a/code/map_data.js
+++ b/code/map_data.js
@@ -88,6 +88,12 @@ window.requestData = function() {
   console.log('refreshing data');
   requests.abort();
   cleanUp();
+  window.statusTotalMapTiles = 0;
+  window.statusCachedMapTiles = 0;
+  window.statusSuccessMapTiles = 0;
+  window.statusStaleMapTiles = 0;
+  window.statusErrorMapTiles = 0;
+
 
   debugDataTileReset();
 
@@ -124,6 +130,7 @@ window.requestData = function() {
       var lngEast = tileToLng(x+1,z);
 
       debugCreateTile(tile_id,[[latSouth,lngWest],[latNorth,lngEast]]);
+      window.statusTotalMapTiles++;
 
       // TODO?: if the selected portal is in this tile, always fetch the data
       if (isDataCacheFresh(tile_id)) {
@@ -131,6 +138,7 @@ window.requestData = function() {
         // TODO?: if a closer zoom level has all four tiles in the cache, use them instead?
         cachedData.result.map[tile_id] = getDataCache(tile_id);
         debugSetTileColour(tile_id,'#0f0','#ff0');
+        window.statusCachedMapTiles++;
       } else {
         // group requests into buckets based on the tile coordinate.
 
@@ -211,9 +219,11 @@ window.handleFailedRequest = function(tile_ids) {
       cachedData.result.map[tile_id] = cached;
       debugSetTileColour(tile_id,'#800','#ff0');
       console.log('(using stale cache entry for map tile '+tile_id+')');
+      window.statusStaleMapTiles++;
     } else {
       // no cached data
       debugSetTileColour(tile_id,'#800','#f00');
+      window.statusErrorMapTiles++;
     }
   });
   if(Object.keys(cachedData.result.map).length > 0) {
@@ -260,15 +270,19 @@ window.handleDataResponse = function(data, fromCache, tile_ids) {
         if (!cacheVal) {
           debugSetTileColour(qk, '#f00','#f00');
           // no data in cache for this tile. continue processing - it's possible it also has some valid data
+          window.statusErrorMapTiles++;
         } else {
+          // stale cache entry exists - use it
           val = cacheVal;
           debugSetTileColour(qk, '#f00','#ff0');
           console.log('(using stale cache entry for map tile '+qk+')');
+          window.statusStaleMapTiles++;
         }
       } else {
         // not an error - store this tile into the cache
         storeDataCache(qk,val);
         debugSetTileColour(qk, '#0f0','#0f0');
+        window.statusSuccessMapTiles++;
       }
 
     }
diff --git a/code/request_handling.js b/code/request_handling.js
index 457be5df..3919bcdb 100644
--- a/code/request_handling.js
+++ b/code/request_handling.js
@@ -5,6 +5,12 @@
 
 window.activeRequests = [];
 window.failedRequestCount = 0;
+window.statusTotalMapTiles = 0;
+window.statusCachedMapTiles = 0;
+window.statusSuccessMapTiles = 0;
+window.statusStaleMapTiles = 0;
+window.statusErrorMapTiles = 0;
+
 
 window.requests = function() {}
 
@@ -52,12 +58,22 @@ window.renderUpdateStatus = function() {
     t += '<span class="help" title="Paused due to user interaction">paused</span';
   else if(isIdle())
     t += '<span style="color:#888">Idle</span>';
-  else if(window.activeRequests.length > 0)
-    t += window.activeRequests.length + ' requests';
   else if(window.requests._quickRefreshPending)
     t += 'refreshing';
-  else
-    t += 'Up to date';
+  else if(window.activeRequests.length > 0)
+    t += window.activeRequests.length + ' requests';
+  else {
+    // tooltip with detailed tile counts
+    t += '<span class="help" title="'+window.statusTotalMapTiles+' tiles: '+window.statusCachedMapTiles+' cached, '+window.statusSuccessMapTiles+' successful, '+window.statusStaleMapTiles+' stale, '+window.statusErrorMapTiles+' failed">';
+
+    // basic error/out of date/up to date message
+    if (window.statusErrorMapTiles) t += '<span style="color:#f66">Errors</span>';
+    else if (window.statusStaleMapTiles) t += '<span style="color:#fa6">Out of date</span>';
+    else t += 'Up to date';
+  
+    t += '</span>';
+
+  }
   t += '</span>';
 
   if(renderLimitReached())