import http from 'http' import { generateTracingInfo } from './tracing' import * as utils from './utils' import { ICloudBaseConfig, IRequestInfo, ICustomParam, IReqOpts, IReqHooks, ICustomReqOpts } from '../type/index' import { ERROR } from '../const/code' import { SYMBOL_CURRENT_ENV } from '../const/symbol' import { CloudBase } from '../cloudbase' import { extraRequest } from './request' import { handleWxOpenApiData } from './requestHook' import { getWxCloudToken, loadWxCloudbaseAccesstoken } from './wxCloudToken' import { sign } from '@cloudbase/signature-nodejs' import URL from 'url' // import { version } from '../../package.json' import SecretManager from './secretManager' const { version } = require('../../package.json') const { E, second, processReturn, getServerInjectUrl } = utils export class Request { private args: IRequestInfo private config: ICloudBaseConfig private opts: ICustomReqOpts private urlPath = '/admin' private defaultTimeout = 15000 private timestamp: number = new Date().valueOf() private tracingInfo: { eventId: string seqId: string trace: string } = generateTracingInfo() private secretManager: SecretManager private slowWarnTimer: NodeJS.Timer = null // 请求参数 private hooks: IReqHooks = {} public constructor(args: IRequestInfo) { this.args = args this.config = args.config this.opts = args.opts || {} this.secretManager = new SecretManager() } /** * 最终发送请求 */ public async request(): Promise { // 校验密钥是否存在 await this.validateSecretIdAndKey() // 构造请求参数 const params = await this.makeParams() const opts = await this.makeReqOpts(params) const action = this.getAction() const key = { functions: 'function_name', database: 'collectionName', wx: 'apiName' }[action.split('.')[0]] const argopts: any = this.opts const config = this.config // 发请求时未找到有效环境字段 if (!params.envName) { // 检查config中是否有设置 if (config.envName) { return processReturn(config.throwOnCode, { ...ERROR.INVALID_PARAM, message: '未取到init 指定 env!' }) } else { console.warn(`当前未指定env,将默认使用第一个创建的环境!`) } } // 注意:必须初始化为 null let retryOptions: any = null if (argopts.retryOptions) { retryOptions = argopts.retryOptions } else if (config.retries && typeof config.retries === 'number') { retryOptions = { retries: config.retries } } return extraRequest(opts, { debug: config.debug, op: `${action}:${this.args.params[key]}@${params.envName}`, seqId: this.getSeqId(), retryOptions: retryOptions, timingsMeasurerOptions: config.timingsMeasurerOptions || {} }).then((response: any) => { this.slowWarnTimer && clearTimeout(this.slowWarnTimer) const { body } = response if (response.statusCode === 200) { let res try { res = typeof body === 'string' ? JSON.parse(body) : body if (this.hooks && this.hooks.handleData) { res = this.hooks.handleData(res, null, response, body) } } catch (e) { res = body } return res } else { const e = E({ code: response.statusCode, message: ` ${response.statusCode} ${ http.STATUS_CODES[response.statusCode] } | [${opts.url}]` }) throw e } }) } public setHooks(hooks: IReqHooks) { Object.assign(this.hooks, hooks) } public getSeqId(): string { return this.tracingInfo.seqId } /** * 接口action */ public getAction(): string { const { params } = this.args const { action } = params return action } /** * 设置超时warning */ public setSlowWarning(timeout: number) { const action = this.getAction() const { seqId } = this.tracingInfo this.slowWarnTimer = setTimeout(() => { /* istanbul ignore next */ const msg = `Your current request ${action || ''} is longer than 3s, it may be due to the network or your query performance | [${seqId}]` /* istanbul ignore next */ console.warn(msg) }, timeout) } /** * 构造params */ public async makeParams(): Promise { const { TCB_SESSIONTOKEN, TCB_ENV, SCF_NAMESPACE } = CloudBase.getCloudbaseContext() const args = this.args const opts = this.opts const config = this.config const { eventId } = this.tracingInfo const crossAuthorizationData = opts.getCrossAccountInfo && (await opts.getCrossAccountInfo()).authorization const {wxCloudApiToken, wxCloudbaseAccesstoken} = getWxCloudToken() const params: ICustomParam = { ...args.params, envName: config.envName, eventId, wxCloudApiToken, wxCloudbaseAccesstoken, tcb_sessionToken: TCB_SESSIONTOKEN || '', sessionToken: config.sessionToken, crossAuthorizationToken: crossAuthorizationData ? Buffer.from(JSON.stringify(crossAuthorizationData)).toString('base64') : '' } // 取当前云函数环境时,替换为云函数下环境变量 if (params.envName === SYMBOL_CURRENT_ENV) { params.envName = TCB_ENV || SCF_NAMESPACE } // 过滤value undefined utils.filterUndefined(params) return params } /** * 构造请求项 */ public async makeReqOpts(params): Promise { const config = this.config const args = this.args const isInternal = await utils.checkIsInternalAsync() const url = this.getUrl({isInternal}) const method = this.getMethod() const opts: IReqOpts = { url: url, method, // 先取模块的timeout,没有则取sdk的timeout,还没有就使用默认值 // timeout: args.timeout || config.timeout || 15000, timeout: this.getTimeout(), // todo 细化到api维度 timeout // 优先取config,其次取模块,最后取默认 headers: await this.getHeaders(url), proxy: config.proxy } opts.keepalive = config.keepalive === true if (args.method === 'post') { if (args.isFormData) { opts.formData = params opts.encoding = null } else { opts.body = params opts.json = true } } else { /* istanbul ignore next */ opts.qs = params } return opts } /** * 协议 */ private getProtocol(): string { return this.config.isHttp === true ? 'http' : 'https' } /** * 请求方法 */ private getMethod(): string { return this.args.method || 'get' } /** * 超时时间 */ private getTimeout(): number { const { opts = {} } = this.args // timeout优先级 自定义接口timeout > config配置timeout > 默认timeout return opts.timeout || this.config.timeout || this.defaultTimeout } /** * 校验密钥和token是否存在 */ private async validateSecretIdAndKey(): Promise { const { TENCENTCLOUD_SECRETID, TENCENTCLOUD_SECRETKEY, TENCENTCLOUD_SESSIONTOKEN } = CloudBase.getCloudbaseContext() // 放在此处是为了兼容本地环境下读环境变量 const isInSCF = utils.checkIsInScf() const isInContainer = utils.checkIsInEks() let opts = this.opts let getCrossAccountInfo = opts.getCrossAccountInfo || this.config.getCrossAccountInfo /* istanbul ignore if */ if (getCrossAccountInfo) { let crossAccountInfo = await getCrossAccountInfo() let { credential } = await getCrossAccountInfo() let { secretId, secretKey, token }: any = credential || {} this.config = { ...this.config, secretId, secretKey, sessionToken: token } this.opts.getCrossAccountInfo = () => Promise.resolve(crossAccountInfo) if (!this.config.secretId || !this.config.secretKey) { throw E({ ...ERROR.INVALID_PARAM, message: 'missing secretId or secretKey of tencent cloud' }) } } else { const { secretId, secretKey } = this.config if (!secretId || !secretKey) { /* istanbul ignore if */ if (isInContainer) { // 这种情况有可能是在容器内,此时尝试拉取临时 const tmpSecret = await this.secretManager.getTmpSecret() this.config = { ...this.config, secretId: tmpSecret.id, secretKey: tmpSecret.key, sessionToken: tmpSecret.token } return } if (!TENCENTCLOUD_SECRETID || !TENCENTCLOUD_SECRETKEY) { if (isInSCF) { throw E({ ...ERROR.INVALID_PARAM, message: 'missing authoration key, redeploy the function' }) } else { throw E({ ...ERROR.INVALID_PARAM, message: 'missing secretId or secretKey of tencent cloud' }) } } else { this.config = { ...this.config, secretId: TENCENTCLOUD_SECRETID, secretKey: TENCENTCLOUD_SECRETKEY, sessionToken: TENCENTCLOUD_SESSIONTOKEN } } } } } /** * * 获取headers 此函数中设置authorization */ private async getHeaders(url: string): Promise { const config = this.config const { secretId, secretKey } = config const args = this.args const method = this.getMethod() const { TCB_SOURCE } = CloudBase.getCloudbaseContext() // Note: 云函数被调用时可能调用端未传递 SOURCE,TCB_SOURCE 可能为空 const SOURCE = utils.checkIsInScf() ? `${TCB_SOURCE || ''},scf` : ',not_scf' let requiredHeaders = { 'User-Agent': `tcb-node-sdk/${version}`, 'x-tcb-source': SOURCE, 'x-client-timestamp': this.timestamp, 'X-SDK-Version': `tcb-node-sdk/${version}`, Host: URL.parse(url).host } if (config.version) { requiredHeaders['X-SDK-Version'] = config.version } if (this.tracingInfo.trace) { requiredHeaders['x-tcb-tracelog'] = this.tracingInfo.trace } const region = this.config.region || process.env.TENCENTCLOUD_REGION || '' if (region) { requiredHeaders['X-TCB-Region'] = region } requiredHeaders = { ...config.headers, ...args.headers, ...requiredHeaders } const { authorization, timestamp } = sign({ secretId: secretId, secretKey: secretKey, method: method, url: url, params: await this.makeParams(), headers: requiredHeaders, withSignedParams: true, timestamp: second() - 1 }) requiredHeaders['Authorization'] = authorization requiredHeaders['X-Signature-Expires'] = 600 requiredHeaders['X-Timestamp'] = timestamp return { ...requiredHeaders } } /** * 获取url * @param action */ /* eslint-disable-next-line complexity */ private getUrl(options: { isInternal: boolean } = { isInternal: false }): string { if (utils.checkIsInScf()) { // 云函数环境下,应该包含以下环境变量,如果没有,后续逻辑可能会有问题 if (!process.env.TENCENTCLOUD_REGION) { console.error('[ERROR] missing `TENCENTCLOUD_REGION` environment') } if (!process.env.SCF_NAMESPACE) { console.error('[ERROR] missing `SCF_NAMESPACE` environment') } } const { TCB_ENV, SCF_NAMESPACE } = CloudBase.getCloudbaseContext() // 优先级:用户配置 > 环境变量 const region = this.config.region || process.env.TENCENTCLOUD_REGION || '' const envId = this.config.envName === SYMBOL_CURRENT_ENV ? TCB_ENV || SCF_NAMESPACE : this.config.envName || '' // 有地域信息则访问地域级别域名,无地域信息则访问默认域名,默认域名固定解析到上海地域保持兼容 const internetRegionEndpoint = region ? `${region}.tcb-api.tencentcloudapi.com` : `tcb-api.tencentcloudapi.com` const internalRegionEndpoint = region ? `internal.${region}.tcb-api.tencentcloudapi.com` : `internal.tcb-api.tencentcloudapi.com` // 同地域走内网,跨地域走公网 const isSameRegionVisit = this.config.region ? this.config.region === process.env.TENCENTCLOUD_REGION : true const endpoint = isSameRegionVisit && (options.isInternal) ? internalRegionEndpoint : internetRegionEndpoint const envEndpoint = envId ? `${envId}.${endpoint}` : endpoint const protocol = options.isInternal ? 'http' : this.getProtocol() // 注意:云函数环境下有地域信息,云应用环境下不确定是否有,如果没有,用户必须显式的传入 const defaultUrl = `${protocol}://${envEndpoint}${this.urlPath}` const { eventId, seqId } = this.tracingInfo const { serviceUrl } = this.config const serverInjectUrl = getServerInjectUrl() const url = serviceUrl || serverInjectUrl || defaultUrl const qs = CloudBase.scfContext ? `&eventId=${eventId}&seqId=${seqId}&scfRequestId=${CloudBase.scfContext.requestId}` : `&eventId=${eventId}&seqId=${seqId}` return url.includes('?') ? `${url}${qs}` : `${url}?${qs}` } } // 业务逻辑都放在这里处理 export default async (args: IRequestInfo): Promise => { const req = new Request(args) const config = args.config const { action } = args.params if (action === 'wx.openApi' || action === 'wx.wxPayApi') { req.setHooks({ handleData: handleWxOpenApiData }) } if (action.startsWith('database')) { req.setSlowWarning(3000) } try { const res = await req.request() // 检查res是否为return {code, message}回包 if (res && res.code) { // 判断是否设置config._returnCodeByThrow = false return processReturn(config.throwOnCode, res) } return res } finally { // } }