Skip to content

Commit 6640aa2

Browse files
uttamukkojiuttamukkoji
authored
Merge pull request #31 from contentstack/feature/refresh-token
Token refresh support added
2 parents 5aa09c8 + 6a253d2 commit 6640aa2

File tree

11 files changed

+166
-40
lines changed

11 files changed

+166
-40
lines changed

‎lib/contentstack.js

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,38 @@ import httpClient from './core/contentstackHTTPClient.js'
119119
console.log(`[${level}] ${data}`)
120120
} })
121121
*
122+
* @prop {function=} params.refreshToken - Optional function used to refresh token.
123+
* @example // OAuth example
124+
* import * as contentstack from '@contentstack/management'
125+
* const client = contentstack.client({
126+
refreshToken: () => {
127+
return new Promise((resolve, reject) => {
128+
return issueToken().then((res) => {
129+
resolve({
130+
authorization: res.authorization
131+
})
132+
}).catch((error) => {
133+
reject(error)
134+
})
135+
})
136+
}
137+
})
138+
* @example // Auth Token example
139+
* import * as contentstack from '@contentstack/management'
140+
* const client = contentstack.client({
141+
refreshToken: () => {
142+
return new Promise((resolve, reject) => {
143+
return issueToken().then((res) => {
144+
resolve({
145+
authtoken: res.authtoken
146+
})
147+
}).catch((error) => {
148+
reject(error)
149+
})
150+
})
151+
}
152+
})
153+
*
122154
* @prop {string=} params.application - Application name and version e.g myApp/version
123155
* @prop {string=} params.integration - Integration name and version e.g react/version
124156
* @returns Contentstack.Client

‎lib/core/concurrency-queue.js

Lines changed: 51 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,22 @@ export function ConcurrencyQueue ({ axios, config }) {
7070
}
7171

