Obiekt Mock

Obiekt mock to obiekt, który reprezentuje atrapy sieciowe i zawiera informacje o żądaniach, które pasowały do podanego url i filterOptions. Można go otrzymać używając polecenia mock.

informacja

Zauważ, że używanie polecenia mock wymaga wsparcia dla protokołu Chrome DevTools. To wsparcie jest dostępne, jeśli uruchamiasz testy lokalnie w przeglądarce opartej na Chromium lub jeśli używasz Selenium Grid w wersji 4 lub wyższej. Tego polecenia nie można używać podczas uruchamiania zautomatyzowanych testów w chmurze. Dowiedz się więcej w sekcji Protokoły Automatyzacji.

Możesz przeczytać więcej o tworzeniu atrap żądań i odpowiedzi w WebdriverIO w naszym przewodniku Atrapy i Szpiedzy.

Właściwości

Obiekt mock zawiera następujące właściwości:

Nazwa	Typ	Szczegóły
url	String	Adres URL przekazany do polecenia mock
filterOptions	Object	Opcje filtrowania zasobów przekazane do polecenia mock
browser	Object	Obiekt Przeglądarki użyty do uzyskania obiektu mock.
calls	Object[]	Informacje o pasujących żądaniach przeglądarki, zawierające właściwości takie jak url, method, headers, initialPriority, referrerPolic, statusCode, responseHeaders i body

Metody

Obiekty mock udostępniają różne polecenia, wymienione w sekcji mock, które pozwalają użytkownikom modyfikować zachowanie żądania lub odpowiedzi.

• abort
• abortOnce
• clear
• request
• requestOnce
• respond
• respondOnce
• restore
• waitForResponse

Wydarzenia

Obiekt mock jest instancją EventEmitter, która emituje kilka zdarzeń na potrzeby Twoich przypadków użycia.

Oto lista zdarzeń.

request

To zdarzenie jest emitowane podczas uruchamiania żądania sieciowego, które pasuje do wzorców atrapy. Żądanie jest przekazywane w wywołaniu zwrotnym zdarzenia.

Interfejs żądania:

interface RequestEvent {
    requestId: number
    request: Matches
    responseStatusCode: number
    responseHeaders: Record<string, string>
}

overwrite

To zdarzenie jest emitowane, gdy odpowiedź sieciowa jest nadpisana za pomocą respond lub respondOnce. Odpowiedź jest przekazywana w wywołaniu zwrotnym zdarzenia.

Interfejs odpowiedzi:

interface OverwriteEvent {
    requestId: number
    responseCode: number
    responseHeaders: Record<string, string>
    body?: string | Record<string, any>
}

fail

To zdarzenie jest emitowane, gdy żądanie sieciowe jest przerywane za pomocą abort lub abortOnce. Informacja o błędzie jest przekazywana w wywołaniu zwrotnym zdarzenia.

Interfejs błędu:

interface FailEvent {
    requestId: number
    errorReason: Protocol.Network.ErrorReason
}

match

To zdarzenie jest emitowane, gdy dodawane jest nowe dopasowanie, przed zdarzeniami continue lub overwrite. Dopasowanie jest przekazywane w wywołaniu zwrotnym zdarzenia.

Interfejs dopasowania:

interface MatchEvent {
    url: string // URL żądania (bez fragmentu).
    urlFragment?: string // Fragment żądanego URL zaczynający się od znaku hash, jeśli obecny.
    method: string // Metoda żądania HTTP.
    headers: Record<string, string> // Nagłówki żądania HTTP.
    postData?: string // Dane żądania HTTP POST.
    hasPostData?: boolean // Prawda, gdy żądanie ma dane POST.
    mixedContentType?: MixedContentType // Typ eksportu zawartości mieszanej żądania.
    initialPriority: ResourcePriority // Priorytet żądania zasobu w momencie wysłania żądania.
    referrerPolicy: ReferrerPolicy // Polityka referrera żądania, zdefiniowana w https://www.w3.org/TR/referrer-policy/
    isLinkPreload?: boolean // Czy jest ładowany przez link preload.
    body: string | Buffer | JsonCompatible // Treść odpowiedzi rzeczywistego zasobu.
    responseHeaders: Record<string, string> // Nagłówki odpowiedzi HTTP.
    statusCode: number // Kod statusu odpowiedzi HTTP.
    mockedResponse?: string | Buffer // Jeśli atrapa emitująca zdarzenie również zmodyfikowała swoją odpowiedź.
}

continue

To zdarzenie jest emitowane, gdy odpowiedź sieciowa nie została ani nadpisana, ani przerwana, lub jeśli odpowiedź została już wysłana przez inną atrapę. requestId jest przekazywany w wywołaniu zwrotnym zdarzenia.

Przykłady

Pobieranie liczby oczekujących żądań:

let pendingRequests = 0
const mock = await browser.mock('**') // ważne jest, aby dopasować wszystkie żądania, w przeciwnym razie uzyskana wartość może być bardzo myląca.
mock.on('request', ({request}) => {
    pendingRequests++
    console.log(`dopasowano żądanie do ${request.url}, oczekuje ${pendingRequests} żądań`)
})
mock.on('match', ({url}) => {
    pendingRequests--
    console.log(`rozwiązano żądanie do ${url}, oczekuje ${pendingRequests} żądań`)
})

Wyrzucanie błędu przy niepowodzeniu sieci 404:

browser.addCommand('loadPageWithout404', (url, {selector, predicate}) => new Promise(async (resolve, reject) => {
    const mock = await this.mock('**')

    mock.on('match', ({url, statusCode}) => {
        if (statusCode === 404) {
            reject(new Error(`żądanie do ${url} nie powiodło się z błędem "Not Found"`))
        }
    })

    await this.url(url).catch(reject)

    // czekamy tutaj, ponieważ niektóre żądania mogą nadal być w toku
    if (selector) {
        await this.$(selector).waitForExist().catch(reject)
    }

    if (predicate) {
        await this.waitUntil(predicate).catch(reject)
    }

    resolve()
}))

await browser.loadPageWithout404(browser, 'some/url', { selector: 'main' })

Określanie, czy wartość odpowiedzi mock została użyta:

const firstMock = await browser.mock('**/foo/**')
const secondMock = await browser.mock('**/foo/bar/**')

firstMock.respondOnce({id: 3, title: 'three'})
secondMock.respond({id: 4, title: 'four'})

firstMock.on('overwrite', () => {
    // wyzwalane dla pierwszego żądania do '**/foo/**'
}).on('continue', () => {
    // wyzwalane dla pozostałych żądań do '**/foo/**'
})

secondMock.on('continue', () => {
    // wyzwalane dla pierwszego żądania do '**/foo/bar/**'
}).on('overwrite', () => {
    // wyzwalane dla pozostałych żądań do '**/foo/bar/**'
})

W tym przykładzie, firstMock został zdefiniowany jako pierwszy i ma jedno wywołanie respondOnce, więc wartość odpowiedzi secondMock nie zostanie użyta dla pierwszego żądania, ale zostanie użyta dla pozostałych.