@checksum-ai/runtime 4.16.2-beta.1 → 4.16.3

package/index.d.ts

@@ -11,7 +11,6 @@ import {
   Dialog,
 } from "@playwright/test";
 
-// import { ExpectWrapper } from "./index.helpers";
 interface ChecksumAIMethod {
   (title: string): IChecksumPage;
   <T>(
@@ -110,7 +109,6 @@ export interface CompoundSelectionInterface {
    *    target?: (base) => base.locator("<relative selector to target element>")
    * }).first().click();
    * ```
-   * @param selection
    * @returns Locator to the common parent(s) or the target element(s) if specified.
    */
   compoundSelection(selection: {

package/package.json

@@ -45,5 +45,5 @@
     "url": "https://github.com/checksum-ai/checksum-ai-monorepo/issues"
   },
   "homepage": "https://github.com/checksum-ai/checksum-ai-monorepo/tree/main/packages/runtime#readme",
-  "version": "4.16.2-beta.1"
+  "version": "4.16.3"
 }

package/scripts/patch.js

@@ -11,8 +11,6 @@ const availablePatchVersions = fs
   .map((patchFile) => path.basename(patchFile, ".js"))
   .sort();
 
-// console.log("patchVersions", availablePatchVersions);
-
 function findSuitablePatchVersion(version) {
   let suitablePatchVersion = availablePatchVersions[0];
   for (const patchVersion of availablePatchVersions) {
@@ -39,20 +37,12 @@ for (const projectPath of projectPaths) {
       const packageJSON = require(absolutePathToPackageJSON);
       const playwrightVersion = packageJSON.version;
       const patchVersion = findSuitablePatchVersion(playwrightVersion);
-      // console.log(
-      //   "Found installed version",
-      //   playwrightVersion,
-      //   "and will use patch for version",
-      //   patchVersion
-      // );
       const patchPath = resolve(
         join(getPlaywrightPatchesDirectory(), `${patchVersion}.js`)
       );
       require(patchPath)(projectPath);
-    } else {
-      // console.warn("Project path not found", projectPath);
     }
   } catch (e) {
-    // ignore for now although we might want to notify users that patching wasn't successful
+    // Patching is best-effort: a failure here must not block the install.
   }
 }

package/scripts/playwright_patches/1.41.2.js

@@ -1,52 +1,41 @@
 const fs = require("fs");
 const { join } = require("path");
 
-// Args
 const on = process.argv[2] !== "off";
 
-// -------- [Modifiers] -------- //
-
-// Amends the file with the given entry point text and append text
-// When "on" is true, the append text is added to the entry point,
-// otherwise the append text is completely removed from the file
+// When `on`, appendText is spliced in after entryPointText; when off, it is
+// stripped back out. Leaves no marker, so an amend cannot be detected later.
 function amend(filePath, entryPointText, appendText) {
   const data = fs.readFileSync(filePath, "utf8");
   if (!data.includes(entryPointText)) {
     throw new Error("Entry point not found!", entryPointText);
   }
-  // Ignore if the append text is already present
   if (on && data.includes(appendText)) {
     return;
   }
-  // Add or clear according to on state
   const result = on
     ? data.replace(entryPointText, entryPointText + appendText)
     : data.replace(appendText, "");
 
-  // Write
   fs.writeFileSync(filePath, result, "utf8");
 }
 
-// Replaces content.
-// When "on" is true, the new content is written to the file replacing the original content,
-// otherwise the original content is restored.
+// When `on`, newContent replaces originalContent; when off, the original is
+// restored. The `/* checksumai */` prefix is the marker that makes the off
+// direction findable.
 function replaceContent(filePath, originalContent, newContent) {
-  // Read the file content
   const fileContent = fs.readFileSync(filePath, "utf8");
 
-  // add a marker for newContent that can be later recognized for "off" state
   newContent = `/* checksumai */ ${newContent}`;
 
   if (on && fileContent.includes(newContent)) {
     return;
   }
 
-  // Join the lines back into a single string
   const updatedContent = on
     ? fileContent.replace(originalContent, newContent)
     : fileContent.replace(newContent, originalContent);
 
-  // Write the modified content back to the file
   fs.writeFileSync(filePath, updatedContent, "utf8");
 }
 
@@ -58,9 +47,6 @@ function doesFileExist(filePath) {
   return true;
 }
 
-// -------- [Modifications] -------- //
-
-// Remove conditions for injecting Playwright scripts
 function alwaysInjectScripts(projectRoot) {
   const file = join(
     projectRoot,
@@ -78,7 +64,6 @@ function alwaysInjectScripts(projectRoot) {
   replaceContent(file, originalContent, newContent);
 }
 
-// Add implementation for generateSelectorAndLocator and inject to Playwright console API
 function addGenerateSelectorAndLocator(projectRoot) {
   const file = join(
     projectRoot,
@@ -99,8 +84,6 @@ function addGenerateSelectorAndLocator(projectRoot) {
   amend(file, entryPointText2, appendText2);
 }
 
-// -------- [Runtime modifications] -------- //
-
 function expect(projectRoot) {
   const file = join(
     projectRoot,
@@ -216,12 +199,18 @@ function testType(projectRoot) {
 }
 
 function indexContent(projectRoot) {
-  const file = join(projectRoot, "node_modules", "playwright", "lib", "index.js")
+  const file = join(
+    projectRoot,
+    "node_modules",
+    "playwright",
+    "lib",
+    "index.js"
+  );
   if (!doesFileExist) {
     return;
   }
   let originalContent, newContent;
-  originalContent = `const browser = await playwright[browserName].launch();`
+  originalContent = `const browser = await playwright[browserName].launch();`;
   newContent = `
     let browser = playwright[browserName];
     try {
@@ -250,8 +239,8 @@ function indexContent(projectRoot) {
       );
     }
     browser = await browser.launch();
-  `
-  replaceContent(file, originalContent, newContent)
+  `;
+  replaceContent(file, originalContent, newContent);
 }
 
 function channelOwner(projectRoot) {
@@ -283,8 +272,6 @@ function channelOwner(projectRoot) {
   amend(file, entryPointText, appendText);
 }
 
-// -------- [Run] -------- //
-
 const isRuntime = true || process.env.RUNTIME === "true";
 
 function run(projectPath) {
@@ -299,11 +286,9 @@ function run(projectPath) {
         channelOwner(projectPath);
         indexContent(projectPath);
       }
-    } else {
-      // console.warn("Project path not found", projectPath);
     }
   } catch (e) {
-    // ignore
+    // Patching is best-effort: a failure here must not block the install.
   }
 }
 

