Merge branch 'main' into document-ai-skill

Author: stefanjudis

packages/cli/e2e/__tests__/pw-test.spec.ts

@@ -54,5 +54,20 @@ describe('pw-test', { timeout: 45000 }, () => {
     expect(checklyConfig.config?.checks?.playwrightChecks.length).toBe(1)
     expect(checklyConfig.config?.checks?.playwrightChecks[0].name).toBe('Playwright Test: --grep @TAG-B')
     expect(checklyConfig.config?.checks?.playwrightChecks[0].testCommand).toBe('npx playwright test --grep @TAG-B')
+    expect(checklyConfig.config?.checks?.playwrightChecks[0].frequency).toBe(10)
+  })
+
+  it('Should add a Playwright test with custom frequency', async () => {
+    const result = await runChecklyCli({
+      args: ['pw-test', '--create-check', '--frequency', '5', '--', `--grep`, '@TAG-B'],
+      apiKey: config.get('apiKey'),
+      accountId: config.get('accountId'),
+      directory: FIXTURE_TEST_PWT_NATIVE,
+      timeout: 120000, // 2 minutes
+    })
+    expect(result.status).toBe(0)
+    const configContent = fs.readFileSync(
+      path.join(FIXTURE_TEST_PWT_NATIVE, 'checkly.config.ts'), 'utf-8')
+    expect(configContent).toContain('frequency: 5')
   })
 })

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

@@ -32,6 +32,7 @@ import {
   findPropertyByName,
   reWriteChecklyConfigFile,
 } from '../helpers/write-config-helpers'
+import * as acornParser from '../helpers/recast-acorn-parser'
 import * as JSON5 from 'json5'
 import { detectPackageManager } from '../services/check-parser/package-files/package-manager'
 import { DEFAULT_REGION } from '../helpers/constants'
@@ -88,6 +89,12 @@ export default class PwTestCommand extends AuthCommand {
       description: 'Create a Checkly check from the Playwright test.',
       default: false,
     }),
+    'frequency': Flags.integer({
+      char: 'f',
+      description: 'The frequency in minutes for the created check.',
+      default: 10,
+      options: ['1', '2', '5', '10', '15', '30', '60', '120', '180', '360', '720', '1440'],
+    }),
     'stream-logs': Flags.boolean({
       description: 'Stream logs from the test run to the console.',
       default: true,
@@ -121,6 +128,7 @@ export default class PwTestCommand extends AuthCommand {
       'create-check': createCheck,
       'stream-logs': streamLogs,
       'include': includeFlag,
+      'frequency': frequency,
     } = flags
     const { configDirectory, configFilenames } = splitConfigFilePath(configFilename)
     const pwPathFlag = this.getConfigPath(playwrightFlags)
@@ -147,6 +155,7 @@ export default class PwTestCommand extends AuthCommand {
       runLocation as keyof Region,
       privateRunLocation,
       dir,
+      frequency,
     )
     if (createCheck) {
       this.style.actionStart('Adding check with specified options to the Checkly config file')
@@ -245,7 +254,8 @@ export default class PwTestCommand extends AuthCommand {
     const checkBundles = Object.values(projectBundle.data.check)
 
     if (!checkBundles.length) {
-      this.log(`Unable to find checks to run`)
+      this.style.shortError('Unable to find checks to run.')
+      this.style.shortInfo('Check your Playwright configuration to ensure it targets your test files.')
       return
     }
 
@@ -297,10 +307,15 @@ export default class PwTestCommand extends AuthCommand {
       }, links))
     })
 
+    const noTestsFoundChecks = new Set<string>()
+
     runner.on(Events.CHECK_SUCCESSFUL,
       (sequenceId: SequenceId, check, result, testResultId, links?: TestResultsShortLinks) => {
         if (result.hasFailures) {
           process.exitCode = 1
+          if (noTestsFoundChecks.has(check.logicalId)) {
+            this.style.shortInfo('Check your Playwright configuration to ensure it targets your test files.')
+          }
         }
 
         reporters.forEach(r => r.onCheckEnd(sequenceId, {
@@ -318,6 +333,9 @@ export default class PwTestCommand extends AuthCommand {
         hasFailures: true,
         runError: message,
       }))
+      if (message.includes('No tests found')) {
+        this.style.shortInfo('Check your Playwright configuration to ensure it targets your test files.')
+      }
       process.exitCode = 1
     })
     runner.on(Events.RUN_FINISHED, () => reporters.forEach(r => r.onEnd()))
@@ -327,6 +345,10 @@ export default class PwTestCommand extends AuthCommand {
     })
     runner.on(Events.STREAM_LOGS, (check: any, sequenceId: SequenceId, logs) => {
       reporters.forEach(r => r.onStreamLogs(check, sequenceId, logs))
+      const hasNoTestsFound = logs.some((log: { message: string }) => log.message?.includes('No tests found'))
+      if (hasNoTestsFound) {
+        noTestsFoundChecks.add(check.logicalId)
+      }
     })
     await runner.run()
   }
@@ -336,6 +358,7 @@ export default class PwTestCommand extends AuthCommand {
     runLocation: keyof Region,
     privateRunLocation: string | undefined,
     dir: string,
+    frequency: number = 10,
   ): Promise<PlaywrightSlimmedProp> {
     const parseArgs = args.map(arg => shellQuote(arg))
     const input = parseArgs.join(' ') || ''
@@ -352,7 +375,7 @@ export default class PwTestCommand extends AuthCommand {
       name: `Playwright Test: ${input}`,
       testCommand,
       ...locationConfig,
-      frequency: 10,
+      frequency,
     }
   }
 
