@empiricalrun/test-gen 0.70.2 → 0.71.2

package/dist/reporter/index.js

@@ -1,149 +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.TestGenUpdatesReporter = void 0;
-exports.getReporter = getReporter;
-exports.setReporterConfig = setReporterConfig;
-const r2_uploader_1 = require("@empiricalrun/r2-uploader");
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const logger_1 = require("../bin/logger");
-const uploader_1 = require("../uploader");
-const lib_1 = require("./lib");
-let reporterInstance = undefined;
-let reporterConfig = undefined;
-function getReporter() {
-    // if no config is set, return undefined
-    if (!reporterConfig) {
-        console.warn("initialising reporter without any config");
-    }
-    // initialise once config is set
-    if (!reporterInstance && reporterConfig) {
-        reporterInstance = new lib_1.Reporter(reporterConfig);
-    }
-    return reporterInstance;
-}
-/**
- * function will upload videos and json summary of test results to r2 and report them to reporter.
- * method won't throw error if it fails to report
- */
-function setReporterConfig(config) {
-    reporterConfig = config;
-}
-class TestGenUpdatesReporter {
-    repoDir;
-    constructor() {
-        this.repoDir = process.cwd();
-    }
-    async reportGenAssets({ projectRepoName, testName, }) {
-        const logger = new logger_1.CustomLogger();
-        try {
-            if (!(0, uploader_1.checkIfResultsUploadAllowed)()) {
-                logger.log("Skipped uploading generated test video");
-                return;
-            }
-            console.log("Uploading assets for the test genearation");
-            const { videoUrls, traceFiles } = await (0, uploader_1.uploadTestResultsUsingPrjRepo)({
-                projectRepoName,
-                testName,
-                repoDir: this.repoDir,
-            });
-            const reporter = getReporter();
-            await Promise.allSettled([
-                ...(videoUrls.length
-                    ? [
-                        reporter?.report(new lib_1.MessageBuilder({
-                            type: "video",
-                            message: JSON.stringify({
-                                type: "video",
-                                videoUrls,
-                            }),
-                        })),
-                    ]
-                    : []),
-                ...(traceFiles.length
-                    ? [
-                        reporter?.report(new lib_1.MessageBuilder({
-                            type: "pw-trace",
-                            message: JSON.stringify({
-                                type: "trace",
-                                traceFiles,
-                            }),
-                        })),
-                    ]
-                    : []),
-            ]);
-        }
-        catch (err) {
-            logger.error("Failed to report test results");
-            console.error(err);
-        }
-    }
-    async sendCurrentView(buffer) {
-        const logger = new logger_1.CustomLogger();
-        if (!(0, uploader_1.checkIfResultsUploadAllowed)()) {
-            logger.log("Skipped uploading current view screenshot");
-            return;
-        }
-        if (!reporterConfig?.projectRepoName) {
-            logger.log("Reporter config is not set skipping screenshot uploads.");
-            return;
-        }
-        try {
-            // upload current screenshot to r2 and report it to reporter
-            if (!fs_1.default.existsSync(path_1.default.join(this.repoDir, "gen-assets"))) {
-                fs_1.default.mkdirSync(path_1.default.join(this.repoDir, "gen-assets"));
-            }
-            fs_1.default.writeFileSync(path_1.default.join(this.repoDir, "gen-assets", `current-view-${Date.now()}.png`), buffer);
-            const uploadDir = (0, uploader_1.getUploadPathForRun)(reporterConfig?.projectRepoName);
-            const files = await (0, r2_uploader_1.uploadDirectory)({
-                sourceDir: path_1.default.join(this.repoDir, "gen-assets"),
-                destinationDir: uploadDir,
-                uploadBucket: uploader_1.UPLOAD_BUCKET,
-            });
-            const filePath = Object.keys(files)[0];
-            const relativeFilePath = filePath.replace(path_1.default.join(this.repoDir, "gen-assets"), "");
-            const url = `${uploader_1.UPLOAD_DOMAIN}/${uploadDir}${relativeFilePath}`;
-            await getReporter()?.report(new lib_1.MessageBuilder({
-                type: "current-snapshot",
-                message: JSON.stringify({ type: "current-view", url }),
-            }));
-            fs_1.default.rmdirSync(path_1.default.join(this.repoDir, "gen-assets"), {
-                recursive: true,
-            });
-        }
-        catch (e) {
-            console.warn("Failed to upload current view screenshot", e);
-        }
-    }
-    async sendMessage(message) {
-        const reporter = getReporter();
-        if (reporter) {
-            await reporter.report(new lib_1.MessageBuilder({
-                type: "message",
-                message,
-            }));
-        }
-    }
-    async sendLogUrl(message) {
-        const reporter = getReporter();
-        if (reporter) {
-            await reporter.report(new lib_1.MessageBuilder({
-                type: "log-url",
-                message,
-            }));
-        }
-    }
-    async sendAgentTraceUrl(message) {
-        const reporter = getReporter();
-        if (reporter) {
-            await reporter.report(new lib_1.MessageBuilder({
-                type: "agent-trace",
-                message,
-            }));
-        }
-    }
-}
-exports.TestGenUpdatesReporter = TestGenUpdatesReporter;

