@gravity-ui/gateway 4.1.1-alpha.0 → 4.2.0

package/dist/esm/utils/overrideEndpoints/overrideEndpoints.js

@@ -1,96 +0,0 @@
-import _ from 'lodash';
-function parseOverrideEndpointsParams(params) {
-    const parsedParams = [];
-    for (const [serviceKeyScope, serviceKeyValues] of Object.entries(params)) {
-        for (const [endpointName, config] of Object.entries(serviceKeyValues)) {
-            let scope = 'root';
-            let serviceKey = serviceKeyScope;
-            const pointInd = serviceKey.indexOf('.');
-            if (pointInd >= 0) {
-                scope = serviceKey.slice(0, pointInd);
-                serviceKey = serviceKey.slice(pointInd + 1);
-            }
-            parsedParams.push({
-                scope,
-                serviceKey,
-                endpointName,
-                config,
-            });
-        }
-    }
-    return parsedParams;
-}
-function getKeys(obj) {
-    return Object.keys(obj);
-}
-function deepCopy(obj) {
-    const res = Object.assign({}, obj);
-    getKeys(res).forEach((key) => {
-        if (typeof res[key] === 'object' && !Array.isArray(res[key]) && res[key] !== null) {
-            res[key] = deepCopy(res[key]);
-        }
-    });
-    return res;
-}
-/**
- * Overrides endpoints in the schema according to overrideParams
- * @param originalSchema Schema for the gateway
- * @param overrideParams Definitions of endpoints for services in the format {[<scope>.<service key>]: {[<endpointName>]: ActionEndpoint}}
- * If <scope> is not specified, root is assumed.
- * Example: '{serviceName: {endpoint: "https://example.com"}}'
- * @param installation
- * @param env
- * @return new overridden schema
- */
-export function overrideEndpoints(originalSchema, overrideParams, installation, env) {
-    if (!installation) {
-        console.warn('overrideEndpoints: installation empty');
-        return originalSchema;
-    }
-    if (!env) {
-        console.warn('overrideEndpoints: env empty');
-        return originalSchema;
-    }
-    const schema = deepCopy(originalSchema);
-    const parsedParams = parseOverrideEndpointsParams(overrideParams);
-    parsedParams.forEach((overrideConfig) => {
-        var _a;
-        const curService = (_a = schema[overrideConfig.scope]) === null || _a === void 0 ? void 0 : _a[overrideConfig.serviceKey];
-        if (!curService || !curService.actions || !curService.endpoints) {
-            console.warn('overrideEndpoints: incorrect service ' +
-                overrideConfig.scope +
-                '.' +
-                overrideConfig.serviceKey);
-            return;
-        }
-        const endpoints = curService.endpoints;
-        const envEndpoints = _.get(endpoints, [installation, env]);
-        if (!envEndpoints) {
-            console.warn('overrideEndpoints: ' + [installation, env] + ' not exists in envEndpoints');
-            return;
-        }
-        if (overrideConfig.endpointName) {
-            if (!envEndpoints[overrideConfig.endpointName]) {
-                console.warn('overrideEndpoints: incorrect endpointName ' + overrideConfig.endpointName);
-            }
-            overrideEndpoint(envEndpoints, overrideConfig.endpointName, overrideConfig);
-        }
-    });
-    return schema;
-}
-function isExtendedEndpointConfig(config) {
-    return typeof config === 'object';
-}
-function overrideEndpoint(envEndpoints, endpointName, overrideConfig) {
-    const config = envEndpoints[endpointName];
-    if (isExtendedEndpointConfig(config)) {
-        if (typeof overrideConfig.config === 'string') {
-            config.path = overrideConfig.config;
-        }
-        else {
-            Object.assign(config, overrideConfig.config);
-        }
-        return;
-    }
-    envEndpoints[endpointName] = overrideConfig.config;
-}

package/dist/esm/utils/parse-error.js

