@teamscale/coverage-collector 1.0.0-beta.6 → 1.0.4

package/dist/src/control/ControlServer.js

@@ -1,100 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControlServer = void 0;
-const CoverageDumper_1 = require("../control/CoverageDumper");
-const express_1 = __importDefault(require("express"));
-/**
- * Provides a REST API for remote configuration of the collector.
- */
-class ControlServer {
-    config;
-    storage;
-    logger;
-    constructor(config, storage, logger) {
-        this.config = config;
-        this.storage = storage;
-        this.logger = logger;
-    }
-    /**
-     * Start the collector remote config API.
-     */
-    start() {
-        if (!this.config.enableControlPort) {
-            return {
-                async stop() {
-                    // nothing to stop in this case
-                }
-            };
-        }
-        const controlServer = (0, express_1.default)();
-        controlServer.use(express_1.default.text({}));
-        controlServer.use(express_1.default.urlencoded({ extended: true }));
-        const serverSocket = controlServer.listen(this.config.enableControlPort);
-        controlServer.post('/refresh/', (request, response) => this.handleRefreshConfigs(request, response));
-        controlServer.post('/dump/', (request, response) => this.handleDumpPost(request, response));
-        controlServer.post('/dump/:configId', (request, response) => this.handleDumpPostForConfig(request, response));
-        controlServer.post('/reset', (request, response) => this.handleGlobalCoverageReset(request, response));
-        controlServer.post('/reset/:configId', (request, response) => this.handleCoverageResetForConfig(request, response));
-        this.logger.info(`Control server enabled at port ${this.config.enableControlPort}.`);
-        return {
-            async stop() {
-                return new Promise(resolve => {
-                    serverSocket.close(() => resolve());
-                });
-            }
-        };
-    }
-    async handleRefreshConfigs(request, response) {
-        this.logger.info('Remote configuration refresh requested via the control API.');
-        await this.storage.refreshAllRemoteConfigurations();
-        this.logger.info('Refresh done.');
-        response.sendStatus(200);
-    }
-    async handleDumpPost(request, response) {
-        this.logger.info('Dumping coverage requested via the control API.');
-        await CoverageDumper_1.CoverageDumper.dumpCoverage(this.storage, this.logger);
-        response.sendStatus(200);
-    }
-    async handleDumpPostForConfig(request, response) {
-        return this.handleConfigScopedRequest(request, response, async (configId) => {
-            this.logger.info(`Dumping coverage requested for config '${configId}' via the control API.`);
-            const appsWithConfig = this.storage.getApplicationsWithConfig(configId);
-            for (const appId of appsWithConfig) {
-                await CoverageDumper_1.CoverageDumper.dumpCoverage(this.storage, this.logger, appId);
-            }
-        });
-    }
-    async handleGlobalCoverageReset(request, response) {
-        this.storage.discardCollectedCoverage();
-        this.logger.info(`Discarding collected coverage information as requested via the control API.`);
-        response.sendStatus(200);
-    }
-    async handleCoverageResetForConfig(request, response) {
-        return this.handleConfigScopedRequest(request, response, async (configId) => {
-            this.logger.info(`Discarding collected coverage information for config '${configId}' as requested via the control API.`);
-            const appsWithConfig = this.storage.getApplicationsWithConfig(configId);
-            for (const appId of appsWithConfig) {
-                this.storage.discardCollectedCoverage(appId);
-            }
-        });
-    }
-    async handleConfigScopedRequest(request, response, configHandler) {
-        const configId = request.params.configId;
-        if (!configId) {
-            throw new Error('Invalid config ID');
-        }
-        try {
-            await configHandler(configId);
-            response.sendStatus(200);
-        }
-        catch (error) {
-            response.set('Content-Type', 'text/plain');
-            response.send(`Failed to handle request for config '${configId}': ${error.message}`);
-            response.sendStatus(500);
-        }
-    }
-}
-exports.ControlServer = ControlServer;

package/dist/src/control/CoverageDumper.d.ts

