chore: minor bug fixes/features for playwright checks (#1144)

* fix: allow passing root dit lock file detector

* fix: pass detectors and proper lock file resolution pw native

* feat: allow relative paths for playwright.config file

* feat: allow passing custom config path when --create-check for pw-test

* fix: pr comments

* fix: glob for package.json only

Author: ferrandiaz

packages/cli/src/commands/pw-test.ts

@@ -110,11 +110,12 @@ export default class PwTestCommand extends AuthCommand {
       'stream-logs': streamLogs,
     } = flags
     const { configDirectory, configFilenames } = splitConfigFilePath(configFilename)
+    const pwPathFlag = this.getConfigPath(playwrightFlags)
     const {
       config: checklyConfig,
       constructs: checklyConfigConstructs,
-    } = await loadChecklyConfig(configDirectory, configFilenames, false)
-    const playwrightConfigPath = this.getConfigPath(playwrightFlags) ?? checklyConfig.checks?.playwrightConfigPath
+    } = await loadChecklyConfig(configDirectory, configFilenames, false, pwPathFlag)
+    const playwrightConfigPath = checklyConfig.checks?.playwrightConfigPath
     const dir = path.dirname(playwrightConfigPath || '.')
     const playwrightCheck = await PwTestCommand.createPlaywrightCheck(
       playwrightFlags,

packages/cli/src/services/check-parser/package-files/package-manager.ts

@@ -364,6 +364,7 @@ export const knownPackageManagers: PackageManagerDetector[] = [
 
 export interface DetectOptions {
   detectors?: PackageManagerDetector[]
+  root?: string
 }
 
 export async function detectPackageManager (
@@ -393,6 +394,7 @@ export async function detectPackageManager (
   try {
     const { packageManager } = await detectNearestLockfile(dir, {
       detectors,
+      root: options?.root,
     })
 
     return packageManager
@@ -451,7 +453,7 @@ export async function detectNearestLockfile (
   const searchPaths: string[] = []
 
   // Next, try to find a lockfile.
-  for (const searchPath of lineage(dir)) {
+  for (const searchPath of lineage(dir, { root: options?.root })) {
     try {
       searchPaths.push(searchPath)
 

packages/cli/src/services/checkly-config-loader.ts

@@ -146,7 +146,7 @@ export async function getChecklyConfigFile (): Promise<{ checklyConfig: string,
 
 export class ConfigNotFoundError extends Error {}
 
-export async function loadChecklyConfig (dir: string, filenames = ['checkly.config.ts', 'checkly.config.mts', 'checkly.config.cts', 'checkly.config.js', 'checkly.config.mjs', 'checkly.config.cjs'], writeChecklyConfig: boolean = true): Promise<{ config: ChecklyConfig, constructs: Construct[] }> {
+export async function loadChecklyConfig (dir: string, filenames = ['checkly.config.ts', 'checkly.config.mts', 'checkly.config.cts', 'checkly.config.js', 'checkly.config.mjs', 'checkly.config.cjs'], writeChecklyConfig: boolean = true, playwrightConfigPath?: string): Promise<{ config: ChecklyConfig, constructs: Construct[] }> {
   let config: ChecklyConfig | undefined
   Session.loadingChecklyConfigFile = true
   Session.checklyConfigFileConstructs = []
@@ -161,7 +161,7 @@ export async function loadChecklyConfig (dir: string, filenames = ['checkly.conf
     break
   }
   if (!config) {
-    config = await handleMissingConfig(dir, filenames, writeChecklyConfig)
+    config = await handleMissingConfig(dir, filenames, writeChecklyConfig, playwrightConfigPath)
   }
   validateConfigFields(config, ['logicalId', 'projectName'] as const)
 
@@ -178,9 +178,10 @@ async function handleMissingConfig (
   dir: string,
   filenames: string[],
   shouldWriteConfig: boolean = true,
+  pwPath?: string,
 ): Promise<ChecklyConfig> {
   const baseName = path.basename(dir)
-  const playwrightConfigPath = findPlaywrightConfigPath(dir)
+  const playwrightConfigPath = pwPath ?? findPlaywrightConfigPath(dir)
   if (playwrightConfigPath) {
     const checklyConfig = getDefaultChecklyConfig(baseName, `./${path.relative(dir, playwrightConfigPath)}`)
     if (shouldWriteConfig) {

packages/cli/src/services/project-parser.ts

@@ -125,14 +125,17 @@ async function loadPlaywrightChecks (
     return
   }
 
+  // Resolve the playwrightConfigPath relative to the project directory
+  const resolvedPlaywrightConfigPath = path.resolve(directory, playwrightConfigPath)
+
   if (playwrightChecks?.length) {
     try {
       setCheckFilePaths(playwrightConfigPath, directory)
       for (const playwrightCheckProps of playwrightChecks) {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const playwrightCheck = new PlaywrightCheck(playwrightCheckProps.logicalId, {
           ...playwrightCheckProps,
-          playwrightConfigPath,
+          playwrightConfigPath: resolvedPlaywrightConfigPath,
           include,
         })
       }
@@ -142,11 +145,11 @@ async function loadPlaywrightChecks (
   } else {
     try {
       setCheckFilePaths(playwrightConfigPath, directory)
-      const basePath = path.basename(playwrightConfigPath)
+      const basePath = path.basename(resolvedPlaywrightConfigPath)
       // eslint-disable-next-line @typescript-eslint/no-unused-vars
       const playwrightCheck = new PlaywrightCheck(basePath, {
         name: basePath,
-        playwrightConfigPath,
+        playwrightConfigPath: resolvedPlaywrightConfigPath,
         include,
       })
     } finally {

packages/cli/src/services/util.ts

@@ -20,7 +20,12 @@ import { readFile } from 'fs/promises'
 import { createHash } from 'crypto'
 import { Session } from '../constructs'
 import semver from 'semver'
-import { detectNearestLockfile } from './check-parser/package-files/package-manager'
+import {
+  detectNearestLockfile,
+  NpmDetector,
+  PNpmDetector,
+  YarnDetector,
+} from './check-parser/package-files/package-manager'
 
 export interface GitInformation {
   commitId: string
@@ -195,6 +200,10 @@ export async function bundlePlayWrightProject (
 }> {
   const dir = path.resolve(path.dirname(playwrightConfig))
   const filePath = path.resolve(dir, playwrightConfig)
+  const supportedDetectors = [new NpmDetector(), new YarnDetector(), new PNpmDetector()]
+  const { lockfile } = await detectNearestLockfile(dir, { detectors: supportedDetectors, root: Session.basePath })
+
+  // No need of loading everything if there is no lockfile
   const pwtConfig = await Session.loadFile(filePath)
   const outputFolder = await fs.mkdtemp(path.join(os.tmpdir(), 'cli-'))
   const outputFile = path.join(outputFolder, 'playwright-project.tar.gz')
@@ -209,12 +218,10 @@ export async function bundlePlayWrightProject (
   archive.pipe(output)
 
   const pwConfigParsed = new PlaywrightConfig(filePath, pwtConfig)
-  const { lockfile } = await detectNearestLockfile(dir)
-
   const [cacheHash, playwrightVersion] = await Promise.all([
     getCacheHash(lockfile),
     getPlaywrightVersion(dir),
-    loadPlaywrightProjectFiles(dir, pwConfigParsed, include, archive),
+    loadPlaywrightProjectFiles(dir, pwConfigParsed, include, archive, lockfile),
   ])
 
   await archive.finalize()
@@ -263,6 +270,7 @@ export async function getPlaywrightVersion (projectDir: string): Promise<string
 
 export async function loadPlaywrightProjectFiles (
   dir: string, pwConfigParsed: PlaywrightConfig, include: string[], archive: Archiver,
+  lockFile: string,
 ) {
   const ignoredFiles = ['**/node_modules/**', '.git/**']
   const parser = new Parser({})
@@ -275,10 +283,11 @@ export async function loadPlaywrightProjectFiles (
     const relativePath = path.relative(dir, file)
     archive.file(file, { name: relativePath, mode })
   }
-  // TODO: This code below should be a single glob
-  archive.glob('**/package*.json', { cwd: path.join(dir, '/'), ignore: ignoredFiles }, { mode })
-  archive.glob('**/pnpm*.yaml', { cwd: path.join(dir, '/'), ignore: ignoredFiles }, { mode })
-  archive.glob('**/yarn.lock', { cwd: path.join(dir, '/'), ignore: ignoredFiles }, { mode })
+  const lockFileDirName = path.dirname(lockFile)
+  archive.file(lockFile, { name: path.basename(lockFile), mode })
+  archive.file(path.join(lockFileDirName, 'package.json'), { name: 'package.json', mode })
+  // handle workspaces
+  archive.glob('**/package.json', { cwd: path.join(dir, '/'), ignore: ignoredFiles }, { mode })
   for (const includePattern of include) {
     archive.glob(includePattern, { cwd: path.join(dir, '/') }, { mode })
   }