@vpalmisano/webrtcperf 4.0.0

package/build/src/server.d.ts

@@ -0,0 +1,173 @@
+import { Stats } from './stats';
+/**
+ * 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.
+ */
+export declare class Server {
+    /** The server listening port. */
+    readonly serverPort: number;
+    /** The basic auth secret. */
+    readonly serverSecret: string;
+    /** If HTTPS protocol should be used. */
+    readonly serverUseHttps: boolean;
+    /** An optional path that the HTTP server will expose with the /data endpoint. */
+    serverData: string;
+    /** The file path that will be used to serve the \`/view/page.log\` requests. */
+    pageLogPath: string;
+    /** The path that will be used to serve the \`/cache\` requests. */
+    videoCachePath: string;
+    /** A {@link Stats} class instance. */
+    stats: Stats;
+    private app;
+    private server;
+    private wss;
+    /**
+     * Server instance.
+     * All the HTTP endpoints are protected by basic authentication with user
+     * `admin` and password {@link Server.serverSecret}.
+     * @param serverPort The server listening port.
+     * @param serverSecret The basic auth secret.
+     * @param serverUseHttps If HTTPS protocol should be used.
+     * @param serverData An optional path that the HTTP server will expose with the /data endpoint.
+     * @param pageLogPath The file path that will be used to serve the \`/view/page.log\` requests.
+     * @param videoCachePath The path that will be used to serve the \`/cache\` requests.
+     * @param stats A {@link Stats} class instance.
+     */
+    constructor({ serverPort, serverSecret, serverUseHttps, serverData, pageLogPath, videoCachePath, }: {
+        serverPort?: number | undefined;
+        serverSecret?: string | undefined;
+        serverUseHttps?: boolean | undefined;
+        serverData?: string | undefined;
+        pageLogPath?: string | undefined;
+        videoCachePath?: string | undefined;
+    } | undefined, stats: Stats);
+    /**
+     * GET /stats endpoint.
+     *
+     * Returns a JSON array of the last statistics for each running Session.
+     */
+    private getStats;
+    /**
+     * GET /download/stats endpoint.
+     *
+     * Returns the {@link Stats.statsWriter} file content.
+     */
+    private getStatsFile;
+    /**
+     * GET /download/detailed-stats endpoint.
+     *
+     * Returns the {@link Stats.detailedStatsWriter} file content.
+     */
+    private getDetailedStatsFile;
+    /**
+     * GET /collected-stats endpoint.
+     *
+     * Returns a JSON array of the last statistics collected from external running
+     * tools.
+     */
+    private getCollectedStats;
+    /**
+     * GET /screenshot/<sessionID> endpoint.
+     *
+     * Returns the page screenshot running inside the {@link Session} identified
+     * by `sessionID`.
+     * Additional query params:
+     * - `page`: the page number (starting from `0`) running inside the {@link Session}.
+     * - `format`: the image format (`jpeg`, `png`, `webp`). Default: `webp`.
+     */
+    private getScreenshot;
+    /**
+     * PUT /collected-stats endpoint.
+     *
+     * Allows to inject {@link Stats} metrics coming from an external tool.
+     */
+    private putCollectedStats;
+    /**
+     * PUT /session endpoint.
+     *
+     * Starts a new {@link Session}.
+     * The request body format will be parsed as a {@link SessionParams} object.
+     */
+    private putSession;
+    /**
+     * PUT /sessions endpoint.
+     *
+     * Starts multiple {@link Session} instances as specified into the
+     * `body.sessions` value.
+     * The request body will be parsed as a {@link SessionParams} object.
+     */
+    private putSessions;
+    /**
+     * DELETE /session endpoint.
+     *
+     * Delete the {@link Session} instance identified by the `body.id` param.
+     */
+    private deleteSession;
+    /**
+     * DELETE /sessions endpoint.
+     *
+     * Delete the {@link Session} instances specified by the `body.ids` array.
+     */
+    private deleteSessions;
+    /**
+     * GET /view/page.log endpoint.
+     *
+     * Returns the page log file content as specified in {@link Config} `pageLogPath`.
+     */
+    private getPageLog;
+    /**
+     * 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
+     * ```
+     */
+    private getDockerLog;
+    /**
+     * GET /download/alert-rules endpoint.
+     *
+     * Downloads the alert rules report stored into the {@link Stats.alertRulesFilename}.
+     */
+    private getAlertRules;
+    /**
+     * GET /empty-page endpoint.
+     *
+     * Returns an empty HTML page. Useful for running tests with raw Javascript
+     * content without any DOM rendering.
+     */
+    private getEmptyPage;
+    /**
+     * GET /data/* endpoint.
+     *
+     * Returns the file content relative to the {@link Config} `serverData` path.
+     * If the requested path points to a directory, it returns the directory
+     * content in tar.gz format.
+     */
+    private getData;
+    private getDataArchive;
+    private getCache;
+    /**
+     * Starts a new {@link Session} instance.
+     * @param id The session unique id.
+     * @param config The session configuration.
+     */
+    private startLocalSession;
+    /**
+     * Stops a new {@link Session} instance.
+     * @param {number} id The session unique id.
+     */
+    private stopLocalSession;
+    /**
+     * Starts the {@link Server} instance.
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the {@link Server} instance.
+     */
+    stop(): void;
+}