@empiricalrun/playwright-utils 0.22.7 → 0.23.0

package/bundled/test-gen/bin/logger/index.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForLogsToFlush = exports.CustomLogger = void 0;
+const reporter_1 = require("@empiricalrun/reporter");
+const picocolors_1 = require("picocolors");
+const reporter_2 = require("../../reporter");
+let queuedReporterMessages = [];
+class CustomLogger {
+    useReporter = false;
+    constructor({ useReporter = true } = {}) {
+        this.useReporter = useReporter;
+    }
+    logToReporter(message) {
+        if (this.useReporter) {
+            (() => {
+                const promise = (0, reporter_2.getReporter)()?.report(new reporter_1.ProcessLogMessageBuilder({ type: "message", message: message }));
+                if (promise) {
+                    queuedReporterMessages.push(promise);
+                }
+            })();
+        }
+    }
+    log(message, ...optionalParams) {
+        console.log("🪵", (0, picocolors_1.cyan)(message), ...optionalParams);
+        this.logToReporter(message);
+    }
+    warn(message, ...optionalParams) {
+        console.log("🟡", (0, picocolors_1.yellow)(message), ...optionalParams);
+        this.logToReporter(message);
+    }
+    success(message, ...optionalParams) {
+        console.log("✅", (0, picocolors_1.green)(message), ...optionalParams);
+        this.logToReporter(message);
+    }
+    error(message, ...optionalParams) {
+        console.error("🚨", (0, picocolors_1.red)(message), ...optionalParams);
+        this.logToReporter(message);
+    }
+    logEmptyLine() {
+        console.log("\n\n");
+    }
+}
+exports.CustomLogger = CustomLogger;
+async function waitForLogsToFlush() {
+    if (queuedReporterMessages.length === 0) {
+        return;
+    }
+    try {
+        await Promise.all(queuedReporterMessages);
+    }
+    catch (e) {
+        console.warn("Error while flushing logs", e);
+        // resolving this as this is not a critical operation
+        return Promise.resolve();
+    }
+}
+exports.waitForLogsToFlush = waitForLogsToFlush;

package/bundled/test-gen/bin/utils/context.d.ts

@@ -0,0 +1,13 @@
+export declare function createGitIgnoreFileFilter(): Promise<(pathname: string) => boolean>;
+export declare function contextForGeneration(file?: string): Promise<{
+    codePrompt: string | undefined;
+    pomPrompt: string | undefined;
+    nonSpecFilePrompt: string | undefined;
+    testFileContent: string;
+}>;
+export declare function createRepoEditFilter(): Promise<(filePath: string) => boolean>;
+export declare function generateTxtForRepository(): Promise<{
+    prompt: string | undefined;
+}>;
+export declare function fetchAppKnowledge(): Promise<string>;
+//# sourceMappingURL=context.d.ts.map

package/bundled/test-gen/bin/utils/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/bin/utils/context.ts"],"names":[],"mappings":"AAQA,wBAAsB,yBAAyB,2CAe9C;AAED,wBAAsB,oBAAoB,CAAC,IAAI,CAAC,EAAE,MAAM;;;;;GAQvD;AAED,wBAAsB,oBAAoB,uBAItB,MAAM,cAMzB;AAED,wBAAsB,wBAAwB;;GAK7C;AAED,wBAAsB,iBAAiB,oBAYtC"}

