Class Server

An HTTP server instance that allows to control the tool using a REST interface. Moreover, it allows to aggregate stats data coming from multiple running tool instances.

Constructors

constructor

new Server(__namedParameters?, stats): Server
Server instance. All the HTTP endpoints are protected by basic authentication with user admin and password Server.serverSecret.
Parameters
- __namedParameters: {
      pageLogPath: undefined | string;
      serverData: undefined | string;
      serverPort: undefined | number;
      serverSecret: undefined | string;
      serverUseHttps: undefined | boolean;
  } = {}
  - pageLogPath: undefined | string
  - serverData: undefined | string
  - serverPort: undefined | number
  - serverSecret: undefined | string
  - serverUseHttps: undefined | boolean
- stats: Stats
  A Stats class instance.
Returns Server
- Defined in src/server.ts:55

Properties

pageLogPath

pageLogPath: string

The file path that will be used to serve the /view/page.log requests.

serverData

serverData: string

An optional path that the HTTP server will expose with the /data endpoint.

`Readonly` serverPort

serverPort: number

The server listening port.

`Readonly` serverSecret

serverSecret: string

The basic auth secret.

`Readonly` serverUseHttps

serverUseHttps: boolean

If HTTPS protocol should be used.

stats

stats: Stats

A Stats class instance.

Methods

`Private` deleteSession

deleteSession(req, res, next): Promise<void>
DELETE /session endpoint.

Delete the Session instance identified by the body.id param.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns Promise<void>
- Defined in src/server.ts:342

`Private` deleteSessions

deleteSessions(req, res, next): Promise<void>
DELETE /sessions endpoint.

Delete the Session instances specified by the body.ids array.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns Promise<void>
- Defined in src/server.ts:365

`Private` getAlertRules

getAlertRules(req, res, next): void
GET /download/alert-rules endpoint.

Downloads the alert rules report stored into the Stats.alertRulesFilename.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns void
- Defined in src/server.ts:442

`Private` getCollectedStats

getCollectedStats(req, res, next): void
GET /collected-stats endpoint.

Returns a JSON array of the last statistics collected from external running tools.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns void
- Defined in src/server.ts:212

`Private` getData

getData(req, res, next): void
GET /data/* endpoint.

Returns the file content relative to the Config serverData path. If the requested path points to a directory, it returns the directory content in tar.gz format.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns void
- Defined in src/server.ts:480

`Private` getDetailedStatsFile

getDetailedStatsFile(req, res, next): void
GET /download/detailed-stats endpoint.

Returns the Stats.detailedStatsWriter file content.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns void
- Defined in src/server.ts:194

`Private` getDockerLog

getDockerLog(req, res, next): Promise<void>
GET /view/docker.log endpoint.

Returns the Docker logs related to the container running the tool. It requires to run the Docker container with the following options:
```
  --cidfile /tmp/docker.id
  -v /tmp/docker.id:/root/.webrtcperf/docker.id:ro
  -v /var/lib/docker:/var/lib/docker:ro
```
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns Promise<void>
- Defined in src/server.ts:416

`Private` getEmptyPage

getEmptyPage(req, res): void
GET /empty-page endpoint.

Returns an empty HTML page. Useful for running tests with raw Javascript content without any DOM rendering.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
Returns void
- Defined in src/server.ts:460

`Private` getPageLog

getPageLog(req, res, next): void
GET /view/page.log endpoint.

Returns the page log file content as specified in Config pageLogPath.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns void
- Defined in src/server.ts:390

`Private` getScreenshot

getScreenshot(req, res, next): Promise<void>
GET /screenshot/ endpoint.

Returns the page screenshot running inside the Session identified by sessionID. Additional query params:
- page: the page number (starting from 0) running inside the Session.
- format: the image format (jpeg, png, webp). Default: webp.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns Promise<void>
- Defined in src/server.ts:240

`Private` getStats

getStats(req, res, next): Promise<void>
GET /stats endpoint.

Returns a JSON array of the last statistics for each running Session.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns Promise<void>
- Defined in src/server.ts:155

`Private` getStatsFile

getStatsFile(req, res, next): void
GET /download/stats endpoint.

Returns the Stats.statsWriter file content.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns void
- Defined in src/server.ts:177

`Private` putCollectedStats

putCollectedStats(req, res, next): void
PUT /collected-stats endpoint.

Allows to inject Stats metrics coming from an external tool.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns void
- Defined in src/server.ts:266

`Private` putSession

putSession(req, res, next): Promise<void>
PUT /session endpoint.

Starts a new Session. The request body format will be parsed as a SessionParams object.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns Promise<void>
- Defined in src/server.ts:289

`Private` putSessions

putSessions(req, res, next): Promise<void>
PUT /sessions endpoint.

Starts multiple Session instances as specified into the body.sessions value. The request body will be parsed as a SessionParams object.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- next: NextFunction
Returns Promise<void>
- Defined in src/server.ts:314

start

start(): Promise<void>
Starts the Server instance.

Returns Promise<void>
- Defined in src/server.ts:557

`Private` startLocalSession

startLocalSession(id, config): Promise<Session>
Starts a new Session instance.
Parameters
- id: number
  The session unique id.
- config: SessionParams
  The session configuration.
Returns Promise<Session>
- Defined in src/server.ts:513

stop

stop(): void
Stops the Server instance.

Returns void
- Defined in src/server.ts:691

`Private` stopLocalSession

stopLocalSession(id): Promise<void>
Stops a new Session instance.
Parameters
- id: number
  The session unique id.
Returns Promise<void>
- Defined in src/server.ts:543

Class Server

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

pageLogPath: undefined | string

serverData: undefined | string

serverPort: undefined | number

serverSecret: undefined | string

serverUseHttps: undefined | boolean

Returns Server

Properties

pageLogPath

serverData

Readonly serverPort

Readonly serverSecret

Readonly serverUseHttps

stats

Methods

Private deleteSession

Parameters

Returns Promise<void>

Private deleteSessions

Parameters

Returns Promise<void>

Private getAlertRules

Parameters

Returns void

Private getCollectedStats

Parameters

Returns void

Private getData

Parameters

Returns void

Private getDetailedStatsFile

Parameters

Returns void

Private getDockerLog

Parameters

Returns Promise<void>

Private getEmptyPage

Parameters

Returns void

Private getPageLog

Parameters

Returns void

Private getScreenshot

Parameters

Returns Promise<void>

Private getStats

Parameters

Returns Promise<void>

Private getStatsFile

Parameters

Returns void

Private putCollectedStats

Parameters

Returns void

Private putSession

Parameters

Returns Promise<void>

Private putSessions

Parameters

Returns Promise<void>

start

Returns Promise<void>

Private startLocalSession

Parameters

Returns Promise<Session>

stop

Returns void

Private stopLocalSession

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` serverPort

`Readonly` serverSecret

`Readonly` serverUseHttps

`Private` deleteSession

`Private` deleteSessions

`Private` getAlertRules

`Private` getCollectedStats

`Private` getData

`Private` getDetailedStatsFile

`Private` getDockerLog

`Private` getEmptyPage

`Private` getPageLog

`Private` getScreenshot

`Private` getStats

`Private` getStatsFile

`Private` putCollectedStats

`Private` putSession

`Private` putSessions

`Private` startLocalSession

`Private` stopLocalSession