package/scripts/playwright_patches/1.46.0.js

@@ -1,52 +1,41 @@
 const fs = require("fs");
 const { join } = require("path");
 
-// Args
 const on = process.argv[2] !== "off";
 
-// -------- [Modifiers] -------- //
-
-// Amends the file with the given entry point text and append text
-// When "on" is true, the append text is added to the entry point,
-// otherwise the append text is completely removed from the file
+// When `on`, appendText is spliced in after entryPointText; when off, it is
+// stripped back out. Leaves no marker, so an amend cannot be detected later.
 function amend(filePath, entryPointText, appendText) {
   const data = fs.readFileSync(filePath, "utf8");
   if (!data.includes(entryPointText)) {
     throw new Error("Entry point not found!", entryPointText);
   }
-  // Ignore if the append text is already present
   if (on && data.includes(appendText)) {
     return;
   }
-  // Add or clear according to on state
   const result = on
     ? data.replace(entryPointText, entryPointText + appendText)
     : data.replace(appendText, "");
 
-  // Write
   fs.writeFileSync(filePath, result, "utf8");
 }
 
-// Replaces content.
-// When "on" is true, the new content is written to the file replacing the original content,
-// otherwise the original content is restored.
+// When `on`, newContent replaces originalContent; when off, the original is
+// restored. The `/* checksumai */` prefix is the marker that makes the off
+// direction findable.
 function replaceContent(filePath, originalContent, newContent) {
-  // Read the file content
   const fileContent = fs.readFileSync(filePath, "utf8");
 
-  // add a marker for newContent that can be later recognized for "off" state
   newContent = `/* checksumai */ ${newContent}`;
 
   if (on && fileContent.includes(newContent)) {
     return;
   }
 
-  // Join the lines back into a single string
   const updatedContent = on
     ? fileContent.replace(originalContent, newContent)
     : fileContent.replace(newContent, originalContent);
 
-  // Write the modified content back to the file
   fs.writeFileSync(filePath, updatedContent, "utf8");
 }
 
