test(files): Make scrolling tests independent from magic values

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

Author: susnux

cypress/e2e/core-utils.ts

@@ -48,3 +48,38 @@ export enum UnifiedSearchFilter {
 export function getUnifiedSearchFilter(filter: UnifiedSearchFilter) {
 	return getUnifiedSearchModal().find(`[data-cy-unified-search-filters] [data-cy-unified-search-filter="${CSS.escape(filter)}"]`)
 }
+
+/**
+ * Assertion that an element is fully within the current viewport.
+ * @param $el The element
+ * @param expected If the element is expected to be fully in viewport or not fully
+ * @example
+ * ```js
+ * cy.get('#my-element')
+ *   .should(beFullyInViewport)
+ * ```
+ */
+export function beFullyInViewport($el: JQuery<HTMLElement>, expected = true) {
+	const { top, left, bottom, right } = $el.get(0)!.getBoundingClientRect()
+	const { innerHeight, innerWidth } = window
+	const fullyVisible = top >= 0 && left >= 0 && bottom <= innerHeight && right <= innerWidth
+
+	if (expected) {
+		expect(fullyVisible, 'Fully within viewport').to.be.true
+	} else {
+		expect(fullyVisible, 'Not fully within viewport').to.be.false
+	}
+}
+
+/**
+ * Opposite of `beFullyInViewport` - resolves when element is not or only partially in viewport.
+ * @param $el The element
+ * @example
+ * ```js
+ * cy.get('#my-element')
+ *   .should(notBeFullyInViewport)
+ * ```
+ */
+export function notBeFullyInViewport($el: JQuery<HTMLElement>) {
+	return beFullyInViewport($el, false)
+}

cypress/e2e/files/FilesUtils.ts

@@ -214,3 +214,15 @@ export const reloadCurrentFolder = () => {
 	cy.get('[data-cy-files-content-breadcrumbs]').findByRole('button', { description: 'Reload current directory' }).click()
 	cy.wait('@propfind')
 }
+
+/**
+ * Enable the grid mode for the files list.
+ * Will fail if already enabled!
+ */
+export function enableGridMode() {
+	cy.intercept('**/apps/files/api/v1/config/grid_view').as('setGridMode')
+	cy.findByRole('button', { name: 'Switch to grid view' })
+		.should('be.visible')
+		.click()
+	cy.wait('@setGridMode')
+}

cypress/e2e/files/scrolling.cy.ts

@@ -4,11 +4,13 @@
  */
 
 import type { User } from '@nextcloud/cypress'
-import { getRowForFile } from './FilesUtils'
+import { enableGridMode, getRowForFile } from './FilesUtils.ts'
+import { notBeFullyInViewport } from '../core-utils.ts'
 
 describe('files: Scrolling to selected file in file list', { testIsolation: true }, () => {
 	const fileIds = new Map<number, string>()
 	let user: User
+	let viewportHeight: number
 
 	before(() => {
 		cy.createRandomUser().then(($user) => {
@@ -19,12 +21,17 @@ describe('files: Scrolling to selected file in file list', { testIsolation: true
 				cy.uploadContent(user, new Blob([]), 'text/plain', `/${i}.txt`)
 					.then((response) => fileIds.set(i, Number.parseInt(response.headers['oc-fileid']).toString()))
 			}
+
+			cy.login(user)
+			cy.viewport(1200, 800)
+			// Calculate height to ensure that those 10 elements can not be rendered in one list (only 6 will fit the screen)
+			calculateViewportHeight(6)
+				.then((height) => { viewportHeight = height })
 		})
 	})
 
 	beforeEach(() => {
-		// Adjust height to ensure that those 10 elements can not be rendered in one list
-		cy.viewport(1200, 6 * 55 /* rows */ + 55 /* table header */ + 50 /* navigation header */ + 50 /* breadcrumbs */ + 46 /* file filters */)
+		cy.viewport(1200, viewportHeight)
 		cy.login(user)
 	})
 
@@ -64,7 +71,6 @@ describe('files: Scrolling to selected file in file list', { testIsolation: true
 				.and(beOverlappedByTableHeader)
 			getRowForFile(`${i + 5}.txt`)
 				.should('exist')
-				.and('be.visible')
 				.and(notBeFullyInViewport)
 		})
 	}
@@ -117,6 +123,7 @@ describe('files: Scrolling to selected file in file list', { testIsolation: true
 describe('files: Scrolling to selected file in file list (GRID MODE)', { testIsolation: true }, () => {
 	const fileIds = new Map<number, string>()
 	let user: User
+	let viewportHeight: number
 
 	before(() => {
 		cy.createRandomUser().then(($user) => {
@@ -127,21 +134,22 @@ describe('files: Scrolling to selected file in file list (GRID MODE)', { testIso
 				cy.uploadContent(user, new Blob([]), 'text/plain', `/${i}.txt`)
 					.then((response) => fileIds.set(i, Number.parseInt(response.headers['oc-fileid']).toString()))
 			}
+
 			// Set grid mode
 			cy.login(user)
-			cy.intercept('**/apps/files/api/v1/config/grid_view').as('setGridMode')
 			cy.visit('/apps/files')
-			cy.findByRole('button', { name: 'Switch to grid view' })
-				.should('be.visible')
-				.click()
-			cy.wait('@setGridMode')
+			enableGridMode()
+
+			// 768px width will limit the columns to 3
+			cy.viewport(768, 800)
+			// Calculate height to ensure that those 12 elements can not be rendered in one list (only 3 will fit the screen)
+			calculateViewportHeight(3)
+				.then((height) => { viewportHeight = height })
 		})
 	})
 
 	beforeEach(() => {
-		// Adjust height to ensure that those 12 files can not be rendered in one list
-		// 768px width will limit the columns to 3
-		cy.viewport(768, 3 * 246 /* rows */ + 55 /* table header */ + 50 /* navigation header */ + 50 /* breadcrumbs */ + 46 /* file filters */)
+		cy.viewport(768, viewportHeight)
 		cy.login(user)
 	})
 
@@ -244,6 +252,35 @@ describe('files: Scrolling to selected file in file list (GRID MODE)', { testIso
 
 /// Some helpers
 
+/**
+ * Calculate the needed viewport height to limit the visible rows of the file list.
+ *
+ * @param rows The number of rows that should be displayed at the same time
+ * @returns The wrapped result
+ */
+function calculateViewportHeight(rows: number): Cypress.Chainable<number> {
+	cy.visit('/apps/files')
+	return cy.get('[data-cy-files-list]')
+		.should('be.visible')
+		.then((filesList) => {
+			const windowHeight = Cypress.$('body').height()!
+			// Size of other page elements
+			const outerHeight = Math.ceil(windowHeight - filesList.height()!)
+			// Size of before and filters
+			const beforeHeight = Math.ceil(Cypress.$('.files-list__before').height()!)
+			const filterHeight = Math.ceil(Cypress.$('.files-list__filters').height()!)
+			// Size of the table header
+			const tableHeaderHeight = Math.ceil(Cypress.$('[data-cy-files-list-thead]').height()!)
+			// table row height
+			const rowHeight = Math.ceil(Cypress.$('[data-cy-files-list-tbody] tr').height()!)
+
+			// sum it up
+			const viewportHeight = outerHeight + beforeHeight + filterHeight + tableHeaderHeight + rows * rowHeight
+			cy.log(`Calculated viewport height: ${viewportHeight} (${outerHeight} + ${beforeHeight} + ${filterHeight} + ${tableHeaderHeight} + ${rows} * ${rowHeight})`)
+			return cy.wrap(viewportHeight)
+		})
+}
+
 function notBeOverlappedByTableHeader($el: JQuery<HTMLElement>) {
 	return beOverlappedByTableHeader($el, false)
 }
@@ -262,19 +299,3 @@ function beOverlappedByTableHeader($el: JQuery<HTMLElement>, expected = true) {
 		expect(overlap, 'Not overlapped by table header').to.be.false
 	}
 }
-
-function beFullyInViewport($el: JQuery<HTMLElement>, expected = true) {
-	const { top, left, bottom, right } = $el.get(0)!.getBoundingClientRect()
-	const { innerHeight, innerWidth } = window
-	const fullyVisible = top >= 0 && left >= 0 && bottom <= innerHeight && right <= innerWidth
-
-	if (expected) {
-		expect(fullyVisible, 'Fully within viewport').to.be.true
-	} else {
-		expect(fullyVisible, 'Not fully within viewport').to.be.false
-	}
-}
-
-function notBeFullyInViewport($el: JQuery<HTMLElement>) {
-	return beFullyInViewport($el, false)
-}