@@ -1,27 +0,0 @@
-import { DataStorage } from '../storage/DataStorage';
-import Logger from 'bunyan';
-/**
- * Functionality for dumping coverage regularly to different targets.
- */
-export declare class CoverageDumper {
-    /**
-     * Start a timer for dumping the data, depending on the configuration;
-     * and for retrieving new configuration values from Teamscale.
-     *
-     * @param storage - The storage with the information to dump.
-     * @param logger - The logger to use.
-     */
-    static startRegularCollectorProcesses(storage: DataStorage, logger: Logger): {
-        stop: () => void;
-    };
-    /**
-     * Dump all the collected coverage. If an `onlyForAppId` is given, only for the app with that ID.
-     * If no `onlyForAppId` is given, coverage will be dumped for every application, separately.
-     */
-    static dumpCoverage(storage: DataStorage, logger: Logger, onlyForAppId?: string): Promise<void>;
-    /**
-     * Returns true if an actual upload request was sent to the remote server.
-     */
-    private static uploadCoverage;
-    private static determineCoverageTargetFolder;
-}

package/dist/src/control/CoverageDumper.js

@@ -1,166 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CoverageDumper = void 0;
-const RestApis_1 = require("../utils/RestApis");
-const TeamscaleUpload_1 = require("../upload/TeamscaleUpload");
-const ArtifactoryUpload_1 = require("../upload/ArtifactoryUpload");
-const fs_1 = __importDefault(require("fs"));
-const CONFIG_REQUERY_INTERVAL_SECONDS = 53;
-const DUMP_COVERAGE_CHECK_AFTER_SECONDS = 60;
-const CHECK_FOR_SCHEDULED_ACTIVITY_AFTER_SECONDS = 31;
-const DEFAULT_COVERAGE_DUMP_AFTER_MINS = 10;
-const STARTUP_TIMESTAMP = Date.now();
-/**
- * Functionality for dumping coverage regularly to different targets.
- */
-class CoverageDumper {
-    /**
-     * Start a timer for dumping the data, depending on the configuration;
-     * and for retrieving new configuration values from Teamscale.
-     *
-     * @param storage - The storage with the information to dump.
-     * @param logger - The logger to use.
-     */
-    static startRegularCollectorProcesses(storage, logger) {
-        const lastConfigRefreshPerApp = new Map();
-        const lastDumpTimestampPerApp = new Map();
-        const doIfExpired = async (key, lastExecutionTimestamps, doAfterMillis, action) => {
-            const lastExecutionTimestamp = lastExecutionTimestamps.get(key) ?? STARTUP_TIMESTAMP;
-            if (Date.now() - lastExecutionTimestamp > doAfterMillis) {
-                try {
-                    await action();
-                }
-                catch (error) {
-                    logger.error(`Regular collector action failed with an error: ` + error?.message);
-                    logger.error(error);
-                }
-                lastExecutionTimestamps.set(key, Date.now());
-            }
-        };
-        const timer = setInterval(async () => {
-            // 1. Re-query the profiler configurations (can be more than one,
-            // one for each application) once every minute.
-            for (const appId of storage.getApplicationIDs()) {
-                await doIfExpired(`config-update-${appId}`, lastConfigRefreshPerApp, 1000 * CONFIG_REQUERY_INTERVAL_SECONDS, async () => {
-                    await storage.refreshApplicationConfiguration(appId);
-                });
-            }
-            // 2. For each application, check if coverage shall be dumped once a minute.
-            // Each application can be configured differently, even if the same config id was assigned initially.
-            for (const appId of storage.getApplicationIDs()) {
-                const appDumpAfterMinutes = storage.getAppConfiguration(appId).dumpAfterMins ?? DEFAULT_COVERAGE_DUMP_AFTER_MINS;
-                await doIfExpired(`coverage-dump-${appId}`, lastDumpTimestampPerApp, 1000 * DUMP_COVERAGE_CHECK_AFTER_SECONDS * appDumpAfterMinutes, async () => {
-                    await this.dumpCoverage(storage, logger, appId);
-                });
-            }
-        }, 1000 * CHECK_FOR_SCHEDULED_ACTIVITY_AFTER_SECONDS);
-        // Dump the coverage before each (correct) config update.
-        storage.addBeforeConfigUpdateCallback(async (appId, dataStorage) => {
-            logger.info(`Dumping coverage before config update for application ${appId}.`);
-            await this.dumpCoverage(dataStorage, logger, appId);
-        });
-        logger.info(`Started the regular remote configuration refresh and coverage dump.`);
-        return {
-            stop: () => {
-                if (timer) {
-                    clearInterval(timer);
-                }
-            }
-        };
-    }
-    /**
-     * Dump all the collected coverage. If an `onlyForAppId` is given, only for the app with that ID.
-     * If no `onlyForAppId` is given, coverage will be dumped for every application, separately.
-     */
-    static async dumpCoverage(storage, logger, onlyForAppId) {
-        const appsToDumpFor = onlyForAppId ? [onlyForAppId] : storage.getApplicationIDs();
-        const dumpTimestamp = new Date();
-        let hadCoverageToDump = false;
-        let hadUploadSent = false;
-        for (const dumpForAppId of appsToDumpFor) {
-            const dumpConfiguration = storage.getAppConfiguration(dumpForAppId);
-            const dumpToFolder = this.determineCoverageTargetFolder(dumpForAppId, dumpConfiguration);
-            const deleteAfterUpload = !(dumpConfiguration.keepCoverageFiles ?? dumpConfiguration.dumpToFolder !== undefined);
-            try {
-                // Write coverage to a file
-                const dumpSummary = storage.dumpToSimpleCoverageFile(dumpToFolder, dumpTimestamp, dumpForAppId);
-                hadCoverageToDump = dumpSummary.hadCoverageToDump || hadCoverageToDump;
-                // Upload to Teamscale or Artifactory if configured
-                for (const { simpleCoverageFile, simpleCoverageFileLines, commit } of dumpSummary.details) {
-                    try {
-                        if (dumpConfiguration.teamscaleServerUrl || dumpConfiguration.artifactoryServerUrl) {
-                            const coverageUploaded = await this.uploadCoverage(dumpConfiguration, simpleCoverageFile, simpleCoverageFileLines, commit, logger, deleteAfterUpload);
-                            hadUploadSent = coverageUploaded || hadUploadSent;
-                        }
-                    }
-                    catch (e) {
-                        if (e instanceof RestApis_1.UploadError) {
-                            logger.error(`Coverage upload failed for application ${dumpForAppId} and commit ${commit}.\n`
-                                + `The coverage files on disk (inside the folder "${dumpToFolder}") were not deleted. `
-                                + `You can still upload them manually. Error: ${e.message}`);
-                        }
-                        else {
-                            logger.error('Coverage dump failed', e);
-                        }
-                    }
-                }
-            }
-            catch (e) {
-                logger.error(`Dumping coverage failed for application ${dumpForAppId}`, e);
-            }
-        }
-        if (hadUploadSent) {
-            logger.info(`Uploaded coverage for timestamp ${dumpTimestamp.toISOString()} to a remote server.`);
-        }
-        if (!hadCoverageToDump) {
-            logger.info('Coverage dump request was processed successfully; no new coverage to dump found.');
-        }
-    }
-    /**
-     * Returns true if an actual upload request was sent to the remote server.
-     */
-    static async uploadCoverage(config, coverageFile, lines, commit, logger, deleteAfterUpload) {
-        let uploadDone = false;
-        if (config.teamscaleServerUrl && (config.teamscaleProject ?? "").length > 0) {
-            // A Teamscale url might be configured for remote configuration. Uploads might not be intended.
-            uploadDone = await (0, TeamscaleUpload_1.uploadToTeamscale)(config, logger, coverageFile, lines, commit);
-        }
-        if (config.artifactoryServerUrl) {
-            uploadDone = uploadDone || await (0, ArtifactoryUpload_1.uploadToArtifactory)(config, logger, coverageFile, lines, commit);
-        }
-        // Delete coverage if upload was successful and keeping coverage files on disk was not configure by the user
-        if (deleteAfterUpload) {
-            fs_1.default.unlinkSync(coverageFile);
-        }
-        return uploadDone;
-    }
-    static determineCoverageTargetFolder(appId, config) {
-        const result = `${config.dumpFolder}/${makeProperDirectoryPath(config.dumpToFolder)}${appId}`;
-        fs_1.default.mkdirSync(result, { recursive: true });
-        return result;
-    }
-}
-exports.CoverageDumper = CoverageDumper;
-/**
- * Only characters that allowed in most file systems. And replace backslashes with forward slashes.
- */
-function makeProperDirectoryPath(path) {
-    if (path === undefined || path.trim().length === 0) {
-        return '';
-    }
-    // Remove leading slashes.
-    path = path.trim().replace(/^\/+/g, '');
-    // Replace backslashes with forward slashes.
-    path = path.replace(/\\/g, '/');
-    // Remove all characters that are not allowed in file paths.
-    // Important: We do not allow points in file paths to avoid directory traversal attacks/confusion.
-    path = path.replace(/[^a-zA-Z0-9\-_/]/g, '_');
-    // Ensure a trailing slash.
-    if (path.endsWith('/')) {
-        return path;
-    }
-    return `${path}/`;
-}

