كائن المحاكاة (Mock)

كائن المحاكاة هو كائن يمثل محاكاة شبكية ويحتوي على معلومات حول الطلبات التي تطابق url وfilterOptions المعطاة. يمكن الحصول عليه باستخدام أمر mock.

معلومات

لاحظ أن استخدام أمر mock يتطلب دعمًا لبروتوكول Chrome DevTools. يتم توفير هذا الدعم إذا كنت تقوم بتشغيل الاختبارات محليًا في متصفح يعتمد على Chromium أو إذا كنت تستخدم Selenium Grid الإصدار 4 أو أعلى. لا يمكن استخدام هذا الأمر عند تشغيل الاختبارات التلقائية في السحابة. اكتشف المزيد في قسم بروتوكولات الأتمتة.

يمكنك قراءة المزيد عن محاكاة الطلبات والاستجابات في WebdriverIO في دليل المحاكاة والتجسس الخاص بنا.

الخصائص

يحتوي كائن المحاكاة على الخصائص التالية:

الاسم	النوع	التفاصيل
url	String	عنوان URL الذي تم تمريره إلى أمر المحاكاة
filterOptions	Object	خيارات تصفية الموارد التي تم تمريرها إلى أمر المحاكاة
browser	Object	كائن المتصفح المستخدم للحصول على كائن المحاكاة.
calls	Object[]	معلومات حول طلبات المتصفح المطابقة، تحتوي على خصائص مثل url وmethod وheaders وinitialPriority وreferrerPolic وstatusCode وresponseHeaders وbody

الطرق

توفر كائنات المحاكاة أوامر متنوعة، مدرجة في قسم mock، تتيح للمستخدمين تعديل سلوك الطلب أو الاستجابة.

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

الأحداث

كائن المحاكاة هو مُصدر أحداث (EventEmitter) ويتم إصدار عدة أحداث لحالات الاستخدام الخاصة بك.

فيما يلي قائمة بالأحداث.

request

يتم إصدار هذا الحدث عند إطلاق طلب شبكي يتطابق مع أنماط المحاكاة. يتم تمرير الطلب في استدعاء الحدث.

واجهة الطلب:

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

overwrite

يتم إصدار هذا الحدث عندما يتم استبدال استجابة الشبكة باستخدام respond أو respondOnce. يتم تمرير الاستجابة في استدعاء الحدث.

واجهة الاستجابة:

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

fail

يتم إصدار هذا الحدث عندما يتم إلغاء طلب الشبكة باستخدام abort أو abortOnce. يتم تمرير الفشل في استدعاء الحدث.

واجهة الفشل:

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

match

يتم إصدار هذا الحدث عند إضافة تطابق جديد، قبل continue أو overwrite. يتم تمرير التطابق في استدعاء الحدث.

واجهة التطابق:

interface MatchEvent {
    url: string // عنوان URL للطلب (بدون جزء الشظية).
    urlFragment?: string // جزء من عنوان URL المطلوب بدءًا من علامة التجزئة، إذا كان موجودًا.
    method: string // طريقة طلب HTTP.
    headers: Record<string, string> // رؤوس طلب HTTP.
    postData?: string // بيانات طلب HTTP POST.
    hasPostData?: boolean // صحيح عندما يحتوي الطلب على بيانات POST.
    mixedContentType?: MixedContentType // نوع تصدير المحتوى المختلط للطلب.
    initialPriority: ResourcePriority // أولوية طلب المورد في وقت إرسال الطلب.
    referrerPolicy: ReferrerPolicy // سياسة المحيل للطلب، كما هو محدد في https://www.w3.org/TR/referrer-policy/
    isLinkPreload?: boolean // ما إذا كان يتم تحميله عبر التحميل المسبق للرابط.
    body: string | Buffer | JsonCompatible // محتوى الاستجابة للمورد الفعلي.
    responseHeaders: Record<string, string> // رؤوس استجابة HTTP.
    statusCode: number // رمز حالة استجابة HTTP.
    mockedResponse?: string | Buffer // إذا كانت المحاكاة تصدر الحدث، وقد عدلت أيضًا استجابتها.
}

continue

يتم إصدار هذا الحدث عندما لا يتم استبدال استجابة الشبكة ولا مقاطعتها، أو إذا تم إرسال الاستجابة بالفعل بواسطة محاكاة أخرى. يتم تمرير requestId في استدعاء الحدث.

أمثلة

الحصول على عدد الطلبات المعلقة:

let pendingRequests = 0
const mock = await browser.mock('**') // من المهم مطابقة جميع الطلبات، وإلا ستكون القيمة الناتجة مربكة للغاية.
mock.on('request', ({request}) => {
    pendingRequests++
    console.log(`matched request to ${request.url}, pending ${pendingRequests} requests`)
})
mock.on('match', ({url}) => {
    pendingRequests--
    console.log(`resolved request to ${url}, pending ${pendingRequests} requests`)
})

إطلاق خطأ عند فشل الشبكة 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(`request to ${url} failed with "Not Found"`))
        }
    })

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

    // الانتظار هنا، لأنه قد لا تزال هناك بعض الطلبات معلقة
    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' })

تحديد ما إذا كانت قيمة استجابة المحاكاة قد استخدمت:

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', () => {
    // يتم تشغيله للطلب الأول إلى '**/foo/**'
}).on('continue', () => {
    // يتم تشغيله لبقية الطلبات إلى '**/foo/**'
})

secondMock.on('continue', () => {
    // يتم تشغيله للطلب الأول إلى '**/foo/bar/**'
}).on('overwrite', () => {
    // يتم تشغيله لبقية الطلبات إلى '**/foo/bar/**'
})

في هذا المثال، تم تعريف firstMock أولاً ويحتوي على استدعاء respondOnce واحد، لذلك لن يتم استخدام قيمة استجابة secondMock للطلب الأول، ولكن سيتم استخدامها لبقية الطلبات.