openapi-static-validator/src/tests/queryParameterCoercion.test.ts at fbc5010ffec9bc7b1c3b1f1084d21f3fc3fff05c · GitbookIO/openapi-static-validator · GitHub

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
import { expect, test } from 'bun:test';
import { Compiler } from '../compiler';
import type { OpenAPISpec } from '../types';

type ValidateRequest = (request: {
    method: string;
    path: string;
    query: Record<string, string | string[]>;
    headers: Record<string, string>;
    body?: unknown;
}) => {
    operationId?: string;
    query: Record<string, unknown>;
};

function buildSpec(): OpenAPISpec {
    return {
        paths: {
            '/inline-array': {
                get: {
                    operationId: 'inlineArray',
                    parameters: [
                        {
                            name: 'addons',
                            in: 'query',
                            schema: {
                                type: 'array',
                                items: {
                                    type: 'string',
                                },
                            },
                        },
                    ],
                },
            },
            '/ref-array': {
                get: {
                    operationId: 'refArray',
                    parameters: [
                        {
                            name: 'addons',
                            in: 'query',
                            schema: {
                                $ref: '#/components/schemas/AddonsQuery',
                            },
                        },
                    ],
                },
            },
            '/non-array': {
                get: {
                    operationId: 'nonArray',
                    parameters: [
                        {
                            name: 'addons',
                            in: 'query',
                            schema: {
                                type: 'string',
                            },
                        },
                    ],
                },
            },
        },
        components: {
            schemas: {
                AddonsQuery: {
                    type: 'array',
                    items: {
                        type: 'string',
                    },
                },
            },
        },
    };
}

function compileValidator(spec: OpenAPISpec) {
    const code = new Compiler(spec).compile();
    const runtimeCode = code.replace(/^export /gm, '');
    const factory = new Function(`${runtimeCode}\nreturn { validateRequest };`) as () => {
        validateRequest: ValidateRequest;
    };

    return {
        code,
        validateRequest: factory().validateRequest,
    };
}

test('query string is coerced to array for inline array schema', () => {
    const { validateRequest } = compileValidator(buildSpec());
    const result = validateRequest({
        path: '/inline-array',
        method: 'get',
        headers: {},
        query: {
            addons: 'translation_words',
        },
    });

    expect(result.query).toEqual({ addons: ['translation_words'] });
});

test('query string is coerced to array for $ref array schema', () => {
    const { validateRequest } = compileValidator(buildSpec());
    const result = validateRequest({
        path: '/ref-array',
        method: 'get',
        headers: {},
        query: {
            addons: 'translation_words',
        },
    });

    expect(result.query).toEqual({ addons: ['translation_words'] });
});

test('query string is not coerced for non-array schema', () => {
    const { validateRequest } = compileValidator(buildSpec());
    const result = validateRequest({
        path: '/non-array',
        method: 'get',
        headers: {},
        query: {
            addons: 'translation_words',
        },
    });

    expect(result.query).toEqual({ addons: 'translation_words' });
});

test('compiled validator includes coercion for inline and $ref array schemas only', () => {
    const { code } = compileValidator(buildSpec());
    const coercionMatches = code.match(/queryParam0 = \[queryParam0\];/g) ?? [];

    expect(code).toContain("if (typeof queryParam0 === 'string')");
    expect(coercionMatches).toHaveLength(2);
});