package/dist/src/main.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/src/main.js

@@ -1,32 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const App_1 = require("./control/App");
-const node_process_1 = __importDefault(require("node:process"));
-const commons_1 = require("@cqse/commons");
-/**
- * Start the application from its entry point function `App.run()`.
- * The present file is defined to be the main file of the collector in `package.json`.
- */
-(async () => {
-    const app = await App_1.App.run();
-    const handleExit = async () => {
-        await app.stop();
-        node_process_1.default.exit();
-    };
-    // Graceful termination on CTRL+C and SIGTERM.
-    node_process_1.default.on('SIGINT', () => handleExit());
-    node_process_1.default.on('SIGTERM', () => handleExit());
-})().catch(reason => {
-    if (reason instanceof commons_1.InvalidConfigurationException) {
-        // Do not print the stack trace for invalid configuration parameters from the user.
-        console.error(`Failed: ${reason.message}`);
-    }
-    else {
-        console.error('Failed: ', reason);
-    }
-    node_process_1.default.exit(1);
-});

package/dist/src/receiver/CollectingServer.d.ts

@@ -1,73 +0,0 @@
-import { DataStorage } from '../storage/DataStorage';
-import Logger from 'bunyan';
-/**
- * A WebSocket based implementation of a coverage receiver.
- * Receives coverage from instrumented JavaScript code.
- */
-export declare class WebSocketCollectingServer {
-    /**
-     * The WebSocket server component.
-     */
-    private server;
-    /**
-     * The storage to put the received coverage information to for aggregation and further processing.
-     */
-    private readonly storage;
-    /**
-     * The logger to use.
-     */
-    private readonly logger;
-    /**
-     * The number of messages that have been received.
-     */
-    private totalNumMessagesReceived;
-    /**
-     * The number of coverage messages that have been received.
-     */
-    private totalNumCoverageMessagesReceived;
-    /**
-     * Constructor.
-     *
-     * @param port - The port the WebSocket server should listen on.
-     * @param storage - The storage to put the received coverage information to.
-     * @param logger - The logger to use.
-     */
-    constructor(port: number, storage: DataStorage, logger: Logger);
-    /**
-     * Start the server socket, handle sessions and dispatch messages.
-     */
-    start(): {
-        stop: () => void;
-    };
-    /**
-     * Handle a message from a client.
-     *
-     * @param session - The session that has been started for the client.
-     * @param message - The message to handle.
-     */
-    private handleMessage;
-    /**
-     * Handle a message with coverage information.
-     *
-     * @param session - The session to handle the message for.
-     * @param body - The body of the message (to be parsed).
-     *
-     * Example for a `body`:
-     * ```
-     * @/foo/bar.ts;1-3;5-6
-     * @/wauz/wee.ts;67-67;100-101
-     * ```
-     *
-     * This processing operates as state machine. The input is split into tokens;
-     * newline and semicolon symbols separate tokens.
-     * A file name is a token; a range (start to end line) is a token.
-     */
-    private handleCoverageMessage;
-    /**
-     * Returns a statistic on the number of messages received.
-     */
-    getStatistics(): {
-        totalMessages: number;
-        totalCoverageMessages: number;
-    };
-}