package/dist/reporter/lib.d.ts

@@ -1,31 +0,0 @@
-type DashboardMessagePayload = {
-    message: string;
-    messageType: "message" | "agent-trace" | "current-snapshot" | "video" | "pw-trace" | "log-url" | "commit-id";
-    pull_request?: string;
-    testCaseName?: string;
-    testCaseId?: number;
-    projectRepoName?: string;
-    testSessionId?: number;
-    generationId?: number;
-};
-export declare class MessageBuilder {
-    private props;
-    constructor(props: {
-        message: string;
-        type: DashboardMessagePayload["messageType"];
-    });
-    buildMessage(dashboardOptions?: {
-        override?: Partial<DashboardMessagePayload>;
-    }): DashboardMessagePayload;
-}
-export declare class Reporter {
-    private config;
-    constructor(config: {
-        testSessionId: number;
-        generationId: number;
-    });
-    report(messageBuilder: MessageBuilder): Promise<void>;
-    private sendMessageToDashboard;
-}
-export {};
-//# sourceMappingURL=lib.d.ts.map

package/dist/reporter/lib.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/reporter/lib.ts"],"names":[],"mappings":"AAMA,KAAK,uBAAuB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EACP,SAAS,GACT,aAAa,GACb,kBAAkB,GAClB,OAAO,GACP,UAAU,GACV,SAAS,GACT,WAAW,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,qBAAa,cAAc;IAEvB,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;KAC9C;IAGH,YAAY,CAAC,gBAAgB,CAAC,EAAE;QAC9B,QAAQ,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;KAC7C,GAAG,uBAAuB;CAO5B;AAED,qBAAa,QAAQ;IAEjB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE;QACd,aAAa,EAAE,MAAM,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC;KACtB;IAGG,MAAM,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;YAc7C,sBAAsB;CAkCrC"}

package/dist/reporter/lib.js

@@ -1,71 +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.Reporter = exports.MessageBuilder = void 0;
-const async_retry_1 = __importDefault(require("async-retry"));
-const DASHBOARD_DOMAIN = process.env.DASHBOARD_DOMAIN ||
-    (process.env.CI === "true" ? "https://dash.empirical.run" : "");
-class MessageBuilder {
-    props;
-    constructor(props) {
-        this.props = props;
-    }
-    buildMessage(dashboardOptions) {
-        return {
-            ...dashboardOptions?.override,
-            message: this.props.message,
-            messageType: this.props.type,
-        };
-    }
-}
-exports.MessageBuilder = MessageBuilder;
-class Reporter {
-    config;
-    constructor(config) {
-        this.config = config;
-    }
-    async report(messageBuilder) {
-        const message = messageBuilder.buildMessage({
-            override: {
-                testSessionId: this.config.testSessionId,
-                generationId: this.config.generationId,
-            },
-        });
-        if (!message) {
-            console.info("No message found. Skipping sending message to dashboard");
-            return;
-        }
-        await this.sendMessageToDashboard(message);
-    }
-    async sendMessageToDashboard(message) {
-        if (!DASHBOARD_DOMAIN) {
-            console.warn("No dashboard domain found. Skipping send message to dashboard");
-            return;
-        }
-        try {
-            await (0, async_retry_1.default)(async () => {
-                const body = JSON.stringify(message);
-                await fetch(`${DASHBOARD_DOMAIN}/api/github/updates`, {
-                    method: "POST",
-                    headers: {
-                        "Content-Type": "application/json",
-                        Authorization: `Bearer ${process.env.EMPIRICALRUN_API_KEY}`,
-                    },
-                    body,
-                });
-            }, {
-                retries: 3,
-                minTimeout: 1000,
-                maxTimeout: 60_000,
-                factor: 3,
-            });
-        }
-        catch (e) {
-            console.error(`Error sending message to Dashboard: ${e.code}`);
-            console.error(e.message);
-        }
-    }
-}
-exports.Reporter = Reporter;

package/dist/tools/test-run.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"test-run.d.ts","sourceRoot":"","sources":["../../src/tools/test-run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAc,MAAM,4BAA4B,CAAC;AAwDnE,eAAO,MAAM,WAAW,EAAE,IAqFzB,CAAC"}

package/dist/uploader/index.d.ts

