| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* eslint-env commonjs, browser */
- import Token from '../../src/token/token';
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- describe( 'Token', () => {
- let requests;
- beforeEach( () => {
- requests = [];
- const xhr = sinon.useFakeXMLHttpRequest();
- xhr.onCreate = request => {
- requests.push( request );
- };
- } );
- afterEach( () => {
- sinon.restore();
- } );
- describe( 'constructor()', () => {
- it( 'should throw an error when no tokenUrl provided', () => {
- expect( () => new Token() ).to.throw(
- CKEditorError,
- 'token-missing-token-url'
- );
- } );
- it( 'should throw an error if the token passed in options is not a string', () => {
- expect( () => new Token( 'http://token-endpoint', { initValue: 123456 } ) ).to.throw(
- CKEditorError,
- 'token-not-in-jwt-format'
- );
- } );
- it( 'should throw an error if the token passed in options is wrapped in additional quotes', () => {
- const tokenInitValue = getTestTokenValue();
- expect( () => new Token( 'http://token-endpoint', { initValue: `"${ tokenInitValue }"` } ) ).to.throw(
- CKEditorError,
- 'token-not-in-jwt-format'
- );
- } );
- it( 'should throw an error if the token passed in options is not a valid JWT token', () => {
- expect( () => new Token( 'http://token-endpoint', { initValue: 'token' } ) ).to.throw(
- CKEditorError,
- 'token-not-in-jwt-format'
- );
- } );
- it( 'should set token value if the token passed in options is valid', () => {
- const tokenInitValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { initValue: tokenInitValue } );
- expect( token.value ).to.equal( tokenInitValue );
- } );
- it( 'should fire `change:value` event if the value of the token has changed', done => {
- const tokenValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { autoRefresh: false } );
- token.on( 'change:value', ( event, name, newValue ) => {
- expect( newValue ).to.equal( tokenValue );
- done();
- } );
- token.init();
- requests[ 0 ].respond( 200, '', tokenValue );
- } );
- it( 'should accept the callback in the constructor', () => {
- expect( () => {
- // eslint-disable-next-line
- const token = new Token( () => Promise.resolve( 'token' ) );
- } ).to.not.throw();
- } );
- } );
- describe( 'init()', () => {
- it( 'should get a token value from the endpoint', done => {
- const tokenValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { autoRefresh: false } );
- token.init()
- .then( () => {
- expect( token.value ).to.equal( tokenValue );
- done();
- } );
- requests[ 0 ].respond( 200, '', tokenValue );
- } );
- it( 'should get a token from the refreshToken function when is provided', () => {
- const tokenValue = getTestTokenValue();
- const token = new Token( () => Promise.resolve( tokenValue ), { autoRefresh: false } );
- return token.init()
- .then( () => {
- expect( token.value ).to.equal( tokenValue );
- } );
- } );
- it( 'should not refresh token if autoRefresh is disabled in options', async () => {
- const clock = sinon.useFakeTimers( { toFake: [ 'setTimeout' ] } );
- const tokenInitValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { initValue: tokenInitValue, autoRefresh: false } );
- await token.init();
- await clock.tickAsync( 3600000 );
- expect( requests ).to.be.empty;
- clock.restore();
- } );
- it( 'should refresh token with the time specified in token `exp` payload property', async () => {
- const clock = sinon.useFakeTimers( { toFake: [ 'setTimeout' ] } );
- const tokenInitValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { initValue: tokenInitValue } );
- await token.init();
- await clock.tickAsync( 1800000 );
- requests[ 0 ].respond( 200, '', getTestTokenValue( 1500 ) );
- await clock.tickAsync( 750000 );
- requests[ 1 ].respond( 200, '', getTestTokenValue( 900 ) );
- await clock.tickAsync( 450000 );
- requests[ 2 ].respond( 200, '', getTestTokenValue( 450 ) );
- await clock.tickAsync( 225000 );
- requests[ 3 ].respond( 200, '', getTestTokenValue( 20 ) );
- await clock.tickAsync( 10000 );
- requests[ 4 ].respond( 200, '', getTestTokenValue( 20 ) );
- expect( requests.length ).to.equal( 5 );
- clock.restore();
- } );
- it( 'should refresh the token with the default time if getting token expiration time failed', async () => {
- const clock = sinon.useFakeTimers( { toFake: [ 'setTimeout' ] } );
- const tokenValue = 'header.test.signature';
- const token = new Token( 'http://token-endpoint', { initValue: tokenValue } );
- await token.init();
- await clock.tickAsync( 3600000 );
- requests[ 0 ].respond( 200, '', tokenValue );
- await clock.tickAsync( 3600000 );
- requests[ 1 ].respond( 200, '', tokenValue );
- expect( requests.length ).to.equal( 2 );
- clock.restore();
- } );
- it( 'should refresh the token with the default time if the token payload does not contain `exp` property', async () => {
- const clock = sinon.useFakeTimers( { toFake: [ 'setTimeout' ] } );
- const tokenValue = `header.${ btoa( JSON.stringify( {} ) ) }.signature`;
- const token = new Token( 'http://token-endpoint', { initValue: tokenValue } );
- await token.init();
- await clock.tickAsync( 3600000 );
- requests[ 0 ].respond( 200, '', tokenValue );
- await clock.tickAsync( 3600000 );
- requests[ 1 ].respond( 200, '', tokenValue );
- await clock.tickAsync( 3600000 );
- requests[ 2 ].respond( 200, '', tokenValue );
- expect( requests.length ).to.equal( 3 );
- clock.restore();
- } );
- } );
- describe( 'destroy', () => {
- it( 'should stop refreshing the token', async () => {
- const clock = sinon.useFakeTimers( { toFake: [ 'setTimeout', 'clearTimeout' ] } );
- const tokenInitValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { initValue: tokenInitValue } );
- await token.init();
- await clock.tickAsync( 1800000 );
- requests[ 0 ].respond( 200, '', getTestTokenValue( 1500 ) );
- await clock.tickAsync( 100 );
- await clock.tickAsync( 750000 );
- requests[ 1 ].respond( 200, '', getTestTokenValue( 900 ) );
- await clock.tickAsync( 100 );
- token.destroy();
- await clock.tickAsync( 3600000 );
- await clock.tickAsync( 3600000 );
- await clock.tickAsync( 3600000 );
- expect( requests.length ).to.equal( 2 );
- clock.restore();
- } );
- } );
- describe( 'refreshToken()', () => {
- it( 'should get a token from the specified address', done => {
- const tokenValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { autoRefresh: false } );
- token.refreshToken()
- .then( newToken => {
- expect( newToken.value ).to.equal( tokenValue );
- done();
- } );
- requests[ 0 ].respond( 200, '', tokenValue );
- } );
- it( 'should throw an error if the returned token is wrapped in additional quotes', done => {
- const tokenValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { autoRefresh: false } );
- token.refreshToken()
- .then( () => {
- done( new Error( 'Promise should be rejected' ) );
- } )
- .catch( error => {
- expect( error.constructor ).to.equal( CKEditorError );
- expect( error ).to.match( /token-not-in-jwt-format/ );
- done();
- } );
- requests[ 0 ].respond( 200, '', `"${ tokenValue }"` );
- } );
- it( 'should throw an error if the returned token is not a valid JWT token', done => {
- const token = new Token( 'http://token-endpoint', { autoRefresh: false } );
- token.refreshToken()
- .then( () => {
- done( new Error( 'Promise should be rejected' ) );
- } )
- .catch( error => {
- expect( error.constructor ).to.equal( CKEditorError );
- expect( error ).to.match( /token-not-in-jwt-format/ );
- done();
- } );
- requests[ 0 ].respond( 200, '', 'token' );
- } );
- it( 'should get a token from the specified callback function', () => {
- const tokenValue = getTestTokenValue();
- const token = new Token( () => Promise.resolve( tokenValue ), { autoRefresh: false } );
- return token.refreshToken()
- .then( newToken => {
- expect( newToken.value ).to.equal( tokenValue );
- } );
- } );
- it( 'should throw an error when cannot download a new token', () => {
- const tokenInitValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { initValue: tokenInitValue, autoRefresh: false } );
- const promise = token._refresh();
- requests[ 0 ].respond( 401 );
- return promise.then( () => {
- throw new Error( 'Promise should be rejected' );
- }, error => {
- expect( error.constructor ).to.equal( CKEditorError );
- expect( error ).to.match( /token-cannot-download-new-token/ );
- } );
- } );
- it( 'should throw an error when the response is aborted', () => {
- const tokenInitValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { initValue: tokenInitValue, autoRefresh: false } );
- const promise = token._refresh();
- requests[ 0 ].abort();
- return promise.then( () => {
- throw new Error( 'Promise should be rejected' );
- }, error => {
- expect( error ).to.match( /Abort/ );
- } );
- } );
- it( 'should throw an error when network error occurs', () => {
- const tokenInitValue = getTestTokenValue();
- const token = new Token( 'http://token-endpoint', { initValue: tokenInitValue, autoRefresh: false } );
- const promise = token._refresh();
- requests[ 0 ].error();
- return promise.then( () => {
- throw new Error( 'Promise should be rejected' );
- }, error => {
- expect( error ).to.match( /Network Error/ );
- } );
- } );
- it( 'should throw an error when the callback throws an error', () => {
- const tokenInitValue = getTestTokenValue();
- const token = new Token( () => Promise.reject( 'Custom error occurred' ), { initValue: tokenInitValue, autoRefresh: false } );
- token.refreshToken()
- .catch( error => {
- expect( error ).to.equal( 'Custom error occurred' );
- } );
- } );
- } );
- describe( 'static create()', () => {
- it( 'should return an initialized token', done => {
- const tokenValue = getTestTokenValue();
- Token.create( 'http://token-endpoint', { autoRefresh: false } )
- .then( token => {
- expect( token.value ).to.equal( tokenValue );
- done();
- } );
- requests[ 0 ].respond( 200, '', tokenValue );
- } );
- it( 'should use default options when none passed', done => {
- const tokenValue = getTestTokenValue();
- Token.create( 'http://token-endpoint' )
- .then( token => {
- expect( token._options ).to.eql( { autoRefresh: true } );
- done();
- } );
- requests[ 0 ].respond( 200, '', tokenValue );
- } );
- } );
- } );
- // Returns valid token for tests with given expiration time offset.
- //
- // @param {Number} [timeOffset=3600000]
- // @returns {String}
- function getTestTokenValue( timeOffset = 3600 ) {
- return `header.${ btoa( JSON.stringify( { exp: ( Math.floor( Date.now() / 1000 ) ) + timeOffset } ) ) }.signature`;
- }
|