Supporting query parameter and response changes made on the API side (#…

…1221)

* refactored search facet use after endpoint change

* grouped facet requests

* fixed groupby in searchFacets service

* updated query parameter in text reuse clusters

* text reuse passages query parameters updated

* disabled `group_by` parameter in search facets query where it used to be a typo before parameter name was fixed. The "articles" value is not valid for this service call.

* replace skip offset

src/components/CollectionDetailPage.vue

@@ -524,9 +524,9 @@ export default {
             type: 'collection',
             q: this.collectionUid,
           }],
-          group_by: 'articles',
+          // group_by: 'articles',
         }
-      }).then(([type]) => new Facet(type));
+      }).then((type) => new Facet(type));
     },
   },
 };

src/components/EntitiesDetailPage.vue

@@ -332,18 +332,16 @@ export default {
       });
       this.facets = [];
       const query = {
+        facets: this.facetTypes,
         filters: [{
           type: 'entity',
           q: [ this.$route.params.entity_id ],
         }],
-        group_by: 'articles',
+        // group_by: 'articles',
       };
-      for (let facetType of this.facetTypes) {
-        const results = await searchFacetsService.get(facetType, {
-          query,
-        }).then(([facetType]) => new Facet(facetType));
-        this.facets = this.facets.concat(results);
-      }
+
+      this.facets = await searchFacetsService.find({ query })
+        .then(response => response.data.map(item => new Facet(item)))
     },
     loadItems(page = 1) {
       if (this.tab.name === TAB_ARTICLES) {

src/components/EntitiesExplorerPage.vue

@@ -578,7 +578,7 @@ export default {
         entityId,
         filters,
         timeResolution: this.punchcardResolution,
-        skip: skipPerEntity[entityId]
+        offset: skipPerEntity[entityId]
       }));
 
       try {

src/components/Explorer.vue

@@ -86,7 +86,7 @@ import {
   topics,
   newspapers,
   collections,
-  searchFacets
+  getSearchFacetsService
 } from '@/services'
 import FacetExplorer from './modules/FacetExplorer';
 import TimeFacetExplorer from './modules/TimeFacetExplorer';
@@ -158,10 +158,9 @@ async function search({
       page: currentPage,
       limit: pageSize,
       order_by: '-count',
-      index
     };
-    const response = await searchFacets.get(type, { query })
-    const result = response[0]
+    const response = await getSearchFacetsService(index).get(type, { query })
+    const result = response
     return {
       totalResults: result.numBuckets,
       buckets: result.buckets.map(d => new Bucket({

src/components/NewspapersDetailPage.vue

@@ -304,15 +304,13 @@ export default {
     async loadFacets() {
       this.facets = [];
       const query = {
+        facets: this.facetTypes,
         filters: [{ type: 'newspaper', q: [this.newspaperUid] }],
-        group_by: 'articles',
+        // group_by: 'articles',
       };
-      for (let facetType of this.facetTypes) {
-        const results = await searchFacetsService.get(facetType, {
-          query,
-        }).then(([facetType]) => new Facet(facetType));
-        this.facets = this.facets.concat(results);
-      }
+
+      this.facets = await searchFacetsService.find({ query })
+        .then(result => result.data.map(item => new Facet(item)))
     },
   },
   watch: {

src/components/SelectionMonitor.vue

@@ -397,8 +397,8 @@ export default defineComponent({
         .then(response => {
           // eslint-disable-next-line no-console
           console.debug('[ItemSelector] loadTimeline success', response)
-          this.timelineValues = Helpers.timeline.fromBuckets(response[0].buckets)
-          this.total = response[0].buckets.reduce((acc, bucket) => acc + bucket.count, 0)
+          this.timelineValues = Helpers.timeline.fromBuckets(response.buckets)
+          this.total = response.buckets.reduce((acc, bucket) => acc + bucket.count, 0)
         })
     },
   },

src/components/TextReuseClusterDetailPage.vue

@@ -185,7 +185,7 @@ export default {
       [this.passageItems, this.paginationInfo] = await textReuseClusterPassages
         .find({ query: {
           clusterId: this.clusterId,
-          skip: this.paginationPerPage * pageNumber,
+          offset: this.paginationPerPage * pageNumber,
           limit: this.paginationPerPage,
           orderBy
         }})

src/components/TextReuseClusterIdCardPage.vue

@@ -110,7 +110,7 @@ export default {
         if (id == null) return
         this.isLoading = true
         try {
-          const response = await textReuseClustersService.get(this.cluster.id, { query: { includeDetails: true }})
+          const response = await textReuseClustersService.get(this.cluster.id, { query: { include_details: true }})
           const facets = response?.details?.facets ?? []
           this.resolution = response?.details?.resolution
           this.facets = facets.map(facet => new FacetModel(facet))
@@ -122,4 +122,4 @@ export default {
     }
   }
 }
-</script>
+</script>

src/components/TextReuseClusterMonitor.vue

@@ -185,7 +185,7 @@ export default {
       const query = {
         page: this.startPassageOffset,
         limit: 1,
-        orderBy: this.startPassageOrderBy,
+        order_by: this.startPassageOrderBy,
         filters: this.filters.length
           ? optimizeFilters(this.filters)
           : [{ type: 'textReuseCluster', q: this.item.id }],
@@ -203,7 +203,7 @@ export default {
       const query = {
         page: this.endPassageOffset,
         limit: 1,
-        orderBy: this.endPassageOrderBy,
+        order_by: this.endPassageOrderBy,
         filters: this.filters.length
           ? optimizeFilters(this.filters)
           : [{ type: 'textReuseCluster', q: this.item.id }],

src/components/TextReuseConnectedClusters.vue

@@ -94,12 +94,12 @@ export default {
         })
       }
     },
-    /** @returns {{ clusterId: string, skip: number, limit: number } | undefined} */
+    /** @returns {{ clusterId: string, offset: number, limit: number } | undefined} */
     clustersQuery() {
       if (this.clusterId == null) return undefined
       return {
         clusterId: this.clusterId,
-        skip: (this.pageNumber - 1) * this.perPage,
+        offset: (this.pageNumber - 1) * this.perPage,
         limit: this.perPage
       }
     }
@@ -128,4 +128,4 @@ export default {
   .connected-cluster-container {
     cursor: pointer;
   }
-</style>
+</style>

src/components/TextReuseExplorerPage.vue

@@ -516,7 +516,7 @@ export default {
     /** @returns {{ query: any, hash: string }} */
     searchApiQueryParameters() {
       const query = {
-        skip: this.paginationPerPage * (this.paginationCurrentPage - 1),
+        offset: this.paginationPerPage * (this.paginationCurrentPage - 1),
         page: this.paginationCurrentPage,
         limit: this.paginationPerPage,
         orderBy: this.orderBy,

src/components/TextReusePassageMonitor.vue

@@ -129,9 +129,9 @@ export default {
         : [{ type: 'textReuseCluster', q: this.item.textReuseCluster.id }]
       filters.push({ type: 'id', q: this.item.id, context: 'exclude' })
       const query = {
-        skip: parseInt(this.endPassageOffset, 10),
+        offset: parseInt(this.endPassageOffset, 10),
         limit: 1,
-        orderBy: this.endPassageOrderBy,
+        order_by: this.endPassageOrderBy,
         filters,
         addons: { newspaper: 'text' },
       }

src/components/TopicDetailPage.vue

@@ -229,13 +229,13 @@ export default {
           type: 'topic',
           q: [ this.topicUid ],
         }],
-        group_by: 'articles',
+        // group_by: 'articles',
       };
       for (let facetType of this.facetTypes) {
-        const results = await searchFacetsService.get(facetType, {
+        const result = await searchFacetsService.get(facetType, {
           query,
-        }).then(([facetType]) => new Facet(facetType));
-        this.facets = this.facets.concat(results);
+        }).then((facetType) => new Facet(facetType));
+        this.facets = this.facets.concat(result);
       }
     },
     async loadTimeline() {

src/components/modules/FilterDynamicRange.vue

@@ -48,7 +48,7 @@
 import BaseTitleBar from '@/components/base/BaseTitleBar'
 import HistogramSlider from '@/components/modules/vis/HistogramSlider'
 import { serializeFilters } from '@/logic/filters'
-import { stats as statsService, searchFacets as searchFacetsService } from '@/services'
+import { stats as statsService, getSearchFacetsService } from '@/services'
 import Tooltip from './tooltips/Tooltip'
 import FilterFactory from '@/models/FilterFactory'
 import InfoButton from '@/components/base/InfoButton'
@@ -257,13 +257,12 @@ export default {
             console.error('[FilterDynamicRange] error', error)
           })
         // when min and max have been calculated, set the range
-        await searchFacetsService
+        await getSearchFacetsService(this.index)
           .get(this.facet.type, {
             query: {
-              index: this.index,
               // searchFacets doesn't support serialized filters
               filters: this.facetFilters,
-              groupby: query.groupby,
+              group_by: query.groupby,
               rangeStart: this.start,
               rangeEnd: this.end + 1,
               rangeGap: this.gap,
@@ -272,7 +271,7 @@ export default {
           })
           .then(response => {
             console.debug('[FilterDynamicRange] loadFacet', response)
-            this.buckets = response[0].buckets
+            this.buckets = response.buckets
           })
           .catch(error => {
             // eslint-disable-next-line

src/components/modules/FilterFacet.vue

@@ -127,7 +127,7 @@ import FilterMonitor from '@/components/modules/FilterMonitor'
 import InfoButton from '@/components/base/InfoButton'
 import { toSerializedFilter } from '@/logic/filters'
 import Bucket from '@/models/Bucket'
-import { searchFacets } from '@/services'
+import { getSearchFacetsService } from '@/services'
 import LazyObserver from '../LazyObserver.vue'
 import { defineComponent } from 'vue'
 
@@ -150,7 +150,7 @@ export default defineComponent({
     selectedBucketsItems: [],
     //
     limit: 10,
-    skip: 0,
+    offset: 0,
     additionalBuckets: [],
     isMoreLoading: false,
     lazyIsPristine: true,
@@ -336,16 +336,15 @@ export default defineComponent({
         return
       }
       this.isMoreLoading = true
-      searchFacets
+      getSearchFacetsService(this.searchIndex)
         .get(this.facet.type, {
           query: {
-            index: this.searchIndex,
             filters: this.contextFilters,
             limit: this.limit,
-            skip: this.skip,
+            offset: this.skip,
           },
         })
-        .then(([{ numBuckets, buckets }]) => {
+        .then(({ numBuckets, buckets }) => {
           console.info('loadMoreBuckets', buckets, this.skip)
           this.additionalBuckets = this.additionalBuckets.concat(
             buckets.map(
@@ -371,20 +370,19 @@ export default defineComponent({
         console.debug('[FilterFacet] @onIntersect type:', this.facet.type)
         this.lazyIsPristine = false
         // load initial buckets
-        searchFacets
+        getSearchFacetsService(this.searchIndex)
           .get(
             this.facet.type,
             {
               query: {
-                index: this.searchIndex,
                 filters: this.contextFilters,
                 limit: this.limit,
-                skip: this.skip,
+                offset: this.skip,
               },
             },
             { ignoreErrors: true },
           )
-          .then(([{ numBuckets, buckets }]) => {
+          .then(({ numBuckets, buckets }) => {
             this.facet.numBuckets = numBuckets
             this.facet.setBuckets(buckets)
           })

src/components/modules/collections/AddToCollection.vue

@@ -123,7 +123,7 @@ export default {
         }
       }
       const query = {
-        skip: this.paginationPerPage * (this.paginationCurrentPage - 1),
+        offset: this.paginationPerPage * (this.paginationCurrentPage - 1),
         page: this.paginationCurrentPage,
         limit: this.paginationPerPage,
         orderBy: this.orderBy,

src/components/modules/collections/CollectionRecommendationsPanel.vue

@@ -272,7 +272,7 @@ export default {
         filters: recommenderResponseToFilters(this.response, this.recommendersSettings).concat(collectionExlusionFilter),
         relevanceContext: recommenderResponseToRelevanceContext(this.response, this.recommendersSettings),
         pagination: {
-          skip: (this.paginationCurrentPage - 1) * this.paginationPerPage,
+          offset: (this.paginationCurrentPage - 1) * this.paginationPerPage,
           limit: this.paginationPerPage
         }
       }

src/components/modules/textReuse/TextReuseOverview.vue

@@ -19,7 +19,7 @@
 
 <script>
 import Facet from '@/models/Facet'
-import { searchFacets } from '@/services'
+import { getSearchFacetsService } from '@/services'
 
 export default {
   name: 'TextReuseOverview',
@@ -46,7 +46,6 @@ export default {
     /** @returns {{ query: any, hash: string }} */
     searchFacetApiQueryParams() {
       const query = {
-        index: this.searchIndex,
         limit: 10,
         order_by: '-count',
         page: 1,
@@ -64,23 +63,24 @@ export default {
     },
   },
   methods: {
-    loadFacet(type, opts = {}) {
+    loadFacets(types, opts = {}) {
       // eslint-disable-next-line
       console.debug(
-        '[TextReuseOverview] loadFacet',
-        type,
+        '[TextReuseOverview] loadFacets',
+        types,
         'query',
         this.searchFacetApiQueryParams.query,
       )
-      searchFacets
-        .get(type, {
+      getSearchFacetsService(this.searchIndex)
+        .find({
           query: {
+            facets: types,
             ...this.searchFacetApiQueryParams.query,
             ...opts,
           },
         })
-        .then(response => {
-          response.forEach(result => {
+        .then(result => {
+          result.data.forEach(result => {
             const facet = this.facets.find(facet => result.type === facet.type)
             if (facet) {
               facet.numBuckets = result.numBuckets
@@ -98,11 +98,15 @@ export default {
         }
         // eslint-disable-next-line
         console.debug('[TextReuse] @searchApiQueryParameters \n query:', query)
-        await this.loadFacet('newspaper')
-        await this.loadFacet('type,country')
-        await this.loadFacet('language')
-        await this.loadFacet('person,location')
-        await this.loadFacet('topic')
+        await this.loadFacets([
+          'newspaper',
+          'type',
+          'country',
+          'language',
+          'person',
+          'location',
+          'topic'
+        ])
       },
       immediate: true,
       deep: false,