Skip to content

Commit 7e3771e

Browse files
nakrovatinakrovati
committed
refactor(web-ts): improve code according to Typescript styleguide
1 parent a170a21 commit 7e3771e

14 files changed

+94
-94
lines changed

‎webdriver-ts/src/benchmarkRunner.ts

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import yargs from "yargs";
22
import {
33
BenchmarkOptions,
4-
BENCHMARK_RUNNER,
4+
BenchmarkRunner,
55
config,
66
ErrorAndWarning,
77
FrameworkData,
@@ -32,13 +32,13 @@ function forkAndCallBenchmark(
3232
let forkedRunner = null;
3333
if (benchmarkInfo.type === BenchmarkType.STARTUP_MAIN) {
3434
forkedRunner = "dist/forkedBenchmarkRunnerLighthouse.js";
35-
} else if (config.BENCHMARK_RUNNER == BENCHMARK_RUNNER.WEBDRIVER_CDP) {
35+
} else if (config.BENCHMARK_RUNNER == BenchmarkRunner.WEBDRIVER_CDP) {
3636
forkedRunner = "dist/forkedBenchmarkRunnerWebdriverCDP.js";
37-
} else if (config.BENCHMARK_RUNNER == BENCHMARK_RUNNER.PLAYWRIGHT) {
37+
} else if (config.BENCHMARK_RUNNER == BenchmarkRunner.PLAYWRIGHT) {
3838
forkedRunner = "dist/forkedBenchmarkRunnerPlaywright.js";
39-
} else if (config.BENCHMARK_RUNNER == BENCHMARK_RUNNER.WEBDRIVER) {
39+
} else if (config.BENCHMARK_RUNNER == BenchmarkRunner.WEBDRIVER) {
4040
forkedRunner = "dist/forkedBenchmarkRunnerWebdriver.js";
41-
} else if (config.BENCHMARK_RUNNER == BENCHMARK_RUNNER.WEBDRIVER_AFTERFRAME) {
41+
} else if (config.BENCHMARK_RUNNER == BenchmarkRunner.WEBDRIVER_AFTERFRAME) {
4242
forkedRunner = "dist/forkedBenchmarkRunnerWebdriverAfterframe.js";
4343
} else {
4444
forkedRunner = "dist/forkedBenchmarkRunnerPuppeteer.js";
@@ -320,21 +320,21 @@ async function main() {
320320
let runner = args.runner;
321321
if (
322322
[
323-
BENCHMARK_RUNNER.WEBDRIVER_CDP,
324-
BENCHMARK_RUNNER.WEBDRIVER,
325-
BENCHMARK_RUNNER.WEBDRIVER_AFTERFRAME,
326-
BENCHMARK_RUNNER.PLAYWRIGHT,
327-
BENCHMARK_RUNNER.PUPPETEER,
323+
BenchmarkRunner.WEBDRIVER_CDP,
324+
BenchmarkRunner.WEBDRIVER,
325+
BenchmarkRunner.WEBDRIVER_AFTERFRAME,
326+
BenchmarkRunner.PLAYWRIGHT,
327+
BenchmarkRunner.PUPPETEER,
328328
].includes(runner)
329329
) {
330330
console.log(`INFO: Using ${runner} benchmark runner`);
331331
config.BENCHMARK_RUNNER = runner;
332332
} else {
333333
console.log("ERROR: argument driver has illegal value " + runner, [
334-
BENCHMARK_RUNNER.WEBDRIVER_CDP,
335-
BENCHMARK_RUNNER.WEBDRIVER,
336-
BENCHMARK_RUNNER.PLAYWRIGHT,
337-
BENCHMARK_RUNNER.PUPPETEER,
334+
BenchmarkRunner.WEBDRIVER_CDP,
335+
BenchmarkRunner.WEBDRIVER,
336+
BenchmarkRunner.PLAYWRIGHT,
337+
BenchmarkRunner.PUPPETEER,
338338
]);
339339
process.exit(1);
340340
}
@@ -381,7 +381,7 @@ async function main() {
381381
let runBenchmarks: Array<BenchmarkInfo> = benchmarkInfos.filter(
382382
(b) =>
383383
// afterframe currently only targets CPU benchmarks
384-
(config.BENCHMARK_RUNNER !== BENCHMARK_RUNNER.WEBDRIVER_AFTERFRAME ||
384+
(config.BENCHMARK_RUNNER !== BenchmarkRunner.WEBDRIVER_AFTERFRAME ||
385385
b.type == BenchmarkType.CPU) &&
386386
runBenchmarksArgs.some((name) => b.id.toLowerCase().indexOf(name) > -1)
387387
);
@@ -390,7 +390,7 @@ async function main() {
390390
let matchesDirectoryArg = (directoryName: string) =>
391391
frameworkArgument.length == 0 || frameworkArgument.some((arg: string) => arg == directoryName);
392392
runFrameworks = (await initializeFrameworks(benchmarkOptions, matchesDirectoryArg)).filter(
393-
(f) => f.keyed || config.BENCHMARK_RUNNER !== BENCHMARK_RUNNER.WEBDRIVER_AFTERFRAME
393+
(f) => f.keyed || config.BENCHMARK_RUNNER !== BenchmarkRunner.WEBDRIVER_AFTERFRAME
394394
);
395395

396396
console.log("ARGS.smotest", args.smoketest);
@@ -406,7 +406,7 @@ async function main() {
406406
});
407407
console.log("Using smoketest config ", JSON.stringify(config));
408408
}
409-
if (config.BENCHMARK_RUNNER == BENCHMARK_RUNNER.WEBDRIVER_AFTERFRAME) {
409+
if (config.BENCHMARK_RUNNER == BenchmarkRunner.WEBDRIVER_AFTERFRAME) {
410410
benchmarkOptions.resultsDirectory = "results_client_" + benchmarkOptions.browser;
411411
}
412412
if (!fs.existsSync(benchmarkOptions.resultsDirectory))

‎webdriver-ts/src/benchmarksCommon.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export const BENCHMARK_26 = "26_run-10k-memory";
7474

7575
export const BENCHMARK_30 = "30_startup";
7676

77-
export type TBenchmarkID =
77+
export type BenchmarkId =
7878
| typeof BENCHMARK_01
7979
| typeof BENCHMARK_02
8080
| typeof BENCHMARK_03

‎webdriver-ts/src/benchmarksPlaywright.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export abstract class MemBenchmarkPlaywright implements benchmarksCommon.Benchma
2727
abstract run(browser: Browser, page: Page, framework: FrameworkData): Promise<any>;
2828
}
2929

30-
export type TBenchmarkPlaywright = CPUBenchmarkPlaywright | MemBenchmarkPlaywright;
30+
export type BenchmarkPlaywright = CPUBenchmarkPlaywright | MemBenchmarkPlaywright;
3131

3232
export let benchRun = new (class extends CPUBenchmarkPlaywright {
3333
constructor() {

‎webdriver-ts/src/benchmarksPuppeteer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export abstract class MemBenchmarkPuppeteer implements benchmarksCommon.Benchmar
2727
abstract run(page: Page, framework: FrameworkData): Promise<any>;
2828
}
2929

30-
export type TBenchmarkPuppeteer = CPUBenchmarkPuppeteer | MemBenchmarkPuppeteer;
30+
export type BenchmarkPuppeteer = CPUBenchmarkPuppeteer | MemBenchmarkPuppeteer;
3131

3232
export let benchRun = new (class extends CPUBenchmarkPuppeteer {
3333
constructor() {

‎webdriver-ts/src/common.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
export interface JSONResultData {
1+
export interface JsonResultData {
22
min: number;
33
max: number;
44
mean: number;
@@ -7,18 +7,18 @@ export interface JSONResultData {
77
values: Array<number>;
88
}
99

10-
export interface JSONResultMap {
11-
[key: string]: JSONResultData;
10+
export interface JsonResultMap {
11+
[key: string]: JsonResultData;
1212
}
13-
export interface JSONResult {
13+
export interface JsonResult {
1414
framework: string;
1515
keyed: boolean;
1616
benchmark: string;
1717
type: string;
18-
values: JSONResultMap;
18+
values: JsonResultMap;
1919
}
2020

21-
export type TBenchmarkStatus = "OK" | "TEST_FAILED" | "TECHNICAL_ERROR";
21+
export type BenchmarkStatus = "OK" | "TEST_FAILED" | "TECHNICAL_ERROR";
2222

2323
export interface ErrorAndWarning<T> {
2424
error: string;
@@ -51,7 +51,7 @@ export interface BenchmarkOptions {
5151
HOST: 'localhost',
5252
*/
5353

54-
export enum BENCHMARK_RUNNER {
54+
export enum BenchmarkRunner {
5555
PUPPETEER = "puppeteer",
5656
PLAYWRIGHT = "playwright",
5757
WEBDRIVER_CDP = "webdrivercdp",
@@ -75,9 +75,9 @@ export let config = {
7575
STARTUP_SLEEP_DURATION: 1000,
7676
WRITE_RESULTS: true,
7777
ALLOW_BATCHING: true,
78-
BENCHMARK_RUNNER: BENCHMARK_RUNNER.PUPPETEER,
78+
BENCHMARK_RUNNER: BenchmarkRunner.PUPPETEER,
7979
};
80-
export type TConfig = typeof config;
80+
export type Config = typeof config;
8181

8282
export interface FrameworkData {
8383
name: string;
@@ -108,11 +108,11 @@ export interface FrameworkInformation {
108108
frameworkHomeURL: string;
109109
}
110110

111-
export interface IMatchPredicate {
111+
export interface MatchPredicate {
112112
(frameworkDirectory: string): boolean;
113113
}
114114

115-
const matchAll: IMatchPredicate = () => true;
115+
const matchAll: MatchPredicate = () => true;
116116

117117
async function fetchFrameworks(url: string) {
118118
try {
@@ -131,7 +131,7 @@ async function fetchFrameworks(url: string) {
131131

132132
export async function initializeFrameworks(
133133
benchmarkOptions: BenchmarkOptions,
134-
matchPredicate: IMatchPredicate = matchAll
134+
matchPredicate: MatchPredicate = matchAll
135135
): Promise<FrameworkData[]> {
136136
let lsResult;
137137
const lsUrl = `http://${benchmarkOptions.host}:${benchmarkOptions.port}/ls`;

‎webdriver-ts/src/createResultJS.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {
88
slowDownFactor,
99
} from "./benchmarksCommon.js";
1010
import { subbenchmarks } from "./benchmarksLighthouse.js";
11-
import { BenchmarkOptions, config, initializeFrameworks, JSONResult } from "./common.js";
11+
import { BenchmarkOptions, config, initializeFrameworks, JsonResult } from "./common.js";
1212

1313
let args: any = yargs(process.argv)
1414
.usage(
@@ -71,7 +71,7 @@ async function main() {
7171
let name = `${fileName(framework, benchmarkInfo)}`;
7272
let file = `${resultsDirectory}/${name}`;
7373
if (fs.existsSync(file)) {
74-
let data: JSONResult = JSON.parse(
74+
let data: JsonResult = JSON.parse(
7575
fs.readFileSync(file, {
7676
encoding: "utf-8",
7777
})

‎webdriver-ts/src/forkedBenchmarkRunnerLighthouse.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as chromeLauncher from "chrome-launcher";
22

33
import {
4-
TConfig,
4+
Config,
55
config as defaultConfig,
66
FrameworkData,
77
ErrorAndWarning,
@@ -11,7 +11,7 @@ import { BenchmarkLighthouse, StartupBenchmarkResult, benchmarks } from "./bench
1111
import { StartupBenchmarkInfo } from "./benchmarksCommon.js";
1212
import lighthouse from "lighthouse";
1313

14-
let config: TConfig = defaultConfig;
14+
let config: Config = defaultConfig;
1515

1616
function extractRawValue(results: any, id: string) {
1717
let audits = results.audits;

‎webdriver-ts/src/forkedBenchmarkRunnerPlaywright.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@ import {
44
benchmarks,
55
CPUBenchmarkPlaywright,
66
MemBenchmarkPlaywright,
7-
TBenchmarkPlaywright,
7+
BenchmarkPlaywright,
88
} from "./benchmarksPlaywright.js";
99
import {
1010
BenchmarkOptions,
1111
config as defaultConfig,
1212
ErrorAndWarning,
1313
FrameworkData,
14-
TConfig,
14+
Config,
1515
} from "./common.js";
1616
import { startBrowser } from "./playwrightAccess.js";
1717
import { computeResultsCPU, fileNameTrace } from "./timeline.js";
1818

19-
let config: TConfig = defaultConfig;
19+
let config: Config = defaultConfig;
2020

2121
async function runBenchmark(
2222
browser: Browser,
2323
page: Page,
24-
benchmark: TBenchmarkPlaywright,
24+
benchmark: BenchmarkPlaywright,
2525
framework: FrameworkData
2626
): Promise<any> {
2727
await benchmark.run(browser, page, framework);
@@ -32,7 +32,7 @@ async function runBenchmark(
3232
async function initBenchmark(
3333
browser: Browser,
3434
page: Page,
35-
benchmark: TBenchmarkPlaywright,
35+
benchmark: BenchmarkPlaywright,
3636
framework: FrameworkData
3737
): Promise<any> {
3838
await benchmark.init(browser, page, framework);
@@ -276,11 +276,11 @@ export async function executeBenchmark(
276276
benchmarkId: string,
277277
benchmarkOptions: BenchmarkOptions
278278
): Promise<ErrorAndWarning<number | CPUBenchmarkResult>> {
279-
let runBenchmarks: Array<TBenchmarkPlaywright> = benchmarks.filter(
279+
let runBenchmarks: Array<BenchmarkPlaywright> = benchmarks.filter(
280280
(b) =>
281281
benchmarkId === b.benchmarkInfo.id &&
282282
(b instanceof CPUBenchmarkPlaywright || b instanceof MemBenchmarkPlaywright)
283-
) as Array<TBenchmarkPlaywright>;
283+
) as Array<BenchmarkPlaywright>;
284284

285285
let benchmark = runBenchmarks[0];
286286

‎webdriver-ts/src/forkedBenchmarkRunnerPuppeteer.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,24 @@ import { BenchmarkType, CPUBenchmarkResult, slowDownFactor } from "./benchmarksC
33
import {
44
CPUBenchmarkPuppeteer,
55
MemBenchmarkPuppeteer,
6-
TBenchmarkPuppeteer,
6+
BenchmarkPuppeteer,
77
benchmarks,
88
} from "./benchmarksPuppeteer.js";
99
import {
1010
BenchmarkOptions,
1111
config as defaultConfig,
1212
ErrorAndWarning,
1313
FrameworkData,
14-
TConfig,
14+
Config,
1515
} from "./common.js";
1616
import { startBrowser } from "./puppeteerAccess.js";
1717
import { computeResultsCPU, computeResultsJS, fileNameTrace } from "./timeline.js";
1818

19-
let config: TConfig = defaultConfig;
19+
let config: Config = defaultConfig;
2020

2121
async function runBenchmark(
2222
page: Page,
23-
benchmark: TBenchmarkPuppeteer,
23+
benchmark: BenchmarkPuppeteer,
2424
framework: FrameworkData
2525
): Promise<any> {
2626
await benchmark.run(page, framework);
@@ -30,7 +30,7 @@ async function runBenchmark(
3030

3131
async function initBenchmark(
3232
page: Page,
33-
benchmark: TBenchmarkPuppeteer,
33+
benchmark: BenchmarkPuppeteer,
3434
framework: FrameworkData
3535
): Promise<any> {
3636
await benchmark.init(page, framework);
@@ -291,11 +291,11 @@ export async function executeBenchmark(
291291
benchmarkId: string,
292292
benchmarkOptions: BenchmarkOptions
293293
): Promise<ErrorAndWarning<any>> {
294-
let runBenchmarks: Array<TBenchmarkPuppeteer> = benchmarks.filter(
294+
let runBenchmarks: Array<BenchmarkPuppeteer> = benchmarks.filter(
295295
(b) =>
296296
benchmarkId === b.benchmarkInfo.id &&
297297
(b instanceof CPUBenchmarkPuppeteer || b instanceof MemBenchmarkPuppeteer)
298-
) as Array<TBenchmarkPuppeteer>;
298+
) as Array<BenchmarkPuppeteer>;
299299
if (runBenchmarks.length != 1) throw `Benchmark name ${benchmarkId} is not unique (puppeteer)`;
300300

301301
let benchmark = runBenchmarks[0];

0 commit comments

Comments
 (0)