test: tighten browse forwarding plumbing

server/utils/queries/libraryItemsBookFilters.js

@@ -393,11 +393,10 @@ module.exports = {
    * @param {number} limit
    * @param {number} offset
    * @param {boolean} isHomePage for home page shelves
-   * @param {{ cursor?: string|null, pageMode?: string, collapseseries?: boolean }} requestOptions
+   * @param {object} browseRequestOptions Reserved for future large-library browse plumbing
    * @returns {{ libraryItems: import('../../models/LibraryItem')[], count: number }}
    */
-  async getFilteredLibraryItems(libraryId, user, filterGroup, filterValue, sortBy, sortDesc, collapseseries, include, limit, offset, isHomePage = false, requestOptions = {}) {
+  async getFilteredLibraryItems(libraryId, user, filterGroup, filterValue, sortBy, sortDesc, collapseseries, include, limit, offset, isHomePage = false, browseRequestOptions = null) {
-    collapseseries = requestOptions.collapseseries ?? collapseseries
     // TODO: Handle collapse sub-series
     if (filterGroup === 'series' && collapseseries) {
       collapseseries = false

server/utils/queries/libraryItemsPodcastFilters.js

@@ -141,12 +141,10 @@ module.exports = {
    * @param {string[]} include
    * @param {number} limit
    * @param {number} offset
-   * @param {{ cursor?: string|null, pageMode?: string, collapseseries?: boolean }} requestOptions
+   * @param {object} browseRequestOptions Reserved for future large-library browse plumbing
    * @returns {Promise<{ libraryItems: import('../../models/LibraryItem')[], count: number }>}
    */
-  async getFilteredLibraryItems(libraryId, user, filterGroup, filterValue, sortBy, sortDesc, include, limit, offset, requestOptions = {}) {
+  async getFilteredLibraryItems(libraryId, user, filterGroup, filterValue, sortBy, sortDesc, include, limit, offset, browseRequestOptions = null) {
-    requestOptions.cursor = requestOptions.cursor || null
-    requestOptions.pageMode = requestOptions.pageMode || 'paged'
     const includeRSSFeed = include.includes('rssfeed')
     const includeNumEpisodesIncomplete = include.includes('numepisodesincomplete')
 

test/server/controllers/LibraryController.largeLibraryBrowse.test.js

@@ -4,6 +4,7 @@ const sinon = require('sinon')
 
 const Database = require('../../../server/Database')
 const LibraryController = require('../../../server/controllers/LibraryController')
+const libraryFilters = require('../../../server/utils/queries/libraryFilters')
 const libraryItemsBookFilters = require('../../../server/utils/queries/libraryItemsBookFilters')
 const libraryItemsPodcastFilters = require('../../../server/utils/queries/libraryItemsPodcastFilters')
 
@@ -81,32 +82,40 @@ describe('LibraryController large-library browse contract', () => {
     })
   })
 
-  it('uses forwarded browse request options inside the book query helper', async () => {
+  it('forwards cursor and pageMode through LibraryItem.getByFilterAndSort into libraryFilters', async () => {
-    const getOrderStub = sinon.stub(libraryItemsBookFilters, 'getOrder').returns([])
+    const getFilteredLibraryItemsStub = sinon.stub(libraryFilters, 'getFilteredLibraryItems').resolves({
-    sinon.stub(libraryItemsBookFilters, 'getMediaGroupQuery').returns({ mediaWhere: {}, replacements: {} })
+      libraryItems: [],
-    sinon.stub(libraryItemsBookFilters, 'getUserPermissionBookWhereQuery').returns({ bookWhere: [], replacements: {} })
+      count: 0,
-    sinon.stub(Database.bookModel, 'findAndCountAll').resolves({ rows: [], count: 0 })
+      nextCursor: null,
+      paginationMode: 'offset',
+      countMode: 'exact-on-initial-page',
+      isCountDeferred: false
+    })
 
-    await libraryItemsBookFilters.getFilteredLibraryItems(
+    await Database.libraryItemModel.getByFilterAndSort(
-      'lib_1',
+      { id: 'lib_1', mediaType: 'book' },
-      { id: 'user_1', isAdminOrUp: false, canAccessExplicitContent: true, accessAllTags: true },
+      { id: 'user_1' },
-      null,
+      {
-      null,
+        sortBy: 'media.metadata.title',
-      'media.metadata.title',
+        limit: 40,
-      false,
+        offset: 0,
-      false,
+        cursor: 'cursor-1',
-      [],
+        pageMode: 'endless',
-      40,
+        include: [],
-      0,
+        collapseseries: true,
-      false,
+        mediaType: 'book'
-      { cursor: 'cursor-1', pageMode: 'endless', collapseseries: true }
+      }
     )
 
-    expect(getOrderStub.firstCall.args[2]).to.equal(true)
+    expect(getFilteredLibraryItemsStub.firstCall.args[2]).to.include({
+      cursor: 'cursor-1',
+      pageMode: 'endless',
+      collapseseries: true
+    })
   })
 
-  it('uses forwarded browse request options inside the podcast query helper', async () => {
+  it('does not mutate caller-owned forwarded browse options in the podcast query helper', async () => {
-    const requestOptions = { cursor: 'cursor-9' }
+    const forwardedBrowseOptions = { cursor: 'cursor-9' }
     sinon.stub(libraryItemsPodcastFilters, 'getMediaGroupQuery').returns({ mediaWhere: {}, replacements: {} })
     sinon.stub(libraryItemsPodcastFilters, 'getUserPermissionPodcastWhereQuery').returns({ podcastWhere: [], replacements: {} })
     sinon.stub(libraryItemsPodcastFilters, 'getOrder').returns([])
@@ -122,13 +131,10 @@ describe('LibraryController large-library browse contract', () => {
       [],
       40,
       0,
-      requestOptions
+      forwardedBrowseOptions
     )
 
-    expect(requestOptions).to.deep.equal({
+    expect(forwardedBrowseOptions).to.deep.equal({ cursor: 'cursor-9' })
-      cursor: 'cursor-9',
-      pageMode: 'paged'
-    })
   })
 
   it('forwards cursor, pageMode, and collapseseries through libraryFilters into the book query helper', async () => {