CHANGELOG.md: Move unreleased changes to version 0.4.0

Basically Solr's numFound has nothing to do with the actual number
of distinct facets that are returned. You need to use Solr's stats
component to get the number of distinct facets, aka countDistinct.
This is apparently deprecated in newer Solr versions, but we're on
version 4.10 and it works there.

Also, I realized that there is no need to return facets for items
without any views or downloads. Using facet.mincount=1 reduces the
result set size and also means we can store less data in the data-
base. The API returns HTTP 404 Not Found if an item is not in the
database anyways.

I can't figure it out exactly, but there is some weird issue with
Solr's facet results when you don't use facet.mincount=1. For some
reason you get tons of results with an id that doesn't even exist
in the document database, let alone as an actual DSpace item!

See: https://lucene.apache.org/solr/guide/6_6/the-stats-component.html

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2018-09-25
+### Fixed
+- Invalid OnCalendar syntax in dspace-statistics-indexer.timer
+- Major logic error in indexer.py
+
 ## [0.3.2] - 2018-09-25
 ## Changed
 - /item/id route now returns HTTP 404 if an item is not found

contrib/dspace-statistics-indexer.timer

@@ -3,7 +3,7 @@ Description=DSpace Statistics Indexer
 
 [Timer]
 # twice a day, at 6AM and 6PM
-OnCalendar=*-*-* 06:00:00,18:00:00
+OnCalendar=*-*-* 06,18:00:00
 # Add a random delay of 0–3600 seconds
 RandomizedDelaySec=3600
 Persistent=true

indexer.py

@@ -31,41 +31,55 @@
 # See: https://wiki.duraspace.org/display/DSPACE/Solr
 
 from database import database_connection
+import json
 from solr import solr_connection
 
 def index_views():
-    print("Populating database with item views.")
+    # get total number of distinct facets for items with a minimum of 1 view,
-
+    # otherwise Solr returns all kinds of weird ids that are actually not in
-    # determine the total number of items with views (aka Solr's numFound)
+    # the database. Also, stats are expensive, but we need stats.calcdistinct
+    # so we can get the countDistinct summary.
+    #
+    # see: https://lucene.apache.org/solr/guide/6_6/the-stats-component.html
     res = solr.query('statistics', {
         'q':'type:2',
         'fq':'isBot:false AND statistics_type:view',
         'facet':True,
         'facet.field':'id',
+        'facet.mincount':1,
+        'facet.limit':1,
+        'facet.offset':0,
+        'stats':True,
+        'stats.field':'id',
+        'stats.calcdistinct':True
     }, rows=0)
 
-    # divide results into "pages" (numFound / 100)
+    # get total number of distinct facets (countDistinct)
-    results_numFound = res.get_num_found()
+    results_totalNumFacets = json.loads(res.get_json())['stats']['stats_fields']['id']['countDistinct']
+
+    # divide results into "pages" (cast to int to effectively round down)
     results_per_page = 100
-    results_num_pages = round(results_numFound / results_per_page)
+    results_num_pages = int(results_totalNumFacets / results_per_page)
     results_current_page = 0
 
     cursor = db.cursor()
 
     while results_current_page <= results_num_pages:
-        print('Page {} of {}.'.format(results_current_page, results_num_pages))
+        print('Indexing item views (page {} of {})'.format(results_current_page, results_num_pages))
 
         res = solr.query('statistics', {
             'q':'type:2',
             'fq':'isBot:false AND statistics_type:view',
             'facet':True,
             'facet.field':'id',
+            'facet.mincount':1,
             'facet.limit':results_per_page,
             'facet.offset':results_current_page * results_per_page
-        })
+        }, rows=0)
+
+        # check number of facets returned in the last query
+        #results_currentNumFacets = len(res.get_facets()['id'])
 
-        # make sure total number of results > 0
-        if res.get_num_found() > 0:
         # SolrClient's get_facets() returns a dict of dicts
         views = res.get_facets()
         # in this case iterate over the 'id' dict and get the item ids and views
@@ -81,38 +95,43 @@ def index_views():
     cursor.close()
 
 def index_downloads():
-    print("Populating database with item downloads.")
+    # get the total number of distinct facets for items with at least 1 download
-
-    # determine the total number of items with downloads (aka Solr's numFound)
     res = solr.query('statistics', {
         'q':'type:0',
         'fq':'isBot:false AND statistics_type:view AND bundleName:ORIGINAL',
         'facet':True,
         'facet.field':'owningItem',
+        'facet.mincount':1,
+        'facet.limit':1,
+        'facet.offset':0,
+        'stats':True,
+        'stats.field':'owningItem',
+        'stats.calcdistinct':True
     }, rows=0)
 
-    # divide results into "pages" (numFound / 100)
+    # get total number of distinct facets (countDistinct)
-    results_numFound = res.get_num_found()
+    results_totalNumFacets = json.loads(res.get_json())['stats']['stats_fields']['owningItem']['countDistinct']
+
+    # divide results into "pages" (cast to int to effectively round down)
     results_per_page = 100
-    results_num_pages = round(results_numFound / results_per_page)
+    results_num_pages = int(results_totalNumFacets / results_per_page)
     results_current_page = 0
 
     cursor = db.cursor()
 
     while results_current_page <= results_num_pages:
-        print('Page {} of {}.'.format(results_current_page, results_num_pages))
+        print('Indexing item downloads (page {} of {})'.format(results_current_page, results_num_pages))
 
         res = solr.query('statistics', {
             'q':'type:0',
             'fq':'isBot:false AND statistics_type:view AND bundleName:ORIGINAL',
             'facet':True,
             'facet.field':'owningItem',
+            'facet.mincount':1,
             'facet.limit':results_per_page,
             'facet.offset':results_current_page * results_per_page
-        })
+        }, rows=0)
 
-        # make sure total number of results > 0
-        if res.get_num_found() > 0:
         # SolrClient's get_facets() returns a dict of dicts
         downloads = res.get_facets()
         # in this case iterate over the 'owningItem' dict and get the item ids and downloads