/* MIT License Copyright (c) 2021 Looker Data Sciences, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ import fetchMock, { enableFetchMocks } from 'jest-fetch-mock'; import { StatusCode, sdkOk } from './transport'; import * as sleepUtils from './sleep'; import { BrowserTransport } from './browserTransport'; import type { IRawResponse, ISDKError, ITransportSettings, IWait, IWaitResponse, } from './transport'; /** eslint-disable jest/no-disabled-tests */ enableFetchMocks(); const retryFoo = 'https://retry.foo'; describe('BrowserTransport', () => { let tried = 0; beforeEach(() => { jest .spyOn(sleepUtils, 'sleep') .mockImplementation((time: number) => Promise.resolve(time)); tried = 0; fetchMock.mockIf(/^https?:\/\/retry\.foo.*$/, async req => { const url = new URL(req.url); const delayed = url.searchParams.get('delay'); if (delayed) { await new Promise(resolve => { setTimeout(resolve, Number(delayed)); }); return { body: '{ "status": "timed" }', status: StatusCode.OK, }; } tried++; if (tried < 4) { return { body: '{ "status": "working" }', headers: { 'Retry-After': String(tried), 'Content-Type': 'application/json', }, status: [ StatusCode.Accepted, StatusCode.TooManyRequests, StatusCode.ServiceUnavailable, ][tried - 1], }; } else { return { body: '{ "status": "done" }', // headers: { 'Content-Type': 'application/json' }, status: StatusCode.OK, }; } }); }); afterEach(() => { jest.clearAllMocks(); }); describe('timeout and cancel', () => { const timer = (ms = 1000) => { return `${retryFoo}?delay=${ms}`; }; const xp = new BrowserTransport({ maxTries: 1 } as ITransportSettings); it('does not timeout by default', async () => { const resp = await xp.rawRequest('GET', timer()); expect(resp.body).toEqual('{ "status": "timed" }'); expect(resp.statusCode).toEqual(200); }); it('completes before 1 second cancel', async () => { const signal = AbortSignal.timeout(1000); const resp = await xp.rawRequest( 'GET', timer(250), // responds to request in 250 ms undefined, undefined, undefined, { signal } ); expect(resp.body).toEqual('{ "status": "timed" }'); expect(resp.statusCode).toEqual(200); }); it.skip('times out in 1 second', async () => { await expect( xp.request( 'GET', timer(1500), // responds to requests in 1.5 seconds, undefined, undefined, undefined, { timeout: 1, } ) ).rejects.toThrow('The operation was aborted.'); }); // TODO need to successfully implement AbortSignal.any for jest for this to work it.skip('cancels in 250 ms', async () => { const signal = AbortSignal.timeout(250); await expect( xp.request('GET', timer(), undefined, undefined, undefined, { signal, }) ).rejects.toThrow('The operation was aborted.'); }); }); it('cannot track performance if performance is not supported', () => { jest.spyOn(BrowserTransport, 'supportsPerformance').mockReturnValue(false); BrowserTransport.trackPerformance = true; expect(BrowserTransport.trackPerformance).toEqual(false); }); it('can track performance if performance is supported', () => { jest.spyOn(BrowserTransport, 'supportsPerformance').mockReturnValue(true); BrowserTransport.trackPerformance = true; expect(BrowserTransport.trackPerformance).toEqual(true); BrowserTransport.trackPerformance = false; expect(BrowserTransport.trackPerformance).toEqual(false); }); it('accepted response is ok if retries are exceeded', async () => { const xp = new BrowserTransport({ maxTries: 1 } as ITransportSettings); const resp = await xp.rawRequest('GET', retryFoo); expect(resp.ok).toEqual(true); expect(resp.statusCode).toEqual(StatusCode.Accepted); expect(resp.body).toEqual('{ "status": "working" }'); expect(tried).toEqual(1); expect(sleepUtils.sleep).toHaveBeenCalledTimes(0); }); it('retries responses with retry status codes', async () => { const xp = new BrowserTransport({ maxTries: 4 } as ITransportSettings); const resp = await xp.rawRequest('GET', retryFoo); expect(resp.ok).toEqual(true); expect(resp.statusCode).toEqual(StatusCode.OK); expect(resp.body).toEqual('{ "status": "done" }'); expect(tried).toEqual(4); expect(sleepUtils.sleep).toHaveBeenCalledTimes(3); }); it('does not exceed retries', async () => { const xp = new BrowserTransport({ maxTries: 3 } as ITransportSettings); const resp = await xp.rawRequest('GET', retryFoo); expect(resp.ok).toEqual(false); expect(resp.statusCode).toEqual(StatusCode.ServiceUnavailable); expect(resp.body).toEqual('{ "status": "working" }'); expect(tried).toEqual(3); expect(sleepUtils.sleep).toHaveBeenCalledTimes(2); }); it('retries can have a custom override', async () => { let slept = 0; const overWait = (wait: IWait): Promise => { slept = wait.attempt; return Promise.resolve({ response: 'retry', reason: 'just a test' }); }; const xp = new BrowserTransport({ maxTries: 3, waitHandler: overWait, } as ITransportSettings); const resp = await xp.rawRequest('GET', retryFoo); expect(resp.ok).toEqual(false); expect(resp.statusCode).toEqual(StatusCode.ServiceUnavailable); expect(resp.body).toEqual('{ "status": "working" }'); expect(tried).toEqual(3); expect(slept).toEqual(2); }); it('retries can cancelled', async () => { let slept = 0; const reason = "I'm outta here!"; const overWait = (wait: IWait): Promise => { slept = wait.attempt; return Promise.resolve({ response: 'cancel', reason }); }; const xp = new BrowserTransport({ maxTries: 3, waitHandler: overWait, } as ITransportSettings); const resp = await xp.rawRequest('GET', retryFoo); expect(resp.statusCode).toEqual(StatusCode.Accepted); expect(resp.ok).toEqual(true); expect(resp.statusMessage).toEqual(reason); expect(resp.body).toEqual('{ "status": "working" }'); expect(tried).toEqual(1); expect(slept).toEqual(1); }); it('retries can error out', async () => { let slept = 0; const reason = 'This is an error'; const overWait = (wait: IWait): Promise => { slept = wait.attempt; return Promise.resolve({ response: 'error', reason }); }; const xp = new BrowserTransport({ maxTries: 3, waitHandler: overWait, } as ITransportSettings); const resp = await xp.rawRequest('GET', retryFoo); expect(resp.statusCode).toEqual(StatusCode.RequestTimeout); expect(resp.ok).toEqual(false); expect(resp.statusMessage).toEqual(reason); expect(resp.body).toEqual('{ "status": "working" }'); expect(tried).toEqual(1); expect(slept).toEqual(1); }); it('just deserializes JSON into an object', async () => { const xp = new BrowserTransport({} as ITransportSettings); interface ITestModel { string1: string; num1: number; string2: string; num2: number; string3: string; num3: number; } const resp: IRawResponse = { headers: {}, url: '', ok: true, contentType: 'application/json', statusCode: 200, statusMessage: 'mock', method: 'GET', body: ` { "string1": 1, "num1": 1, "string2": "2", "num2": "2", "string3": "3", "num3": 3, "string4": "4", "num4": 4 } `, requestStarted: 1000, responseCompleted: 2000, }; const untyped: any = await sdkOk(xp.parseResponse(resp)); expect(untyped.string1).toBe(1); expect(untyped.num1).toBe(1); expect(untyped.string2).toBe('2'); expect(untyped.num2).toBe('2'); expect(untyped.string3).toBe('3'); expect(untyped.num3).toBe(3); expect(untyped.string4).toBe('4'); expect(untyped.num4).toBe(4); const typed = await sdkOk(xp.parseResponse(resp)); expect(typed.string1).toBe(1); expect(typed.num1).toBe(1); expect(typed.string2).toBe('2'); expect(typed.num2).toBe('2'); expect(typed.string3).toBe('3'); expect(typed.num3).toBe(3); expect((typed as any).string4).toBe('4'); expect((typed as any).num4).toBe(4); }); });