@@ -1,26 +0,0 @@
-export declare const UPLOAD_BUCKET = "test-report";
-export declare const UPLOAD_DOMAIN = "https://reports.empirical.run";
-export declare function getFullUploadPath(repoDir: string, filePath: string, uploadDir: string): string;
-export declare function getRelativeUploadPath(filePath: string, repoDir: string): string;
-/**
- * Function to upload test results to R2 using the project repo name and test name.
- * This function uploads both the JSON summary of test results and associated video files.
- * @param {Object} params - The parameters for the function.
- * @param {string} params.projectRepoName - Name of the project repository.
- * @param {string} params.testName - Name of the testcase which called this test-gen.
- * @returns {Promise<Object>} An object containing arrays of video URLs and the summary JSON URL.
- * @returns {string[]} returns.videoUrls - URLs of the uploaded video files.
- * @returns {string} returns.summaryUrl - URL of the uploaded summary JSON file.
- */
-export declare function uploadTestResultsUsingPrjRepo({ projectRepoName, testName, repoDir, }: {
-    projectRepoName: string;
-    testName: string;
-    repoDir: string;
-}): Promise<{
-    videoUrls: string[];
-    summaryUrl: string;
-    traceFiles: string[];
-}>;
-export declare function getUploadPathForRun(projectRepoName: string): string;
-export declare function checkIfResultsUploadAllowed(): string | undefined;
-//# sourceMappingURL=index.d.ts.map

package/dist/uploader/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/uploader/index.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,aAAa,gBAAgB,CAAC;AAC3C,eAAO,MAAM,aAAa,kCAAkC,CAAC;AAG7D,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,UAKlB;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAEtE;AAED;;;;;;;;;GASG;AACH,wBAAsB,6BAA6B,CAAC,EAClD,eAAe,EACf,QAAQ,EACR,OAAO,GACR,EAAE;IACD,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,OAAO,CAAC;IACV,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC,CAiED;AAED,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,MAAM,UAM1D;AAED,wBAAgB,2BAA2B,uBAQ1C"}

package/dist/uploader/index.js

@@ -1,103 +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.UPLOAD_DOMAIN = exports.UPLOAD_BUCKET = void 0;
-exports.getFullUploadPath = getFullUploadPath;
-exports.getRelativeUploadPath = getRelativeUploadPath;
-exports.uploadTestResultsUsingPrjRepo = uploadTestResultsUsingPrjRepo;
-exports.getUploadPathForRun = getUploadPathForRun;
-exports.checkIfResultsUploadAllowed = checkIfResultsUploadAllowed;
-const r2_uploader_1 = require("@empiricalrun/r2-uploader");
-const path_1 = __importDefault(require("path"));
-const utils_1 = require("./utils");
-// json summary of test results
-// originally we used to upload test results directory for this
-// but now we have our test results (per testcase artifacts) inside playwright-report/data
-// but we also have summary.json in playwright-report/
-// we can avoid html report upload here if we don't want
-const PLAYWRIGHT_REPORT_DATA = "playwright-report/data";
-exports.UPLOAD_BUCKET = "test-report";
-exports.UPLOAD_DOMAIN = "https://reports.empirical.run"; // domain based on bucket mentioned above
-const uploadId = crypto.randomUUID();
-function getFullUploadPath(repoDir, filePath, uploadDir) {
-    // remove the source dir from the file path - only keep the relative path
-    const relativeFilePath = getRelativeUploadPath(filePath, repoDir);
-    return `${exports.UPLOAD_DOMAIN}/${uploadDir}${relativeFilePath}`;
-}
-function getRelativeUploadPath(filePath, repoDir) {
-    return filePath.replace(path_1.default.join(repoDir, PLAYWRIGHT_REPORT_DATA), "");
-}
-/**
- * Function to upload test results to R2 using the project repo name and test name.
- * This function uploads both the JSON summary of test results and associated video files.
- * @param {Object} params - The parameters for the function.
- * @param {string} params.projectRepoName - Name of the project repository.
- * @param {string} params.testName - Name of the testcase which called this test-gen.
- * @returns {Promise<Object>} An object containing arrays of video URLs and the summary JSON URL.
- * @returns {string[]} returns.videoUrls - URLs of the uploaded video files.
- * @returns {string} returns.summaryUrl - URL of the uploaded summary JSON file.
- */
-async function uploadTestResultsUsingPrjRepo({ projectRepoName, testName, repoDir, }) {
-    const uploadDir = getUploadPathForRun(projectRepoName);
-    console.log("Current directory for assets upload", repoDir);
-    const files = await (0, r2_uploader_1.uploadDirectory)({
-        sourceDir: path_1.default.join(repoDir, PLAYWRIGHT_REPORT_DATA),
-        destinationDir: uploadDir,
-        uploadBucket: exports.UPLOAD_BUCKET,
-    });
-    // upload summary.json
-    await (0, r2_uploader_1.uploadDirectory)({
-        sourceDir: path_1.default.join(repoDir, "playwright-report"),
-        // TODO: this will only work for repos that use playwright 1.47.1
-        fileList: [path_1.default.join(repoDir, "playwright-report", "summary.json")],
-        destinationDir: uploadDir,
-        uploadBucket: exports.UPLOAD_BUCKET,
-    });
-    // fileNames are relative upload paths
-    const fileNames = Object.keys(files);
-    console.log("Uploaded files", fileNames.map((f) => getFullUploadPath(repoDir, f, uploadDir)));
-    const defaultLocation = path_1.default.join(repoDir, "playwright-report", "summary.json");
-    const results = (0, utils_1.parseJsonReport)(defaultLocation);
-    const flatTestsList = (0, utils_1.getFlattenedTestList)(results.suites);
-    const testAttachmentPaths = [];
-    for (const test of flatTestsList) {
-        if (test.title === testName) {
-            if (test.tests[0]) {
-                if (test.tests[0].results[0]) {
-                    // results array is basically made by retries
-                    for (const attachments of test.tests[0].results[0].attachments) {
-                        if (attachments.path) {
-                            testAttachmentPaths.push(getRelativeUploadPath(attachments.path, repoDir));
-                        }
-                    }
-                }
-            }
-        }
-    }
-    const videoFiles = fileNames.filter((fileName) => fileName.endsWith(".webm") && testAttachmentPaths.includes(fileName));
-    const traceFiles = fileNames.filter((fileName) => fileName.endsWith(".zip") && testAttachmentPaths.includes(fileName));
-    console.log("videoFiles", videoFiles);
-    console.log("traceFiles", traceFiles);
-    return {
-        videoUrls: videoFiles
-            .map((fileName) => getFullUploadPath(repoDir, fileName, uploadDir))
-            .filter((url) => !!url),
-        summaryUrl: `${exports.UPLOAD_DOMAIN}/${uploadDir}/summary.json`,
-        traceFiles: traceFiles
-            .map((fileName) => getFullUploadPath(repoDir, fileName, uploadDir))
-            .filter((url) => !!url),
-    };
-}
-function getUploadPathForRun(projectRepoName) {
-    const uploadDir = `test-generation/${projectRepoName.replace("-tests", "")}/${uploadId}`;
-    return uploadDir;
-}
-function checkIfResultsUploadAllowed() {
-    // TODO: check for valid R2 credentials
-    // check for project repo name, and r2 creds
-    return (process.env.R2_ACCOUNT_ID &&
-        process.env.R2_ACCESS_KEY_ID &&
-        process.env.R2_SECRET_ACCESS_KEY);
-}

