testilo 33.6.2 → 34.0.1

package/README.md

@@ -343,7 +343,7 @@ const standard = 'only';
 const observe = false;
 const requester = 'me@mydomain.tld';
 const timeStamp = '241215T1200';
-const jobs = merge(script, batch, standard, observe, requester, timeStamp);
+const jobs = merge(script, batch, standard, observe, requester, timeStamp, deviceID);
 ```
 
 The first two arguments are a script and a batch obtained from files or from prior calls to `script()` and `batch()`.
@@ -356,6 +356,8 @@ The `requester` argument is an email address to which any notices about the job
 
 The `timeStamp` argument specifies the earliest UTC date and time when the jobs may be assigned, or it may be an empty string if now.
 
+The `deviceID` argument specifies the ID of the test device. It must be either `'default'` or the ID of one of the test devices recognized by Playwright, published at `https://github.com/microsoft/playwright/blob/main/packages/playwright-core/src/server/deviceDescriptorsSource.json`.
+
 The `merge()` function returns the jobs in an array. The invoking module can further dispose of the jobs as needed.
 
 ##### By a user
@@ -367,13 +369,13 @@ A user can invoke `merge()` in this way:
 - In the Testilo project directory, execute the statement:
 
 ```javascript
-node call merge scriptID batchID standard observe requester timeStamp todoDir
+node call merge scriptID batchID standard observe requester timeStamp deviceID todoDir
 ```
 
 In this statement, replace:
 - `scriptID` with the ID (which is also the base of the file name) of the script.
 - `batchID` with the ID (which is also the base of the file name) of the batch.
-- `standard`, `observe`, `requester`, and `timeStamp` as described above.
+- `standard`, `observe`, `requester`, `timeStamp`, and `deviceID` as described above.
 - `todoDir`: `true` if the jobs are to be saved in the `todo` subdirectory, or `false` if they are to be saved in the `pending` subdirectory, of the `JOBDIR` directory.
 
 The `call` module will retrieve the named script and batch from their respective directories.
@@ -399,6 +401,7 @@ A Testaro job produced by `merge` may look like this:
       type: 'launch',
       which: 'webkit',
       what: 'Acme Clothes',