package/dist/src/receiver/CollectingServer.js

@@ -1,207 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebSocketCollectingServer = void 0;
-const WebSocket = __importStar(require("ws"));
-const commons_1 = require("@cqse/commons");
-const Session_1 = require("./Session");
-/** A message that provides coverage information */
-const MESSAGE_TYPE_COVERAGE = 'c';
-/** A message that defines the bucket to put the coverage into */
-const MESSAGE_TYPE_BUCKET = 'b';
-/**
- * A WebSocket based implementation of a coverage receiver.
- * Receives coverage from instrumented JavaScript code.
- */
-class WebSocketCollectingServer {
-    /**
-     * The WebSocket server component.
-     */
-    server;
-    /**
-     * The storage to put the received coverage information to for aggregation and further processing.
-     */
-    storage;
-    /**
-     * The logger to use.
-     */
-    logger;
-    /**
-     * The number of messages that have been received.
-     */
-    totalNumMessagesReceived;
-    /**
-     * The number of coverage messages that have been received.
-     */
-    totalNumCoverageMessagesReceived;
-    /**
-     * Constructor.
-     *
-     * @param port - The port the WebSocket server should listen on.
-     * @param storage - The storage to put the received coverage information to.
-     * @param logger - The logger to use.
-     */
-    constructor(port, storage, logger) {
-        commons_1.Contract.require(port > 0 && port < 65536, 'Port must be valid (range).');
-        this.storage = commons_1.Contract.requireDefined(storage);
-        this.logger = commons_1.Contract.requireDefined(logger);
-        this.server = new WebSocket.Server({ port });
-        this.totalNumMessagesReceived = 0;
-        this.totalNumCoverageMessagesReceived = 0;
-    }
-    /**
-     * Start the server socket, handle sessions and dispatch messages.
-     */
-    start() {
-        this.logger.info(`Starting server on port ${this.server?.options.port}.`);
-        // Handle new connections from clients
-        this.server?.on('connection', (webSocket, req) => {
-            let session = new Session_1.Session(this.storage);
-            this.logger.trace(`Connection from: ${req.socket.remoteAddress}`);
-            // Handle disconnecting clients
-            webSocket.on('close', code => {
-                if (session) {
-                    session = null;
-                    this.logger.trace(`Closing with code ${code}`);
-                }
-            });
-            // Handle incoming messages
-            webSocket.on('message', (message) => {
-                this.totalNumMessagesReceived += 1;
-                if (session && Buffer.isBuffer(message)) {
-                    void this.handleMessage(session, message);
-                }
-            });
-            // Handle errors
-            webSocket.on('error', (e) => {
-                this.logger.error('Error on server socket triggered.', e);
-            });
-        });
-        return {
-            stop: () => {
-                this.server?.clients.forEach(client => client.close());
-                this.server?.close();
-                this.server = null;
-            }
-        };
-    }
-    /**
-     * Handle a message from a client.
-     *
-     * @param session - The session that has been started for the client.
-     * @param message - The message to handle.
-     */
-    async handleMessage(session, message) {
-        try {
-            const messageType = message.toString('utf8', 0, 1);
-            if (messageType === MESSAGE_TYPE_BUCKET) {
-                const bucketDefinitionEncoded = message.toString('utf-8', 1).trim();
-                const bucketDefinitionDecoded = Buffer.from(bucketDefinitionEncoded, 'base64').toString('utf8');
-                const bucketDefinition = JSON.parse(bucketDefinitionDecoded);
-                this.logger.debug(`Received bucket definition: ${JSON.stringify(bucketDefinition)} for session ${session.sessionId}.`);
-                await session.setupBucketAndApplication(bucketDefinition);
-            }
-            else if (messageType === MESSAGE_TYPE_COVERAGE) {
-                this.totalNumCoverageMessagesReceived += 1;
-                const linesCoveredApprox = this.handleCoverageMessage(session, message.subarray(1));
-                if (linesCoveredApprox > 0) {
-                    this.logger.debug(`Coverage for approximately ${linesCoveredApprox} lines processed for session ${session.sessionId}.`);
-                }
-            }
-            else {
-                this.logger.error(`Unknown message type: ${messageType}`);
-            }
-        }
-        catch (e) {
-            this.logger.error(`Error while processing message starting with ${message.toString('utf8', 0, Math.min(250, message.length))}`);
-            this.logger.error(e.message);
-        }
-    }
-    /**
-     * Handle a message with coverage information.
-     *
-     * @param session - The session to handle the message for.
-     * @param body - The body of the message (to be parsed).
-     *
-     * Example for a `body`:
-     * ```
-     * @/foo/bar.ts;1-3;5-6
-     * @/wauz/wee.ts;67-67;100-101
-     * ```
-     *
-     * This processing operates as state machine. The input is split into tokens;
-     * newline and semicolon symbols separate tokens.
-     * A file name is a token; a range (start to end line) is a token.
-     */
-    handleCoverageMessage(session, body) {
-        // Number of lines signaled to be covered (just an approximation, for debugging purposes)
-        let lineCoverageStatements = 0;
-        // Split the input into tokens; these are either file names or code ranges.
-        const tokens = body.toString().split(/[\n;]/).map(line => line.trim());
-        // Placeholder for group/filename.
-        let filename = '';
-        tokens.forEach(token => {
-            // Check if the token starts with '@' - indicating a new group/filename.
-            if (token.startsWith('@')) {
-                filename = token.substring(1).trim(); // Remove the '@' character and extra spaces.
-            }
-            else if (filename) {
-                // It is not a file name, we have a range token here.
-                // Example for range a token: `3-5`, or just `42` (corresponding to `42-42`).
-                const range = token.split(/,|-/).map(value => Number.parseInt(value));
-                if (range.length === 1) {
-                    lineCoverageStatements += session.putLineCoverage(filename, range[0], range[0]);
-                }
-                else if (range.length === 2) {
-                    lineCoverageStatements += session.putLineCoverage(filename, range[0], range[1]);
-                }
-                else {
-                    this.logger.error(`Invalid range token: ${token}`);
-                }
-            }
-        });
-        return lineCoverageStatements;
-    }
-    /**
-     * Returns a statistic on the number of messages received.
-     */
-    getStatistics() {
-        return {
-            totalMessages: this.totalNumMessagesReceived,
-            totalCoverageMessages: this.totalNumCoverageMessagesReceived
-        };
-    }
-}
-exports.WebSocketCollectingServer = WebSocketCollectingServer;