7272
// Request interceptor to queue the request
73-
const requestHandler = request => {
73+
const requestHandler = (request) => {
7474
if (typeof request.data === 'function') {
7575
request.formdata = request.data
7676
request.data = transformFormData(request)
7777
}
7878
request.retryCount = request.retryCount || 0
7979
if (request.headers.authorization && request.headers.authorization !== undefined) {
80+
if (this.config.authorization && this.config.authorization !== undefined) {
81+
request.headers.authorization = this.config.authorization
82+
request.authorization = this.config.authorization
83+
}
8084
delete request.headers.authtoken
85+
} else if (request.headers.authtoken && request.headers.authtoken !== undefined && this.config.authtoken && this.config.authtoken !== undefined) {
86+
request.headers.authtoken = this.config.authtoken
87+
request.authtoken = this.config.authtoken
8188
}
82-
8389
if (request.cancelToken === undefined) {
8490
const source = Axios.CancelToken.source()
8591
request.cancelToken = source.token
@@ -102,26 +108,62 @@ export function ConcurrencyQueue ({ axios, config }) {
102108
})
103109
}
104110

105-
const delay = (time) => {
111+
const delay = (time, isRefreshToken = false) => {
106112
if (!this.paused) {
107113
this.paused = true
108114
// Check for current running request.
109115
// Wait for running queue to complete.
110116
// Wait and prosed the Queued request.
111117
if (this.running.length > 0) {
112118
setTimeout(() => {
113-
delay(time)
119+
delay(time, isRefreshToken)
114120
}, time)
115121
}
116122
return new Promise(resolve => setTimeout(() => {
117123
this.paused = false
118-
for (let i = 0; i < this.config.maxRequests; i++) {
119-
this.initialShift()
124+
if (isRefreshToken) {
125+
return refreshToken()
126+
} else {
127+
for (let i = 0; i < this.config.maxRequests; i++) {
128+
this.initialShift()
129+
}
120130
}
121131
}, time))
122132
}
123133
}
124-
134+
const refreshToken = () => {
135+
return config.refreshToken().then((token) => {
136+
if (token.authorization) {
137+
axios.defaults.headers.authorization = token.authorization
138+
axios.defaults.authorization = token.authorization
139+
axios.httpClientParams.authorization = token.authorization
140+
axios.httpClientParams.headers.authorization = token.authorization
141+
this.config.authorization = token.authorization
142+
} else if (token.authtoken) {
143+
axios.defaults.headers.authtoken = token.authtoken
144+
axios.defaults.authtoken = token.authtoken
145+
axios.httpClientParams.authtoken = token.authtoken
146+
axios.httpClientParams.headers.authtoken = token.authtoken
147+
this.config.authtoken = token.authtoken
148+
}
149+
}).catch((error) => {
150+
throw error
151+
}).finally(() => {
152+
this.queue.forEach((queueItem) => {
153+
if (this.config.authorization) {
154+
queueItem.request.headers.authorization = this.config.authorization
155+
queueItem.request.authorization = this.config.authorization
156+
}
157+
if (this.config.authtoken) {
158+
queueItem.request.headers.authtoken = this.config.authtoken
159+
queueItem.request.authtoken = this.config.authtoken
160+
}
161+
})
162+
for (let i = 0; i < this.config.maxRequests; i++) {
163+
this.initialShift()
164+
}
165+
})
166+
}
125167
// Response interceptor used for
126168
const responseHandler = (response) => {
127169
response.config.onComplete()
@@ -150,7 +192,7 @@ export function ConcurrencyQueue ({ axios, config }) {
150192
} else {
151193
return Promise.reject(responseHandler(error))
152194
}
153-
} else if (response.status === 429) {
195+
} else if (response.status === 429 || (response.status === 401 && this.config.refreshToken)) {
154196
retryErrorType = `Error with status: ${response.status}`
155197
networkError++
156198

@@ -159,7 +201,7 @@ export function ConcurrencyQueue ({ axios, config }) {
159201
}
160202
this.running.shift()
161203
// Cool down the running requests
162-
delay(wait)
204+
delay(wait, response.status === 401)
163205
error.config.retryCount = networkError
164206

165207
return axios(updateRequestConfig(error, retryErrorType, wait))

‎lib/organization/index.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,9 +203,8 @@ export function Organization (http, data) {
203203
}
204204
}
205205
}
206-
207206
/**
208-
* @description
207+
* @description Market place application information
209208
* @memberof Organization
210209
* @func app
211210
* @param {String} uid: App uid.

‎package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@contentstack/management",
3-
"version": "1.5.0",
3+
"version": "1.6.0",
44
"description": "The Content Management API is used to manage the content of your Contentstack account",
55
"main": "./dist/node/contentstack-management.js",
66
"browser": "./dist/web/contentstack-management.js",

‎test/unit/ContentstackHTTPClient-test.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ describe('Contentstack HTTP Client', () => {
1818
expect(logHandlerStub.callCount).to.be.equal(0)
1919
expect(axiosInstance.defaults.headers.apiKey).to.be.equal('apiKey', 'Api not Equal to \'apiKey\'')
2020
expect(axiosInstance.defaults.headers.accessToken).to.be.equal('accessToken', 'Api not Equal to \'accessToken\'')
21-
expect(axiosInstance.defaults.baseURL).to.be.equal('https://defaulthost:443/v3', 'Api not Equal to \'https://defaulthost:443/v3\'')
21+
expect(axiosInstance.defaults.baseURL).to.be.equal('https://defaulthost:443/{api-version}', 'Api not Equal to \'https://defaulthost:443/v3\'')
2222
done()
2323
})
2424

@@ -32,7 +32,7 @@ describe('Contentstack HTTP Client', () => {
3232
})
3333
expect(axiosInstance.defaults.headers.apiKey).to.be.equal('apiKey', 'Api not Equal to \'apiKey\'')
3434
expect(axiosInstance.defaults.headers.accessToken).to.be.equal('accessToken', 'Api not Equal to \'accessToken\'')
35-
expect(axiosInstance.defaults.baseURL).to.be.equal('https://contentstack.com:443/v3', 'Api not Equal to \'https://defaulthost:443/v3\'')
35+
expect(axiosInstance.defaults.baseURL).to.be.equal('https://contentstack.com:443/{api-version}', 'Api not Equal to \'https://defaulthost:443/v3\'')
3636
done()
3737
})
3838

@@ -47,7 +47,7 @@ describe('Contentstack HTTP Client', () => {
4747

4848
expect(axiosInstance.defaults.headers.apiKey).to.be.equal('apiKey', 'Api not Equal to \'apiKey\'')
4949
expect(axiosInstance.defaults.headers.accessToken).to.be.equal('accessToken', 'Api not Equal to \'accessToken\'')
50-
expect(axiosInstance.defaults.baseURL).to.be.equal('https://contentstack.com:443/v3', 'Api not Equal to \'https://contentstack.com:443/v3\'')
50+
expect(axiosInstance.defaults.baseURL).to.be.equal('https://contentstack.com:443/{api-version}', 'Api not Equal to \'https://contentstack.com:443/v3\'')
5151
done()
5252
})
5353

@@ -63,7 +63,7 @@ describe('Contentstack HTTP Client', () => {
6363

6464
expect(axiosInstance.defaults.headers.apiKey).to.be.equal('apiKey', 'Api not Equal to \'apiKey\'')
6565
expect(axiosInstance.defaults.headers.accessToken).to.be.equal('accessToken', 'Api not Equal to \'accessToken\'')
66-
expect(axiosInstance.defaults.baseURL).to.be.equal('https://contentstack.com:443/stack/v3', 'Api not Equal to \'https://contentstack.com:443/stack/v3\'')
66+
expect(axiosInstance.defaults.baseURL).to.be.equal('https://contentstack.com:443/stack/{api-version}', 'Api not Equal to \'https://contentstack.com:443/stack/v3\'')
6767
done()
6868
})
6969
it('Contentstack Http Client blank API key', done => {

‎test/unit/apps-test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ describe('Contentstack apps test', () => {
1717
expect(app.fetchOAuth).to.be.equal(undefined)
1818
expect(app.updateOAuth).to.be.equal(undefined)
1919
expect(app.install).to.be.equal(undefined)
20-
expect(app.installation).to.not.equal(undefined)
20+
expect(app.installation).to.be.equal(undefined)
2121
done()
2222
})
2323

‎test/unit/concurrency-Queue-test.js

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import FormData from 'form-data'
99
import { createReadStream } from 'fs'
1010
import path from 'path'
1111
import multiparty from 'multiparty'
12+
import { client } from '../../lib/contentstack'
1213
const axios = Axios.create()
1314

1415
let server
@@ -60,10 +61,24 @@ const reconfigureQueue = (options = {}) => {
6061
concurrencyQueue = new ConcurrencyQueue({ axios: api, config })
6162
}
6263
var returnContent = false
64+
var unauthorized = false
65+
var token = 'Bearer <token_value_new>'
6366
describe('Concurrency queue test', () => {
6467
before(() => {
6568
server = http.createServer((req, res) => {
66-
if (req.url === '/timeout') {
69+
if (req.url === '/user-session') {
70+
res.writeHead(200, { 'Content-Type': 'application/json' })
71+
res.end(JSON.stringify({ token }))
72+
} else if (req.url === '/unauthorized') {
73+
if (req.headers.authorization === token) {
74+
res.writeHead(200, { 'Content-Type': 'application/json' })
75+
res.end(JSON.stringify({ randomInteger: 123 }))
76+
} else {
77+
res.writeHead(401, { 'Content-Type': 'application/json' })
78+
res.end(JSON.stringify({ errorCode: 401 }))
79+
}
80+
unauthorized = !unauthorized
81+
} else if (req.url === '/timeout') {
6782
setTimeout(function () {
6883
res.writeHead(400, { 'Content-Type': 'application/json' })
6984
res.end()
@@ -111,6 +126,39 @@ describe('Concurrency queue test', () => {
111126
}
112127
})
113128

129+
it('Refresh Token on 401 with 1000 concurrent request', done => {
130+
const axios2 = client({
131+
baseURL: `${host}:${port}`
132+
})
133+
const axios = client({
134+
baseURL: `${host}:${port}`,
135+
authorization: 'Bearer <token_value>',
136+
logHandler: logHandlerStub,
137+
refreshToken: () => {
138+
return new Promise((resolve, reject) => {
139+
return axios2.login().then((res) => {
140+
resolve({ authorization: res.token })
141+
}).catch((error) => {
142+
reject(error)
143+
})
144+
})
145+
}
146+
})
147+
Promise.all(sequence(1003).map(() => axios.axiosInstance.get('/unauthorized')))
148+
.then((responses) => {
149+
return responses.map(r => r.config.headers.authorization)
150+
})
151+
.then(objects => {
152+
objects.forEach((authorization) => {
153+
expect(authorization).to.be.equal(token)
154+
})
155+
expect(logHandlerStub.callCount).to.be.equal(5)
156+
expect(objects.length).to.be.equal(1003)
157+
done()
158+
})
159+
.catch(done)
160+
})
161+
114162
it('Initialize with bad axios instance', done => {
115163
try {
116164
new ConcurrencyQueue({ axios: undefined })

‎test/unit/entry-test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ describe('Contentstack Entry test', () => {
293293
it('Entry set Workflow stage test', done => {
294294
var mock = new MockAdapter(Axios);
295295

296-
mock.post('/content_types/content_type_uid/entries/UID/workflow').reply(200, {
296+
mock.onPost('/content_types/content_type_uid/entries/UID/workflow').reply(200, {
297297
...noticeMock
298298
})
299299

‎test/unit/stack-test.js

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -844,23 +844,23 @@ describe('Contentstack Stack test', () => {
844844
})
845845
.catch(done)
846846
})
847-
it('Update users roles in Stack test', done => {
848-
const mock = new MockAdapter(Axios)
849-
mock.onGet('/stacks').reply(200, {
850-
notice: "The roles were applied successfully.",
851-
})
852-
makeStack({
853-
stack: {
854-
api_key: 'stack_api_key'
855-
}
856-
})
857-
.updateUsersRoles({ user_id: ['role1', 'role2']})
858-
.then((response) => {
859-
expect(response.notice).to.be.equal(noticeMock.notice)
860-
done()
861-
})
862-
.catch(done)
863-
})
847+
// it('Update users roles in Stack test', done => {
848+
// const mock = new MockAdapter(Axios)
849+
// mock.onGet('/stacks').reply(200, {
850+
// notice: "The roles were applied successfully.",
851+
// })
852+
// makeStack({
853+
// stack: {
854+
// api_key: 'stack_api_key'
855+
// }
856+
// })
857+
// .updateUsersRoles({ user_id: ['role1', 'role2']})
858+
// .then((response) => {
859+
// expect(response.notice).to.be.equal(noticeMock.notice)
860+
// done()
861+
// })
862+
// .catch(done)
863+
// })
864864

865865

866866
it('Stack transfer ownership test', done => {

‎types/contentstackClient.d.ts

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,15 @@ export interface ProxyConfig {
1818
}
1919
export interface RetryDelayOption {
2020
base?: number
21-
customBackoff: (retryCount: number, error: Error) => number
21+
customBackoff?: (retryCount: number, error: Error) => number
2222
}
2323

24-
export interface ContentstackConfig extends AxiosRequestConfig {
24+
export interface ContentstackToken {
25+
authorization?: string
26+
authtoken?: string
27+
}
28+
29+
export interface ContentstackConfig extends AxiosRequestConfig, ContentstackToken {
2530
proxy?: ProxyConfig | false
2631
endpoint?: string
2732
host?: string
@@ -32,12 +37,12 @@ export interface ContentstackConfig extends AxiosRequestConfig {
3237
retryDelay?: number
3338
retryCondition?: (error: Error) => boolean
3439
retryDelayOptions?: RetryDelayOption
40+
refreshToken?: () => Promise<ContentstackToken>
3541
maxContentLength?: number
3642
maxBodyLength?: number
3743
logHandler?: (level: string, data: any) => void
3844
application?: string
3945
integration?: string
40-
authtoken?: string
4146
}
4247

4348
export interface LoginDetails {

0 commit comments

Comments
 (0)