package/dist/uploader/utils.d.ts

@@ -1,8 +0,0 @@
-import type { JSONReportSpec, JSONReportSuite } from "@playwright/test/reporter";
-export declare function parseJsonReport<T>(srcFile: string): T;
-export type flattenedSpecT = JSONReportSpec & {
-    nesting: string[];
-    suitesString: string;
-};
-export declare const getFlattenedTestList: (suites: JSONReportSuite[]) => flattenedSpecT[];
-//# sourceMappingURL=utils.d.ts.map

package/dist/uploader/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/uploader/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EAChB,MAAM,2BAA2B,CAAC;AAGnC,wBAAgB,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC,CAErD;AAMD,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG;IAC5C,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AACF,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,eAAe,EAAE,KACxB,cAAc,EA4BhB,CAAC"}

package/dist/uploader/utils.js

@@ -1,35 +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.getFlattenedTestList = void 0;
-exports.parseJsonReport = parseJsonReport;
-const fs_1 = __importDefault(require("fs"));
-function parseJsonReport(srcFile) {
-    return JSON.parse(fs_1.default.readFileSync(srcFile, { encoding: "utf-8" }));
-}
-const getFlattenedTestList = (suites) => {
-    let flattenedSpecs = [];
-    const traverseSuites = (suite, nesting = []) => {
-        nesting = [...nesting, suite.title];
-        flattenedSpecs.push(...suite.specs.map((spec) => {
-            const finalNesting = [...nesting, spec.title];
-            const suites = nesting.slice(1);
-            const suitesString = suites.length ? suites.join("~~") : "~~";
-            return {
-                ...spec,
-                nesting: finalNesting,
-                suitesString,
-            };
-        }));
-        // Traverse nested suites recursively
-        if (suite.suites && suite.suites.length > 0) {
-            suite.suites.forEach((suite) => traverseSuites(suite, nesting));
-        }
-    };
-    // Start the traversal from the top-level suites
-    suites.forEach((suite) => traverseSuites(suite));
-    return flattenedSpecs;
-};
-exports.getFlattenedTestList = getFlattenedTestList;