@senacor/azure-function-middleware/dist/validation/requestQueryParamsValidation.test.js

Middleware for azure functions to handle authentication, authorization, error handling and logging

"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const functions_1 = require("@azure/functions");
const joi_1 = __importDefault(require("joi"));
const requestQueryParamsValidation_1 = require("./requestQueryParamsValidation");
describe('requestQueryParamsValidation should', () => {
    const context = new functions_1.InvocationContext();
    const exampleSchema = joi_1.default.object({ status: joi_1.default.string().valid('active', 'expired').optional() });
    test.each([{ status: 'active' }, {}, undefined])('accept valid query params %s', (queryParams) => __awaiter(void 0, void 0, void 0, function* () {
        const validator = (0, requestQueryParamsValidation_1.requestQueryParamsValidation)(exampleSchema);
        yield expect(validator(createRequest(queryParams), context, { $failed: false, $result: undefined })).resolves.toBeUndefined();
    }));
    test('successfully validate query params with joi validation options', () => __awaiter(void 0, void 0, void 0, function* () {
        const validator = (0, requestQueryParamsValidation_1.requestQueryParamsValidation)(exampleSchema, { joiValidationOptions: { allowUnknown: true } });
        yield expect(validator(createRequest({ unknownValue: 'yes' }), context, { $failed: false, $result: undefined })).resolves.toBeUndefined();
    }));
    test('throw error if the query params do not match the given schema', () => __awaiter(void 0, void 0, void 0, function* () {
        const validator = (0, requestQueryParamsValidation_1.requestQueryParamsValidation)(exampleSchema);
        yield expect(validator(createRequest({ status: 'invalid' }), context, { $failed: false, $result: undefined })).rejects.toMatchObject({
            message: 'Request query params validation error',
            status: 400,
            body: { message: '"status" must be one of [active, expired]' },
        });
    }));
    test('throw error if the query params do not match the given schema and transform error message correctly', () => __awaiter(void 0, void 0, void 0, function* () {
        const validator = (0, requestQueryParamsValidation_1.requestQueryParamsValidation)(exampleSchema, {
            transformErrorMessage: () => `Custom error message`,
        });
        yield expect(validator(createRequest({ status: 'invalid' }), context, { $failed: false, $result: undefined })).rejects.toMatchObject({
            message: 'Request query params validation error',
            status: 400,
            body: 'Custom error message',
        });
    }));
    test('throw no error if the query params do not match the given schema and shouldThrowOnValidationError = false', () => __awaiter(void 0, void 0, void 0, function* () {
        const validator = (0, requestQueryParamsValidation_1.requestQueryParamsValidation)(exampleSchema, { shouldThrowOnValidationError: false });
        yield expect(validator(createRequest({ status: 'invalid' }), context, { $failed: false, $result: undefined })).resolves.toBeUndefined();
    }));
    test('ignore code query param per default', () => __awaiter(void 0, void 0, void 0, function* () {
        const validator = (0, requestQueryParamsValidation_1.requestQueryParamsValidation)(exampleSchema);
        yield expect(validator(createRequest({ status: 'active', code: 'secret-function-key' }), context, {
            $failed: false,
            $result: undefined,
        })).resolves.toBeUndefined();
    }));
    test('throw error if code query param is present and excludeCodeFromValidation = false', () => __awaiter(void 0, void 0, void 0, function* () {
        const validator = (0, requestQueryParamsValidation_1.requestQueryParamsValidation)(exampleSchema, {
            queryParamsToExcludeFromValidation: [],
        });
        yield expect(() => validator(createRequest({ status: 'active', code: 'secret-function-key' }), context, {
            $failed: false,
            $result: undefined,
        })).rejects.toThrow('Request query params validation error');
    }));
});
function createRequest(query) {
    return new functions_1.HttpRequest({
        url: 'http://localhost:8080',
        method: 'GET',
        query,
    });
}