wikimedia/mediawiki-skins-Vector
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git synced 2024-11-28 01:20:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Revert "Add fetch tests from WVUI""

Browse source
This commit is contained in:
jenkins-bot 2022-02-15 19:16:06 +00:00 committed by Gerrit Code Review
parent 91ebd9da17 3c161cf49e
commit 45badb5127
4 changed files with 55 additions and 157 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
jest.config.js
View file

@ -28,10 +28,10 @@ module.exports = {
// An object that configures minimum threshold enforcement for coverage results
coverageThreshold: {
global: {
branches: 6,
functions: 12,
lines: 8,
statements: 8
branches: 0,
functions: 0,
lines: 0,
statements: 0
}
},

53
resources/skins.vector.search/fetch.js
View file

@ -1,53 +0,0 @@
/**
* @typedef {Object} AbortableFetch
* @property {Promise<any>} fetch
* @property {Function} abort
*/
/**
* @typedef {Object} NullableAbortController
* @property {AbortSignal | undefined} signal
* @property {Function} abort
*/
const nullAbortController = {
signal: undefined,
abort: () => {} // Do nothing (no-op)
};
/**
* A wrapper which combines native fetch() in browsers and the following json() call.
*
* @param {string} resource
* @param {RequestInit} [init]
* @return {AbortableFetch}
*/
function fetchJson( resource, init ) {
// As of 2020, browser support for AbortController is limited:
// https://caniuse.com/abortcontroller
// so replacing it with no-op if it doesn't exist.
/* eslint-disable compat/compat */
const controller = window.AbortController ?
new AbortController() :
nullAbortController;
/* eslint-enable compat/compat */
const getJson = fetch( resource, $.extend( init, {
signal: controller.signal
} ) ).then( ( response ) => {
if ( !response.ok ) {
return Promise.reject(
'Network request failed with HTTP code ' + response.status
);
}
return response.json();
} );
return {
fetch: getJson,
abort: () => {
controller.abort();
}
};
}
module.exports = fetchJson;

52
resources/skins.vector.search/restSearchClient.js
View file

@ -1,6 +1,56 @@
/** @module restSearchClient */
const fetchJson = require( './fetch.js' );
/**
* @typedef {Object} AbortableFetch
* @property {Promise<any>} fetch
* @property {Function} abort
*/
/**
* @typedef {Object} NullableAbortController
* @property {AbortSignal | undefined} signal
* @property {Function} abort
*/
const nullAbortController = {
signal: undefined,
abort: () => {} // Do nothing (no-op)
};
/**
* A wrapper which combines native fetch() in browsers and the following json() call.
*
* @param {string} resource
* @param {RequestInit} [init]
* @return {AbortableFetch}
*/
function fetchJson( resource, init ) {
// As of 2020, browser support for AbortController is limited:
// https://caniuse.com/abortcontroller
// so replacing it with no-op if it doesn't exist.
/* eslint-disable compat/compat */
const controller = window.AbortController ?
new AbortController() :
nullAbortController;
/* eslint-enable compat/compat */
const getJson = fetch( resource, $.extend( init, {
signal: controller.signal
} ) ).then( ( response ) => {
if ( !response.ok ) {
return Promise.reject(
'Network request failed with HTTP code ' + response.status
);
}
return response.json();
} );
return {
fetch: getJson,
abort: () => {
controller.abort();
}
};
}
/**
* @typedef {Object} RestResponse

99
tests/jest/fetch.test.js
View file

@ -1,99 +0,0 @@
/* global fetchMock */
const fetchJson = require( '../../resources/skins.vector.search/fetch.js' );
const jestFetchMock = require( 'jest-fetch-mock' );
const mockedRequests = !process.env.TEST_LIVE_REQUESTS;
const url = '//en.wikipedia.org/w/rest.php/v1/search/title?q=jfgkdajgioj&limit=10';
describe( 'abort() using AbortController', () => {
test( 'Aborting an unfinished request throws an AbortError', async () => {
expect.assertions( 1 );
const { abort, fetch } = fetchJson( url );
abort();
return fetch.catch( ( e ) => {
expect( e.name ).toStrictEqual( 'AbortError' );
} );
} );
} );
describe( 'fetch() using window.fetch', () => {
beforeAll( () => {
jestFetchMock.enableFetchMocks();
} );
afterAll( () => {
jestFetchMock.disableFetchMocks();
} );
beforeEach( () => {
fetchMock.resetMocks();
if ( !mockedRequests ) {
fetchMock.disableMocks();
}
fetchMock.mockIf( /^\/\/en.wikipedia.org\//, async ( req ) => {
if ( req.url === url ) {
return {
body: JSON.stringify( { pages: [] } ),
headers: {
'Content-Type': 'application/json'
}
};
} else {
return {
status: 404,
body: 'Page not found'
};
}
} );
} );
test( '200 without init param passed', async () => {
const { fetch } = fetchJson( url );
const json = await fetch;
// eslint-disable-next-line compat/compat
const controller = new AbortController();
expect( json ).toStrictEqual( { pages: [] } );
if ( mockedRequests ) {
expect( fetchMock ).toHaveBeenCalledTimes( 1 );
expect( fetchMock ).toHaveBeenCalledWith( url, { signal: controller.signal } );
}
} );
test( '200 with init param passed', async () => {
const { fetch } = fetchJson( url, { mode: 'cors' } );
const json = await fetch;
expect( json ).toStrictEqual( { pages: [] } );
if ( mockedRequests ) {
expect( fetchMock ).toHaveBeenCalledTimes( 1 );
expect( fetchMock ).toHaveBeenCalledWith(
url,
expect.objectContaining( { mode: 'cors' } )
);
}
} );
test( '404 response', async () => {
expect.assertions( 1 );
const { fetch } = fetchJson( '//en.wikipedia.org/doesNotExist' );
await expect( fetch )
.rejects.toStrictEqual( 'Network request failed with HTTP code 404' );
if ( mockedRequests ) {
const controller = new AbortController();
expect.assertions( 3 );
expect( fetchMock ).toHaveBeenCalledTimes( 1 );
expect( fetchMock ).toHaveBeenCalledWith(
'//en.wikipedia.org/doesNotExist', { signal: controller.signal }
);
}
} );
} );