@@ -1,210 +0,0 @@
-import _ from 'lodash';
-import { Lang } from '../constants.js';
-import { decodeAnyMessageRecursively } from './grpc.js';
-const DEFAULT_GATEWAY_CODE = 'GATEWAY_REQUEST_ERROR';
-const DEFAULT_GATEWAY_MESSAGE = 'Gateway request error';
-export function parseMixedError(e) {
-    return {
-        status: 500,
-        message: String(e.message || DEFAULT_GATEWAY_MESSAGE),
-        code: String(e.code || DEFAULT_GATEWAY_CODE),
-        debug: {
-            originalError: e,
-            stack: e.stack,
-        },
-    };
-}
-function getErrorTitle(error) {
-    const prop = _.propertyOf(error);
-    const details = prop('details[0]');
-    if (details) {
-        return prop('details[0].type') || prop('details[0].code') || prop('code');
-    }
-    return prop('type') || prop('code');
-}
-function getErrorMessage(error) {
-    const prop = _.propertyOf(error);
-    const message = prop('message');
-    const detail = prop('detail');
-    const detailsMessage = prop('details[0].message');
-    if (message) {
-        return message;
-    }
-    if (detailsMessage) {
-        return detailsMessage;
-    }
-    if (detail) {
-        return prop('detail.Description') || prop('detail.Body') || detail;
-    }
-    return '';
-}
-function getStatusByGrpcCode(code) {
-    switch (code) {
-        case 0:
-            return 200;
-        case 1:
-            return 499;
-        case 2:
-            return 500;
-        case 3:
-            return 400;
-        case 4:
-            return 504;
-        case 5:
-            return 404;
-        case 6:
-            return 409;
-        case 7:
-            return 403;
-        case 8:
-            return 429;
-        case 9:
-            return 400;
-        case 10:
-            return 409;
-        case 11:
-            return 400;
-        case 12:
-            return 501;
-        case 13:
-            return 500;
-        case 14:
-            return 503;
-        case 15:
-            return 500;
-        case 16:
-            return 401;
-        default:
-            return 500;
-    }
-}
-export function parseRestError(error, lang) {
-    const prop = _.propertyOf(error);
-    let status = 500;
-    let title;
-    let description;
-    let details;
-    let type;
-    let code;
-    let debug;
-    if (prop('response')) {
-        const responseData = prop('response.data');
-        const statusTitle = `${prop('response.status')} ${prop('response.statusText')}`;
-        const errorTitle = getErrorTitle(responseData);
-        status = prop('response.status');
-        code = prop('response.data.code');
-        type = prop('response.data.type');
-        details = prop('response.data.details');
-        debug = prop('response.data.debug');
-        title = errorTitle ? errorTitle : statusTitle;
-        description = getErrorMessage(responseData);
-        if (status === 403) {
-            title = lang === Lang.Ru ? 'Доступ запрещен' : 'Access denied';
-        }
-    }
-    else {
-        code = prop('code');
-        title = lang === Lang.Ru ? 'Ошибка' : 'Error';
-        if (code === 'ECONNABORTED' || code === 'ETIMEDOUT') {
-            status = 504;
-            description = lang === Lang.Ru ? 'Превышено время ожидания ответа' : 'Timeout exceeded';
-        }
-        else {
-            status = 500;
-            description =
-                lang === Lang.Ru
-                    ? 'Произошла непредвиденная ошибка. Попробуйте обновить страницу через некоторое время.'
-                    : 'An unexpected error has occurred. Try to refresh the page in a few moments.';
-        }
-    }
-    return {
-        status,
-        message: String(description || DEFAULT_GATEWAY_MESSAGE),
-        code: String(code || DEFAULT_GATEWAY_CODE),
-        details: Object.assign({ type,
-            title,
-            description }, (typeof details === 'object' && !Array.isArray(details) ? details : { details })),
-        debug,
-    };
-}
-function decodeGrpcStatusMessage(metadata, packageRoot, decodeAnyMessageProtoLoaderOptions) {
-    const statusMessageBin = metadata.get('grpc-status-details-bin')[0];
-    if (!statusMessageBin) {
-        return undefined;
-    }
-    return decodeAnyMessageRecursively(packageRoot, {
-        type_url: 'type.googleapis.com/google.rpc.Status',
-        value: statusMessageBin,
-    }, decodeAnyMessageProtoLoaderOptions);
-}
-export function parseGrpcError(error, packageRoot, lang = Lang.Ru, decodeAnyMessageProtoLoaderOptions) {
-    let title = lang === Lang.Ru ? 'Ошибка' : 'Error';
-    if (error.code === 7) {
-        // Always redefine title for Access denied errors
-        title = lang === Lang.Ru ? 'Доступ запрещен' : 'Access denied';
-    }
-    let code = error.code;
-    let description = error.details;
-    let details;
-    if (error.metadata) {
-        try {
-            const statusMessage = decodeGrpcStatusMessage(error.metadata, packageRoot, decodeAnyMessageProtoLoaderOptions);
-            if (statusMessage) {
-                code = statusMessage.code;
-                description = statusMessage.message;
-                details = statusMessage.details;
-            }
-        }
-        catch (e) { }
-    }
-    // Always redefine description for Timeout exceeded errors
-    if (error.code === 4) {
-        description = lang === Lang.Ru ? 'Превышено время ожидания ответа' : 'Timeout exceeded';
-    }
-    // Use default description if description is undefined, but not for Access denied errors
-    if (!description) {
-        description =
-            lang === Lang.Ru
-                ? 'Произошла непредвиденная ошибка. Попробуйте обновить страницу через некоторое время.'
-                : 'An unexpected error has occurred. Try to refresh the page in a few moments.';
-    }
-    const status = getStatusByGrpcCode(error.code);
-    return {
-        status,
-        message: String(description || DEFAULT_GATEWAY_MESSAGE),
-        code: DEFAULT_GATEWAY_CODE,
-        details: Object.assign({ title,
-            description, grpcCode: code }, (typeof details === 'object' && !Array.isArray(details) ? details : { details })),
-    };
-}
-export class GrpcError extends Error {
-    constructor(message, parsedError, rawError) {
-        super(message);
-        this.parsedError = parsedError;
-        this.rawError = rawError;
-    }
-    getGatewayError() {
-        return this.parsedError;
-    }
-    getRawError() {
-        return this.rawError;
-    }
-    getAppError(ErrorConstructor) {
-        return new ErrorConstructor(this.parsedError.message, {
-            code: this.parsedError.code,
-            details: this.parsedError.details,
-            debug: this.parsedError.debug,
-        });
-    }
-}
-export function isGrpcError(error) {
-    return error.getGatewayError !== undefined;
-}
-export function grpcErrorFactory(error) {
-    return new GrpcError(error.message, {
-        status: 500,
-        code: '',
-        message: error.message,
-        details: {},
-    });
-}

package/dist/esm/utils/proto-path-resolver.d.ts

@@ -1,2 +0,0 @@
-import * as protobufjs from 'protobufjs';
-export declare function patchProtoPathResolver(root: protobufjs.Root, includeDirs: string[]): void;

package/dist/esm/utils/proto-path-resolver.js

@@ -1,23 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import * as protobufjs from 'protobufjs';
-export function patchProtoPathResolver(root, includeDirs) {
-    const originalResolvePath = root.resolvePath;
-    root.resolvePath = function (origin, target) {
-        if (target in protobufjs.common || path.isAbsolute(target)) {
-            return target;
-        }
-        for (let i = 0; i < includeDirs.length; i++) {
-            const directory = includeDirs[i];
-            const fullPath = path.join(directory, target);
-            try {
-                fs.accessSync(fullPath, fs.constants.R_OK);
-                return fullPath;
-            }
-            catch (err) {
-                continue;
-            }
-        }
-        return originalResolvePath(origin, target);
-    };
-}

package/dist/esm/utils/redact-sensitive-headers.d.ts

@@ -1,3 +0,0 @@
-import { IncomingHttpHeaders } from 'http';
-import { GatewayContext } from '../models/context.js';
-export declare function redactSensitiveHeaders(ctx: GatewayContext, headers: IncomingHttpHeaders): IncomingHttpHeaders;

package/dist/esm/utils/redact-sensitive-headers.js

@@ -1,12 +0,0 @@
-export function redactSensitiveHeaders(ctx, headers) {
-    var _a, _b;
-    if ((_a = ctx.utils) === null || _a === void 0 ? void 0 : _a.redactSensitiveHeaders) {
-        return ctx.utils.redactSensitiveHeaders(headers);
-    }
-    else if ((_b = ctx.utils) === null || _b === void 0 ? void 0 : _b.redactSensitiveKeys) {
-        return ctx.utils.redactSensitiveKeys(headers);
-    }
-    else {
-        return headers;
-    }
-}

package/dist/esm/utils/source-dir.d.ts

@@ -1 +0,0 @@
-export declare const sourceDir: string;

package/dist/esm/utils/source-dir.js

@@ -1,4 +0,0 @@
-import * as path from 'path';
-import * as url from 'url';
-// @ts-ignore to get the CommonJS build to ignore it
-export const sourceDir = path.resolve(url.fileURLToPath(new URL('.', import.meta.url)), '..');

package/dist/esm/utils/typed-api.d.ts

@@ -1,2 +0,0 @@
-import { ContextApiWithRoot, SchemasByScope } from '../models/common.js';
-export declare function getTypedApiFactory<TSchema extends SchemasByScope>(): (api: unknown) => ContextApiWithRoot<TSchema>;

package/dist/esm/utils/typed-api.js

@@ -1,3 +0,0 @@
-export function getTypedApiFactory() {
-    return (api) => api;
-}

package/dist/esm/utils/validate.d.ts

@@ -1,4 +0,0 @@
-export declare function validateArgs<TParams>(args: TParams, schema: object): string | false;
-export declare function encodePathParams<TParams extends {}>(params: TParams): Record<string, any>;
-export declare function getPathParam(value: string): string;
-export declare function getPathArgsProxy<TParams extends {}>(args: TParams, encodePathArgs?: boolean): TParams;

package/dist/esm/utils/validate.js

@@ -1,47 +0,0 @@
-import { Ajv } from 'ajv';
-export function validateArgs(args, schema) {
-    const ajv = new Ajv();
-    const validate = ajv.compile(schema);
-    return validate(args) ? false : ajv.errorsText(validate.errors);
-}
-export function encodePathParams(params) {
-    const encodedParams = {};
-    Object.keys(params).forEach((key) => {
-        const value = params[key];
-        if (value instanceof Buffer) {
-            encodedParams[key] = value;
-        }
-        else if (typeof value === 'object' && value !== null) {
-            encodedParams[key] = encodePathParams(value);
-        }
-        else {
-            encodedParams[key] = encodeURIComponent(value);
-        }
-    });
-    return encodedParams;
-}
-export function getPathParam(value) {
-    return /^((?!(\.\.|\?|#|\\|\/)).)*$/i.test(value) ? value : 'GATEWAY_INVALID_PARAM_VALUE';
-}
-export function getPathArgsProxy(args, encodePathArgs) {
-    const encodePathArgsVal = encodePathArgs !== null && encodePathArgs !== void 0 ? encodePathArgs : true;
-    if (!args) {
-        return args;
-    }
-    return new Proxy(args, {
-        get: (object, key) => {
-            const value = object[key];
-            if (value instanceof Buffer) {
-                return value;
-            }
-            if (typeof value === 'object' && value !== null) {
-                return getPathArgsProxy(value);
-            }
-            if (typeof value === 'string') {
-                const pathParam = getPathParam(value);
-                return encodePathArgsVal ? encodeURIComponent(pathParam) : pathParam;
-            }
-            return value; // TODO return error INVALID_PARAMS
-        },
-    });
-}