-
Notifications
You must be signed in to change notification settings - Fork 268
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: remove headers with undefined value (#468)
* fix: remove headers with undefined value
- Loading branch information
1 parent
e49f969
commit cd2c14c
Showing
7 changed files
with
295 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,280 @@ | ||
| /* global USER_AGENT */ | ||
| jest.mock('cross-fetch'); | ||
|
|
||
| import http from '../../lib/http'; | ||
| import { OktaAuth, DEFAULT_CACHE_DURATION, AuthApiError, STATE_TOKEN_KEY_NAME } from '@okta/okta-auth-js'; | ||
|
|
||
| describe('HTTP Requestor', () => { | ||
| let sdk; | ||
| let httpRequestClient; | ||
| let url; | ||
| let response1; | ||
| let response2; | ||
|
|
||
| beforeEach(() => { | ||
| url = 'http://my-fake-url'; | ||
| response1 = 'my fake response 1'; | ||
| response2 = 'my fake response 2'; | ||
| }); | ||
| afterEach(() => { | ||
| sdk = null; | ||
| httpRequestClient = null; | ||
| }); | ||
| function createAuthClient(options) { | ||
| httpRequestClient = httpRequestClient || jest.fn().mockReturnValue(Promise.resolve({ | ||
| responseText: JSON.stringify(response1) | ||
| })); | ||
| sdk = new OktaAuth(Object.assign({ | ||
| issuer: 'http://my-okta-domain', | ||
| pkce: false, | ||
| httpRequestClient, | ||
| tokenManager: { autoRenew: false } | ||
| }, options)); | ||
| } | ||
| describe('withCredentials', () => { | ||
| it('can be disabled', () => { | ||
| createAuthClient(); | ||
| return http.httpRequest(sdk, { url, withCredentials: false }) | ||
| .then(res => { | ||
| expect(res).toBe(response1); | ||
| expect(httpRequestClient).toHaveBeenCalledWith(undefined, url, { | ||
| data: undefined, | ||
| headers: { | ||
| 'Accept': 'application/json', | ||
| 'Content-Type': 'application/json', | ||
| 'X-Okta-User-Agent-Extended': USER_AGENT | ||
| }, | ||
| withCredentials: false | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
| describe('headers', () => { | ||
| it('sets defaults', () => { | ||
| createAuthClient(); | ||
| return http.httpRequest(sdk, { url }) | ||
| .then(res => { | ||
| expect(res).toBe(response1); | ||
| expect(httpRequestClient).toHaveBeenCalledWith(undefined, url, { | ||
| data: undefined, | ||
| headers: { | ||
| 'Accept': 'application/json', | ||
| 'Content-Type': 'application/json', | ||
| 'X-Okta-User-Agent-Extended': USER_AGENT | ||
| }, | ||
| withCredentials: true | ||
| }); | ||
| }); | ||
| }); | ||
| it('accepts headers on sdk instance', () => { | ||
| createAuthClient({ | ||
| headers: { | ||
| 'fake': 'value' | ||
| } | ||
| }); | ||
| return http.httpRequest(sdk, { url }) | ||
| .then(res => { | ||
| expect(res).toBe(response1); | ||
| expect(httpRequestClient).toHaveBeenCalledWith(undefined, url, { | ||
| data: undefined, | ||
| headers: { | ||
| 'Accept': 'application/json', | ||
| 'Content-Type': 'application/json', | ||
| 'X-Okta-User-Agent-Extended': USER_AGENT, | ||
| 'fake': 'value' | ||
| }, | ||
| withCredentials: true | ||
| }); | ||
| }); | ||
| }); | ||
| it('accepts headers on httpRequest', () => { | ||
| createAuthClient(); | ||
| return http.httpRequest(sdk, { | ||
| url, | ||
| headers: { | ||
| 'fake': 'value' | ||
| } | ||
| }) | ||
| .then(res => { | ||
| expect(res).toBe(response1); | ||
| expect(httpRequestClient).toHaveBeenCalledWith(undefined, url, { | ||
| data: undefined, | ||
| headers: { | ||
| 'Accept': 'application/json', | ||
| 'Content-Type': 'application/json', | ||
| 'X-Okta-User-Agent-Extended': USER_AGENT, | ||
| 'fake': 'value' | ||
| }, | ||
| withCredentials: true | ||
| }); | ||
| }); | ||
| }); | ||
| it('removes headers with undefined value', () => { | ||
| createAuthClient(); | ||
| return http.httpRequest(sdk, { | ||
| url, | ||
| headers: { | ||
| 'fake': undefined | ||
| } | ||
| }) | ||
| .then(res => { | ||
| expect(res).toBe(response1); | ||
| expect(httpRequestClient).toHaveBeenCalledWith(undefined, url, { | ||
| data: undefined, | ||
| headers: { | ||
| 'Accept': 'application/json', | ||
| 'Content-Type': 'application/json', | ||
| 'X-Okta-User-Agent-Extended': USER_AGENT | ||
| }, | ||
| withCredentials: true | ||
| }); | ||
| }); | ||
| }); | ||
| it('can set an Authorization header using accessToken', () => { | ||
| createAuthClient(); | ||
| return http.httpRequest(sdk, { | ||
| url, | ||
| accessToken: 'fake' | ||
| }) | ||
| .then(res => { | ||
| expect(res).toBe(response1); | ||
| expect(httpRequestClient).toHaveBeenCalledWith(undefined, url, { | ||
| data: undefined, | ||
| headers: { | ||
| 'Accept': 'application/json', | ||
| 'Content-Type': 'application/json', | ||
| 'X-Okta-User-Agent-Extended': USER_AGENT, | ||
| 'Authorization': 'Bearer fake' | ||
| }, | ||
| withCredentials: true | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
| describe('cacheResponse', () => { | ||
| let storageUtil; | ||
| let httpCache; | ||
| beforeEach(() => { | ||
| createAuthClient(); | ||
| storageUtil = sdk.options.storageUtil; | ||
| httpCache = storageUtil.getHttpCache(sdk.options.cookies); | ||
| jest.spyOn(storageUtil, 'getHttpCache').mockReturnValue(httpCache); // force same object on each call | ||
| }); | ||
| afterEach(() => { | ||
| httpCache.clearStorage(); | ||
| }); | ||
| it('can return a cached response', () => { | ||
| httpCache.updateStorage(url, { | ||
| expiresAt: Math.floor(Date.now()/1000) + DEFAULT_CACHE_DURATION, | ||
| response: response2 | ||
| }); | ||
| return http.httpRequest(sdk, { url, cacheResponse: true }) | ||
| .then(res => { | ||
| expect(res).toBe(response2); | ||
| expect(httpRequestClient).not.toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
| it('will update cache', () => { | ||
| jest.spyOn(httpCache, 'updateStorage'); | ||
| jest.spyOn(Date, 'now').mockReturnValue(1000); | ||
| return http.httpRequest(sdk, { url, cacheResponse: true, method: 'GET' }) | ||
| .then(res => { | ||
| expect(res).toBe(response1); | ||
| expect(httpRequestClient).toHaveBeenCalledWith('GET', url, expect.any(Object)); | ||
| expect(httpCache.updateStorage).toHaveBeenCalledWith(url, { | ||
| expiresAt: 1 + DEFAULT_CACHE_DURATION, | ||
| response: response1 | ||
| }); | ||
| }); | ||
| }); | ||
| it('cache can be disabled', () => { | ||
| jest.spyOn(httpCache, 'updateStorage'); | ||
| httpCache.updateStorage(url, { | ||
| expiresAt: Math.floor(Date.now()/1000) + DEFAULT_CACHE_DURATION, | ||
| response: response2 | ||
| }); | ||
| httpCache.updateStorage.mockClear(); | ||
| return http.httpRequest(sdk, { url, cacheResponse: false, method: 'GET' }) | ||
| .then(res => { | ||
| expect(res).toBe(response1); | ||
| expect(httpRequestClient).toHaveBeenCalledWith('GET', url, expect.any(Object)); | ||
| expect(httpCache.updateStorage).not.toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
| }); | ||
| describe('error handling', () => { | ||
| function initWithErrorResponse(response) { | ||
| httpRequestClient = jest.fn().mockReturnValue(Promise.reject(response)); | ||
| } | ||
| it('handles string errors', () => { | ||
| const response = { responseText: 'fake error', status: 404 }; | ||
| initWithErrorResponse(response); | ||
| createAuthClient(); | ||
| return http.httpRequest(sdk, { url }) | ||
| .catch(err => { | ||
| expect(err).toBeInstanceOf(AuthApiError); | ||
| expect(err.errorSummary).toBe('Unknown error'); | ||
| expect(err.xhr).toEqual(response); | ||
| }); | ||
| }); | ||
| it('handles JSON errors', () => { | ||
| const json = { errorSummary: 'fake error' }; | ||
| const response = { responseText: JSON.stringify(json), status: 404 }; | ||
| initWithErrorResponse(response); | ||
| createAuthClient(); | ||
| return http.httpRequest(sdk, { url }) | ||
| .catch(err => { | ||
| expect(err).toBeInstanceOf(AuthApiError); | ||
| expect(err.xhr).toEqual(response); | ||
| expect(err.errorSummary).toBe('fake error'); | ||
| }); | ||
| }); | ||
| it('sets errorSummary to "Unknown error" on 50x errors', () => { | ||
| const json = { errorSummary: '501 error' }; | ||
| const response = { responseText: JSON.stringify(json), status: 501 }; | ||
| initWithErrorResponse(response); | ||
| createAuthClient(); | ||
| return http.httpRequest(sdk, { url }) | ||
| .catch(err => { | ||
| expect(err).toBeInstanceOf(AuthApiError); | ||
| expect(err.xhr).toEqual(response); | ||
| expect(err.errorSummary).toBe('Unknown error'); | ||
| }); | ||
| }); | ||
| it('can transform the error XHR with "transformErrorXHR" option', () => { | ||
| const json = { errorCode: 'original error' }; | ||
| const response = { responseText: JSON.stringify(json), status: 501 }; | ||
| initWithErrorResponse(response); | ||
| const transformErrorXHR = jest.fn().mockImplementation(xhr => { | ||
| xhr.status = 404; | ||
| return xhr; | ||
| }); | ||
| createAuthClient({ | ||
| transformErrorXHR | ||
| }); | ||
| return http.httpRequest(sdk, { url }) | ||
| .catch(err => { | ||
| expect(err).toBeInstanceOf(AuthApiError); | ||
| expect(err.xhr).toEqual({ | ||
| responseText: '{"errorCode":"original error"}', | ||
| status: 404 | ||
| }); | ||
| expect(err.errorCode).toBe('original error'); | ||
| }); | ||
| }); | ||
| it('will delete state token if receives error "E0000011"', () => { | ||
| const json = { errorCode: 'E0000011' }; | ||
| const response = { responseText: JSON.stringify(json), status: 403 }; | ||
| initWithErrorResponse(response); | ||
| createAuthClient(); | ||
| const storage = sdk.options.storageUtil.storage; | ||
| jest.spyOn(storage, 'delete'); | ||
| return http.httpRequest(sdk, { url }) | ||
| .catch(err => { | ||
| expect(err).toBeInstanceOf(AuthApiError); | ||
| expect(err.xhr).toEqual(response); | ||
| expect(storage.delete).toHaveBeenCalledWith(STATE_TOKEN_KEY_NAME); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |