fix: support include field for bundling [sc-0]

Author: umutuzgur

Diff for: packages/cli/src/commands/deploy.ts

@@ -115,6 +115,7 @@ export default class Deploy extends AuthCommand {
       verifyRuntimeDependencies,
       checklyConfigConstructs,
       playwrightConfigPath: checklyConfig.checks?.playwrightConfigPath,
+      include: checklyConfig.checks?.include,
       playwrightChecks: checklyConfig.checks?.playwrightChecks,
     })
     const repoInfo = getGitInformation(project.repoUrl)
@@ -138,7 +139,7 @@ export default class Deploy extends AuthCommand {
         }
         const {
           relativePlaywrightConfigPath, browsers, key,
-        } = await PlaywrightCheck.bundleProject(check.playwrightConfigPath)
+        } = await PlaywrightCheck.bundleProject(check.playwrightConfigPath, check.include)
         check.codeBundlePath = key
         check.browsers = browsers
         check.playwrightConfigPath = relativePlaywrightConfigPath

Diff for: packages/cli/src/commands/test.ts

@@ -184,6 +184,7 @@ export default class Test extends AuthCommand {
       verifyRuntimeDependencies,
       checklyConfigConstructs,
       playwrightConfigPath: checklyConfig.checks?.playwrightConfigPath,
+      include: checklyConfig.checks?.include,
       playwrightChecks: checklyConfig.checks?.playwrightChecks,
     })
     const checks = Object.entries(project.data.check)
@@ -240,7 +241,7 @@ export default class Test extends AuthCommand {
       }
       const {
         relativePlaywrightConfigPath, browsers, key,
-      } = await PlaywrightCheck.bundleProject(check.playwrightConfigPath)
+      } = await PlaywrightCheck.bundleProject(check.playwrightConfigPath, check.include)
       check.codeBundlePath = key
       check.browsers = browsers
       check.playwrightConfigPath = relativePlaywrightConfigPath

Diff for: packages/cli/src/constructs/playwright-check.ts

