sitespeed.io 27.5.0 → 27.6.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG - sitespeed.io  (we use [semantic versioning](https://semver.org))
 
+
+## 27.6.0 - 2023-05-10
+### Fixed
+* More fixes to the upcoming API, and fixing wrong exit code.
+
+### Added
+* Firefox and Edge 113 in the Docker container.
+
+## 27.5.1 - 2023-05-03
+### Fixed
+* Another fix for storing result data as JSON.
+
 ## 27.5.0 - 2023-05-03
 ### Added 
 * Use Chrome 113 in the Docker container.

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM sitespeedio/webbrowsers:chrome-113.0-firefox-112.0-edge-112.0
+FROM sitespeedio/webbrowsers:chrome-113.0-firefox-113.0-edge-113.0
 
 ARG TARGETPLATFORM=linux/amd64
 

package/bin/sitespeed.js

@@ -56,7 +56,7 @@ async function api(options) {
     }).start();
 
     try {
-      const data = await addTest(hostname, apiOptions, spinner);
+      const data = await addTest(hostname, apiOptions);
       const testId = JSON.parse(data).id;
       spinner.color = 'yellow';
       spinner.text = `Added test with id ${testId}`;
@@ -74,7 +74,6 @@ async function api(options) {
         );
         if (result.status === 'completed') {
           spinner.succeed(`Got test result with id ${testId}`);
-
           if (options.api.json) {
             console.log(JSON.stringify(result));
           } else {
@@ -87,7 +86,7 @@ async function api(options) {
         }
       }
     } catch (error) {
-      spinner.fail(error.toString());
+      spinner.fail(error.message);
       process.exitCode = 1;
       process.exit();
     }
@@ -115,6 +114,7 @@ async function start() {
   parsed.options.urlsMetaData = parsed.urlsMetaData;
 
   let options = parsed.options;
+
   if (options.api && options.api.hostname) {
     api(options);
   } else {
@@ -123,8 +123,13 @@ async function start() {
 
       // This can be used as an option to get hold of where the data is stored
       // for third parties
-      if (options.storeResult == 'true') {
-        writeFileSync('result.json', JSON.stringify(result));
+      if (options.storeResult) {
+        if (options.storeResult == 'true') {
+          writeFileSync('result.json', JSON.stringify(result));
+        } else {
+          // Use the name supplied
+          writeFileSync(options.storeResult, JSON.stringify(result));
+        }
       }
 
       if (result.errors.length > 0) {

package/lib/api/send.js

@@ -3,7 +3,7 @@ import https from 'node:https';
 
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
-export async function addTest(hostname, options, spinner) {
+export async function addTest(hostname, options) {
   const port = options.api.port ?? 3000;
   const postData = options;
   const postOptions = {
@@ -21,24 +21,17 @@ export async function addTest(hostname, options, spinner) {
     // not perfect but maybe work for us
     const library = options.api.port === 443 ? https : http;
     const request = library.request(postOptions, res => {
-      if (res.statusCode === 200) {
-        res.setEncoding('utf8');
-        let body = '';
-        res.on('data', chunk => (body += chunk));
-        res.on('end', () => resolve(body));
-      } else {
-        spinner.text = `Got ${res.statusCode} from the API: ${res.statusMessage}`;
-        spinner.color = 'red';
-        const e = new Error(
-          `Got ${res.statusCode} from the API: ${res.statusMessage}`
-        );
-        reject(e);
-      }
+      // res.setEncoding('utf8');
+      let data = [];
+      res.on('data', chunk => data.push(chunk));
+      res.on('end', () => {
+        return res.statusCode === 200
+          ? resolve(Buffer.concat(data).toString('utf8'))
+          : reject(Buffer.concat(data).toString('utf8'));
+      });
     });
     request.on('error', error => {
-      spinner.text = `Got ${error.toString()} from the API`;
-      spinner.color = 'red';
-      reject(error);
+      reject({ message: error.toString() });
     });
     request.write(JSON.stringify(postData));
     request.end();
@@ -71,21 +64,14 @@ export async function get(testId, hostname, options) {
     library
       .get(url, res => {
         let data = [];
-
-        if (res.statusCode != 200) {
-          return reject(
-            new Error(
-              `Got response code ${res.statusCode} from the API: ${res.statusMessage}`
-            )
-          );
-        }
-
         res.on('data', chunk => {
           data.push(chunk);
         });
 
         res.on('end', () => {
-          return resolve(JSON.parse(Buffer.concat(data).toString()));
+          return res.statusCode === 200
+            ? resolve(Buffer.concat(data).toString('utf8'))
+            : reject(Buffer.concat(data).toString('utf8'));
         });
       })
       .on('error', () => {

package/lib/cli/cli.js

@@ -149,6 +149,11 @@ function validateInput(argv) {
     return 'There is no benefit running debug mode inside a Docker container.';
   }
 
+  // If we ask the API for finished test, we don't need a URL
+  if (argv._.length === 0 && !argv.api.id) {
+    return 'You need to supply one/multiple URLs or scripts';
+  }
+
   // validate URLs/files
   const urlOrFiles = argv._;
   for (let urlOrFile of urlOrFiles) {
@@ -208,7 +213,6 @@ export async function parseCommandLine() {
     .parserConfiguration({ 'deep-merge-config': true })
     .env('SITESPEED_IO')
     .usage('$0 [options] <url>/<file>')
-    .require(1, 'One or multiple URLs or scripts')
 
     .option('debugMessages', {
       default: false,
@@ -1092,21 +1096,6 @@ export async function parseCommandLine() {
         'The wait time before you start the real testing after your pre-cache request.'
     })
     /*
-    API options
-    */
-    .option('api.key', {
-      describe: 'The API key to use',
-      group: 'API'
-    })
-    .option('api.hostname', {
-      describe: 'The hostname of the server hosting the API',
-      group: 'API'
-    })
-    .option('api.serverName', {
-      describe: 'The serverName that will run the actual test',
-      group: 'API'
-    })
-    /*
    Crawler options
    */
     .option('crawler.depth', {
@@ -1814,8 +1803,13 @@ export async function parseCommandLine() {
     });
 
   parsed
-    .option('api.type', {
-      describe: 'The type of API call you want to do: S',
+    .option('api.key', {
+      describe: 'The API key to use.',
+      group: 'API'
+    })
+    .option('api.action', {
+      describe:
+        'The type of API call you want to do: You get add a test and wait for the result, just add a test or get the result. To get the result, make sure you add the id using --api.id',
       default: 'addAndGetResult',
       choices: ['add', 'addAndGetResult', 'get'],
       group: 'API'
@@ -1824,9 +1818,20 @@ export async function parseCommandLine() {
       describe: 'The hostname of the API server.',
       group: 'API'
     })
+    .option('api.location', {
+      describe: 'The location of the worker that run the test.',
+      group: 'API'
+    })
+    .option('api.testType', {
+      describe:
+        'The test type you want to run. The location needs tp have the chosen test type.',
+      default: 'desktop',
+      choices: ['desktop', 'emulatedMobile', 'android', 'ios'],
+      group: 'API'
+    })
     .option('api.silent', {
       describe:
-        'Set to true if you do not want to log anything from the comunication',
+        'Set to true if you do not want to log anything from the communication',
       default: false,
       type: 'boolean',
       group: 'API'
@@ -1838,13 +1843,15 @@ export async function parseCommandLine() {
     })
     .option('api.id', {
       describe:
-        'The id of the test. You it when you want to get the test result.',
+        'The id of the test. Use it when you want to get the test result.',
+      type: 'string',
       group: 'API'
     })
     .option('api.json', {
       describe: 'Output the result as JSON.',
       group: 'API'
     });
+
   parsed
     .option('mobile', {
       describe:

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "sitespeed.io",
-  "version": "27.5.0",
+  "version": "27.6.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "sitespeed.io",
-      "version": "27.5.0",
+      "version": "27.6.0",
       "license": "MIT",
       "dependencies": {
         "@google-cloud/storage": "6.9.5",

package/package.json

@@ -5,7 +5,7 @@
     "sitespeed.io": "./bin/sitespeed.js",
     "sitespeed.io-wpr": "./bin/browsertimeWebPageReplay.js"
   },
-  "version": "27.5.0",
+  "version": "27.6.0",
   "description": "Analyze the web performance of your site",
   "keywords": [
     "performance",