package/bundled/test-gen/bin/utils/context.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchAppKnowledge = exports.generateTxtForRepository = exports.createRepoEditFilter = exports.contextForGeneration = exports.createGitIgnoreFileFilter = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const ignore_1 = __importDefault(require("ignore"));
+const fs_1 = require("./fs");
+async function createGitIgnoreFileFilter() {
+    const ignoreFn = (0, ignore_1.default)();
+    if (fs_extra_1.default.existsSync(".gitignore")) {
+        // Not checking for nested gitignore
+        let gitignore = (await fs_extra_1.default.readFile(".gitignore")).toString();
+        gitignore = `
+${gitignore}
+.git/
+.github/
+package-lock.json
+`;
+        ignoreFn.add(gitignore);
+    }
+    const filter = ignoreFn.createFilter();
+    return filter;
+}
+exports.createGitIgnoreFileFilter = createGitIgnoreFileFilter;
+async function contextForGeneration(file) {
+    const filter = await createGitIgnoreFileFilter();
+    return {
+        codePrompt: await (0, fs_1.generatePromptFromDirectory)("./tests", filter),
+        pomPrompt: await (0, fs_1.generatePromptFromDirectory)("./pages", filter),
+        nonSpecFilePrompt: await (0, fs_1.generatePromptFromNonSpecFiles)("./tests", filter),
+        testFileContent: file ? await fs_extra_1.default.readFile(file, "utf-8") : "",
+    };
+}
+exports.contextForGeneration = contextForGeneration;
+async function createRepoEditFilter() {
+    const allowedExtensions = /\.(ts|js|mjs|json|md)$/i;
+    const gitIgnoreFilter = await createGitIgnoreFileFilter();
+    return (filePath) => {
+        return (gitIgnoreFilter(filePath) &&
+            (fs_extra_1.default.statSync(filePath).isDirectory() || allowedExtensions.test(filePath)));
+    };
+}
+exports.createRepoEditFilter = createRepoEditFilter;
+async function generateTxtForRepository() {
+    const filter = await createRepoEditFilter();
+    return {
+        prompt: await (0, fs_1.generatePromptFromDirectory)(".", filter),
+    };
+}
+exports.generateTxtForRepository = generateTxtForRepository;
+async function fetchAppKnowledge() {
+    let fileExists = true;
+    const appKnowledgePath = "./app_knowledge.md";
+    try {
+        await fs_extra_1.default.access(appKnowledgePath);
+    }
+    catch (e) {
+        fileExists = false;
+    }
+    if (!fileExists) {
+        return "";
+    }
+    return await fs_extra_1.default.readFile(appKnowledgePath, "utf-8");
+}
+exports.fetchAppKnowledge = fetchAppKnowledge;

package/bundled/test-gen/bin/utils/fs/index.d.ts

@@ -0,0 +1,6 @@
+import type { FileContent } from "@empiricalrun/shared-types";
+export declare function readFilesInDirectory(dir: string | undefined, filterFunc: (file: string) => boolean): Promise<FileContent[]>;
+export declare function convertFileContentsToString(files?: FileContent[]): string;
+export declare function generatePromptFromDirectory(dir: string | undefined, filterFunc: (file: string) => boolean): Promise<string | undefined>;
+export declare function generatePromptFromNonSpecFiles(dir: string | undefined, filterFunc: (file: string) => boolean): Promise<string | undefined>;
+//# sourceMappingURL=index.d.ts.map

package/bundled/test-gen/bin/utils/fs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/bin/utils/fs/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAI9D,wBAAsB,oBAAoB,CACxC,GAAG,oBAAa,EAChB,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,0BAgBtC;AAED,wBAAgB,2BAA2B,CAAC,KAAK,GAAE,WAAW,EAAO,UAQpE;AAED,wBAAsB,2BAA2B,CAC/C,GAAG,oBAAK,EACR,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,+BAStC;AAED,wBAAsB,8BAA8B,CAClD,GAAG,oBAAa,EAChB,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,+BAgBtC"}

package/bundled/test-gen/bin/utils/fs/index.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatePromptFromNonSpecFiles = exports.generatePromptFromDirectory = exports.convertFileContentsToString = exports.readFilesInDirectory = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+async function readFilesInDirectory(dir = "", filterFunc) {
+    let files = [];
+    const items = await fs_extra_1.default.readdir(dir);
+    const filteredItems = items.map((i) => path_1.default.join(dir, i)).filter(filterFunc);
+    for (const item of filteredItems) {
+        const stat = await fs_extra_1.default.stat(item);
+        if (stat.isDirectory()) {
+            files = files.concat(await readFilesInDirectory(item, filterFunc));
+        }
+        else if (stat.isFile()) {
+            const content = await fs_extra_1.default.readFile(item, "utf-8");
+            files.push({ filePath: item, content });
+        }
+    }
+    return files;
+}
+exports.readFilesInDirectory = readFilesInDirectory;
+function convertFileContentsToString(files = []) {
+    let prompt = "";
+    files.forEach((file) => {
+        prompt += `File Path: ${file.filePath}\n`;
+        prompt += `File:\n`;
+        prompt += `${file.content}\n\n------\n\n`;
+    });
+    return prompt;
+}
+exports.convertFileContentsToString = convertFileContentsToString;
+async function generatePromptFromDirectory(dir = "", filterFunc) {
+    try {
+        const files = await readFilesInDirectory(dir, filterFunc);
+        const prompt = convertFileContentsToString(files);
+        return prompt;
+    }
+    catch (error) {
+        console.error("Error reading directory:", error);
+    }
+}
+exports.generatePromptFromDirectory = generatePromptFromDirectory;
+async function generatePromptFromNonSpecFiles(dir = "", filterFunc) {
+    try {
+        let nonSpecFiles = [];
+        const files = await readFilesInDirectory(dir, filterFunc);
+        for (const file of files) {
+            if (!file.filePath.endsWith(".spec.ts")) {
+                nonSpecFiles.push(file);
+            }
+        }
+        const prompt = convertFileContentsToString(nonSpecFiles);
+        return prompt;
+    }
+    catch (error) {
+        console.error("Error reading directory:", error);
+    }
+}
+exports.generatePromptFromNonSpecFiles = generatePromptFromNonSpecFiles;

