@faasjs/http 0.0.2-beta.302 → 0.0.2-beta.320

package/lib/index.js

@@ -1,549 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var func = require('@faasjs/func');
-var deep_merge = require('@faasjs/deep_merge');
-var logger = require('@faasjs/logger');
-var crypto = require('crypto');
-var zlib = require('zlib');
-
-class Session {
-    constructor(cookie, config) {
-        this.cookie = cookie;
-        this.config = Object.assign({
-            key: 'key',
-            secret: crypto.randomBytes(128).toString('hex'),
-            salt: 'salt',
-            signedSalt: 'signedSalt',
-            keylen: 64,
-            iterations: 100,
-            digest: 'sha256',
-            cipherName: 'aes-256-cbc'
-        }, config);
-        this.secret = crypto.pbkdf2Sync(this.config.secret, this.config.salt, this.config.iterations, this.config.keylen / 2, this.config.digest);
-        this.signedSecret = crypto.pbkdf2Sync(this.config.secret, this.config.signedSalt, this.config.iterations, this.config.keylen, this.config.digest);
-        this.content = Object.create(null);
-    }
-    invoke(cookie) {
-        try {
-            this.content = cookie ? this.decode(cookie) : Object.create(null);
-        }
-        catch (error) {
-            console.error(error);
-            this.content = Object.create(null);
-        }
-        this.changed = false;
-    }
-    encode(text) {
-        if (typeof text !== 'string')
-            text = JSON.stringify(text);
-        const iv = crypto.randomBytes(16);
-        const cipher = crypto.createCipheriv(this.config.cipherName, this.secret, iv);
-        const encrypted = Buffer.concat([cipher.update(text), cipher.final()]).toString('base64');
-        const main = Buffer.from([encrypted, iv.toString('base64')].join('--')).toString('base64');
-        const hmac = crypto.createHmac(this.config.digest, this.signedSecret);
-        hmac.update(main);
-        const digest = hmac.digest('hex');
-        return main + '--' + digest;
-    }
-    decode(text) {
-        text = decodeURIComponent(text);
-        const signedParts = text.split('--');
-        const hmac = crypto.createHmac(this.config.digest, this.signedSecret);
-        hmac.update(signedParts[0]);
-        const digest = hmac.digest('hex');
-        if (signedParts[1] !== digest)
-            throw Error('Not valid');
-        const message = Buffer.from(signedParts[0], 'base64').toString();
-        const parts = message.split('--').map(function (part) {
-            return Buffer.from(part, 'base64');
-        });
-        const cipher = crypto.createDecipheriv(this.config.cipherName, this.secret, parts[1]);
-        const part = Buffer.from(cipher.update(parts[0])).toString('utf8');
-        const final = cipher.final('utf8');
-        const decrypt = [part, final].join('');
-        return JSON.parse(decrypt);
-    }
-    read(key) {
-        return this.content[key];
-    }
-    write(key, value) {
-        if (value === null || typeof value === 'undefined')
-            delete this.content[key];
-        else
-            this.content[key] = value;
-        this.changed = true;
-        return this;
-    }
-    update() {
-        if (this.changed)
-            this.cookie.write(this.config.key, this.encode(JSON.stringify(this.content)));
-        return this;
-    }
-}
-
-class Cookie {
-    constructor(config) {
-        this.config = deep_merge.deepMerge({
-            path: '/',
-            expires: 31536000,
-            secure: true,
-            httpOnly: true,
-            session: {}
-        }, config);
-        this.session = new Session(this, this.config.session);
-        this.content = Object.create(null);
-        this.setCookie = Object.create(null);
-    }
-    invoke(cookie) {
-        this.content = Object.create(null);
-        // 解析 cookie
-        if (cookie)
-            cookie.split(';').forEach(x => {
-                x = x.trim();
-                const k = /([^=]+)/.exec(x);
-                if (k !== null)
-                    this.content[k[0]] = decodeURIComponent(x.replace(`${k[0]}=`, '').replace(/;$/, ''));
-            });
-        this.setCookie = Object.create(null);
-        // 预读取 session
-        this.session.invoke(this.read(this.session.config.key));
-        return this;
-    }
-    read(key) {
-        return this.content[key];
-    }
-    write(key, value, opts) {
-        opts = Object.assign(this.config, opts || {});
-        let cookie;
-        if (value === null || typeof value === 'undefined') {
-            opts.expires = 'Thu, 01 Jan 1970 00:00:01 GMT';
-            cookie = `${key}=;`;
-            delete this.content[key];
-        }
-        else {
-            cookie = `${key}=${encodeURIComponent(value)};`;
-            this.content[key] = value;
-        }
-        if (typeof opts.expires === 'number')
-            cookie += `max-age=${opts.expires};`;
-        else if (typeof opts.expires === 'string')
-            cookie += `expires=${opts.expires};`;
-        cookie += `path=${opts.path || '/'};`;
-        if (opts.domain)
-            cookie += `domain=${opts.domain};`;
-        if (opts.secure)
-            cookie += 'Secure;';
-        if (opts.httpOnly)
-            cookie += 'HttpOnly;';
-        if (opts.sameSite)
-            cookie += `SameSite=${opts.sameSite};`;
-        this.setCookie[key] = cookie;
-        return this;
-    }
-    headers() {
-        if (Object.keys(this.setCookie).length === 0)
-            return {};
-        else
-            return { 'Set-Cookie': Object.values(this.setCookie) };
-    }
-}
-
-class Validator {
-    constructor(config, logger) {
-        this.paramsConfig = config.params;
-        this.cookieConfig = config.cookie;
-        this.sessionConfig = config.session;
-        this.before = config.before;
-        this.logger = logger;
-    }
-    async valid(request) {
-        if (this.before) {
-            const result = await this.before(request);
-            if (result)
-                throw new HttpError(result);
-        }
-        this.request = request;
-        if (this.paramsConfig && request.params) {
-            this.logger.debug('Valid Params');
-            this.validContent('params', request.params, '', this.paramsConfig);
-        }
-        if (this.cookieConfig && request.cookie) {
-            this.logger.debug('Valid Cookie');
-            if (request.cookie == null)
-                throw Error('Not found Cookie');
-            this.validContent('cookie', request.cookie.content, '', this.cookieConfig);
-        }
-        if (this.sessionConfig && request.session) {
-            this.logger.debug('Valid Session');
-            if (request.session == null)
-                throw Error('Not found Session');
-            this.validContent('session', request.session.content, '', this.sessionConfig);
-        }
-    }
-    validContent(type, params, baseKey, config) {
-        if (config.whitelist) {
-            const paramsKeys = Object.keys(params);
-            const rulesKeys = Object.keys(config.rules);
-            const diff = paramsKeys.filter(k => !rulesKeys.includes(k));
-            if (diff.length > 0)
-                if (config.whitelist === 'error') {
-                    const diffKeys = diff.map(k => `${baseKey}${k}`);
-                    const error = Error(`[${type}] Not permitted keys: ${diffKeys.join(', ')}`);
-                    if (config.onError) {
-                        const res = config.onError(`${type}.whitelist`, baseKey, diffKeys);
-                        if (res)
-                            throw new HttpError(res);
-                    }
-                    throw error;
-                }
-                else if (config.whitelist === 'ignore')
-                    for (const key of diff)
-                        delete params[key];
-        }
-        for (const key in config.rules) {
-            const rule = config.rules[key];
-            if (!rule)
-                continue;
-            let value = params[key];
-            // default
-            if (rule.default)
-                if (type === 'cookie' || type === 'session')
-                    this.logger.warn('Cookie and Session not support default rule.');
-                else if (typeof value === 'undefined' && rule.default) {
-                    value = typeof rule.default === 'function' ? rule.default(this.request) : rule.default;
-                    params[key] = value;
-                }
-            // required
-            if (rule.required)
-                if (typeof value === 'undefined' || value === null) {
-                    const error = Error(`[${type}] ${baseKey}${key} is required.`);
-                    if (config.onError) {
-                        const res = config.onError(`${type}.rule.required`, `${baseKey}${key}`, value);
-                        if (res)
-                            throw new HttpError(res);
-                    }
-                    throw error;
-                }
-            if (typeof value !== 'undefined' && value !== null) {
-                // type
-                if (rule.type)
-                    if (type === 'cookie')
-                        this.logger.warn('Cookie not support type rule');
-                    else {
-                        let typed = true;
-                        switch (rule.type) {
-                            case 'array':
-                                typed = Array.isArray(value);
-                                break;
-                            case 'object':
-                                typed = Object.prototype.toString.call(value) === '[object Object]';
-                                break;
-                            default:
-                                typed = typeof value === rule.type;
-                                break;
-                        }
-                        if (!typed) {
-                            const error = Error(`[${type}] ${baseKey}${key} must be a ${rule.type}.`);
-                            if (config.onError) {
-                                const res = config.onError(`${type}.rule.type`, `${baseKey}${key}`, value);
-                                if (res)
-                                    throw new HttpError(res);
-                            }
-                            throw error;
-                        }
-                    }
-                // in
-                if ((rule.in) && !rule.in.includes(value)) {
-                    const error = Error(`[${type}] ${baseKey}${key} must be in ${rule.in.join(', ')}.`);
-                    if (config.onError) {
-                        const res = config.onError(`${type}.rule.in`, `${baseKey}${key}`, value);
-                        if (res)
-                            throw new HttpError(res);
-                    }
-                    throw error;
-                }
-                // nest config
-                if (rule.config)
-                    if (type === 'cookie')
-                        this.logger.warn('Cookie not support nest rule.');
-                    else if (Array.isArray(value))
-                        // array
-                        for (const val of value)
-                            this.validContent(type, val, (baseKey ? `${baseKey}.${key}.` : `${key}.`), rule.config);
-                    else if (typeof value === 'object')
-                        // object
-                        this.validContent(type, value, (baseKey ? `${baseKey}.${key}.` : `${key}.`), rule.config);
-            }
-        }
-    }
-}
-
-const ContentType = {
-    plain: 'text/plain',
-    html: 'text/html',
-    xml: 'application/xml',
-    csv: 'text/csv',
-    css: 'text/css',
-    javascript: 'application/javascript',
-    json: 'application/json',
-    jsonp: 'application/javascript'
-};
-class HttpError extends Error {
-    constructor({ statusCode, message }) {
-        super(message);
-        if (Error.captureStackTrace)
-            Error.captureStackTrace(this, HttpError);
-        this.statusCode = statusCode || 500;
-        this.message = message;
-    }
-}
-const Name = 'http';
-class Http {
-    /**
-     * 创建 Http 插件实例
-     * @param config {object} 配置项
-     * @param config.name {string} 配置名
-     * @param config.config {object} 网关配置
-     * @param config.config.method {string} 请求方法，默认为 POST
-     * @param config.config.path {string} 请求路径，默认为云函数文件路径
-     * @param config.config.ignorePathPrefix {string} 排除的路径前缀，当设置 path 时无效
-     * @param config.config.cookie {object} Cookie 配置
-     * @param config.validator {object} 入参校验配置
-     * @param config.validator.params {object} params 校验配置
-     * @param config.validator.params.whitelist {string} 白名单配置
-     * @param config.validator.params.onError {function} 自定义报错
-     * @param config.validator.params.rules {object} 参数校验规则
-     * @param config.validator.cookie {object} cookie 校验配置
-     * @param config.validator.cookie.whitelist {string} 白名单配置
-     * @param config.validator.cookie.onError {function} 自定义报错
-     * @param config.validator.cookie.rules {object} 参数校验规则
-     * @param config.validator.session {object} session 校验配置
-     * @param config.validator.session.whitelist {string} 白名单配置
-     * @param config.validator.session.onError {function} 自定义报错
-     * @param config.validator.session.rules {object} 参数校验规则
-     * @param config.validator.before {function} 参数校验前自定义函数
-     */
-    constructor(config) {
-        this.type = Name;
-        this.name = Name;
-        this.name = (config === null || config === void 0 ? void 0 : config.name) || this.type;
-        this.config = ((config === null || config === void 0 ? void 0 : config.config)) || Object.create(null);
-        if ((config === null || config === void 0 ? void 0 : config.validator))
-            this.validatorOptions = config.validator;
-        this.logger = new logger.Logger(this.name);
-        this.headers = Object.create(null);
-        this.cookie = new Cookie(this.config.cookie || {});
-        this.session = this.cookie.session;
-    }
-    async onDeploy(data, next) {
-        var _a;
-        await next();
-        this.logger.debug('组装网关配置');
-        this.logger.debug('%j', data);
-        const config = data.config.plugins ?
-            deep_merge.deepMerge(data.config.plugins[this.name || this.type], { config: this.config }) :
-            { config: this.config };
-        // 根据文件及文件夹名生成路径
-        if (!config.config.path) {
-            config.config.path = '/' + ((_a = data.name) === null || _a === void 0 ? void 0 : _a.replace(/_/g, '/').replace(/\/index$/, ''));
-            if (config.config.path === '/index')
-                config.config.path = '/';
-            if (config.config.ignorePathPrefix) {
-                config.config.path = config.config.path.replace(new RegExp('^' + config.config.ignorePathPrefix), '');
-                if (config.config.path === '')
-                    config.config.path = '/';
-            }
-        }
-        this.logger.debug('组装完成 %j', config);
-        // 引用服务商部署插件
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        const Provider = require(config.provider.type).Provider;
-        const provider = new Provider(config.provider.config);
-        // 部署网关
-        await provider.deploy(this.type, data, config);
-    }
-    async onMount(data, next) {
-        this.logger.debug('[onMount] merge config');
-        if (data.config.plugins && data.config.plugins[this.name || this.type])
-            this.config = deep_merge.deepMerge(this.config, data.config.plugins[this.name || this.type].config);
-        this.logger.debug('[onMount] prepare cookie & session');
-        this.cookie = new Cookie(this.config.cookie || {});
-        this.session = this.cookie.session;
-        if (this.validatorOptions) {
-            this.logger.debug('[onMount] prepare validator');
-            this.validator = new Validator(this.validatorOptions, this.logger);
-        }
-        await next();
-    }
-    async onInvoke(data, next) {
-        var _a, _b;
-        this.headers = data.event.headers || Object.create(null);
-        this.body = data.event.body;
-        this.params = Object.create(null);
-        this.response = { headers: Object.create(null) };
-        if (data.event.body) {
-            if (data.event.headers && data.event.headers['content-type'] && data.event.headers['content-type'].includes('application/json')) {
-                this.logger.debug('[onInvoke] Parse params from json body');
-                this.params = JSON.parse(data.event.body);
-            }
-            else {
-                this.logger.debug('[onInvoke] Parse params from raw body');
-                this.params = data.event.body;
-            }
-            this.logger.debug('[onInvoke] Params: %j', this.params);
-        }
-        else if (data.event.queryString) {
-            this.logger.debug('[onInvoke] Parse params from queryString');
-            this.params = data.event.queryString;
-            this.logger.debug('[onInvoke] Params: %j', this.params);
-        }
-        this.cookie.invoke(this.headers.cookie);
-        if (this.headers.cookie) {
-            this.logger.debug('[onInvoke] Cookie: %j', this.cookie.content);
-            this.logger.debug('[onInvoke] Session: %j', this.session.content);
-        }
-        if (this.validator) {
-            this.logger.debug('[onInvoke] Valid request');
-            try {
-                await this.validator.valid({
-                    headers: this.headers,
-                    params: this.params,
-                    cookie: this.cookie,
-                    session: this.session
-                });
-            }
-            catch (error) {
-                this.logger.error(error);
-                data.response = {
-                    statusCode: error.statusCode || 500,
-                    headers: { 'Content-Type': 'application/json; charset=utf-8' },
-                    body: JSON.stringify({ error: { message: error.message } })
-                };
-                return;
-            }
-        }
-        try {
-            await next();
-        }
-        catch (error) {
-            data.response = error;
-        }
-        // update session
-        this.session.update();
-        // 处理 body
-        if (data.response)
-            if (data.response instanceof Error || ((_a = data.response.constructor) === null || _a === void 0 ? void 0 : _a.name) === 'Error') {
-                // 当结果是错误类型时
-                this.logger.error(data.response);
-                this.response.body = JSON.stringify({ error: { message: data.response.message } });
-                try {
-                    this.response.statusCode = data.response.statusCode || 500;
-                }
-                catch (error) {
-                    this.response.statusCode = 500;
-                }
-            }
-            else if (Object.prototype.toString.call(data.response) === '[object Object]' && data.response.statusCode && data.response.headers)
-                // 当返回结果是响应结构体时
-                this.response = data.response;
-            else
-                this.response.body = JSON.stringify({ data: data.response });
-        // 处理 statusCode
-        if (!this.response.statusCode)
-            this.response.statusCode = this.response.body ? 200 : 201;
-        // 处理 headers
-        this.response.headers = Object.assign({
-            'Content-Type': 'application/json; charset=utf-8',
-            'Cache-Control': 'no-cache, no-store'
-        }, this.cookie.headers(), this.response.headers);
-        data.response = this.response;
-        if (process.env.FaasMode === 'local') {
-            this.logger.debug('[onInvoke] Response: %j', data.response);
-            return;
-        }
-        // 判断是否需要压缩
-        if (data.response.isBase64Encoded ||
-            typeof data.response.body !== 'string' ||
-            !((_b = data.response.headers['Content-Type']) === null || _b === void 0 ? void 0 : _b.includes('json')) ||
-            data.response.body.length < 100)
-            return;
-        const acceptEncoding = this.headers['accept-encoding'] || this.headers['Accept-Encoding'];
-        if (!acceptEncoding || !/(br|gzip|deflate)/.test(acceptEncoding))
-            return;
-        const originBody = data.response.body;
-        try {
-            if (acceptEncoding.includes('br')) {
-                data.response.headers['Content-Encoding'] = 'br';
-                data.response.body = zlib.brotliCompressSync(originBody).toString('base64');
-            }
-            else if (acceptEncoding.includes('gzip')) {
-                data.response.headers['Content-Encoding'] = 'gzip';
-                data.response.body = zlib.gzipSync(originBody).toString('base64');
-            }
-            else if (acceptEncoding.includes('deflate')) {
-                data.response.headers['Content-Encoding'] = 'deflate';
-                data.response.body = zlib.deflateSync(originBody).toString('base64');
-            }
-            else
-                throw Error('No matched compression.');
-            data.response.isBase64Encoded = true;
-            data.response.originBody = originBody;
-        }
-        catch (error) {
-            console.error(error);
-            // 若压缩失败还原
-            data.response.body = originBody;
-            delete data.response.headers['Content-Encoding'];
-        }
-    }
-    /**
-     * 设置 header
-     * @param key {string} key
-     * @param value {*} value
-     */
-    setHeader(key, value) {
-        this.response.headers[key] = value;
-        return this;
-    }
-    /**
-     * 设置 Content-Type
-     * @param type {string} 类型
-     * @param charset {string} 编码
-     */
-    setContentType(type, charset = 'utf-8') {
-        if (ContentType[type])
-            this.setHeader('Content-Type', `${ContentType[type]}; charset=${charset}`);
-        else
-            this.setHeader('Content-Type', `${type}; charset=${charset}`);
-        return this;
-    }
-    /**
-     * 设置状态码
-     * @param code {number} 状态码
-     */
-    setStatusCode(code) {
-        this.response.statusCode = code;
-        return this;
-    }
-    /**
-     * 设置 body
-     * @param body {*} 内容
-     */
-    setBody(body) {
-        this.response.body = body;
-        return this;
-    }
-}
-function useHttp(config) {
-    return func.usePlugin(new Http(config));
-}
-
-exports.ContentType = ContentType;
-exports.Cookie = Cookie;
-exports.Http = Http;
-exports.HttpError = HttpError;
-exports.Session = Session;
-exports.Validator = Validator;
-exports.useHttp = useHttp;

