Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 | 1x 1x 1x 1x 1x 1x 14x 1x 13x 1x 12x 1x 11x 1x 10x 1x 9x 9x 9x 9x 12x 1x 11x 1x 10x 1x 9x 8x 6x 6x 5x 1x 5x 5x 5x 5x 8x 8x 8x 7x 1x 1x 7x 2x 5x 1x | 'use strict';
const { Agent } = require('http');
const superagent = require('superagent');
const { SdkError } = require('general-mq');
const { DataTypes } = require('general-mq/lib/constants');
const { ErrorCode } = require('./constants');
const keepAliveAgent = new Agent({ keepAlive: true });
/**
* Options of the HTTP client `Client` that contains OAuth2 information.
*
* @typedef {Object} ClientOptions
* @property {string} authBase `sylvia-iot-auth` base path with scheme. For example
* `http://localhost:1080/auth`.
* @property {string} coremgrBase `sylvia-iot-coremgr` base path with scheme. For example
* `http://localhost:1080/coremgr`.
* @property {string} clientId Client ID.
* @property {string} clientSecret Client secret.
*/
/**
* Client response.
*
* @typedef {Object} ClientResponse
* @property {number} status Status code.
* @property {Object|Array} body Body.
*/
/**
* The HTTP client to request Sylvia-IoT APIs. With this client, you do not need to handle 401
* refresh token flow.
*
* @class Client
*/
class Client {
/**
* Create an instance.
*
* @param {ClientOptions} opts
* @throws {Error} Wrong arguments.
*/
constructor(opts) {
if (!opts || typeof opts !== DataTypes.Object || Array.isArray(opts)) {
throw Error('`opts` is not an object');
} else if (!opts.authBase || typeof opts.authBase !== DataTypes.String) {
throw Error('`opts.authBase` is not a string');
} else if (!opts.coremgrBase || typeof opts.coremgrBase !== DataTypes.String) {
throw Error('`opts.coremgrBase` is not a string');
} else if (!opts.clientId || typeof opts.clientId !== DataTypes.String) {
throw Error('`opts.clientId` is not a string');
} else if (!opts.clientSecret || typeof opts.clientSecret !== DataTypes.String) {
throw Error('`opts.clientSecret` is not a string');
}
this.#authBase = opts.authBase;
this.#coremgrBase = opts.coremgrBase;
this.#clientId = opts.clientId;
this.#clientSecret = opts.clientSecret;
}
/**
* Execute a Sylvia-IoT API request.
*
* @async
* @param {string} method
* @param {string} apiPath The relative path (of the coremgr base) the API with query string. For
* example: `/api/v1/user/list?contains=word`, the client will do a request with
`http://coremgr-host/coremgr/api/v1/user/list?contains=word` URL.
* @param {Object} [body]
* @returns {Promise<ClientResponse>}
* @throws {Error} Wrong arguments.
* @throws {SdkError}
*/
async request(method, apiPath, body) {
if (!method || typeof method !== DataTypes.String) {
throw Error('`method` is not a string');
} else if (!apiPath || typeof apiPath !== DataTypes.String) {
throw Error('`apiPath` is not a string');
} else if (body !== undefined && (!body || typeof body !== DataTypes.Object)) {
throw Error('`body` is not an object');
}
if (!this.#accessToken) {
this.#accessToken = await this.#authToken();
}
for (let retry = 1; retry >= 0; retry--) {
const res = await superagent(method, `${this.#coremgrBase}${apiPath}`)
.agent(keepAliveAgent)
.set('Authorization', `Bearer ${this.#accessToken}`)
.send(body)
.buffer(false)
.ok((res) => !!res)
.catch((err) => {
throw SdkError({ code: ErrorCode.Rsc, message: `${err}` });
});
Iif (res.statusCode === 401) {
this.#accessToken = await this.#authToken();
continue;
}
let retBody = res.body;
Iif (res.body.length > 0) {
// Try to parse JSON body.
try {
retBody = JSON.parse(res.body.toString());
} catch (e) {}
}
return {
status: res.statusCode,
body: retBody,
};
}
throw SdkError({
code: ErrorCode.Rsc,
message: 'exceed retry',
});
}
/**
* To authorize the client and get access token/refresh token.
*
* @async
* @returns {Promise<string>} The access token.
* @throws {Error} Wrong arguments.
* @throws {SdkError}
*/
async #authToken() {
const url = `${this.#authBase}/oauth2/token`;
const body = { grant_type: 'client_credentials' };
const res = await superagent
.agent(keepAliveAgent)
.post(url)
.auth(this.#clientId, this.#clientSecret)
.type('form')
.accept('application/json')
.send(body)
.ok((res) => !!res)
.redirects(0)
.catch((err) => {
const body = {
code: ErrorCode.Rsc,
message: `${err}`,
};
throw SdkError(JSON.stringify(body));
});
if (res.statusCode !== 200) {
throw SdkError(JSON.stringify(res.body));
}
return res.body.access_token;
}
/**
* `sylvia-iot-auth` base path.
*
* @type {string}
*/
#authBase;
/**
* `sylvia-iot-coremgr` base path.
*
* @type {string}
*/
#coremgrBase;
/**
* Client ID.
*
* @type {string}
*/
#clientId;
/**
* Client secret.
*
* @type {string}
*/
#clientSecret;
/**
* The access token.
*
* @type {string}
*/
#accessToken;
}
module.exports = {
Client,
};
|