package/dist/src/receiver/Session.d.ts

@@ -1,45 +0,0 @@
-import { CoverageBucketSpecifier, DataStorage } from '../storage/DataStorage';
-/**
- * The session maintains the relevant information for a client.
- * One session is created for each client.
- * The mapping based on sourcemaps is conducted here.
- */
-export declare class Session {
-    /**
-     * An internal session ID for debugging purposes.
-     */
-    private readonly internalSessionId;
-    /**
-     * The storage to forward coverage information to for aggregation.
-     */
-    private readonly storage;
-    /**
-     * The application to contribute coverage to.
-     */
-    private appId?;
-    /**
-     * The commit to contribute coverage for.
-     */
-    private commitId?;
-    /**
-     * Constructor
-     *
-     * @param storage - The storage to store and aggregate coverage information in.
-     */
-    constructor(storage: DataStorage);
-    /**
-     * If not already done, the bucket to send coverage into for the given application is set up.
-     */
-    setupBucketAndApplication(bucketSpecifier: CoverageBucketSpecifier): Promise<void>;
-    /**
-     * Put coverage information to the storage for aggregation.
-     * This method also conducts the mapping based on the source map.
-     *
-     * @param fileId - The identifier of the instrumented bundle (file).
-     * @param startLine - The line number within the bundle the range starts.
-     * @param endLine - The line number within the bundle the range ends.
-     */
-    putLineCoverage(fileId: string, startLine: number, endLine: number): number;
-    /** Returns the internal session ID for debugging purposes. */
-    get sessionId(): string;
-}