benchmark/lib/types.ts at main · bunsvr/benchmark · 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
140
141
142
143
144
145
146
147
148
149
export interface Expect {
    /**
     * Response body
     */
    body?: string;

    /**
     * Status code
     */
    statusCode?: number;

    /**
     *
     */
    headers?: Dict<string | string[]>;
}

export interface Test {
    /**
     * Test pathname
     */
    path: string;

    /**
     * Request method. Defaults to GET
     */
    method?: string;

    /**
     * Expect response
     */
    expect: Expect;

    /**
     * Header
     */
    headers?: Record<string, string>;

    /**
     * The body file
     */
    bodyFile?: string;

    /**
     * Test description
     */
    description: string;

    /**
     * Test name
     */
    name?: string;
}

/**
 * Config types
 */
export interface Config {
    /**
     * Boot up time in milliseconds
     */
    boot?: number;
    /**
     * Frameworks to be included
     */
    include?: string[];
    /**
     * Frameworks to be excluded
     */
    exclude?: string[];
    /**
     * All test cases
     */
    tests: Test[];
    /**
     * All scripts to run before benchmark
     */
    scripts: {
        /**
         * Use node, deno or bun or anything to run the script. Defaults to bun
         */
        type?: string;

        /**
         * Script relative path in ./scripts
         */
        file: string;
    }[];
    /**
     * Bombardier options
     */
    command: {
        connections: number;
        requests?: number;
        duration?: string;
        fasthttp?: boolean;
        timeout?: string;
    };
    /**
     * Additional environment variable
     */
    env?: Record<string, string>;

    /**
     * Explicitly set the package manager for installations
     */
    pkg?: 'npm' | 'yarn' | 'pnpm' | 'bun';
    /**
     * The tool to test the benchmark. Defaults to `bombardier`
     */
    cli?: string;
}
/**
 * Framework info
 */
export interface Info {
    /**
     * Required dependencies
     */
    dependencies: Record<string, string>;
    /**
     * Script to boot up args
     */
    run: [string, ...string[]];
    /**
     * A build script
     */
    build: [string, ...string[]];
    /**
     * Entry point
     */
    main: string;
    /**
     * Runtime for the framework
     */
    runtime: 'bun' | 'node' | (string & {});
    /**
     * The framework version
     */
    version: string;
    /**
     * Display homepage
     */
    homepage: string;
    /**
     * Display description
     */
    description: string;
}