@@ -15,6 +15,7 @@ export interface PlaywrightCheckProps extends CheckProps {
   pwProjects?: string|string[]
   pwTags?: string|string[]
   browsers?: string[]
+  include?: string|string[]
 }
 
 export class PlaywrightCheck extends Check {
@@ -25,6 +26,7 @@ export class PlaywrightCheck extends Check {
   pwTags: string[]
   codeBundlePath?: string
   browsers?: string[]
+  include: string[]
   constructor (logicalId: string, props: PlaywrightCheckProps) {
     super(logicalId, props)
     this.codeBundlePath = props.codeBundlePath
@@ -36,6 +38,9 @@ export class PlaywrightCheck extends Check {
     this.pwTags = props.pwTags
       ? (Array.isArray(props.pwTags) ? props.pwTags : [props.pwTags])
       : []
+    this.include = props.include
+      ? (Array.isArray(props.include) ? props.include : [props.include])
+      : []
     this.testCommand = props.testCommand ?? 'npx playwright test'
     if (!fs.existsSync(props.playwrightConfigPath)) {
       throw new ValidationError(`Playwright config doesnt exist ${props.playwrightConfigPath}`)
@@ -54,10 +59,12 @@ export class PlaywrightCheck extends Check {
     return `${testCommand} --config ${playwrightConfigPath}${playwrightProject?.length ? ' --project ' + playwrightProject.map(project => `"${project}"`).join(' ') : ''}${playwrightTag?.length ? ' --grep="' + playwrightTag.join('|') + '"' : ''}`
   }
 
-  static async bundleProject (playwrightConfigPath: string) {
+  static async bundleProject (playwrightConfigPath: string, include: string[]) {
     let dir = ''
     try {
-      const { outputFile, browsers, relativePlaywrightConfigPath } = await bundlePlayWrightProject(playwrightConfigPath)
+      const {
+        outputFile, browsers, relativePlaywrightConfigPath,
+      } = await bundlePlayWrightProject(playwrightConfigPath, include)
       dir = outputFile
       const { data: { key } } = await uploadPlaywrightProject(dir)
       return { key, browsers, relativePlaywrightConfigPath }

Diff for: packages/cli/src/services/checkly-config-loader.ts

@@ -70,6 +70,11 @@ export type ChecklyConfig = {
      * Playwright config path to be used during bundling and playwright config parsing
      */
     playwrightConfigPath?: string,
+
+    /**
+     * Extra files to be included into the playwright bundle
+     */
+    include?: string | string[],
     /**
      * List of playwright checks that use the defined playwright config path
      */

Diff for: packages/cli/src/services/project-parser.ts

@@ -32,6 +32,7 @@ type ProjectParseOpts = {
   verifyRuntimeDependencies?: boolean,
   checklyConfigConstructs?: Construct[],
   playwrightConfigPath?: string
+  include?: string | string[],
   playwrightChecks?: PlaywrightSlimmedProp[]
 }
 
@@ -55,6 +56,7 @@ export async function parseProject (opts: ProjectParseOpts): Promise<Project> {
     verifyRuntimeDependencies,
     checklyConfigConstructs,
     playwrightConfigPath,
+    include,
     playwrightChecks,
   } = opts
   const project = new Project(projectLogicalId, {
@@ -72,13 +74,16 @@ export async function parseProject (opts: ProjectParseOpts): Promise<Project> {
   Session.defaultRuntimeId = defaultRuntimeId
   Session.verifyRuntimeDependencies = verifyRuntimeDependencies ?? true
 
+  const includeWrapped = include
+    ? (Array.isArray(include) ? include : [include])
+    : []
   // TODO: Do we really need all of the ** globs, or could we just put node_modules?
   const ignoreDirectories = ['**/node_modules/**', '**/.git/**', ...ignoreDirectoriesMatch]
   await Promise.all([
     loadAllCheckFiles(directory, checkMatch, ignoreDirectories),
     loadAllBrowserChecks(directory, browserCheckMatch, ignoreDirectories, project),
     loadAllMultiStepChecks(directory, multiStepCheckMatch, ignoreDirectories, project),
-    loadPlaywrightChecks(playwrightChecks, playwrightConfigPath),
+    loadPlaywrightChecks(playwrightChecks, playwrightConfigPath, includeWrapped),
   ])
 
   // private-location must be processed after all checks and groups are loaded.
@@ -87,16 +92,18 @@ export async function parseProject (opts: ProjectParseOpts): Promise<Project> {
   return project
 }
 
-async function loadPlaywrightChecks (playwrightChecks?: PlaywrightSlimmedProp[], playwrightConfigPath?: string) {
+async function loadPlaywrightChecks (
+  playwrightChecks?: PlaywrightSlimmedProp[], playwrightConfigPath?: string, include?: string[]) {
   if (!playwrightConfigPath) {
     return
   }
+
   if (playwrightChecks?.length) {
     for (const playwrightCheckProps of playwrightChecks) {
       // TODO: Don't upload for each check
       const {
         key, browsers, relativePlaywrightConfigPath,
-      } = await PlaywrightCheck.bundleProject(playwrightConfigPath)
+      } = await PlaywrightCheck.bundleProject(playwrightConfigPath, include ?? [])
       const playwrightCheck = new PlaywrightCheck(playwrightCheckProps.name, {
         ...playwrightCheckProps,
         codeBundlePath: key,
@@ -107,7 +114,7 @@ async function loadPlaywrightChecks (playwrightChecks?: PlaywrightSlimmedProp[],
   } else {
     const {
       key, browsers, relativePlaywrightConfigPath,
-    } = await PlaywrightCheck.bundleProject(playwrightConfigPath)
+    } = await PlaywrightCheck.bundleProject(playwrightConfigPath, include ?? [])
     const playwrightCheck = new PlaywrightCheck(path.basename(playwrightConfigPath), {
       name: path.basename(playwrightConfigPath),
       codeBundlePath: key,

Diff for: packages/cli/src/services/util.ts

@@ -231,7 +231,7 @@ export function assignProxy (baseURL: string, axiosConfig: CreateAxiosDefaults)
   return axiosConfig
 }
 
-export async function bundlePlayWrightProject (playwrightConfig: string):
+export async function bundlePlayWrightProject (playwrightConfig: string, include: string[]):
 Promise<{outputFile: string, browsers: string[], relativePlaywrightConfigPath: string}> {
   const dir = path.resolve(path.dirname(playwrightConfig))
   const filePath = path.resolve(dir, playwrightConfig)
@@ -249,7 +249,7 @@ Promise<{outputFile: string, browsers: string[], relativePlaywrightConfigPath: s
     },
   })
   archive.pipe(output)
-  await loadPlaywrightProjectFiles(dir, pwtConfig, archive)
+  await loadPlaywrightProjectFiles(dir, pwtConfig, include, archive)
   archive.file(playwrightConfig, { name: path.basename(playwrightConfig) })
   await archive.finalize()
   return new Promise((resolve, reject) => {
@@ -263,8 +263,10 @@ Promise<{outputFile: string, browsers: string[], relativePlaywrightConfigPath: s
   })
 }
 
-export async function loadPlaywrightProjectFiles (dir: string, playwrightConfig: any, archive: Archiver) {
-  const ignoredFiles: string[] = ['**/node_modules/**', '.git/**']
+export async function loadPlaywrightProjectFiles (
+  dir: string, playwrightConfig: any, include: string[], archive: Archiver,
+) {
+  const ignoredFiles = ['**/node_modules/**', '.git/**']
   const testFiles = getPlaywrightTestFiles(playwrightConfig)
   try {
     const gitignore = await fs.readFile(path.join(dir, '.gitignore'), { encoding: 'utf-8' })
@@ -276,7 +278,11 @@ export async function loadPlaywrightProjectFiles (dir: string, playwrightConfig:
     const relativePath = path.relative(dir, file)
     archive.file(file, { name: relativePath })
   }
+  // TODO: This code below should be a single glob
   archive.glob('**/package*.json', { cwd: path.join(dir, '/'), ignore: ignoredFiles })
+  for (const includePattern of include) {
+    archive.glob(includePattern, { cwd: path.join(dir, '/'), ignore: ignoredFiles })
+  }
 }
 
 export function getPlaywrightTestFiles (playwrightConfig: any): (string | RegExp)[] {