Merge pull request #11697 from jimchamp/login-stats

Add unique login stats to `/stats` page

Author: mekarpeles

openlibrary/core/admin.py

@@ -9,6 +9,8 @@
 from infogami import config
 from openlibrary.core import cache
 
+from . import db
+
 
 class Stats:
     def __init__(self, docs, key, total_key):
@@ -175,6 +177,39 @@ def get_stats(ndays=30, use_mock_data=False):
     }
 
 
+def get_unique_logins_since(since_days=30):
+    since_date = datetime.datetime.now() - datetime.timedelta(days=since_days)
+    date_str = since_date.strftime("%Y-%m-%d")
+
+    query = """
+        SELECT COUNT(id) FROM store_index
+            WHERE type = 'account'
+            AND name = 'last_login'
+            AND value > $date
+    """
+
+    oldb = db.get_db()
+    results = list(oldb.query(query, vars={"date": date_str}))
+
+    if not results:
+        return 0
+    return results[0].get('count', 0)
+
+
+def get_cached_unique_logins_since(since_days=30):
+    from openlibrary.plugins.openlibrary.home import caching_prethread
+
+    twelve_hours = 60 * 60 * 12
+    key_prefix = 'logins_since'
+    mc = cache.memcache_memoize(
+        get_unique_logins_since,
+        key_prefix=key_prefix,
+        timeout=twelve_hours,
+        prethread=caching_prethread(),
+    )
+    return mc(since_days=since_days)
+
+
 def mock_get_stats():
     keyNames = [
         "human_edits",

openlibrary/i18n/messages.pot

@@ -3478,6 +3478,12 @@ msgstr ""
 msgid "Items"
 msgstr ""
 
+#: admin/index.html
+msgid ""
+"<span class=\"login-counts\">0</span> patrons have logged in at least "
+"once over the past 30 days."
+msgstr ""
+
 #: admin/index.html
 msgid "Stats"
 msgstr ""
@@ -3614,6 +3620,14 @@ msgstr ""
 msgid "Borrows, last 2 years graph"
 msgstr ""
 
+#: admin/index.html
+msgid "Unique Logins"
+msgstr ""
+
+#: admin/index.html
+msgid "Gathering login statistics..."
+msgstr ""
+
 #: admin/loans_table.html
 msgid "BookReader"
 msgstr ""

openlibrary/plugins/openlibrary/api.py

@@ -25,6 +25,7 @@
 )
 from openlibrary.core import cache, lending, models
 from openlibrary.core import helpers as h
+from openlibrary.core.admin import get_cached_unique_logins_since
 from openlibrary.core.auth import ExpiredTokenError, HMACToken
 from openlibrary.core.bestbook import Bestbook
 from openlibrary.core.bookshelves_events import BookshelvesEvents
@@ -1061,3 +1062,14 @@ def make_dark(self, edition):
         if not data['source_records']:
             del data['source_records']
         web.ctx.site.save(data, 'Remove OCAID: Item no longer available to borrow.')
+
+
+class monthly_logins(delegate.page):
+    path = "/api/monthly_logins"
+    encoding = "json"
+
+    def GET(self):
+        return delegate.RawText(
+            json.dumps({"loginCount": get_cached_unique_logins_since()}),
+            content_type="application/json",
+        )

openlibrary/plugins/openlibrary/js/index.js

@@ -582,4 +582,11 @@ jQuery(function () {
         import(/* webpackChunkName: "list-books" */ './list_books')
             .then(module => module.ListBooks.init());
     }
+
+    // Stats page login counts
+    const monthlyLoginStats = document.querySelector('.monthly-login-counts')
+    if (monthlyLoginStats) {
+        import(/* webpackChunkName: "stats" */ './stats')
+            .then(module => module.initUniqueLoginCounts(monthlyLoginStats))
+    }
 });

openlibrary/plugins/openlibrary/js/stats/index.js

@@ -0,0 +1,35 @@
+/**
+ * Fetches unique login counts and updates the view with the results.
+ *
+ * @param {HTMLElement} containerElem
+ * @returns {Promise<void>}
+ * @see /openlibrary/templates/admin/index.html
+ */
+export async function initUniqueLoginCounts(containerElem) {
+    const loadingIndicator = containerElem.querySelector('.loadingIndicator')
+    const i18nStrings = JSON.parse(containerElem.dataset.i18n)
+
+    const counts = await fetchCounts()
+        .then((resp) => {
+            if (resp.status !== 200) {
+                throw new Error(`Failed to fetch partials. Status code: ${resp.status}`)
+            }
+            return resp.json()
+        })
+
+    const countDiv = document.createElement('DIV')
+    countDiv.innerHTML = i18nStrings.uniqueLoginsCopy
+    const countSpan = countDiv.querySelector('.login-counts')
+    countSpan.textContent = counts.loginCount
+    loadingIndicator.replaceWith(countDiv)
+}
+
+/**
+ * Fetches login counts from the server.
+ *
+ * @returns {Promise<Response>}
+ * @see `monthly_logins` class in /openlibrary/plugins/openlibrary/api.py
+ */
+async function fetchCounts() {
+    return fetch('/api/monthly_logins.json')
+}

openlibrary/templates/admin/index.html

@@ -4,6 +4,11 @@
 $ _x = ctx.setdefault('usergroup', 'admin')
 
 $ stats = get_admin_stats()
+
+$ i18n_strings = {
+$   "uniqueLoginsCopy": _('<span class="login-counts">0</span> patrons have logged in at least once over the past 30 days.')
+$ }
+
 <script type="text/json+graph" id="graph-json-editgraph">$:json_encode(counts.human_edits.get_counts(80, True))</script>
 <script type="text/json+graph" id="graph-json-membergraph">$:json_encode(counts.members.get_counts(80, True))</script>
 
@@ -248,5 +253,8 @@ <h2>$_("Borrows")</h2>
   <img alt="$_('Borrows, last 2 years graph')" src="https://graphite.us.archive.org/render?target=hitcount(stats.ol.loans.bookreader,%221d%22)&from=-24months&tz=UTC&width=900"/>
 
   <div class="contentSpacer"></div>
-
+  <h2>$_("Unique Logins")</h2>
+  <div class="monthly-login-counts" data-i18n="$json_encode(i18n_strings)">
+      $:macros.LoadingIndicator(_("Gathering login statistics..."), hidden=False)
+  </div>
 </div>