import path from 'node:path'
import { expect, describe, it, vi, beforeEach } from 'vitest'
import { remote } from '../../../src/index.js'
vi.mock('fetch')
vi.mock('@wdio/logger', () => import(path.join(process.cwd(), '__mocks__', '@wdio/logger')))
describe('waitForDisplayed', () => {
const timeout = 1000
let browser: WebdriverIO.Browser
beforeEach(async () => {
vi.mocked(fetch).mockClear()
browser = await remote({
baseUrl: 'http://foobar.com',
capabilities: {
browserName: 'foobar'
}
})
})
it('should call waitUntil', async () => {
const cb = vi.fn()
const tmpElem = await browser.$('#foo')
const elem = {
selector: '#foo',
on: vi.fn(),
off: vi.fn(),
waitForDisplayed: tmpElem.waitForDisplayed,
elementId: 123,
waitUntil: vi.fn().mockImplementation(cb),
options : { waitforInterval: 5, waitforTimeout: timeout }
} as unknown as WebdriverIO.Element
await elem.waitForDisplayed({ timeout })
expect(cb).toBeCalled()
expect(vi.mocked(elem.waitUntil).mock.calls).toMatchSnapshot()
})
it('should call isDisplayed and return true immediately if true', async () => {
const elem = await browser.$('#foo')
const result = await elem.waitForDisplayed({ timeout })
expect(result).toBe(true)
expect(vi.mocked(fetch).mock.calls[2][0]!.pathname)
.toBe('/session/foobar-123/execute/sync')
})
it('should call isDisplayed and return true if eventually true', async () => {
const tmpElem = await browser.$('#foo')
const elem = {
selector: '#foo',
on: vi.fn(),
off: vi.fn(),
waitForDisplayed: tmpElem.waitForDisplayed,
elementId: 123,
waitUntil: tmpElem.waitUntil,
isDisplayed: vi.fn()
.mockImplementationOnce(() => false)
.mockImplementationOnce(() => false)
.mockImplementationOnce(() => true),
options: { waitforTimeout: 50, waitforInterval: 5 },
} as unknown as WebdriverIO.Element
const result = await elem.waitForDisplayed({ timeout })
expect(result).toBe(true)
})
it('should call isDisplayed and return false', async () => {
expect.assertions(2)
const tmpElem = await browser.$('#foo')
const elem = {
selector: '#foo',
on: vi.fn(),
off: vi.fn(),
waitForDisplayed: tmpElem.waitForDisplayed,
elementId: 123,
waitUntil: tmpElem.waitUntil,
isDisplayed: vi.fn(() => false),
options: { waitforTimeout: 500, waitforInterval: 50 },
} as unknown as WebdriverIO.Element
try {
await elem.waitForDisplayed({ timeout, withinViewport: true })
} catch (err: any) {
expect(err.message).toBe(`element ("#foo") still not displayed within viewport after ${timeout}ms`)
}
expect(elem.isDisplayed).toBeCalledWith({ withinViewport: true, contentVisibilityAuto: true, opacityProperty: true, visibilityProperty: true })
})
it('should not call isDisplayed and return false if never found', async () => {
const tmpElem = await browser.$('#foo')
const elem = {
selector: '#foo',
parent: {
$: vi.fn(() => { return elem}),
on: vi.fn(),
off: vi.fn(),
},
waitForDisplayed: tmpElem.waitForDisplayed,
waitUntil: tmpElem.waitUntil,
isDisplayed: tmpElem.isDisplayed,
options: { waitforTimeout: 500, waitforInterval: 50 },
} as unknown as WebdriverIO.Element
elem.getElement = () => Promise.resolve(elem)
try {
await elem.waitForDisplayed({ timeout })
} catch (err: any) {
expect(err.message).toBe(`element ("#foo") still not displayed after ${timeout}ms`)
}
})
it('should do reverse', async () => {
const cb = vi.fn()
const tmpElem = await browser.$('#foo')
const elem = {
selector: '#foo',
waitForDisplayed: tmpElem.waitForDisplayed,
elementId: 123,
waitUntil: vi.fn().mockImplementation(cb),
isDisplayed: vi.fn(() => true),
options: { waitforTimeout: 500, waitforInterval: 50 },
} as unknown as WebdriverIO.Element
await elem.waitForDisplayed({ reverse: true })
expect(vi.mocked(elem.waitUntil).mock.calls).toMatchSnapshot()
})
it('should call isDisplayed and return false with custom error', async () => {
expect.assertions(1)
const tmpElem = await browser.$('#foo')
const elem = {
selector: '#foo',
on: vi.fn(),
off: vi.fn(),
waitForDisplayed: tmpElem.waitForDisplayed,
elementId: 123,
waitUntil: tmpElem.waitUntil,
isDisplayed: vi.fn(() => false),
options: { waitforTimeout: 500 },
} as unknown as WebdriverIO.Element
try {
await elem.waitForDisplayed({ timeout, timeoutMsg: 'Element foo never displayed' })
} catch (err: any) {
expect(err.message).toBe('Element foo never displayed')
}
})
})