+      deviceID: 'Galaxy S8',
       url: 'https://acmeclothes.com/'
     },
     {
@@ -412,6 +415,7 @@ A Testaro job produced by `merge` may look like this:
       type: 'launch',
       which: 'webkit',
       what: 'Acme Clothes',
+      deviceID: 'Galaxy S8',
       url: 'https://acmeclothes.com/'
     },
     {
@@ -929,7 +933,7 @@ node call credit legislators 241106
 ```
 
 When a user invokes `credit` in this example, the `call` module:
-- gets all reports, or if the third argument to `call()` exists all reports whose file names begin with `'241106'`, in the `scored` subdirectory of the `REPORTDIR` directory. 
+- gets all reports, or if the third argument to `call()` exists all reports whose file names begin with `'241106'`, in the `scored` subdirectory of the `REPORTDIR` directory.
 - gets the `score` properties of those reports.
 - creates an ID for the credit report.
 - writes the credit report as a JSON file, with the ID as the base of its file name and `legislators` as its description, to the `credit` subdirectory of the `REPORTDIR` directory.

package/call.js

@@ -185,6 +185,7 @@ const callMerge = async (
   observe,
   requester,
   timeStamp,
+  deviceID,
   todoDir
 ) => {
   try {
@@ -199,7 +200,7 @@ const callMerge = async (
     const batchJSON = await fs.readFile(`${specDir}/batches/${batchID}.json`, 'utf8');
     const batch = JSON.parse(batchJSON);
     // Merge them into an array of jobs.
-    const jobs = merge(script, batch, standard, observe === 'true', requester, timeStamp);
+    const jobs = merge(script, batch, standard, observe === 'true', requester, timeStamp, deviceID);
     // Save the jobs.
     const subdir = `${jobDir}/${todoDir === 'true' ? 'todo' : 'pending'}`;
     for (const job of jobs) {
@@ -362,7 +363,7 @@ const callSummarize = async (what, selector = '') => {
     };
     // Save the summary report.
     const summaryDir = `${reportDir}/summarized`;
-    await fs.mkdir(summaryDir, {recursive: true}); 
+    await fs.mkdir(summaryDir, {recursive: true});
     const filePath = `${summaryDir}/${summaryReport.id}.json`;
     await fs.writeFile(filePath, `${JSON.stringify(summaryReport, null, 2)}\n`);
     console.log(`Reports summarized and summary report saved as ${filePath}`);
@@ -385,7 +386,7 @@ const callCompare = async (what, compareProcID, selector) => {
       const {comparer} = require(`${comparerDir}/index`);
       // Compare the reports and save the comparison.
       const comparisonDir = `${reportDir}/comparative`;
-      await fs.mkdir(comparisonDir, {recursive: true}); 
+      await fs.mkdir(comparisonDir, {recursive: true});
       const id = getFileID(2);
       const comparison = await compare(id, what, comparer, summaryReport);
       const comparisonPath = `${comparisonDir}/${id}.html`;
@@ -476,7 +477,7 @@ else if (fn === 'script' && (fnArgs.length === 2 || fnArgs.length > 3)) {
     console.log('Execution completed');
   });
 }
-else if (fn === 'merge' && fnArgs.length === 7) {
+else if (fn === 'merge' && fnArgs.length === 8) {
   callMerge(... fnArgs)
   .then(() => {
     console.log('Execution completed');

package/merge.js

@@ -8,7 +8,7 @@
 // Module to keep secrets.
 require('dotenv').config();
 // Utility module.
-const {alphaNumOf, dateOf, getRandomString, getNowStamp} = require('./procs/util');
+const {alphaNumOf, dateOf, getRandomString, getNowStamp, isValidDeviceID} = require('./procs/util');
 
 // ########## CONSTANTS
 
@@ -27,7 +27,7 @@ const mergeIDLength = 2;
 // ########## FUNCTIONS
 
 // Merges a script and a batch and returns jobs.
-exports.merge = (script, batch, standard, observe, requester, timeStamp) => {
+exports.merge = (script, batch, standard, observe, requester, timeStamp, deviceID) => {
   // If standard is invalid:
   if (! ['also', 'only', 'no'].includes(standard)) {
     // Report this and quit.
@@ -45,7 +45,7 @@ exports.merge = (script, batch, standard, observe, requester, timeStamp) => {
     // If it is invalid:
     if (! dateOf(timeStamp)) {
       // Report this and quit.
-      console.log(`ERROR: Timestamp invalid`);
+      console.log('ERROR: Timestamp invalid');
       return [];
     }
   }
@@ -54,6 +54,12 @@ exports.merge = (script, batch, standard, observe, requester, timeStamp) => {
     // Create one for the job.
     timeStamp = getNowStamp();
   }
+  // If deviceID is invalid:
+  if (! isValidDeviceID(deviceID)) {
+    // Report this and quit.
+    console.log('ERROR: Device ID invalid');
+    return [];
+  }
   // Initialize a job as a copy of the script.
   const protoJob = JSON.parse(JSON.stringify(script));
   // Add an initialized sources property to it.
@@ -137,11 +143,12 @@ exports.merge = (script, batch, standard, observe, requester, timeStamp) => {
           if (replacerName && target.acts) {
             let replacerActs = target.acts[replacerName];
             if (replacerActs) {
-              // Add a which property to any launch act in the replacer.
+              // Add properties to any launch act in the replacer.
               replacerActs = JSON.parse(JSON.stringify(replacerActs));
               for (const replacerAct of replacerActs) {
                 if (replacerAct.type === 'launch') {
                   replacerAct.which = act.launch;
+                  replacerAct.deviceID = deviceID;
                 }
               }
               acts[actIndex] = replacerActs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "33.6.2",
+  "version": "34.0.1",
   "description": "Prepares Testaro jobs and processes Testaro reports",
   "main": "call.js",
   "scripts": {
@@ -18,7 +18,8 @@
   },
   "homepage": "https://github.com/jrpool/testilo",
   "dependencies": {
-    "dotenv": "*"
+    "dotenv": "*",
+    "playwright": "*"
   },
   "devDependencies": {
     "eslint": "*"

package/procs/util.js

@@ -3,6 +3,11 @@
   Utility functions.
 */
 
+// IMPORTS
+
+// Devices recognized by Playwright.
+const {devices} = require('playwright');
+
 // CONSTANTS
 
 // Array of 62 alphanumeric characters.
@@ -87,3 +92,8 @@ exports.getBarCell = (num, colMax, svgWidth, isRight = false) => {
   const cell = `<td aria-hidden="true"${rightClass}>${svg}</td>`;
   return cell;
 };
+// Returns whether a device ID is recognized by Playwright.
+exports.isValidDeviceID = deviceID => {
+  const deviceIDs = Object.keys(devices);
+  return deviceIDs.includes(deviceID);
+};