feat: run all recording files in directory with cli (#184)

* feat: run all recording files in directory with cli

* docs: document how to run all the recordings from a folder

README.md

@@ -52,6 +52,24 @@ In your `package.json` add a new script to invoke the `replay` command:
 }
 ```
 
+You can also give folder name as a parameter to run all the files in a folder.
+
+Using CLI + npx:
+
+```bash
+npx @puppeteer/replay all-recordings # runs all recordings in the "all-recordings" folder.
+```
+
+Using CLI + package.json:
+
+```json
+{
+  "scripts": {
+    "replay": "replay all-recordings"
+  }
+}
+```
+
 Set the `PUPPETEER_HEADLESS` environment variable or `--headless` CLI flag to control whether the browser is start in a headful or headless mode. For example,
 
 ```

src/CLIUtils.ts

@@ -15,12 +15,47 @@
  */
 
 import { parse, createRunner } from '../lib/main.js';
-import { readFileSync } from 'fs';
-import { join, isAbsolute } from 'path';
+import { readFileSync, readdirSync, lstatSync } from 'fs';
+import { join, isAbsolute, extname } from 'path';
 import { pathToFileURL } from 'url';
 import { cwd } from 'process';
 import { PuppeteerRunnerOwningBrowserExtension } from '../lib/main.js';
 
+export function getJSONFilesFromFolder(path: string): string[] {
+  return readdirSync(path)
+    .filter((file) => extname(file) === '.json')
+    .map((file) => join(path, file));
+}
+
+export function getRecordingPaths(
+  paths: string[],
+  log: boolean = true
+): string[] {
+  const recordingPaths: string[] = [];
+
+  for (const path of paths) {
+    let isDirectory;
+    try {
+      isDirectory = lstatSync(path).isDirectory();
+    } catch (err) {
+      log && console.error(`Couldn't find file/folder: ${path}`, err);
+
+      continue;
+    }
+
+    if (isDirectory) {
+      const filesInFolder = getJSONFilesFromFolder(path);
+
+      if (!filesInFolder.length)
+        log && console.error(`There is no recordings in: ${path}`);
+
+      recordingPaths.push(...filesInFolder);
+    } else recordingPaths.push(path);
+  }
+
+  return recordingPaths;
+}
+
 export function getHeadlessEnvVar(headless?: string) {
   if (!headless) {
     return true;

src/cli.ts

@@ -16,8 +16,7 @@
 
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
-
-import { getHeadlessEnvVar, runFiles } from './CLIUtils.js';
+import { getHeadlessEnvVar, getRecordingPaths, runFiles } from './CLIUtils.js';
 
 interface Arguments {
   files: string[];
@@ -32,7 +31,9 @@ yargs(hideBin(process.argv))
     () => {},
     async (argv) => {
       const args = argv as unknown as Arguments;
-      await runFiles(args.files, {
+      const recordingPaths = getRecordingPaths(args.files);
+
+      await runFiles(recordingPaths, {
         log: true,
         headless: getHeadlessEnvVar(
           args.headless || process.env.PUPPETEER_HEADLESS

test/cli.test.ts

@@ -14,7 +14,12 @@
     limitations under the License.
  */
 
-import { runFiles, getHeadlessEnvVar } from '../src/CLIUtils.js';
+import {
+  runFiles,
+  getHeadlessEnvVar,
+  getRecordingPaths,
+  getJSONFilesFromFolder,
+} from '../src/CLIUtils.js';
 import { assert } from 'chai';
 import path from 'path';
 import url from 'url';
@@ -42,6 +47,20 @@ describe('cli', () => {
       );
     });
 
+    it('is not able to run', async () => {
+      assert.isFalse(
+        await runFiles([path.join(__dirname, 'resources', 'replay-fail.json')])
+      );
+    });
+
+    it('is able to run able to run folder of recordings', async () => {
+      const recordings = getJSONFilesFromFolder(
+        path.join(__dirname, 'resources')
+      );
+
+      assert.isFalse(await runFiles([...recordings]));
+    });
+
     it('is able to run successfully with an extension', async () => {
       assert.isTrue(
         await runFiles([path.join(__dirname, 'resources', 'replay.json')], {
@@ -52,4 +71,26 @@ describe('cli', () => {
       );
     });
   });
+
+  describe('getRecordingPaths', () => {
+    it('is able to get recordings from a directory', () => {
+      const recordingsFolderPath = 'test/resources';
+      const recordingPaths = getRecordingPaths([recordingsFolderPath]);
+
+      assert.isTrue(
+        !!recordingPaths.find((path) => path.includes('replay.json'))
+      );
+      assert.isTrue(
+        !!recordingPaths.find((path) => path.includes('replay-fail.json'))
+      );
+    });
+  });
+
+  describe('getJSONFilesFromFolder', () => {
+    it('is able to return json files from a directory', () => {
+      const files = getJSONFilesFromFolder(path.join(__dirname, 'resources'));
+
+      assert.isTrue(files.every((file) => file.endsWith('.json')));
+    });
+  });
 });

test/resources/replay-fail.json

@@ -0,0 +1,8 @@
+{
+  "steps": [
+    {
+      "type": "navigate",
+      "url": "https://www.wikipedia.org/"
+    }
+  ]
+}