update api driver #46
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,12 @@ | ||
| 'use strict'; | ||
| const axios = require('axios'); | ||
|
There was a problem hiding this comment. @harshaio you used the code from |
||
| const Promise = require('bluebird'); | ||
| const RouterMap = require('./RouterMap').RouterMap; | ||
| const fs = require('fs'); | ||
| const url = require('url'); | ||
| const { URL } = require('url'); | ||
|
|
||
| const out = { | ||
| info: console.log, | ||
| error: console.log | ||
| }; | ||
|
|
@@ -24,11 +25,15 @@ function safeCallback(callback, response) { | |
|
|
||
| /** | ||
| * @param error | ||
| * @param status | ||
| * @param {Object} body | ||
| * @returns {*} | ||
| */ | ||
| function processError(error, status, body) { | ||
|
|
||
| if (error?.response?.data) { | ||
| return error.response.data; | ||
| } | ||
|
|
||
| if (error) { | ||
| if (typeof error === 'string') { | ||
|
|
@@ -56,24 +61,24 @@ function processError(error, response, body) { | |
|
|
||
| /** | ||
| * @param error | ||
| * @param status | ||
| * @param {?Object} body | ||
| * @returns {{error: *, body: ?Object}} | ||
| */ | ||
| function processResponse(error, status, body) { | ||
|
|
||
| error = processError(error, status, body); | ||
| if (error) { | ||
| body = null; | ||
| } | ||
|
|
||
| const ret = { | ||
| error: error, | ||
| body: body | ||
| }; | ||
|
|
||
| if (status) { | ||
| ret.statusCode = status; | ||
| } | ||
|
|
||
| return ret; | ||
|
|
@@ -86,7 +91,7 @@ function processResponse(error, response, body) { | |
| function loadLocalRoutesConfiguration(filePath) { | ||
|
|
||
| try { | ||
| const file = fs.readFileSync(filePath, 'utf8'); | ||
| return JSON.parse(file); | ||
| } catch (error) { | ||
| out.error('Routes configuration file error: ' + filePath + '\n' + error.message); | ||
|
|
@@ -107,7 +112,7 @@ function basicTransformResponseBody(body) { | |
| * @constructor | ||
| * @param {?Object} config | ||
| */ | ||
| const ApiDriver = function(config) { | ||
|
|
||
| // defaults | ||
| config = config || {}; | ||
|
|
@@ -148,12 +153,13 @@ var ApiDriver = function(config) { | |
| } | ||
|
|
||
| config.verbose = !!config.verbose; | ||
| config.multiArgs = !!config.multiArgs; | ||
|
|
||
| if (typeof config.transformResponseBody !== 'function') { | ||
| config.transformResponseBody = basicTransformResponseBody; | ||
| } | ||
|
|
||
| this.promSend = Promise.promisify(this.send, { context: this, multiArgs: config.multiArgs }); | ||
| this.config = config; | ||
| this.routesMap = new RouterMap(); | ||
|
|
||
|
|
@@ -169,8 +175,8 @@ var ApiDriver = function(config) { | |
| */ | ||
| ApiDriver.prototype.createCustomFunction = function(routeConfig) { | ||
|
|
||
| const customFn = this.config.customImplementationsModule[routeConfig.rawConfig.customImplementation]; | ||
| const promCustomFn = Promise.promisify(customFn); | ||
|
|
||
| if (typeof customFn !== 'function') { | ||
| throw new Error( | ||
|
|
@@ -183,7 +189,7 @@ ApiDriver.prototype.createCustomFunction = function(routeConfig) { | |
|
|
||
| data = data || {}; | ||
| // promisify this.send with binding to this | ||
| const routeJson = this.routesMap.getRouteJson(routeConfig.fullName, data); | ||
|
|
||
| if (typeof done === 'function') { | ||
| // if callback, use callback... | ||
|
|
@@ -204,7 +210,7 @@ ApiDriver.prototype.createGeneratedFunction = function(routeConfig) { | |
| return (function(data, done) { | ||
|
|
||
| data = data || {}; | ||
| const routeJson = this.routesMap.getRouteJson(routeConfig.fullName, data); | ||
|
|
||
| if (typeof done === 'function') { | ||
| // if callback, use callback... | ||
|
|
@@ -221,15 +227,15 @@ ApiDriver.prototype.createGeneratedFunction = function(routeConfig) { | |
| */ | ||
| ApiDriver.prototype.onRouteConfigCreated = function(routeConfig) { | ||
|
|
||
| const fn = (routeConfig.rawConfig.customImplementation) ? | ||
| this.createCustomFunction(routeConfig) : | ||
| this.createGeneratedFunction(routeConfig); | ||
|
|
||
| // build hierarchy, if needed | ||
| let item; | ||
| let active = this; | ||
| let hierarchy = routeConfig.namespaceSequence; | ||
| for (let i = 0; i < hierarchy.length; i++) { | ||
| item = hierarchy[i]; | ||
| active[item] = active[item] || {}; | ||
| active = active[item]; | ||
|
|
@@ -249,72 +255,114 @@ ApiDriver.prototype.send = function(routeFullName, routeJson, sendParams, done) | |
| if (routeJson == null) { | ||
| throw new Error('Unknown route!'); | ||
| } | ||
| if (!routeJson.uri) { | ||
| throw new Error('Missing uri param for route ' + routeFullName); | ||
| } | ||
| if (!routeJson.method) { | ||
| throw new Error('Missing method param for route ' + routeFullName); | ||
| } | ||
|
|
||
| const requestJson = { | ||
| method: routeJson.method, | ||
| // this is to avoid exception if user sets this.config.baseUrl to empty string '' | ||
| url: new URL(routeJson.uri, this.config.baseUrl ? this.config.baseUrl : undefined).toString() | ||
| }; | ||
|
|
||
| if (routeJson.formData || sendParams.formData) { | ||
| requestJson.data = routeJson.formData || sendParams.formData; | ||
| requestJson.headers = (routeJson.formData || sendParams.formData).getHeaders(); | ||
| } | ||
| if (routeJson.auth) { | ||
| requestJson.auth = routeJson.auth; | ||
| } | ||
| if (routeJson.body || sendParams.body) { | ||
| requestJson.data = routeJson.body || sendParams.body; | ||
| } | ||
| if (routeJson.qs || sendParams.qs) { | ||
| requestJson.params = routeJson.qs || sendParams.qs; | ||
| } | ||
| if (routeJson.headers) { | ||
| requestJson.headers = Object.assign(requestJson.headers || {}, routeJson.headers); | ||
| } | ||
| if (sendParams.headers) { | ||
| requestJson.headers = Object.assign(requestJson.headers || {}, sendParams.headers); | ||
| } | ||
| if (sendParams.json) { | ||
| if (typeof sendParams.json === 'object') { | ||
| requestJson.data = sendParams.json; | ||
| } | ||
| requestJson.json = true; | ||
| } | ||
|
|
||
| if (this.config.token) { | ||
| requestJson.headers = Object.assign( | ||
| requestJson.headers || {}, { 'Authorization': 'Bearer ' + this.config.token }); | ||
| } | ||
|
|
||
| axios(requestJson).then(response => { | ||
| if ([200, 201, 202, 302].indexOf(response.status) === -1) { | ||
| safeCallback(done, processResponse(null, response.status, response.data)); | ||
| return; | ||
| } | ||
|
|
||
| if (response.status === 302 && response.headers.location) { | ||
| let parsed = url.parse(response.headers.location); | ||
| this.config.baseUrl = parsed.protocol + '//' + parsed.host; | ||
| routeJson.uri = parsed.path; | ||
| return this.send(routeFullName, routeJson, sendParams, done); | ||
| } | ||
|
|
||
| try { | ||
| if (typeof response.data === 'string') { | ||
| response.data = this.config.transformResponseBody(response.data); | ||
| } | ||
| } catch (parseError) { | ||
| // even our own API sometimes returns string instead of JSON (POST /stores for example), | ||
| // in case the response body cannot be parsed, return it as it is | ||
| } | ||
|
|
||
| const responseJson = processResponse(null, response.status, response.data); | ||
|
|
||
| safeCallback(done, responseJson); | ||
|
|
||
| if (this.config.verbose) { | ||
| out.info(routeFullName + ' successfully done.\nsendParams:\t', JSON.stringify(sendParams || {})); | ||
| out.info('response code: ' + response.status); | ||
| out.info(JSON.stringify(response.data, null, '\t')); | ||
| } | ||
| }).catch(error => { | ||
| safeCallback(done, processResponse(error, error?.response?.status, error?.response?.data)); | ||
| }); | ||
| }; | ||
|
|
||
| /** | ||
| * @param {Object} options - classic request-promise object | ||
| */ | ||
| ApiDriver.prototype.sendAsync = function(options) { | ||
|
|
||
| return this.promSend(options.uri || '', options, { json: true }); | ||
| }; | ||
|
|
||
| /** | ||
| * @param {string} token | ||
| * @return {ApiDriver} | ||
| */ | ||
| ApiDriver.prototype.setAccessToken = function(token) { | ||
|
|
||
| if (!token) { | ||
| throw new Error('Missing token.'); | ||
| } | ||
| this.config.token = token; | ||
| return this; | ||
| }; | ||
|
|
||
| /** | ||
| * Get JWT token. | ||
| * @return {string} | ||
| */ | ||
| ApiDriver.prototype.getAccessToken = function() { | ||
|
|
||
| return this.config.token; | ||
| }; | ||
|
|
||
| /** | ||
|
|
@@ -325,4 +373,12 @@ ApiDriver.prototype.setBaseUrl = function(url) { | |
| this.config.baseUrl = url; | ||
| }; | ||
|
|
||
| /** | ||
| * @return {string} | ||
| */ | ||
| ApiDriver.prototype.getBaseUrl = function() { | ||
|
|
||
| return this.config.baseUrl; | ||
| }; | ||
|
|
||
| module.exports = ApiDriver; | ||
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't open the PR into
master, I cannot merge that. If I did, it could break customers' functionality. This repo is public and is used in modules.We can merge it to
devand then create a new tag, once tested.