@@ -58,9 +47,6 @@ function doesFileExist(filePath) {
   return true;
 }
 
-// -------- [Modifications] -------- //
-
-// Remove conditions for injecting Playwright scripts
 function alwaysInjectScripts(projectRoot) {
   const file = join(
     projectRoot,
@@ -78,7 +64,6 @@ function alwaysInjectScripts(projectRoot) {
   replaceContent(file, originalContent, newContent);
 }
 
-// Add implementation for generateSelectorAndLocator and inject to Playwright console API
 function addGenerateSelectorAndLocator(projectRoot) {
   const file = join(
     projectRoot,
@@ -99,8 +84,6 @@ function addGenerateSelectorAndLocator(projectRoot) {
   amend(file, entryPointText2, appendText2);
 }
 
-// -------- [Runtime modifications] -------- //
-
 function expect(projectRoot) {
   const file = join(
     projectRoot,
@@ -110,30 +93,6 @@ function expect(projectRoot) {
     return;
   }
   let originalContent, newContent;
-
-  // originalContent = `return (...args) => {
-  //     const testInfo = (0, _globals.currentTestInfo)();`;
-  // newContent = `return (...args) => {
-  //     let noSoft = false;
-  //     if (args.find(arg=>arg==='no-soft')){
-  //       noSoft = true;
-  //       args.pop();
-  //     }
-  //     const testInfo = (0, _globals.currentTestInfo)();`;
-  // replaceContent(file, originalContent, newContent);
-
-  // originalContent = `step.complete({
-  //         error
-  //       })`;
-  // newContent = `step.complete({
-  //         error,
-  //         noSoft
-  //       })`;
-  // replaceContent(file, originalContent, newContent);
-
-  // originalContent = `if (this._info.isSoft) testInfo._failWithError(error);else throw error;`;
-  // newContent = `if (this._info.isSoft && !noSoft) testInfo._failWithError(error);else throw error;`;
-  // replaceContent(file, originalContent, newContent);
 }
 
 function testInfo(projectRoot) {
@@ -147,10 +106,6 @@ function testInfo(projectRoot) {
   let originalContent, newContent;
   let entryPointText, appendText;
 
-  // originalContent = `const filteredStack = (0, _util.filteredStackTrace)((0, _utils.captureRawStack)());`;
-  // newContent = `const filteredStack = (0, _util.filteredStackTrace)((0, _utils.captureRawStack)().filter(s=>!s.includes('@checksum-ai/runtime')));`;
-  // replaceContent(file, originalContent, newContent);
-
   entryPointText = `data.location = data.location || filteredStack[0];`;
   appendText = `\nif (this._checksumInternal) {
       data.location = undefined;
@@ -256,10 +211,6 @@ function channelOwner(projectRoot) {
     }`;
   amend(file, entryPointText, appendText);
 
-  // originalContent = `const stack = (0, _stackTrace.captureRawStack)();`;
-  // newContent = `const stack = (0, _stackTrace.captureRawStack)().filter(s=>!s.includes('@checksum-ai/runtime'));`;
-  // replaceContent(file, originalContent, newContent);
-
   entryPointText = `let apiName = stackTrace.apiName;`;
   appendText = `\nif (!isInternal && this._checksumTitle){
       apiName = this._checksumTitle;
@@ -289,8 +240,6 @@ function stackTrace(projectRoot) {
   replaceContent(file, originalContent, newContent);
 }
 
-// -------- [Run] -------- //
-
 const isRuntime = true || process.env.RUNTIME === "true";
 
 function run(projectPath) {
@@ -306,11 +255,9 @@ function run(projectPath) {
         stackTrace(projectPath);
         indexContent(projectPath);
       }
-    } else {
-      // console.warn("Project path not found", projectPath);
     }
   } catch (e) {
-    // ignore
+    // Patching is best-effort: a failure here must not block the install.
   }
 }
 

package/scripts/playwright_patches/1.51.0.js

@@ -1,52 +1,41 @@
 const fs = require("fs");
 const { join } = require("path");
 
-// Args
 const on = process.argv[2] !== "off";
 
-// -------- [Modifiers] -------- //
-
-// Amends the file with the given entry point text and append text
-// When "on" is true, the append text is added to the entry point,
-// otherwise the append text is completely removed from the file
+// When `on`, appendText is spliced in after entryPointText; when off, it is
+// stripped back out. Leaves no marker, so an amend cannot be detected later.
 function amend(filePath, entryPointText, appendText) {
   const data = fs.readFileSync(filePath, "utf8");
   if (!data.includes(entryPointText)) {
     throw new Error("Entry point not found!", entryPointText);
   }
-  // Ignore if the append text is already present
   if (on && data.includes(appendText)) {
     return;
   }
-  // Add or clear according to on state
   const result = on
     ? data.replace(entryPointText, entryPointText + appendText)
     : data.replace(appendText, "");
 
-  // Write
   fs.writeFileSync(filePath, result, "utf8");
 }
 
-// Replaces content.
-// When "on" is true, the new content is written to the file replacing the original content,
-// otherwise the original content is restored.
+// When `on`, newContent replaces originalContent; when off, the original is
+// restored. The `/* checksumai */` prefix is the marker that makes the off
+// direction findable.
 function replaceContent(filePath, originalContent, newContent) {
-  // Read the file content
   const fileContent = fs.readFileSync(filePath, "utf8");
 
-  // add a marker for newContent that can be later recognized for "off" state
   newContent = `/* checksumai */ ${newContent}`;
 
   if (on && fileContent.includes(newContent)) {
     return;
   }
 
-  // Join the lines back into a single string
   const updatedContent = on
     ? fileContent.replace(originalContent, newContent)
     : fileContent.replace(newContent, originalContent);
 
-  // Write the modified content back to the file
   fs.writeFileSync(filePath, updatedContent, "utf8");
 }
 
@@ -58,9 +47,6 @@ function doesFileExist(filePath) {
   return true;
 }
 
-// -------- [Modifications] -------- //
-
-// Remove conditions for injecting Playwright scripts
 function alwaysInjectScripts(projectRoot) {
   const file = join(
     projectRoot,
@@ -71,7 +57,6 @@ function alwaysInjectScripts(projectRoot) {
   }
   const originalContent =
     "if ((0, _debug.debugMode)() === 'console') await this.extendInjectedScript(consoleApiSource.source);";
-  // "if ((0, _utils.debugMode)() === 'console') await this.extendInjectedScript(consoleApiSource.source);";
 
   const newContent =
     "await this.extendInjectedScript(consoleApiSource.source);";
@@ -79,7 +64,6 @@ function alwaysInjectScripts(projectRoot) {
   replaceContent(file, originalContent, newContent);
 }
 
-// Add implementation for generateSelectorAndLocator and inject to Playwright console API
 function addGenerateSelectorAndLocator(projectRoot) {
   const file = join(
     projectRoot,
@@ -100,8 +84,6 @@ function addGenerateSelectorAndLocator(projectRoot) {
   amend(file, entryPointText2, appendText2);
 }
 
-// -------- [Runtime modifications] -------- //
-
 function expect(projectRoot) {
   const file = join(
     projectRoot,
@@ -111,30 +93,6 @@ function expect(projectRoot) {
     return;
   }
   let originalContent, newContent;
-
-  // originalContent = `return (...args) => {
-  //     const testInfo = (0, _globals.currentTestInfo)();`;
-  // newContent = `return (...args) => {
-  //     let noSoft = false;
-  //     if (args.find(arg=>arg==='no-soft')){
-  //       noSoft = true;
-  //       args.pop();
-  //     }
-  //     const testInfo = (0, _globals.currentTestInfo)();`;
-  // replaceContent(file, originalContent, newContent);
-
-  // originalContent = `step.complete({
-  //         error
-  //       })`;
-  // newContent = `step.complete({
-  //         error,
-  //         noSoft
-  //       })`;
-  // replaceContent(file, originalContent, newContent);
-
-  // originalContent = `if (this._info.isSoft) testInfo._failWithError(error);else throw error;`;
-  // newContent = `if (this._info.isSoft && !noSoft) testInfo._failWithError(error);else throw error;`;
-  // replaceContent(file, originalContent, newContent);
 }
 
 function testInfo(projectRoot) {
@@ -148,10 +106,6 @@ function testInfo(projectRoot) {
   let originalContent, newContent;
   let entryPointText, appendText;
 
-  // originalContent = `const filteredStack = (0, _util.filteredStackTrace)((0, _utils.captureRawStack)());`;
-  // newContent = `const filteredStack = (0, _util.filteredStackTrace)((0, _utils.captureRawStack)().filter(s=>!s.includes('@checksum-ai/runtime')));`;
-  // replaceContent(file, originalContent, newContent);
-
   entryPointText = `data.location = data.location || filteredStack[0];`;
   appendText = `\nif (this._checksumInternal) {
       data.location = undefined;
@@ -189,7 +143,6 @@ function testType(projectRoot) {
   }
 
   entryPointText = `return await (0, _utils.currentZone)().with('stepZone', step).run(async () => {`;
-  // entryPointText = `return await _utils.zones.run('stepZone', step, async () => {`;
   appendText = `\nif (options.obtainStep){
         options.obtainStep(step);
       }`;
@@ -253,18 +206,12 @@ function channelOwner(projectRoot) {
   let entryPointText, appendText;
 
   entryPointText = `async _wrapApiCall(func, isInternal) {`;
-  // entryPointText = `async _wrapApiCall(func, isInternal = false) {`;
 
   appendText = `\nif (this._checksumInternal){
       isInternal = true;
     }`;
   amend(file, entryPointText, appendText);
 
-  // originalContent = `const stack = (0, _stackTrace.captureRawStack)();`;
-  // newContent = `const stack = (0, _stackTrace.captureRawStack)().filter(s=>!s.includes('@checksum-ai/runtime'));`;
-  // replaceContent(file, originalContent, newContent);
-
-  // entryPointText = `let apiName = stackTrace.apiName;`;
   entryPointText = `const apiZone = {
       apiName: stackTrace.apiName,
       frames: stackTrace.frames,
@@ -287,18 +234,11 @@ function channelOwner(projectRoot) {
       apiZone.apiName = apiZone.apiName.replace('proxy', 'page');
     }`;
   amend(file, entryPointText, appendText);
-
-  // entryPointText = `if (isInternal) apiName = undefined;`;
-  // appendText = `\nif (apiName && apiName.startsWith('proxy')) {
-  //     apiName = apiName.replace('proxy', 'page');
-  //   }`;
-  // amend(file, entryPointText, appendText);
 }
 
 function stackTrace(projectRoot) {
   const file = join(
     projectRoot,
-    // "node_modules/playwright-core/lib/utils/stackTrace.js"
     "node_modules/playwright-core/lib/utils/isomorphic/stackTrace.js"
   );
   if (!doesFileExist(file)) {
@@ -311,8 +251,6 @@ function stackTrace(projectRoot) {
   replaceContent(file, originalContent, newContent);
 }
 
-// -------- [Run] -------- //
-
 const isRuntime = true || process.env.RUNTIME === "true";
 
 function run(projectPath) {
@@ -328,11 +266,9 @@ function run(projectPath) {
         stackTrace(projectPath);
         indexContent(projectPath);
       }
-    } else {
-      // console.warn("Project path not found", projectPath);
     }
   } catch (e) {
-    // ignore
+    // Patching is best-effort: a failure here must not block the install.
   }
 }