package/bundled/test-gen/bin/utils/index.d.ts

@@ -0,0 +1,9 @@
+export interface CliOptions {
+    token?: string;
+    name?: string;
+    file?: string;
+    prompt?: string;
+    suites?: string;
+}
+export declare function validateAndCompleteCliOptions(options: CliOptions): Promise<CliOptions>;
+//# sourceMappingURL=index.d.ts.map

package/bundled/test-gen/bin/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/bin/utils/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AASD,wBAAsB,6BAA6B,CACjD,OAAO,EAAE,UAAU,GAClB,OAAO,CAAC,UAAU,CAAC,CAiErB"}

package/bundled/test-gen/bin/utils/index.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAndCompleteCliOptions = void 0;
+const inquirer_1 = __importDefault(require("inquirer"));
+async function validateAndCompleteCliOptions(options) {
+    const hasToken = !!options.token;
+    if (hasToken) {
+        return options;
+    }
+    const questions = [];
+    if (!options.name) {
+        questions.push({
+            type: "input",
+            name: "name",
+            message: "Enter the test name:",
+            validate: (input) => input.trim().length > 0 || "Test name is required",
+        });
+    }
+    if (!options.file) {
+        questions.push({
+            type: "input",
+            name: "file",
+            message: "Enter the test file path (inside tests dir):",
+            validate: (input) => input.trim().length > 0 || "Test file path is required",
+        });
+    }
+    if (!options.prompt) {
+        questions.push({
+            type: "editor",
+            name: "prompt",
+            message: "Enter the test prompt (opens in your editor):",
+            validate: (input) => input.trim().length > 0 || "Test prompt is required",
+        });
+    }
+    if (!options.suites) {
+        questions.push({
+            type: "input",
+            name: "suites",
+            message: "Enter comma-separated test suites (optional):",
+        });
+    }
+    if (questions.length > 0) {
+        // Ask each question individually to avoid type issues
+        const answers = {};
+        for (const question of questions) {
+            const answer = await inquirer_1.default.prompt({
+                type: question.type,
+                name: "value",
+                message: question.message,
+                validate: question.validate,
+            });
+            answers[question.name] = answer.value;
+        }
+        return {
+            ...options,
+            ...answers,
+        };
+    }
+    return options;
+}
+exports.validateAndCompleteCliOptions = validateAndCompleteCliOptions;

package/bundled/test-gen/bin/utils/platform/web/index.d.ts