@@ -378,7 +401,7 @@ export default class PwTestCommand extends AuthCommand {
       this.style.actionSuccess()
       return
     }
-    const checklyAst = recast.parse(configFile.checklyConfig)
+    const checklyAst = recast.parse(configFile.checklyConfig, { parser: acornParser })
     const checksAst = findPropertyByName(checklyAst, 'checks')
     if (!checksAst) {
       this.style.longError('Unable to automatically sync your config file.', 'This can happen if your Checkly config is '
@@ -395,7 +418,7 @@ export default class PwTestCommand extends AuthCommand {
     )
 
     const playwrightCheckString = `const playwrightCheck = ${JSON5.stringify(playwrightCheck, { space: 2 })}`
-    const playwrightCheckAst = recast.parse(playwrightCheckString)
+    const playwrightCheckAst = recast.parse(playwrightCheckString, { parser: acornParser })
     const playwrightCheckNode = playwrightCheckAst.program.body[0].declarations[0].init
     addOrReplaceItem(checksAst.value, playwrightPropertyNode, 'playwrightConfigPath')
     addItemToArray(checksAst.value, playwrightCheckNode, 'playwrightChecks')

packages/cli/src/commands/sync-playwright.ts

@@ -6,6 +6,7 @@ import path from 'path'
 import { ux } from '@oclif/core'
 import PlaywrightConfigTemplate from '../playwright/playwright-config-template'
 import { addOrReplaceItem, findPropertyByName, reWriteChecklyConfigFile } from '../helpers/write-config-helpers'
+import * as acornParser from '../helpers/recast-acorn-parser'
 
 export default class SyncPlaywright extends BaseCommand {
   static hidden = false
@@ -20,7 +21,7 @@ export default class SyncPlaywright extends BaseCommand {
     if (!configFile) {
       return this.handleError('Could not find a checkly config file')
     }
-    const checklyAst = recast.parse(configFile.checklyConfig)
+    const checklyAst = recast.parse(configFile.checklyConfig, { parser: acornParser })
 
     const config = await loadPlaywrightConfig()
     if (!config) {
@@ -35,7 +36,7 @@ export default class SyncPlaywright extends BaseCommand {
     }
 
     const pwtConfig = new PlaywrightConfigTemplate(config).getConfigTemplate()
-    const pwtConfigAst = findPropertyByName(recast.parse(pwtConfig), 'playwrightConfig')
+    const pwtConfigAst = findPropertyByName(recast.parse(pwtConfig, { parser: acornParser }), 'playwrightConfig')
     addOrReplaceItem(checksAst.value, pwtConfigAst, 'playwrightConfig')
 
     const checklyConfigData = recast.print(checklyAst, { tabWidth: 2 }).code

packages/cli/src/helpers/__tests__/recast-acorn-parser.spec.ts

@@ -0,0 +1,38 @@
+import { describe, it, expect } from 'vitest'
+import * as recast from 'recast'
+import * as acornParser from '../recast-acorn-parser'
+import { findPropertyByName } from '../write-config-helpers'
+
+const normalizeLineEndings = (str: string) => str.replace(/\r\n/g, '\n')
+
+describe('recast-acorn-parser', () => {
+  it('should parse numeric literals with underscore separators', () => {
+    const source = 'const x = 1_000_000'
+    const ast = recast.parse(source, { parser: acornParser })
+    const output = recast.print(ast).code
+    expect(normalizeLineEndings(output)).toBe(source)
+  })
+
+  it('should parse config-like code with underscore-separated numbers', () => {
+    const source = `const config = {
+  timeout: 30_000,
+  frequency: 1_440,
+}`
+    const ast = recast.parse(source, { parser: acornParser })
+    const prop = findPropertyByName(ast, 'timeout')
+    expect(prop).toBeDefined()
+    expect(normalizeLineEndings(recast.print(ast).code)).toBe(source)
+  })
+
+  it('should preserve comments', () => {
+    const source = '// a comment\nconst x = 1'
+    const ast = recast.parse(source, { parser: acornParser })
+    expect(normalizeLineEndings(recast.print(ast).code)).toBe(source)
+  })
+
+  it('should parse module syntax', () => {
+    const source = 'import foo from \'bar\'\nexport default foo'
+    const ast = recast.parse(source, { parser: acornParser })
+    expect(normalizeLineEndings(recast.print(ast).code)).toBe(source)
+  })
+})

packages/cli/src/helpers/recast-acorn-parser.ts

@@ -0,0 +1,22 @@
+import * as acorn from 'acorn'
+
+export function parse (source: string) {
+  const comments: acorn.Comment[] = []
+  const tokens: acorn.Token[] = []
+  const ast = acorn.parse(source, {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    locations: true,
+    allowImportExportEverywhere: true,
+    allowReturnOutsideFunction: true,
+    onComment: comments,
+    onToken: tokens,
+  })
+  if (!(ast as any).comments) {
+    (ast as any).comments = comments
+  }
+  if (!(ast as any).tokens) {
+    (ast as any).tokens = tokens
+  }
+  return ast
+}