package/lib/session.d.ts

@@ -1,38 +0,0 @@
-import { Cookie } from './cookie';
-export declare type SessionOptions = {
-    key: string;
-    secret: string;
-    salt?: string;
-    signedSalt?: string;
-    keylen?: number;
-    iterations?: number;
-    digest?: string;
-    cipherName?: string;
-};
-export declare type SessionContent = string | number | {
-    [key: string]: any;
-} | null | undefined;
-export declare class Session<S extends Record<string, string> = any, C extends Record<string, string> = any> {
-    content: Record<string, string>;
-    readonly config: {
-        key: string;
-        secret: string;
-        salt: string;
-        signedSalt: string;
-        keylen: number;
-        iterations: number;
-        digest: string;
-        cipherName: string;
-    };
-    private readonly secret;
-    private readonly signedSecret;
-    private readonly cookie;
-    private changed?;
-    constructor(cookie: Cookie<C, S>, config: SessionOptions);
-    invoke(cookie?: string): void;
-    encode(text: SessionContent): string;
-    decode(text: string): SessionContent;
-    read(key: string): string;
-    write(key: string, value?: string): Session<S, C>;
-    update(): Session<S, C>;
-}

package/lib/validator.d.ts

@@ -1,57 +0,0 @@
-import { Cookie } from './cookie';
-import { Session } from './session';
-import { Logger } from '@faasjs/logger';
-export declare type ValidatorRuleOptions = {
-    type?: 'string' | 'number' | 'boolean' | 'object' | 'array';
-    required?: boolean;
-    in?: any[];
-    default?: any;
-    config?: Partial<ValidatorOptions>;
-};
-export declare type ValidatorOptions<Content = Record<string, any>> = {
-    whitelist?: 'error' | 'ignore';
-    rules: {
-        [k in keyof Content]?: ValidatorRuleOptions;
-    };
-    onError?: (type: string, key: string | string[], value?: any) => {
-        statusCode?: number;
-        message: any;
-    } | void;
-};
-declare type Request<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any> = {
-    headers: {
-        [key: string]: string;
-    };
-    params?: TParams;
-    cookie?: Cookie<TCookie, TSession>;
-    session?: Session<TSession, TCookie>;
-};
-export declare type BeforeOption<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any> = (request: Request<TParams, TCookie, TSession>) => Promise<void | {
-    statusCode?: number;
-    message: string;
-}>;
-export declare type ValidatorConfig<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any> = {
-    params?: ValidatorOptions<TParams>;
-    cookie?: ValidatorOptions<TCookie>;
-    session?: ValidatorOptions<TSession>;
-    before?: BeforeOption;
-};
-export declare class Validator<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any> {
-    before?: BeforeOption<TParams, TCookie, TSession>;
-    paramsConfig?: ValidatorOptions<TParams>;
-    cookieConfig?: ValidatorOptions<TCookie>;
-    sessionConfig?: ValidatorOptions<TSession>;
-    private request;
-    private readonly logger;
-    constructor(config: {
-        params?: ValidatorOptions<TParams>;
-        cookie?: ValidatorOptions<TCookie>;
-        session?: ValidatorOptions<TSession>;
-        before?: BeforeOption<TParams, TCookie, TSession>;
-    }, logger: Logger);
-    valid(request: Request<TParams, TCookie, TSession>): Promise<void>;
-    validContent(type: string, params: {
-        [key: string]: any;
-    }, baseKey: string, config: ValidatorOptions): void;
-}
-export {};