@@ -0,0 +1,78 @@
+import { TraceClient } from "@empiricalrun/llm";
+import type { TestCase } from "@empiricalrun/shared-types";
+import { Node, SourceFile } from "ts-morph";
+export declare const getTestModuleAliasFromSourceFile: (sourceFile: SourceFile) => string;
+/**
+ * function to get the test block and test node for the scenario
+ * @export
+ * @param {string} scenarioName
+ * @param {string} content
+ * @return { testBlock: string; parentDescribe: string; } testBlock - the test block content, testNode - the test function node
+ */
+export declare function getTypescriptTestBlock({ scenarioName, suites, content, }: {
+    scenarioName: string;
+    suites?: string[];
+    content: string;
+}): {
+    testBlock: string | undefined;
+    testNode: Node | undefined;
+    testAlias: string;
+};
+export declare function hasTopLevelDescribeConfigureWithSerialMode(filePath: string): Promise<boolean>;
+/**
+ * Function to find the first 'describe' block configured with 'serial: true'
+ *
+ * e.g.
+ *
+ * test.describe("foo", () => {
+ *
+ *    test.describe.configure({ mode: "serial" });
+ *
+ *    test.describe("bar", () => {
+ *
+ *      test.describe.configure({ mode: "serial" });
+ *
+ *    })
+ *
+ * })
+ *
+ * for the above example,
+ * this function will return the first 'describe' block which is named "foo"
+ *
+ * @param {(Node | undefined)} node
+ * @return {(Node | undefined)}
+ */
+export declare function findFirstSerialDescribeBlock(node: Node | undefined): Node | undefined;
+export declare function appendToTestBlock(testBlock: string, content: string): string;
+export declare function validateTypescript(filePath: string): string[];
+export declare function stripAndPrependImports(content: string, testName: string): Promise<(string | undefined)[]>;
+export declare function lintErrors(filePath: string): Promise<void>;
+export declare function formatCode(filePath: string, trace?: TraceClient): Promise<void>;
+export declare function addNewImport(contents: string, modules: string[], pkg: string): string;
+export declare function removeTestOnly(filePath: string): Promise<void>;
+export declare function getFixtureImportPath(filePath: string): string;
+export declare function getPageVariableNameFromCreateTest(filePath: string): Promise<string | undefined>;
+export declare function replaceCreateTestWithNewCode(filePath: string, contents: string, generatedCode: string): string;
+export declare const injectCodeSnippetBySuiteChain: ({ testFileContent, codeSnippet, suites, }: {
+    testFileContent: string;
+    codeSnippet: string;
+    suites: string[];
+}) => string;
+export declare const importAllExportsStmtFromFilePaths: (repoDir: string, filePaths: string[], testFilePath: string) => Promise<string[]>;
+export declare function addUserContextFixture({ scenarioName, filePath, suites, }: {
+    scenarioName: string;
+    filePath: string;
+    suites: string[];
+}): Promise<void>;
+export declare function appendScopeToCreateTest(filePath: string, scopeVariables: string[]): Promise<void>;
+export declare function isTestPresent({ specPath, testCase, }: {
+    specPath: string;
+    testCase: TestCase;
+}): boolean;
+export declare function buildTestNamePrompt({ testName, suites, }: {
+    testName: string;
+    suites: string[];
+}): string;
+export declare function getVariableDeclarationsFromCode(sourceCode: string): string[];
+export declare function isSyntaxValid(code: string): boolean;
+//# sourceMappingURL=index.d.ts.map

package/bundled/test-gen/bin/utils/platform/web/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/bin/utils/platform/web/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAM3D,OAAO,EAGL,IAAI,EAEJ,UAAU,EAEX,MAAM,UAAU,CAAC;AAGlB,eAAO,MAAM,gCAAgC,eAC/B,UAAU,KACrB,MAgBF,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,EACrC,YAAY,EACZ,MAAM,EACN,OAAO,GACR,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG;IACF,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,QAAQ,EAAE,IAAI,GAAG,SAAS,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;CACnB,CA2CA;AAwBD,wBAAsB,0CAA0C,CAC9D,QAAQ,EAAE,MAAM,oBA+BjB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,IAAI,GAAG,SAAS,GACrB,IAAI,GAAG,SAAS,CA4BlB;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAG5E;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CA8C7D;AAED,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,mCAWjB;AAED,wBAAsB,UAAU,CAAC,QAAQ,EAAE,MAAM,iBAShD;AAED,wBAAsB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,iBAgBrE;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,UAE5E;AAED,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,iBAMpD;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,UAcpD;AAED,wBAAsB,iCAAiC,CAAC,QAAQ,EAAE,MAAM,+BAoBvE;AA+CD,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,UAoCtB;AAED,eAAO,MAAM,6BAA6B;qBAKvB,MAAM;iBACV,MAAM;YACX,MAAM,EAAE;YA2DjB,CAAC;AAEF,eAAO,MAAM,iCAAiC,YACnC,MAAM,aACJ,MAAM,EAAE,gBACL,MAAM,sBAyBrB,CAAC;AAEF,wBAAsB,qBAAqB,CAAC,EAC1C,YAAY,EACZ,QAAQ,EACR,MAAM,GACP,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,iBAgDA;AAED,wBAAsB,uBAAuB,CAC3C,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,EAAE,iBAsBzB;AAED,wBAAgB,aAAa,CAAC,EAC5B,QAAQ,EACR,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;CACpB,WAYA;AAED,wBAAgB,mBAAmB,CAAC,EAClC,QAAQ,EACR,MAAM,GACP,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,UAOA;AAED,wBAAgB,+BAA+B,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CA4B5E;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAQnD"}